介绍
# Drizzle ORM Documentation
嵌入在 Markdown 中的完整 Drizzle ORM 文档。请阅读 `references/` 目录以回答有关模式设计、查询、迁移和数据库集成的问题。
## 文档结构
所有文档位于 `references/` 中，并按主题组织：
### 入门 (`references/get-started/`) - 安装和设置 - 模式定义基础 - 数据库连接 - 第一次查询
### 数据库连接 (`references/connect-*.mdx`) 连接到各种数据库和平台： - **PostgreSQL:** `connect-neon.mdx`, `connect-supabase.mdx`, `connect-effect-postgres.mdx`, `connect-pglite.mdx` - **MySQL:** `connect-planetscale.mdx`, `connect-tidb.mdx` - **SQLite:** `connect-cloudflare-d1.mdx`, `connect-turso.mdx`, `connect-bun-sqlite.mdx`, `connect-expo-sqlite.mdx`, `connect-op-sqlite.mdx` - **Serverless:** `connect-drizzle-proxy.mdx`, `connect-cloudflare-do.mdx` - **Edge:** `connect-nile.mdx`, `connect-sqlite-cloud.mdx`
### 列类型 (`references/column-types/`) 所有数据库列类型和修饰符： - PostgreSQL, MySQL, SQLite 类型 - 自定义类型和验证器 - 类型安全和推断
### 查询与操作 核心查询构建器功能： - `select.mdx` - 查询操作 - `insert.mdx` - 插入操作 - `update.mdx` - 更新操作 - `delete.mdx` - 删除操作 - `joins.mdx` - 连接查询 - `indexes.mdx` - 索引管理 - `views.mdx` - 数据库视图 - `batch-api.mdx` - 批量操作 - `transactions.mdx` - 事务处理
### 关系与模式 (`references/relations/`) - 一对一、一对多、多对多 - 外键和约束 - 级联操作
### 迁移 (`references/migrate/`) 模式迁移工具： - `drizzle-kit` 使用 - 迁移生成 - 推送 与生成 模式 - 迁移部署
### 集成与扩展 (`references/extensions/`) - 验证 (Zod, Valibot, Arktype, Effect) - 类型安全增强 - 缓存策略
### 指南 (`references/guides/`) 最佳实践和操作指南： - 性能优化 - 类型安全查询 - 测试策略 - 生产环境模式
### 教程 (`references/tutorials/`) 常见用例的分步演练。
### 最新版本 (`references/latest-releases/`) 特定版本的功能和更新。
## 快速参考
### 常见任务
| 任务 | 阅读文件 | |------|--------------| | 设置 Drizzle | `references/get-started/` | | 连接到 Neon | `references/connect-neon.mdx` | | 连接到 Supabase | `references/connect-supabase.mdx` | | 连接到 PlanetScale | `references/connect-planetscale.mdx` | | 连接到 Cloudflare D1 | `references/connect-cloudflare-d1.mdx` | | 连接到 Turso | `references/connect-turso.mdx` | | 定义模式 | `references/get-started/` + `references/column-types/` | | 运行查询 | `references/select.mdx`, `references/insert.mdx`, 等. | | 设置关系 | `references/relations/` | | 运行迁移 | `references/migrate/` | | 使用 Zod 验证 | `references/zod.mdx` | | 批量操作 | `references/batch-api.mdx` | | 事务 | `references/transactions.mdx` |
### 何时使用此技能
- 在 TypeScript 项目中设置 Drizzle ORM - 定义类型安全的数据库模式 - 连接到 PostgreSQL, MySQL 或 SQLite 数据库 - 使用 serverless/edge 数据库 (Neon, Supabase, D1, Turso) - 编写类型安全查询 - 管理数据库迁移 - 使用 Zod/Valibot 添加验证 - 有关 Drizzle ORM 模式和最佳实践的问题
### 如何浏览
1. **从 `references/get-started/` 开始** 了解安装和基础知识 2. **对于数据库设置：** 查找相关的 `connect-*.mdx` 文件 3. **对于模式设计：** 查看 `references/column-types/` 和 `references/relations/` 4. **对于查询：** 使用特定查询文件 (select, insert, update, delete, joins) 5. **对于迁移：** 参见 `references/migrate/` 6. **对于验证：** 查看 `references/zod.mdx` 或其他验证器文件 7. **对于最佳实践：** 浏览 `references/guides/`
所有文件均为 `.mdx` (Markdown + JSX) 格式，但可作为纯 Markdown 阅读。