v1.0
98%
Benchmarks
Extension
Studio
Studio Package
Gateway
Drizzle Run
Our goodies!
Our Primary backer
PlanetScale
Our Cloud Partner
Railway
Lokalise
Replit
Sentry
Sevalla
Clerk
Warp
Turso
🚀 Drizzle is giving you 10% off Turso Scaler and Pro for 1 Year 🚀
Payload
Xata
Neon
SQLite Cloud
Upstash
Sponsor

Drizzle 模式

Drizzle 允许你使用 TypeScript 定义模式，并支持底层数据库中的各种模型和属性。
当你定义模式时，它会作为未来查询修改（使用 Drizzle-ORM）和迁移（使用 Drizzle-Kit）的事实来源。

如果你正在使用 Drizzle-Kit 进行迁移流程，请务必导出你在模式文件中定义的所有模型，以便 Drizzle-Kit 可以导入它们，并在迁移 diff 过程中使用它们。

使用导入
使用回调
使用 import *
import { int, mssqlTable, varchar } from "drizzle-orm/mssql-core";

export const usersTable = mssqlTable("users", {
  id: int().primaryKey().identity(),
  name: varchar({ length: 256 }).notNull(),
  age: int().notNull(),
  email: varchar({ length: 256 }).notNull().unique(),
});

组织你的 schema 文件

你可以直接在 TypeScript 中声明你的 SQL schema，要么放在单个 schema.ts 文件里， 要么把它们分散到多个文件中——随你喜欢，完全自由！

1 个文件中的 Schema

在 Drizzle 中声明 schema 最常见的方式，是把所有表都放在一个 schema.ts 文件里。

注意：你可以把 schema 文件命名为任何你喜欢的名字。比如，它可以叫 models.ts，或者别的什么。

如果你定义的表模型不多，或者你希望把它们都放在一个文件里，这种方式就很适合。

示例：

📦 <project root>
 └ 📂 src
    └ 📂 db
       └ 📜 schema.ts

在 drizzle.config.ts 文件中，你需要指定 schema 文件的路径。通过这个配置，Drizzle 会 读取 schema.ts 文件，并在生成迁移的过程中使用这些信息。关于 drizzle.config.ts 文件以及 Drizzle 的迁移， 请查看：link

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: 'mssql',
  schema: './src/db/schema.ts'
})

多个文件中的 Schema

你可以把你的 Drizzle 模型——例如 tables、enums、sequences 等——不仅放在一个文件里，也可以放在任何你喜欢的文件中。 你唯一需要确保的是：把这些文件中的所有模型都导出，这样 Drizzle kit 才能导入 它们，并在迁移中使用它们。

一种用法是把每张表拆分到各自独立的文件中。

📦 <project root>
 └ 📂 src
    └ 📂 db
       └ 📂 schema
          ├ 📜 users.ts
          ├ 📜 countries.ts
          ├ 📜 cities.ts
          ├ 📜 products.ts
          ├ 📜 clients.ts
          └ 📜 etc.ts

在 drizzle.config.ts 文件中，你需要指定 schema 文件夹的路径。通过这个配置，Drizzle 会 读取 schema 文件夹，并递归查找所有文件，从那里获取所有的 drizzle tables。关于 drizzle.config.ts 文件以及 Drizzle 的迁移， 请查看：link

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: 'mssql',
  schema: './src/db/schema'
})

你也可以按你喜欢的任何方式对它们进行分组，例如按用户相关表、消息相关表、产品相关表等来分组。

📦 <project root>
 └ 📂 src
    └ 📂 db
       └ 📂 schema
          ├ 📜 users.ts
          ├ 📜 messaging.ts
          └ 📜 products.ts

设计你的数据模式

Drizzle schema 由你正在使用的数据库中的多种模型类型组成。使用 drizzle，你可以指定：

让我们逐一看看应该如何使用 drizzle 定义 schema

表和列的声明

Drizzle 中的表至少应定义 1 列，这与在数据库中应如何做是相同的。需要知道的一点是， Drizzle 中没有通用的表对象。你需要选择 MSSQL 的表对象。

import { mssqlTable, int } from "drizzle-orm/mssql-core"

export const users = mssqlTable('users', {
  id: int()
});

默认情况下，Drizzle 会在数据库查询中使用 TypeScript 的键名作为列名。 因此，上面的 schema 和查询将生成如下所示的 SQL 查询

此示例使用了一个 db 对象，其初始化不在本文档的这一部分中介绍。要了解如何连接到数据库，请参阅 连接文档


TypeScript 键 = 数据库键

// schema.ts
import { int, mssqlTable, varchar } from "drizzle-orm/mssql-core";

export const users = mssqlTable('users', {
  id: int(),
  first_name: varchar({ length: 256 })
})
// query.ts
await db.select().from(users);
SELECT [id], [first_name] FROM [users];

如果你想在 TypeScript 代码和数据库中使用不同的名称，可以使用列别名

// schema.ts
import { int, mssqlTable, varchar } from "drizzle-orm/mssql-core";

