Skip to content

Instantly share code, notes, and snippets.

@BUNotesAI
Created December 22, 2025 08:51
Show Gist options
  • Select an option

  • Save BUNotesAI/297121a8670ed704df433391e4853c6d to your computer and use it in GitHub Desktop.

Select an option

Save BUNotesAI/297121a8670ed704df433391e4853c6d to your computer and use it in GitHub Desktop.
drizzle orm llms.txt (created at 2025-12-22)

Drizzle ORM - LLMs.txt

Drizzle ORM 是一个无头(headless)的 TypeScript ORM,具有类 SQL 的查询 API 和关系查询 API。它轻量、高性能、类型安全、无依赖,专为 serverless 环境设计。

仓库信息


📚 核心文档

概述与入门


🚀 快速入门指南 (按数据库类型)

PostgreSQL

MySQL

SQLite

其他数据库

  • CockroachDB: CockroachDB 分布式数据库支持
  • MSSQL: Microsoft SQL Server 支持
  • SingleStore: SingleStore 数据库支持
  • Gel: Gel 数据库支持

🔌 数据库连接

连接概述

  • 数据库连接概述: Drizzle 如何通过数据库驱动执行 SQL 查询,支持各种运行时和 serverless 环境

PostgreSQL 系列

MySQL 系列

SQLite 系列

其他

  • Drizzle Proxy: 自定义代理连接,用于自定义驱动集成

📋 Schema 定义

基础 Schema

列类型参考 (按数据库)


🔍 数据查询

CRUD 操作

  • Select - 查询: 完整的 SELECT 查询文档,包括基础查询、部分选择、条件选择、过滤器、排序、分页、WITH 子句、子查询、聚合函数等
  • Insert - 插入: INSERT 语句,包括批量插入、ON CONFLICT 处理、RETURNING 等
  • Update - 更新: UPDATE 语句
  • Delete - 删除: DELETE 语句

高级查询


🔗 关系与关系查询

关系定义

关系查询 (RQB - Relational Query Builder)


🛠 Drizzle Kit (CLI 工具)

概述与配置

迁移命令

Drizzle Studio

迁移进阶


🌱 数据库填充 (Seeding)


🔒 安全与高级特性


⚡ 性能优化


🔧 集成与扩展

Schema 验证

  • Zod: drizzle-zod 集成,从 Drizzle Schema 生成 Zod schemas
  • Valibot: drizzle-valibot 集成
  • TypeBox: drizzle-typebox 集成
  • ArkType: drizzle-arktype 集成

其他集成

PostgreSQL 扩展


📖 实用指南

查询技巧

分页

数据操作

PostgreSQL 专用

默认值

本地开发设置

数据填充指南

特定平台


📚 教程

与数据库集成

与框架集成

边缘运行时教程


📦 其他资源


目录结构

src/content/docs/
├── column-types/          # 各数据库列类型参考
│   ├── pg.mdx
│   ├── mysql.mdx
│   ├── sqlite.mdx
│   ├── mssql.mdx
│   ├── singlestore.mdx
│   └── cockroach.mdx
├── extensions/            # PostgreSQL 扩展
├── get-started/           # 各数据库/平台快速入门
├── guides/                # 实用指南
├── latest-releases/       # 版本发布说明
├── migrate/               # 迁移相关
└── tutorials/             # 完整教程
    ├── drizzle-on-the-edge/
    ├── drizzle-with-db/
    └── drizzle-with-frameworks/

支持的数据库方言

数据库 包路径
PostgreSQL drizzle-orm/pg-core
MySQL drizzle-orm/mysql-core
SQLite drizzle-orm/sqlite-core
MSSQL (SQL Server) drizzle-orm/mssql-core
SingleStore drizzle-orm/singlestore-core
CockroachDB drizzle-orm/cockroach-core

核心特性总结

  1. 类型安全: 完整的 TypeScript 类型推断
  2. 类 SQL API: 熟悉 SQL 的开发者零学习曲线
  3. 关系查询 API: 简化嵌套数据获取
  4. 零依赖: 轻量级设计
  5. Serverless Ready: 原生支持边缘运行时
  6. 多数据库支持: PostgreSQL、MySQL、SQLite 及更多
  7. 自动迁移: drizzle-kit 工具链
  8. 可视化工具: Drizzle Studio
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment