Drizzle ORM Documentation
Complete Drizzle ORM documentation embedded in markdown. Read from references/ to answer questions about schema design, querying, migrations, and database integrations.
Documentation Structure
All documentation is in references/ organized by topic:
Getting Started (references/get-started/)
Installation and setup
Schema definition basics
Database connections
First queries
Database Connections (references/connect-*.mdx)
Connect to various databases and platforms:
PostgreSQL:
connect-neon.mdx,connect-supabase.mdx,connect-effect-postgres.mdx,connect-pglite.mdxMySQL:
connect-planetscale.mdx,connect-tidb.mdxSQLite:
connect-cloudflare-d1.mdx,connect-turso.mdx,connect-bun-sqlite.mdx,connect-expo-sqlite.mdx,connect-op-sqlite.mdxServerless:
connect-drizzle-proxy.mdx,connect-cloudflare-do.mdxEdge:
connect-nile.mdx,connect-sqlite-cloud.mdx
Column Types (references/column-types/)
All database column types and modifiers:
PostgreSQL, MySQL, SQLite types
Custom types and validators
Type safety and inference
Queries & Operations
Core query builder features:
select.mdx- Select queriesinsert.mdx- Insert operationsupdate.mdx- Update operationsdelete.mdx- Delete operationsjoins.mdx- Join queriesindexes.mdx- Index managementviews.mdx- Database viewsbatch-api.mdx- Batch operationstransactions.mdx- Transaction handling
Relations & Schema (references/relations/)
One-to-one, one-to-many, many-to-many
Foreign keys and constraints
Cascading operations
Migrations (references/migrate/)
Schema migration tools:
drizzle-kitusageMigration generation
Push vs generate modes
Migration deployment
Integrations & Extensions (references/extensions/)
Validation (Zod, Valibot, Arktype, Effect)
Type safety enhancements
Caching strategies
Guides (references/guides/)
Best practices and how-tos:
Performance optimization
Type-safe queries
Testing strategies
Production patterns
Tutorials (references/tutorials/)
Step-by-step walkthroughs for common use cases.
Latest Releases (references/latest-releases/)
Version-specific features and updates.
Quick Reference
Common Tasks
| Task | File to Read |
|---|---|
| Setup Drizzle | references/get-started/ |
| Connect to Neon | references/connect-neon.mdx |
| Connect to Supabase | references/connect-supabase.mdx |
| Connect to PlanetScale | references/connect-planetscale.mdx |
| Connect to Cloudflare D1 | references/connect-cloudflare-d1.mdx |
| Connect to Turso | references/connect-turso.mdx |
| Define schema | references/get-started/ + references/column-types/ |
| Run queries | references/select.mdx, references/insert.mdx, etc. |
| Setup relations | references/relations/ |
| Run migrations | references/migrate/ |
| Validate with Zod | references/zod.mdx |
| Batch operations | references/batch-api.mdx |
| Transactions | references/transactions.mdx |
When to Use This Skill
Setting up Drizzle ORM in a TypeScript project
Defining database schemas with type safety
Connecting to PostgreSQL, MySQL, or SQLite databases
Working with serverless/edge databases (Neon, Supabase, D1, Turso)
Writing type-safe queries
Managing database migrations
Adding validation with Zod/Valibot
Questions about Drizzle ORM patterns and best practices
How to Navigate
Start with
references/get-started/for installation and basicsFor database setup: Find relevant
connect-*.mdxfileFor schema design: Check
references/column-types/andreferences/relations/For queries: Use query-specific files (select, insert, update, delete, joins)
For migrations: See
references/migrate/For validation: Check
references/zod.mdxor other validator filesFor best practices: Browse
references/guides/
All files are .mdx (Markdown + JSX) but readable as plain markdown.