export const users = mssqlTable('users', {
  id: int(),
  firstName: varchar('first_name', { length: 256 })
})
// query.ts
await db.select().from(users);
SELECT [id], [first_name] FROM [users];

驼峰命名与蛇形命名

数据库模型名称通常使用 snake_case 约定，而在 TypeScript 中，通常使用 camelCase 来命名模型。 这可能会导致 schema 中需要定义大量别名。为了解决这个问题，Drizzle 提供了一种通过专用构建器自动 将 TypeScript 中的 camelCase 映射到数据库中的 snake_case 的方式。

使用来自 drizzle-orm/mssql-core 的 snakeCase 或 camelCase 构建器来声明一个表，其列键会 自动映射到所选的数据库命名约定

// schema.ts
import { snakeCase, camelCase } from 'drizzle-orm/mssql-core';

export const users = snakeCase.table('users', {
  id: int().primaryKey(),
  fullName: text(), // → 数据库中的 full_name
  createdAt: datetime2(), // → 数据库中的 created_at
});

// 适用于所有实体类型：
snakeCase.table / snakeCase.view / snakeCase.schema
camelCase.table / camelCase.view / camelCase.schema
// db.ts
import { drizzle } from "drizzle-orm/node-mssql";

const db = drizzle({ connection: process.env.DATABASE_URL })
// query.ts
await db.select().from(users);
select [id], [full_name], [created_at] from [users]

高级

你可以在 Drizzle ORM 中使用一些技巧。只要 Drizzle 完全位于 TypeScript 文件中， 本质上你就可以像在一个简单的 TypeScript 项目中那样对代码做任何事情。

一个常见做法是将列拆分到不同位置，然后重复使用它们。 例如，考虑 updated_at、created_at 和 deleted_at 列。许多表/模型可能都需要这三个字段， 来跟踪并分析系统中实体的创建、删除和更新

我们可以在单独的文件中定义这些列，然后导入并将它们展开到你拥有的所有表对象中

// columns.helpers.ts
export const timestamps = {
  updated_at: datetime2(),
  created_at: datetime2()..defaultGetDate().notNull(),
  deleted_at: datetime2(),
}
// users.sql.ts
export const users = mssqlTable('users', {
  id: int(),
  ...timestamps
})
// posts.sql.ts
export const posts = mssqlTable('posts', {
  id: int(),
  ...timestamps
})

模式


在 MSSQL 中，有一个名为 schema 的实体（我们认为它应该叫做 folders）。这会在 MSSQL 中创建一个结构：

你可以使用 mssqlSchema 管理你的 PostgreSQL schemas，并将其他任意模型放入其中。

使用 Drizzle 定义你想要管理的 schema

import { mssqlSchema } from "drizzle-orm/mssql-core"

export const customSchema = mssqlSchema('custom');

然后将表放入 schema 对象中

import { int, mssqlSchema } from "drizzle-orm/mssql-core";

export const customSchema = mssqlSchema('custom');

export const users = customSchema.table('users', {
  id: int()
})

示例

一旦你了解了基础内容，我们来定义一个真实项目的 schema 示例，以获得更好的视角和理解

所有示例都会使用 generateUniqueString。它的实现将在所有 schema 示例之后提供

import type { AnyMsSqlColumn } from "drizzle-orm/mssql-core";
import { mssqlTable as table } from "drizzle-orm/mssql-core";
import * as t from "drizzle-orm/mssql-core";

export const users = table(
  "users",
  {
    id: t.int().primaryKey().identity(),
    firstName: t.varchar("first_name", { length: 256 }),
    lastName: t.varchar("last_name", { length: 256 }),
    email: t.varchar({ length: 256 }).notNull(),
    invitee: t.int().references((): AnyMsSqlColumn => users.id),
    role: t.varchar({ length: 20, enum: ["guest", "admin", "user"] }).default("guest"),
  },
  (table) => [
    t.uniqueIndex("email_idx").on(table.email)
  ]
);

export const posts = table(
  "posts",
  {
    id: t.int().primaryKey().identity(),
    slug: t.varchar({ length: 256 }).$default(() => generateUniqueString(16)),
    title: t.varchar({ length: 256 }),
    ownerId: t.int("owner_id").references(() => users.id),
  },
  (table) => [
    t.uniqueIndex("slug_idx").on(table.slug),
    t.index("title_idx").on(table.title),
  ]
);

export const comments = table("comments", {
  id: t.int().primaryKey().identity(),
  text: t.varchar({ length: 256 }),
  postId: t.int("post_id").references(() => posts.id),
  ownerId: t.int("owner_id").references(() => users.id),
});

generateUniqueString 实现：

function generateUniqueString(length: number = 12): string {
  const characters =
    "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
  let uniqueString = "";

  for (let i = 0; i < length; i++) {
    const randomIndex = Math.floor(Math.random() * characters.length);
    uniqueString += characters[randomIndex];
  }

  return uniqueString;
}

接下来是什么？


管理 schema

列类型 索引和约束 数据库视图 数据库模式

从零到高手

数据库连接 数据查询 迁移