Drizzle ORM

https://rqbv2.drizzle-orm-fe.pages.dev/docs
Admin
Drizzle ORM is a lightweight, performant, and typesafe TypeScript ORM. It offers both SQL-like and...
Tokens:431,389
Snippets:3,613
Trust Score:7.2
Update:19 hours ago
Show doc for...
Tokens:
Raw
### Connecting to database and making first query

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/latest-releases/drizzle-orm-v0110

Quick start example showing how to connect to a PostgreSQL database and execute a select query with a typed result.

```typescript
import { drizzle, PgTable } from 'drizzle-orm'

export class UsersTable extends PgTable<UsersTable> {
  public id = this.serial('id').primaryKey();
  public fullName = this.text('full_name');
  public phone = this.varchar('phone', { size: 256 });

  public tableName(): string {
    return 'users';
  }
}
export type User = InferType<UsersTable>

const db = await drizzle.connect("postgres://user:password@host:port/db");
const usersTable = new UsersTable(db);

const users: User[] = await usersTable.select().execute();
```

--------------------------------

### Example usage of findSimilarGuides

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/guides/vector-similarity-search

Example invocation of findSimilarGuides with a sample description to retrieve similar guides.

```typescript
const description = 'Guides on using Drizzle ORM with different platforms';

const similarGuides = await findSimilarGuides(description);
```

--------------------------------

### Example output of similar guides search

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/guides/vector-similarity-search

Example result array from findSimilarGuides showing four similar guides with their similarity scores.

```json
[
  {
    name: 'Drizzle with Turso',
    url: '/docs/tutorials/drizzle-with-turso',
    similarity: 0.8642314333984994
  },
  {
    name: 'Drizzle with Supabase Database',
    url: '/docs/tutorials/drizzle-with-supabase',
    similarity: 0.8593631126014918
  },
  {
    name: 'Drizzle with Neon Postgres',
    url: '/docs/tutorials/drizzle-with-neon',
    similarity: 0.8541051184461372
  },
  {
    name: 'Drizzle with Vercel Edge Functions',
    url: '/docs/tutorials/drizzle-with-vercel-edge-functions',
    similarity: 0.8481551084241092
  }
]
```

--------------------------------

### Install @planetscale/database with bun

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-vercel-edge-functions

Install the @planetscale/database driver using bun.

```bash
bun add @planetscale/database
```

--------------------------------

### Install @libsql/client with bun

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-turso

Install @libsql/client package using bun.

```bash
bun add @libsql/client
```

--------------------------------

### Basic file structure after setup

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started/expo-new

Shows the expected project structure after installing the template and adding the db folder. The db/schema.ts file will contain Drizzle table definitions, and the drizzle folder will hold SQL migration files and snapshots.

```text
📦 <project root>
 ├ 📂 assets
 ├ 📂 drizzle
 ├ 📂 db
 │  └ 📜 schema.ts
 ├ 📜 .gitignore
 ├ 📜 .npmrc
 ├ 📜 app.json
 ├ 📜 App.tsx
 ├ 📜 babel.config.ts
 ├ 📜 drizzle.config.ts
 ├ 📜 package.json
 └ 📜 tsconfig.json
```

--------------------------------

### Install @libsql/client with npm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-turso

Install @libsql/client package using npm.

```bash
npm i @libsql/client
```

--------------------------------

### Install @libsql/client with yarn

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-turso

Install @libsql/client package using yarn.

```bash
yarn add @libsql/client
```

--------------------------------

### Install @libsql/client with pnpm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-turso

Install @libsql/client package using pnpm.

```bash
pnpm add @libsql/client
```

--------------------------------

### Install @planetscale/database with pnpm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-vercel-edge-functions

Install the @planetscale/database driver using pnpm.

```bash
pnpm add @planetscale/database
```

--------------------------------

### Install Neon serverless driver (bun)

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-nextjs-neon

Install the Neon serverless driver using bun.

```bash
bun add @neondatabase/serverless
```

--------------------------------

### Install @planetscale/database with npm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-vercel-edge-functions

Install the @planetscale/database driver using npm.

```bash
npm i @planetscale/database
```

--------------------------------

### Install @planetscale/database with yarn

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-vercel-edge-functions

Install the @planetscale/database driver using yarn.

```bash
yarn add @planetscale/database
```

--------------------------------

### Install drizzle-kit with bun

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/kit-overview

Install the Drizzle Kit CLI using bun.

```bash
bun add drizzle-kit
```

--------------------------------

### Install Neon serverless driver (npm)

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-nextjs-neon

Install the Neon serverless driver using npm.

```bash
npm i @neondatabase/serverless
```

--------------------------------

### Install Drizzle ORM and better-sqlite3 with bun

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started-sqlite

Install the required packages using bun. The first command installs the runtime dependencies, the second installs the development dependencies.

```bash
bun add drizzle-orm better-sqlite3
bun add -D drizzle-kit @types/better-sqlite3
```

--------------------------------

### Install packages with bun

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started/mysql-new

Installs the same packages using bun.

```bash
bun add drizzle-orm mysql2 dotenv
bun add -D drizzle-kit tsx
```

--------------------------------

### Install Gel CLI on Linux or macOS

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started/gel-new

Command to install the Gel CLI using curl. After installation, run 'gel project init' to initialize the project.

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.edgedb.com | sh
```

--------------------------------

### Install @vercel/postgres with bun

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-vercel

Install @vercel/postgres package using bun.

```bash
bun add @vercel/postgres
```

--------------------------------

### Install postgres with bun

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-supabase

Install postgres package for connecting to Postgres database using bun.

```bash
bun add postgres
```

--------------------------------

### Install Neon serverless driver (yarn)

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-nextjs-neon

Install the Neon serverless driver using yarn.

```bash
yarn add @neondatabase/serverless
```

--------------------------------

### Install drizzle-kit with npm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/kit-overview

Install the Drizzle Kit CLI using npm.

```bash
npm i drizzle-kit
```

--------------------------------

### Install Neon serverless driver (pnpm)

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-nextjs-neon

Install the Neon serverless driver using pnpm.

```bash
pnpm add @neondatabase/serverless
```

--------------------------------

### Install drizzle-kit with yarn

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/kit-overview

Install the Drizzle Kit CLI using yarn.

```bash
yarn add drizzle-kit
```

--------------------------------

### Install drizzle-kit with pnpm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/kit-overview

Install the Drizzle Kit CLI using pnpm.

```bash
pnpm add drizzle-kit
```

--------------------------------

### v2 filtering by relations

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/relations-v1-v2

Shows how to filter by related records using the `where` object with a relation name. The example gets users with ID > 10 and who have at least one post with content starting with 'M'.

```typescript
const usersWithPosts = await db.query.usersTable.findMany({
  where: {
    id: {
      gt: 10
    },
    posts: {
      content: {
        like: 'M%'
      }
    }
  },
});
```

--------------------------------

### Initialize Netlify project (netlify init)

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-netlify-edge-functions-supabase

Command to initialize a new Netlify project. Follow the CLI prompts; in this tutorial choose 'Yes, create and deploy site manually' -> <YOUR_TEAM> -> <SITE_NAME>.

```bash
netlify init
```

--------------------------------

### drizzle-kit push CLI configuration examples (npm)

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/drizzle-kit-push

Three CLI commands showing how to provide configuration options directly: basic, pglite driver, and tablesFilter/extensionsFilters.

```bash
npx drizzle-kit push dialect=postgresql schema=src/schema.ts url=postgresql://user:password@host:port/dbname
npx drizzle-kit push dialect=postgresql schema=src/schema.ts driver=pglite url=database/
npx drizzle-kit push dialect=postgresql schema=src/schema.ts --tablesFilter=‘user*’ --extensionsFilters=postgis url=postgresql://user:password@host:port/dbname
```

--------------------------------

### Example database URL for the created container

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/guides/postgresql-local-setup

A concrete example URL using the container's credentials and localhost.

```text
postgres://postgres:mypassword@localhost:5432/postgres
```

--------------------------------

### Install postgres with npm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-supabase

Install postgres package for connecting to Postgres database using npm.

```bash
npm i postgres
```

--------------------------------

### intPrimaryKey generator example

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/seed-functions

Generates sequential integers starting from 1. The example shows using funcs.intPrimaryKey() with no parameters.

```javascript
import { seed } from "drizzle-seed";

