Nile

新数据库

了解 Drizzle

Drizzle 和 Nile 入门

本指南假定您熟悉

dotenv - 用于管理环境变量的包 - 点击此处阅读
tsx - 用于运行 TypeScript 文件的包 - 点击此处阅读
Nile - 为多租户应用重新设计的 PostgreSQL - 点击此处阅读

基本文件结构

这是项目的基本文件结构。在 src/db 目录中，我们在 schema.ts 中定义了表。在 drizzle 文件夹中，包含 SQL 迁移文件和快照。

📦 <project root>
 ├ 📂 drizzle
 ├ 📂 src
 │   ├ 📂 db
 │   │  └ 📜 schema.ts
 │   └ 📜 index.ts
 ├ 📜 .env
 ├ 📜 drizzle.config.ts
 ├ 📜 package.json
 └ 📜 tsconfig.json

步骤 1 - 安装 postgres 包

npm

yarn

pnpm

bun

npm i drizzle-orm pg dotenv
npm i -D drizzle-kit tsx @types/pg

yarn add drizzle-orm pg dotenv
yarn add -D drizzle-kit tsx @types/pg

pnpm add drizzle-orm pg dotenv
pnpm add -D drizzle-kit tsx @types/pg

bun add drizzle-orm pg dotenv
bun add -D drizzle-kit tsx @types/pg

步骤 2 - 设置连接变量

在项目的根目录中创建 .env 文件，并添加你的数据库连接变量

NILEDB_URL=

第 3 步 - 将 Drizzle ORM 连接到数据库

在 src 目录中创建 index.ts 文件并初始化连接

node-postgres

带配置的 node-postgres

您的 node-postgres 驱动

import 'dotenv/config';
import { drizzle } from 'drizzle-orm/node-postgres';

const db = drizzle(process.env.NILEDB_URL!);

import 'dotenv/config';
import { drizzle } from 'drizzle-orm/node-postgres';

// You can specify any property from the node-postgres connection options
const db = drizzle({ 
  connection: { 
    connectionString: process.env.NILEDB_URL!,
    ssl: true
  }
});

import 'dotenv/config';
import { pgTable, serial, text, varchar } from "drizzle-orm/pg-core";
import { drizzle } from "drizzle-orm/node-postgres";
import { Pool } from "pg";

const pool = new Pool({
  connectionString: process.env.NILEDB_URL!,
});
const db = drizzle({ client: pool });

多租户

Nile 提供虚拟租户数据库。当您查询 Nile 时，可以设置租户上下文，Nile 会将您的查询指向该特定租户的虚拟数据库。所有带有租户上下文的查询将仅适用于该租户（例如，select * from table 将只返回该租户的记录）。要了解更多关于如何使用 Drizzle 设置租户上下文的信息，请查看官方 Nile-Drizzle 示例。

第 4 步 - 创建表

在 src/db 目录中创建一个 schema.ts 文件并声明您的表。由于 Nile 是为多租户应用设计的 Postgres，我们的 schema 包含一个用于租户的表和一个包含 tenant_id 列的待办事项表（我们将这些称为租户感知表）

import { pgTable, uuid, text, timestamp, varchar, vector, boolean } from "drizzle-orm/pg-core"
import { sql } from "drizzle-orm"

export const tenantsTable = pgTable("tenants", {
	id: uuid().default(sql`public.uuid_generate_v7()`).primaryKey().notNull(),
	name: text(),
	created: timestamp({ mode: 'string' }).default(sql`LOCALTIMESTAMP`).notNull(),
	updated: timestamp({ mode: 'string' }).default(sql`LOCALTIMESTAMP`).notNull(),
	deleted: timestamp({ mode: 'string' }),
});

export const todos = pgTable("todos", {
	id: uuid().defaultRandom(),
	tenantId: uuid("tenant_id"),
	title: varchar({ length: 256 }),
	estimate: varchar({ length: 256 }),
	embedding: vector({ dimensions: 3 }),
	complete: boolean(),
});

第 5 步 - 设置 Drizzle 配置文件

Drizzle config - 由 Drizzle Kit 使用的配置文件，包含有关你的数据库连接、迁移文件夹和 schema 文件的所有信息。

在项目的根目录中创建 drizzle.config.ts 文件并添加以下内容

import 'dotenv/config';
import { defineConfig } from 'drizzle-kit';

export default defineConfig({
  out: './drizzle',
  schema: './src/db/schema.ts',
  dialect: 'postgresql',
  dbCredentials: {
    url: process.env.NILEDB_URL!,
  },
});

第 6 步 - 将更改应用于数据库

您可以使用 drizzle-kit push 命令直接将更改应用到您的数据库。这是一种在本地开发环境中快速测试新 schema 设计或修改的便捷方法，无需管理迁移文件即可实现快速迭代

npx drizzle-kit push

在文档中阅读更多关于 push 命令的信息。

提示

或者，你可以使用 drizzle-kit generate 命令生成迁移，然后使用 drizzle-kit migrate 命令应用它们

生成迁移

npx drizzle-kit generate

应用迁移

npx drizzle-kit migrate

在文档中阅读更多关于迁移过程的信息。

第 7 步 - 填充和查询数据库

让我们更新 src/index.ts 文件，添加用于创建、读取、更新和删除租户及待办事项的查询。

import 'dotenv/config';
import { drizzle } from 'drizzle-orm/node-postgres';
import { eq, sql } from 'drizzle-orm';
import { tenantsTable, todosTable } from './db/schema';
  
const db = drizzle(process.env.NILEDB_URL!);

async function main() {
  const tenant: typeof tenantsTable.$inferInsert = {
    name: 'AwesomeSauce Inc.',
  };

  await db.insert(tenantsTable).values(tenant);
  console.log('New tenant created!')

  const tenants = await db.select().from(tenantsTable);
  console.log('Getting all tenants from the database: ', tenants)

  const todo: typeof todosTable.$inferInsert = {
    tenantId: tenants[0].id,
    title: 'Update pitch deck with AI stuff'
  }

  await db.insert(todosTable).values(todo);
  console.log('New todo created!')

  const todos = await db.select().from(todosTable);
  console.log('Getting all todos from the database: ', todos)

  await db.execute(sql`SET nile.tenant_id = '${sql.raw(tenants[0].id)}'`);
  console.log("Set tenant context");

  // note the lack of tenant_id in the query
  const tenant_todos = await db.select().from(todosTable);
  console.log('Getting all todos from the tenant virtual database: ', tenant_todos)

  await db
    .update(todosTable)
    .set({
      complete: true,
    })
    .where(eq(todosTable.id, todo.id));
  console.log('Todo marked as done!')

  await db.delete(todosTable).where(eq(todosTable.id, todo.id));
  console.log('Todo deleted!')
}

main();

第 8 步 - 运行 index.ts 文件

要运行任何 TypeScript 文件，你有多种选择，但我们只使用一种：使用 tsx

你已经安装了 tsx，所以我们现在可以运行查询了

运行 index.ts 脚本

npm

yarn

pnpm

bun

npx tsx src/index.ts

yarn tsx src/index.ts

pnpm tsx src/index.ts

bun tsx src/index.ts

提示

我们建议使用 bun 运行 TypeScript 文件。使用 bun，无论您的项目配置为 CommonJS (CJS)、ECMAScript Modules (ESM) 或任何其他模块格式，此类脚本都可以顺利执行，无需额外设置。要使用 bun 运行脚本，请使用以下命令

bun src/index.ts

如果你没有安装 bun，请查看 Bun 安装文档