Guide

SQL 数据库

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

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

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

选择实验性功能

数据库支持目前仍处于实验阶段。 请参考 db0 问题 获取状态和错误报告。

要启用数据库层,您需要启用实验性功能标志。

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

同时安装 better-sqlite3 依赖:

npm i -D better-sqlite3

使用方法

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 配置仅在开发模式中覆盖数据库配置。