await seed(db, schema, { count: 1000 }).refine((funcs) => ({
  posts: {
    columns: {
      id: funcs.intPrimaryKey(),
    },
  },
}));
```

--------------------------------

### Project structure with multiple config files

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/drizzle-kit-check

Example directory layout showing where config files and migration folders reside.

```text
📦 <project root>
 ├ 📂 drizzle
 ├ 📂 src
 ├ 📜 .env
 ├ 📜 drizzle-dev.config.ts
 ├ 📜 drizzle-prod.config.ts
 ├ 📜 package.json
 └ 📜 tsconfig.json
```

--------------------------------

### Apollo Server setup (server.ts and schema.ts)

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/graphql

Example server.ts and schema.ts files for setting up a GraphQL server with Apollo Server and drizzle-graphql. The server.ts file creates a Drizzle instance, builds the GraphQL schema, and starts the Apollo Server. The schema.ts file defines the Drizzle tables and relations for users and posts.

```typescript
import { buildSchema } from 'drizzle-graphql';
import { drizzle } from 'drizzle-orm/...';
import client from './db';
import { ApolloServer } from '@apollo/server';
import { startStandaloneServer } from '@apollo/server/standalone';

import * as dbSchema from './schema';

const db = drizzle({ client, schema: dbSchema });

const { schema } = buildSchema(db);

const server = new ApolloServer({ schema });
const { url } = await startStandaloneServer(server);

console.log(`🚀 Server ready at ${url}`);
```

```typescript
import { integer, serial, text, pgTable } from 'drizzle-orm/pg-core';
import { relations } from 'drizzle-orm';

export const users = pgTable('users', {
  id: serial('id').primaryKey(),
  name: text('name').notNull(),
});

export const usersRelations = relations(users, ({ many }) => ({
  posts: many(posts),
}));

export const posts = pgTable('posts', {
  id: serial('id').primaryKey(),
  content: text('content').notNull(),
  authorId: integer('author_id').notNull(),
});

export const postsRelations = relations(posts, ({ one }) => ({
  author: one(users, { fields: [posts.authorId], references: [users.id] }),
}));
```

--------------------------------

### GraphQL Yoga setup (server.ts and schema.ts)

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/graphql

Example server.ts and schema.ts files for setting up a GraphQL server with GraphQL Yoga and drizzle-graphql. The server.ts file creates a Drizzle instance, builds the GraphQL schema, and starts the server on port 4000. The schema.ts file defines the Drizzle tables and relations for users and posts.

```typescript
import { buildSchema } from 'drizzle-graphql';
import { drizzle } from 'drizzle-orm/...';
import { createYoga } from 'graphql-yoga';
import { createServer } from 'node:http';

import * as dbSchema from './schema';

const db = drizzle({ schema: dbSchema });

const { schema } = buildSchema(db);

const yoga = createYoga({ schema });
const server = createServer(yoga);

server.listen(4000, () => {
  console.info('Server is running on http://localhost:4000/graphql');
});
```

```typescript
import { integer, serial, text, pgTable } from 'drizzle-orm/pg-core';
import { relations } from 'drizzle-orm';

export const users = pgTable('users', {
  id: serial('id').primaryKey(),
  name: text('name').notNull(),
});

export const usersRelations = relations(users, ({ many }) => ({
  posts: many(posts),
}));

