SuperAPI AI Directory

drizzle

Coding & development

View repository

Updated 10-16 08:37

About this skill

Drizzle ORM API Reference

Drizzle ORM / Drizzle Kit — TypeScript headless ORM (target version drizzle-orm / drizzle-kit 1.0.0-rc.5。npm dist-tag latest の 0.45.2 is out of scope; npm i drizzle-orm@rc / npm i -D drizzle-kit@rc Install with .drizzle-kit は drizzle-orm and are versioned independently, but at the point targeted by this skill, both use 1.0.0-rc.5)。 pgTable / mysqlTable / sqliteTable for schema declaration, an SQL-like query builder, and RQB (Relational Queries, db.query) as two query API systems, and thedrizzle-kit CLI for migrations (generate / migrate / push / pull) as the core; refer to these when designing and implementing APIs.

For low-level connections to SQL Server (thetedious / msnodesqlv8 driver itself), refer to the separate skill mssql (there is a boundary line atreferences/column-types/mssql.md / references/connect/mssql.md ). Similarly, for Supabase itself refer to supabase, for zod's own API refer to zod, and for the Upstash Redis client itself refer to upstash .

A list of breaking changes from v0.x → v1.0 is in references/migration/v0-v1-changes.md , and the affected individual pages (drizzle-kit/ commands,relational-queries/rqb.md / relations.md、 column-types/mssql.md / cockroach.md、connect/mssql.md , etc.) have ## Notes に Migration (v0 → v1): ... explicitly noted per-page.

Directory structure

skills/drizzle/
  SKILL.md
  references/
    getting-started/
      README.md
      overview.md
      get-started.md
      why-drizzle.md
      gotchas.md
      faq.md
      sustainability.md
      latest-releases.md
    schema/
      README.md
      sql-schema-declaration.md
      indexes-constraints.md
      sequences.md
      views.md
      schemas.md
      extensions.md
      rls.md
      generated-columns.md
      custom-types.md
      codecs.md
    column-types/
      README.md
      pg.md
      mysql.md
      sqlite.md
      singlestore.md
      cockroach.md
      mssql.md
    connect/
      README.md
      connect-overview.md
      get-started-postgresql.md
      connect-neon.md
      connect-supabase.md
      connect-vercel-postgres.md
      connect-pglite.md
      connect-xata.md
      connect-nile.md
      connect-bun-sql.md
      connect-effect-postgres.md
      connect-netlify-db.md
      connect-aws-data-api-pg.md
      connect-prisma-postgres.md
      connect-planetscale-postgres.md
      connect-drizzle-proxy.md
      mysql-drivers.md
      sqlite-drivers.md
      mssql.md
      cockroach.md
      singlestore.md
    queries/
      README.md
      data-querying.md
      select.md
      insert.md
      update.md
      delete.md
      operators.md
      query-utils.md
      joins.md
      aliases.md
      sql.md
      sql-comments.md
    relational-queries/
      README.md
      rqb.md
      relations.md
      relations-schema-declaration.md
      relations-v1-v2.md
    drizzle-kit/
      README.md
      kit-overview.md
      drizzle-kit-generate.md
      drizzle-kit-migrate.md
      drizzle-kit-push.md
      drizzle-kit-pull.md
      drizzle-kit-export.md
      drizzle-kit-check.md
      drizzle-kit-up.md
      drizzle-kit-studio.md
      kit-custom-migrations.md
      kit-migrations-for-teams.md
      kit-web-mobile.md
      drizzle-config-file.md
    advanced/
      README.md
      transactions.md
      batch-api.md
      cache.md
      dynamic-query-building.md
      read-replicas.md
      set-operations.md
      jit-mappers.md
      perf-queries.md
      perf-serverless.md
    validations/
      README.md
      zod.md
      valibot.md
      typebox.md
      typebox-legacy.md
      arktype.md
      effect-schema.md
    extensions/
      README.md
      eslint-plugin.md
      graphql.md
    migration/
      README.md
      upgrade-v1.md
      v0-v1-changes.md
    seeding/
      README.md
      seed-overview.md
      seed-functions.md
      seed-versioning.md
      seed-limitations.md
  samples/
    README.md
    schema-definition.md
    rqb-avoid-n-plus-one.md
    cursor-pagination.md
    limit-offset-pagination.md
    transactions.md
    joins-partial-select.md
    include-exclude-columns.md
    drizzle-zod-validation.md
    read-replicas.md
    upstash-cache.md
    nextjs-neon-todo.md
    connect-supabase.md
    connect-neon.md
    seed-with-relations.md
    conditional-filters.md
    upsert.md
    count-rows.md
  scripts/
    README.md
    install.md
    drizzle-kit.md
    config.md
    studio.md

Exploration procedure

Derive the category from the task, and identify the target page in the category's README.md:

  1. Find the category corresponding to the task in the mapping table below
  2. For that category, references/{category}/README.md to identify the target page
  3. Read the .md of the corresponding page to check the details

Task → Category Mapping

Task Category Reference README
Installation, Quick Start,generate と push differences and FAQ getting-started references/getting-started/README.md
pgTable , index/constraint, sequence, view, schema namespace, RLS, generated column, custom type schema references/schema/README.md
Want to look up dialect-specific column types (PostgreSQL / MySQL / SQLite / SingleStore / CockroachDB / MSSQL) column-types references/column-types/README.md
How to connect to DB / hosting (Neon, Supabase, Vercel, PGlite, Xata, Nile, Bun, Effect, Netlify, AWS Data API, PlanetScale, drizzle-proxy), dialect-specific drivers connect references/connect/README.md
SQL-like select / insert / update / delete, filter operators, join, alias, magic sql operator queries references/queries/README.md
db.query (RQB)、defineRelations、with nested relation fetching, v1 → v2 migration relational-queries references/relational-queries/README.md
drizzle-kit generate / migrate / push / pull / export / check / up / studio、drizzle.config.ts drizzle-kit references/drizzle-kit/README.md
Transactions, batch API, query caching, dynamic query building, read replica, set operations, performance tuning advanced references/advanced/README.md
Schema generation with drizzle-zod / valibot / typebox / arktype / effect-schema validations references/validations/README.md
eslint-plugin-drizzle、drizzle-graphql extensions references/extensions/README.md
Breaking changes and upgrade procedure from v0.x → v1.0 migration references/migration/README.md
Deterministic fake data seeding with drizzle-seed seeding references/seeding/README.md
Want to know typical usage samples samples/README.md
Want to know installation and CLI commands scripts scripts/README.md

Future extensions

drizzle-orm When v1.0.0 GA is released (when npm dist-tag becomes latest が 1.0.0 ) /update-skill drizzle check is executed.