# 文档 - [概览](/docs.md): Drizzle ORM 是「活在 TypeScript 里的 SQL」——类型优先、零代码生成的 TypeScript SQL ORM。 - [快速开始](/docs/quickstart.md): 从零安装 Drizzle ORM,连接 PostgreSQL,定义 schema,生成迁移并完成第一次查询。 - [升级到 Drizzle v1](/docs/upgrade-v1.md): v0 到 v1(beta/RC)的主要变化、升级步骤、迁移历史转换与回滚建议。 - **核心概念** - [为什么选择 Drizzle](/docs/why-drizzle.md): 理解 Drizzle 的设计取舍:SQL 优先、类型安全、零代码生成、无头架构,以及它适合与不适合的场景。 - [常见陷阱](/docs/gotchas.md): 默认值与 $default、timestamp 模式、SQLite 布尔、join 结果形状、迁移不可变等高频坑点与规避代码。 - **连接数据库** - [连接数据库](/docs/connections.md): 根据运行时选择 PostgreSQL、MySQL、SQLite 与边缘数据库驱动,正确配置连接池、环境变量与类型。 - [PostgreSQL 驱动](/docs/drivers-postgres.md): node-postgres、postgres.js、Bun SQL、PGLite、AWS Data API、Effect Postgres 与 HTTP proxy 的初始化代码与选型建议。 - [PostgreSQL 提供商](/docs/providers-postgres.md): Neon、Supabase、Vercel Postgres、Prisma Postgres、Xata、Nile、PlanetScale、Netlify 与 Appwrite 的接入代码与坑点。 - [MySQL 驱动](/docs/drivers-mysql.md): mysql2、PlanetScale、TiDB Serverless、Bun SQL 与 HTTP proxy 的初始化代码、环境变量与选型建议。 - [SQLite 驱动](/docs/drivers-sqlite.md): better-sqlite3、libSQL/Turso、Cloudflare D1 与 Durable Objects、Bun、Node、Expo、OP-SQLite、SQLite Cloud 全矩阵。 - [在已有项目中使用 Drizzle](/docs/existing-project.md): 用 drizzle-kit pull 内省旧库生成 schema,渐进接管部分表,并对齐迁移基线。 - **Schema 建模** - [Schema 与类型](/docs/schema.md): 用 TypeScript 定义表、列、约束、索引与外键,并从 schema 推导插入与查询类型。 - [PostgreSQL 列类型](/docs/column-types-postgres.md): drizzle-orm/pg-core 列类型完整参考:整数、浮点、精确小数、字符串、日期时间、JSON、UUID、枚举、数组、几何、网络与向量类型及常用选项。 - [MySQL 列类型](/docs/column-types-mysql.md): drizzle-orm/mysql-core 列类型完整参考:整数与 unsigned、浮点与 decimal、字符串与 text 系列、二进制、日期时间、JSON、mysqlEnum 及 mode 选项。 - [SQLite 列类型](/docs/column-types-sqlite.md): drizzle-orm/sqlite-core 列类型参考:integer、real、text、blob、numeric 与 mode 选项(timestamp、boolean、json),存储类映射及枚举/数组的替代方案。 - [索引与约束](/docs/indexes-constraints.md): Drizzle 中主键、自增、notNull、default、unique、check、外键与索引的声明方式,覆盖 PostgreSQL、MySQL、SQLite 三种方言及迁移注意事项。 - [生成列](/docs/generated-columns.md): 用 generatedAlwaysAs 声明由数据库计算的生成列:PostgreSQL 仅 STORED,MySQL 与 SQLite 支持 virtual/stored,含支持矩阵、示例与限制。 - [自定义类型(customType)](/docs/custom-types.md): 用 customType 的 dataType、toDriver、fromDriver 三个函数映射任意数据库列类型,对比 $type 的取舍。 - [序列(Sequences)](/docs/sequences.md): 用 pgSequence 声明 PostgreSQL 序列,控制起始值、步长与循环,并在列默认值中通过 nextval 引用。 - [视图(Views)](/docs/views.md): 用 pgView、mysqlView、sqliteView 声明视图,掌握 PostgreSQL 物化视图的刷新与既有视图的迁移行为。 - [多 Schema 组织](/docs/schemas.md): 用 pgSchema 与 mysqlSchema 把表、枚举、序列组织进独立命名空间,并配置 drizzle-kit 的 schemaFilter。 - [PostgreSQL 扩展](/docs/extensions.md): 在 Drizzle 项目中使用 pgvector、PostGIS、uuid-ossp 等扩展:启用方式、内置列类型与迁移处理。 - [行级安全(RLS)](/docs/rls.md): 用 pgPolicy 声明 PostgreSQL 行级安全策略,掌握 enableRLS、角色、current_setting 与 Supabase / Neon 场景。 - [关联查询](/docs/relations.md): 用 defineRelations 声明 v2 关系(one/many/through),通过 db.query 的 with、columns、对象化 where 一次获取嵌套数据,并了解 v1 到 v2 的迁移要点。 - **查询** - [查询构建器](/docs/queries.md): 从 select、where、join 到聚合、CTE 与写入操作,系统掌握 Drizzle 的 SQL 风格查询 API。 - [SQL Select](/docs/select.md): db.select() 完整参考:全列与部分选择、表达式列、distinct、子查询与 CTE、过滤排序分页、聚合计数与动态查询构建。 - [SQL Insert](/docs/insert.md): db.insert() 完整参考:单行与批量插入、默认值与 $default、returning 与 $returningId、onConflict 系列 upsert 与 MySQL onDuplicateKeyUpdate。 - [SQL Update](/docs/update.md): db.update() 完整参考:set 对象、undefined 与 null 的区别、sql 表达式自增、where 过滤、returning 与 PostgreSQL 的 update … from 多表更新。 - [SQL Delete](/docs/delete.md): db.delete() 完整参考:where 过滤、returning 返回被删行、跨表条件删除的子查询写法,以及清空表与 truncate 的注意事项。 - [运算符](/docs/operators.md): Drizzle 过滤运算符速查:eq、inArray、like、between、exists、and/or/not 与 PostgreSQL 数组运算符,全部参数化、可组合。 - [Joins](/docs/joins.md): Drizzle join 完整参考:inner/left/right/full/cross 与 lateral、多表与子查询 join、自连接别名、嵌套结果类型与关系查询的取舍。 - [sql`` 模板运算符](/docs/sql-operator.md): 用 sql`` 模板标签编写原生 SQL 片段:嵌套组合、类型映射、sql.raw、占位符与预编译语句,以及防注入的正确姿势。 - [查询工具](/docs/query-utils.md): db.$count 统计行数、作为关联子查询嵌入 select 与关系查询,以及 exists 等相关辅助能力的用法。 - [别名](/docs/aliases.md): 用 alias 给表起别名实现自连接,用 .as() 给列、子查询与 CTE 命名,让复杂查询保持可读。 - [集合操作](/docs/set-operations.md): union、unionAll、intersect、intersectAll、except、exceptAll 的两种写法,以及对合并结果排序与分页。 - [Batch API](/docs/batch.md): db.batch 把多条语句打包成一次数据库调用:SQLite libSQL/Turso 与 Cloudflare D1、PostgreSQL Neon HTTP 的用法、返回类型与事务差异。 - [动态查询构建](/docs/dynamic.md): 用 $dynamic() 解除查询构建器方法只能调用一次的限制,编写可复用的分页、过滤与 join 增强函数。 - **迁移与工具** - [迁移](/docs/migrations.md): 用 drizzle-kit 生成可审查的 SQL 迁移,在 CI 与生产环境中安全地演进数据库。 - [迁移进阶](/docs/migrations-advanced.md): 团队协作中的迁移冲突处理、web 与 mobile 环境的迁移打包与运行时执行、自定义 SQL 与数据迁移。 - [drizzle-kit CLI](/docs/drizzle-kit.md): drizzle-kit 命令与配置参考:generate、migrate、push、pull、studio、check 与 up。 - [drizzle-kit 命令参考](/docs/kit-commands.md): generate、migrate、push、pull、export、check、up、studio 八个命令的用途、flags、产物与使用时机。 - [Drizzle Studio](/docs/studio.md): 使用 Drizzle Studio 在本地浏览、查询与编辑数据库,并了解访问控制与安全注意事项。 - [Drizzle Seed](/docs/seed.md): 用 drizzle-seed 生成确定性、可复现的假数据:seed/reset、refine、关联数据、generators 与版本控制。 - **校验与扩展** - [Zod 校验](/docs/zod.md): 用 drizzle-zod 从表定义生成 insert/select/update 校验 schema,refine 定制、coerce 类型转换与 tRPC/表单集成。 - [其他校验集成](/docs/validations.md): valibot、TypeBox、ArkType、Effect Schema 与 Drizzle 的集成:包名、createSchema 函数与 insert 校验示例。 - [GraphQL 集成](/docs/graphql.md): 用 drizzle-graphql 的 buildSchema(db) 一行生成 GraphQL schema,接入 Apollo Server 或 GraphQL Yoga,并按需裁剪。 - **进阶** - [事务](/docs/transactions.md): 使用 db.transaction 保证多条写入的原子性,理解回滚、隔离级别、保存点与驱动差异。 - [查询缓存](/docs/cache.md): 用 upstashCache 与 $withCache 为 Drizzle 查询加上显式或全局缓存,理解自动失效、TTL 与写后读一致性。 - [读写分离](/docs/read-replicas.md): 用 withReplicas 把 SELECT 路由到只读副本、写操作固定走主库,支持自定义权重路由与 $primary 强制主库。 - [性能](/docs/performance.md): 从列裁剪、索引、N+1、预编译到连接池,理解 Drizzle 应用中的常见性能杠杆。 - [实时查询(Drizzle Pulse)](/docs/realtime.md): Drizzle Pulse 通过 PostgreSQL 逻辑复制把查询结果常驻内存:live collections 与 CDC 事件流的定义、服务端 setup 与关键注意点。 - **生态与集成** - [生态系统](/docs/ecosystem.md): Drizzle 的驱动矩阵、drizzle-kit、Drizzle Studio、drizzle-seed 与 schema 校验工具。 - [框架集成](/docs/integrations.md): 在 Next.js、SvelteKit、Remix、Astro、Nuxt、Expo 与 tRPC 中接入 Drizzle:初始化位置、查询示例与各自的坑。 - [面向 AI Agent 的 Drizzle](/docs/ai-agents.md): 用官方 agent setup、Drizzle Kit MCP server 与 drizzle skill 武装编码助手,以及本站的 LLM 友好文档端点。 - **参考** - [常见问题](/docs/faq.md): 关于 Drizzle 的方言支持、代码生成、迁移、版本差异与边缘部署的常见疑问。