export const posts = pgTable('posts', {
  id: serial('id').primaryKey(),
  content: text('content').notNull(),
  authorId: integer('author_id').notNull(),
});

export const postsRelations = relations(posts, ({ one }) => ({
  author: one(users, { fields: [posts.authorId], references: [users.id] }),
}));
```

--------------------------------

### Example .env with file: prefix

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started/sqlite-new

Example of setting DB_FILE_NAME to create a local SQLite database file in the project root. The 'file:' prefix is required by LibSQL.

```bash
DB_FILE_NAME=file:local.db
```

--------------------------------

### Select data with Drizzle ORM

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-neon

Provides three select query examples: get a user by ID, get users with post counts using left join and group by, and get posts from the last 24 hours using a between condition with SQL template.

```typescript
import { asc, between, count, eq, getTableColumns, sql } from 'drizzle-orm';
import { db } from '../db';
import { SelectUser, usersTable, postsTable } from '../schema';

export async function getUserById(id: SelectUser['id']): Promise<
  Array<{
    id: number;
    name: string;
    age: number;
    email: string;
  }>
> {
  return db.select().from(usersTable).where(eq(usersTable.id, id));
}

export async function getUsersWithPostsCount(
  page = 1,
  pageSize = 5,
): Promise<
  Array<{
    postsCount: number;
    id: number;
    name: string;
    age: number;
    email: string;
  }>
> {
  return db
    .select({
      ...getTableColumns(usersTable),
      postsCount: count(postsTable.id),
    })
    .from(usersTable)
    .leftJoin(postsTable, eq(usersTable.id, postsTable.userId))
    .groupBy(usersTable.id)
    .orderBy(asc(usersTable.id))
    .limit(pageSize)
    .offset((page - 1) * pageSize);
}

export async function getPostsForLast24Hours(
  page = 1,
  pageSize = 5,
): Promise<
  Array<{
    id: number;
    title: string;
  }>
> {
  return db
    .select({
      id: postsTable.id,
      title: postsTable.title,
    })
    .from(postsTable)
    .where(between(postsTable.createdAt, sql`now() - interval '1 day'`, sql`now()`))
    .orderBy(asc(postsTable.title), asc(postsTable.id))
    .limit(pageSize)
    .offset((page - 1) * pageSize);
}
```

--------------------------------

### Turso CLI: Signup and Login

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-turso

Authenticate with Turso CLI. Run 'turso auth signup' for new accounts or 'turso auth login' for existing users.

```bash
turso auth signup
```

```bash
turso auth login
```

--------------------------------

### Configure extensionsFilters in drizzle.config.ts

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/drizzle-config-file

Use extensionsFilters to declare installed extensions whose tables should be ignored by drizzle-kit push and pull. This example ignores tables created by the 'postgis' extension.

```TypeScript
export default defineConfig({
  dialect: "postgresql",
  extensionsFilters: ["postgis"],
});
```

--------------------------------

### Configure tablesFilter in drizzle.config.ts

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/drizzle-config-file

Use tablesFilter to specify a glob-based filter for table names. This example filters tables to 'users', 'posts', and any table starting with 'project1_'. Applies to generate, push, and pull commands.

```TypeScript
import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "postgresql",
  tablesFilter: ["users", "posts", "project1_*"],
});
```

--------------------------------

### sql.empty() dynamic SQL construction

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/sql

Starts with a blank SQL object using sql.empty() and appends chunks to build a query incrementally. The example appends a SELECT, WHERE, and a loop of id conditions with OR separators, producing a parameterized query.

```javascript
const finalSql = sql.empty();

// some logic

finalSql.append(sql`select * from users`);

// some logic

finalSql.append(sql` where `);

// some logic

