Guide

SQL 数据库

Nitro 提供了一个内置的轻量 SQL 数据库层。

默认的数据库连接已预配置SQLite,并且可以在开发模式和任何兼容 Node.js 的生产部署中开箱即用。默认情况下,数据将存储在 .data/db.sqlite 中。

你可以更改默认连接或为任何 支持的数据库 定义更多连接。
你可以将数据库实例集成到任何 支持的 ORM 中。
Read more in DB0 文档.

自愿参与实验特性

数据库支持目前处于实验阶段。 请参阅 db0 问题 以获取状态和报告 bug。

为了启用数据库层,你需要启用实验特性标志。

export default defineNitroConfig({
  experimental: {
    database: true
  }
})

用法

index.ts
export default defineEventHandler(async () => {
  const db = useDatabase();

  // Create users table
  await db.sql`DROP TABLE IF EXISTS users`;
  await db.sql`CREATE TABLE IF NOT EXISTS users ("id" TEXT PRIMARY KEY, "firstName" TEXT, "lastName" TEXT, "email" TEXT)`;

  // Add a new user
  const userId = String(Math.round(Math.random() * 10_000));
  await db.sql`INSERT INTO users VALUES (${userId}, 'John', 'Doe', '')`;

  // Query for users
  const { rows } = await db.sql`SELECT * FROM users WHERE id = ${userId}`;

  return {
    rows,
  };
});

配置

你可以使用 database 配置来配置数据库连接:

export default defineNitroConfig({
  database: {
    default: {
      connector: 'sqlite',
      options: { name: 'db' }
    },
    users: {
      connector: 'postgresql',
      url: 'postgresql://username:password@hostname:port/database_name'
    }
  }
})
你可以使用 devDatabase 配置仅在开发模式下覆盖数据库配置。