for (let i = 0; i < 5; i++) {
	finalSql.append(sql`id = ${i}`);

	if (i === 4) continue;
	finalSql.append(sql` or `);
}
```

```sql
select * from users where id = $1 or id = $2 or id = $3 or id = $4 or id = $5; --> [0, 1, 2, 3, 4]
```

--------------------------------

### Initialize Supabase project

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-supabase-edge-functions

Creates a new Supabase project in the current folder, generating a supabase folder with config.toml.

```bash
supabase init
```

--------------------------------

### Create an identity column with generatedAlwaysAsIdentity

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/column-types/pg

Defines a table with an identity column that always generates values starting at 1000. Requires drizzle-orm@0.32.0+ and drizzle-kit@0.23.0+. The example uses integer().primaryKey().generatedAlwaysAsIdentity({ startWith: 1000 }).

```typescript
import { pgTable, integer, text } from 'drizzle-orm/pg-core' 

export const ingredients = pgTable("ingredients", {
  id: integer().primaryKey().generatedAlwaysAsIdentity({ startWith: 1000 }),
  name: text().notNull(),
  description: text(),
});
```

--------------------------------

### Example MySQL database URL

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/guides/mysql-local-setup

Example URL for the created container using root user and password mypassword.

```text
mysql://root:mypassword@localhost:3306/mysql
```

--------------------------------

### Create HNSW indexes for L2, inner product, and cosine distance

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/latest-releases/drizzle-orm-v0310

Translates pg_vector index creation examples to Drizzle schema definitions. Requires PostgreSQL with pg_vector extension installed. Uses the vector column type and index().using('hnsw', ...) with operator classes.

```typescript
// CREATE INDEX ON items USING hnsw (embedding vector_l2_ops);
// CREATE INDEX ON items USING hnsw (embedding vector_ip_ops);
// CREATE INDEX ON items USING hnsw (embedding vector_cosine_ops);

const table = pgTable('items', {
    embedding: vector('embedding', { dimensions: 3 })
}, (table) => ({
    l2: index('l2_index').using('hnsw', table.embedding.op('vector_l2_ops'))
    ip: index('ip_index').using('hnsw', table.embedding.op('vector_ip_ops'))
    cosine: index('cosine_index').using('hnsw', table.embedding.op('vector_cosine_ops'))
}))
```

--------------------------------

### Install Drizzle ORM and better-sqlite3 with pnpm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started-sqlite

Install the required packages using pnpm. The first command installs the runtime dependencies, the second installs the development dependencies.

```bash
pnpm add drizzle-orm better-sqlite3
pnpm add -D drizzle-kit @types/better-sqlite3
```

--------------------------------

### Install Drizzle ORM and better-sqlite3 with yarn

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started-sqlite

Install the required packages using yarn. The first command installs the runtime dependencies, the second installs the development dependencies.

```bash
yarn add drizzle-orm better-sqlite3
yarn add -D drizzle-kit @types/better-sqlite3
```

--------------------------------

### Prepared statement example for SQLite

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/perf-queries

Shows how to prepare a statement and execute it multiple times using .all(). Use for SQLite.

```typescript
const db = drizzle(...);

const prepared = db.select().from(customers).prepare();

const res1 = prepared.all();
const res2 = prepared.all();
const res3 = prepared.all();
```

--------------------------------

### Database connection URL example with breakdown

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/connect-overview

Example PostgreSQL connection URL with annotations showing the role, password, hostname, and database parts.

```text
postgresql://alex:AbC123dEf@ep-cool-darkness-123456.us-east-2.aws.neon.tech/dbname
             └──┘ └───────┘ └─────────────────────────────────────────────┘ └────┘
              ʌ    ʌ          ʌ                                              ʌ
        role -│    │          │- hostname                                    │- database
                   │
                   │- password
```

--------------------------------

### Install Drizzle ORM and better-sqlite3 with npm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started-sqlite

Install the required packages using npm. The first command installs the runtime dependencies, the second installs the development dependencies.

```bash
npm i drizzle-orm better-sqlite3
npm i -D drizzle-kit @types/better-sqlite3
```

--------------------------------

### Install Drizzle and PGlite with npm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/connect-pglite

Install the required packages using npm. The first command installs the runtime dependencies, and the second installs drizzle-kit as a dev dependency.

```bash
npm i drizzle-orm @electric-sql/pglite
npm i -D drizzle-kit
```

--------------------------------

### Install Drizzle ORM and mysql2 with bun

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started-mysql

Install the required packages using bun. The first command installs runtime dependencies, the second installs drizzle-kit as a dev dependency.

```bash
bun add drizzle-orm mysql2
bun add -D drizzle-kit
```

--------------------------------

### Install Drizzle ORM and mysql2 with pnpm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started-mysql

Install the required packages using pnpm. The first command installs runtime dependencies, the second installs drizzle-kit as a dev dependency.

```bash
pnpm add drizzle-orm mysql2
pnpm add -D drizzle-kit
```

--------------------------------

### Install @netlify/edge-functions (bun)

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-netlify-edge-functions-supabase

Optionally install the @netlify/edge-functions package to import types for the Context object using bun.

```bash
bun add @netlify/edge-functions
```

--------------------------------

### Install Drizzle ORM and mysql2 with yarn

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started-mysql

Install the required packages using yarn. The first command installs runtime dependencies, the second installs drizzle-kit as a dev dependency.

```bash
yarn add drizzle-orm mysql2
yarn add -D drizzle-kit
```

--------------------------------

### bun drizzle-kit pull CLI examples

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/drizzle-kit-pull

Example commands using bun drizzle-kit pull with various options: basic connection, pglite driver, and tablesFilter with extensionsFilters.

```bash
bun drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --url=postgresql://user:password@host:port/dbname
bun drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --driver=pglite url=database/
bun drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --tablesFilter=‘user*’ --extensionsFilters=postgis url=postgresql://user:password@host:port/dbname
```

--------------------------------

### Install Drizzle ORM and mysql2 with npm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started-mysql

Install the required packages using npm. The first command installs runtime dependencies, the second installs drizzle-kit as a dev dependency.

```bash
npm i drizzle-orm mysql2
npm i -D drizzle-kit
```

--------------------------------

### Install Drizzle and PlanetScale packages with bun

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/connect-planetscale

Install the required packages using bun. The first command installs the runtime dependencies, and the second installs drizzle-kit as a dev dependency.

```bash
bun add drizzle-orm @planetscale/database
bun add -D drizzle-kit
```

--------------------------------

### Install Drizzle and PlanetScale packages with pnpm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/connect-planetscale

Install the required packages using pnpm. The first command installs the runtime dependencies, and the second installs drizzle-kit as a dev dependency.

```bash
pnpm add drizzle-orm @planetscale/database
pnpm add -D drizzle-kit
```

--------------------------------

### Install Drizzle and PlanetScale packages with yarn

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/connect-planetscale

Install the required packages using yarn. The first command installs the runtime dependencies, and the second installs drizzle-kit as a dev dependency.

```bash
yarn add drizzle-orm @planetscale/database
yarn add -D drizzle-kit
```

--------------------------------

### Install express

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-nile

Install the express package for the web framework. Commands are shown for npm, yarn, pnpm, and bun.

```bash
npm i express
```

```bash
yarn add express
```

```bash
pnpm add express
```

```bash
bun add express
```

--------------------------------

### Install Drizzle and PlanetScale packages with npm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/connect-planetscale

Install the required packages using npm. The first command installs the runtime dependencies, and the second installs drizzle-kit as a dev dependency.

```bash
npm i drizzle-orm @planetscale/database
npm i -D drizzle-kit
```

--------------------------------

### drizzle-kit push CLI configuration examples (bun)

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/drizzle-kit-push

Three CLI commands using bun with the same configuration options.

```bash
bun drizzle-kit push dialect=postgresql schema=src/schema.ts url=postgresql://user:password@host:port/dbname
bun drizzle-kit push dialect=postgresql schema=src/schema.ts driver=pglite url=database/
bun drizzle-kit push dialect=postgresql schema=src/schema.ts --tablesFilter=‘user*’ --extensionsFilters=postgis url=postgresql://user:password@host:port/dbname
```

--------------------------------

### Install packages with pnpm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started/mysql-new

Installs the same packages using pnpm.

```bash
pnpm add drizzle-orm mysql2 dotenv
pnpm add -D drizzle-kit tsx
```

--------------------------------

### Install packages with yarn

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started/mysql-new

Installs the same packages using yarn.

```bash
yarn add drizzle-orm mysql2 dotenv
yarn add -D drizzle-kit tsx
```

--------------------------------

### Project structure for drizzle-kit push example

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/drizzle-kit-push

Shows the file layout of the example project, including src/schema.ts, src/index.ts, and drizzle.config.ts.

```text
📦 <project root>
 ├ 📂 src
 │ ├ 📜 schema.ts
 │ └ 📜 index.ts
 ├ 📜 drizzle.config.ts
 └ …
```

--------------------------------

### Initialize Gel project

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started/gel-new

Command to initialize a Gel project after the CLI is installed.

```bash
gel project init   
```

--------------------------------

### Example .env with SQLite database filename

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/get-started/bun-sqlite-new

Example .env file that sets DB_FILE_NAME to mydb.sqlite, creating an SQLite database file in the project root for testing.

```plaintext
DB_FILE_NAME=mydb.sqlite
```

--------------------------------

### Start Supabase local development stack

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-supabase-edge-functions

Starts the Supabase local development stack. Docker must be running.

```bash
supabase start
```

--------------------------------

### Install @vercel/postgres with pnpm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-vercel

Install @vercel/postgres package using pnpm.

```bash
pnpm add @vercel/postgres
```

--------------------------------

### npm drizzle-kit pull CLI examples

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/drizzle-kit-pull

Example commands using npx drizzle-kit pull with various options: basic connection, pglite driver, and tablesFilter with extensionsFilters.

```bash
npx drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --url=postgresql://user:password@host:port/dbname
npx drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --driver=pglite url=database/
npx drizzle-kit pull --dialect=postgresql --schema=src/schema.ts --tablesFilter=‘user*’ --extensionsFilters=postgis url=postgresql://user:password@host:port/dbname
```

--------------------------------

### Install @vercel/postgres with yarn

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-vercel

Install @vercel/postgres package using yarn.

```bash
yarn add @vercel/postgres
```

--------------------------------

### SingleStore withReplicas setup

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/read-replicas

Configures a primary database and two read replicas using mysql2, then creates a db instance with withReplicas().

```typescript
import { drizzle } from "drizzle-orm/singlestore";
import mysql from "mysql2/promise";
import { boolean, singlestoreTable, serial, text, withReplicas } from 'drizzle-orm/singlestore-core';

const usersTable = singlestoreTable('users', {
	id: serial('id' as string).primaryKey(),
	name: text('name').notNull(),
	verified: boolean('verified').notNull().default(false),
});

const primaryClient = await mysql.createConnection({
  host: "host",
  user: "user",
  database: "primary_db",
})
const primaryDb = drizzle({ client: primaryClient });

const read1Client = await mysql.createConnection({
  host: "host",
  user: "user",
  database: "read_1",
})
const read1 = drizzle({ client: read1Client });

const read2Client = await mysql.createConnection({
  host: "host",
  user: "user",
  database: "read_2",
})
const read2 = drizzle({ client: read2Client });

const db = withReplicas(primaryDb, [read1, read2]);
```

--------------------------------

### Install @vercel/postgres with npm

Source: https://rqbv2.drizzle-orm-fe.pages.dev/docs/tutorials/drizzle-with-vercel

Install @vercel/postgres package using npm.

```bash
npm i @vercel/postgres
```
Tokens:
Raw