Drizzle

https://drizzle.zhcndoc.com/docs
Admin
Drizzle is a headless SQL-like ORM that provides type-safe database access with support for...
Tokens:367,883
Snippets:2,728
Trust Score:5.8
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install Drizzle Packages (bun)

Source: https://drizzle.zhcndoc.com/docs/get-started/sqlite-new

Installs the necessary Drizzle ORM packages and development tools for bun users. This includes the core ORM, the libsql client for SQLite, dotenv for environment variables, and drizzle-kit for schema management.

```bash
bun add drizzle-orm @libsql/client dotenv
bun add -D drizzle-kit tsx
```

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

### Install Drizzle Packages with bun

Source: https://drizzle.zhcndoc.com/docs/get-started/tidb-new

Installs the Drizzle ORM core, the TiDB Serverless driver, dotenv for environment variables, and development dependencies like drizzle-kit and tsx using bun.

```bash
bun add drizzle-orm @tidbcloud/serverless dotenv
bun add -D drizzle-kit tsx
```

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

### Install Drizzle ORM and libSQL Client Packages

Source: https://drizzle.zhcndoc.com/docs/connect-turso

Installs the necessary Drizzle ORM and libSQL client packages for different Node.js package managers. Also installs drizzle-kit for development.

```shell
npm i drizzle-orm @libsql/client
npm i -D drizzle-kit
```

```shell
yarn add drizzle-orm @libsql/client
yarn add -D drizzle-kit
```

```shell
pnpm add drizzle-orm @libsql/client
pnpm add -D drizzle-kit
```

```shell
bun add drizzle-orm @libsql/client
bun add -D drizzle-kit
```

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

### Install Drizzle Packages (npm)

Source: https://drizzle.zhcndoc.com/docs/get-started/sqlite-new

Installs the necessary Drizzle ORM packages and development tools for npm users. This includes the core ORM, the libsql client for SQLite, dotenv for environment variables, and drizzle-kit for schema management.

```bash
npm i drizzle-orm @libsql/client dotenv
npm i -D drizzle-kit tsx
```

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

### Install Drizzle Packages (pnpm)

Source: https://drizzle.zhcndoc.com/docs/get-started/sqlite-new

Installs the necessary Drizzle ORM packages and development tools for pnpm users. This includes the core ORM, the libsql client for SQLite, dotenv for environment variables, and drizzle-kit for schema management.

```bash
pnpm add drizzle-orm @libsql/client dotenv
pnpm add -D drizzle-kit tsx
```

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

### Install Drizzle Packages (yarn)

Source: https://drizzle.zhcndoc.com/docs/get-started/sqlite-new

Installs the necessary Drizzle ORM packages and development tools for yarn users. This includes the core ORM, the libsql client for SQLite, dotenv for environment variables, and drizzle-kit for schema management.

```bash
yarn add drizzle-orm @libsql/client dotenv
yarn add -D drizzle-kit tsx
```

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

### Install Drizzle ORM and Related Packages (bun)

Source: https://drizzle.zhcndoc.com/docs/get-started/singlestore-new

Installs the necessary Drizzle ORM packages, the mysql2 driver for database interaction, dotenv for environment variables, and Drizzle Kit with tsx for development using bun.

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

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

### Install Drizzle ORM and Related Packages (pnpm)

Source: https://drizzle.zhcndoc.com/docs/get-started/singlestore-new

Installs the necessary Drizzle ORM packages, the mysql2 driver for database interaction, dotenv for environment variables, and Drizzle Kit with tsx for development using pnpm.

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

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

### Start Supabase Local Development Stack

Source: https://drizzle.zhcndoc.com/docs/tutorials/drizzle-with-supabase-edge-functions

Starts the local Supabase development environment, including the database and other services. This command is necessary before applying database migrations.

```bash
supabase start
```

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

### Install Drizzle ORM and Related Packages (npm)

Source: https://drizzle.zhcndoc.com/docs/get-started/singlestore-new

Installs the necessary Drizzle ORM packages, the mysql2 driver for database interaction, dotenv for environment variables, and Drizzle Kit with tsx for development.

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

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

### Install Drizzle ORM and Related Packages (yarn)

Source: https://drizzle.zhcndoc.com/docs/get-started/singlestore-new

Installs the necessary Drizzle ORM packages, the mysql2 driver for database interaction, dotenv for environment variables, and Drizzle Kit with tsx for development using yarn.

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

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

### Configure PostgreSQL Database URL

Source: https://drizzle.zhcndoc.com/docs/guides/postgresql-local-setup

This is the standard format for a PostgreSQL database connection URL. Replace the placeholders with your specific credentials and host information to connect to your running PostgreSQL instance.

```bash
postgres://<user>:<password>@<host>:<port>/<database>
```

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

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

### Install Drizzle Packages with npm

Source: https://drizzle.zhcndoc.com/docs/get-started/tidb-new

Installs the Drizzle ORM core, the TiDB Serverless driver, dotenv for environment variables, and development dependencies like drizzle-kit and tsx.

```bash
npm i drizzle-orm @tidbcloud/serverless dotenv
npm i -D drizzle-kit tsx
```

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

### Install @libsql/client package (bun)

Source: https://drizzle.zhcndoc.com/docs/tutorials/drizzle-with-turso

Installs the @libsql/client package using bun.

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

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

### Initialize Gel Project using bun

Source: https://drizzle.zhcndoc.com/docs/get-started/gel-new

Initializes a new Gel project using bun. This command sets up the necessary files and configurations for a Gel project. Ensure you have bun installed.

```bash
bunx gel project init
```

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

### Install Drizzle Packages with pnpm

Source: https://drizzle.zhcndoc.com/docs/get-started/tidb-new

Installs the Drizzle ORM core, the TiDB Serverless driver, dotenv for environment variables, and development dependencies like drizzle-kit and tsx using pnpm.

```bash
pnpm add drizzle-orm @tidbcloud/serverless dotenv
pnpm add -D drizzle-kit tsx
```

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

### Initialize a New Netlify Project

Source: https://drizzle.zhcndoc.com/docs/tutorials/drizzle-with-netlify-edge-functions-neon

Initializes a new Netlify project in your current directory. The command will guide you through a series of questions in the CLI to set up your project, including selecting a team and site name. Choose 'Yes, manually create and deploy a site' for manual configuration.

```bash
netlify init
```

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

### SQL Example: Database Schema Migrations

Source: https://drizzle.zhcndoc.com/docs/tutorials/drizzle-with-neon

Example SQL statements generated by Drizzle-kit for creating and altering tables, including foreign key constraints.

```sql
CREATE TABLE IF NOT EXISTS "posts_table" (
	"id" serial PRIMARY KEY NOT NULL,
	"title" text NOT NULL,
	"content" text NOT NULL,
	"user_id" integer NOT NULL,
	"created_at" timestamp DEFAULT now() NOT NULL,
	"updated_at" timestamp NOT NULL
);
--> statement-breakpoint
CREATE TABLE IF NOT EXISTS "users_table" (
	"id" serial PRIMARY KEY NOT NULL,
	"name" text NOT NULL,
	"age" integer NOT NULL,
	"email" text NOT NULL,
	CONSTRAINT "users_table_email_unique" UNIQUE("email")
);
--> statement-breakpoint
DO $$ BEGIN
 ALTER TABLE "posts_table" ADD CONSTRAINT "posts_table_user_id_users_table_id_fk" FOREIGN KEY ("user_id") REFERENCES "public"."users_table"("id") ON DELETE cascade ON UPDATE no action;
EXCEPTION
 WHEN duplicate_object THEN null;
END $$;
```

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

### Install Drizzle Packages with yarn

Source: https://drizzle.zhcndoc.com/docs/get-started/tidb-new

Installs the Drizzle ORM core, the TiDB Serverless driver, dotenv for environment variables, and development dependencies like drizzle-kit and tsx using yarn.

```bash
yarn add drizzle-orm @tidbcloud/serverless dotenv
yarn add -D drizzle-kit tsx
```

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

### Initialize Gel Project using npm

Source: https://drizzle.zhcndoc.com/docs/get-started/gel-new

Initializes a new Gel project using npm. This command sets up the necessary files and configurations for a Gel project. Ensure you have Node.js and npm installed.

```bash
npx gel project init
```

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

### Initialize Drizzle Driver with Nile

Source: https://drizzle.zhcndoc.com/docs/connect-nile

Initializes the Drizzle ORM client using the Nile connection URL. This example demonstrates a basic query after setup.

```typescript
// Ensure 'pg' package is installed
import { drizzle } from 'drizzle-orm/node-postgres'

const db = drizzle(process.env.NILEDB_URL);

const response = await db.select().from(...);
```

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

### Start PostgreSQL Docker Container

Source: https://drizzle.zhcndoc.com/docs/guides/postgresql-local-setup

This command starts a new PostgreSQL container in detached mode. It sets a password, maps port 5432, and names the container 'drizzle-postgres'. You can also specify user and database names using environment variables.

```bash
docker run --name drizzle-postgres -e POSTGRES_PASSWORD=mypassword -d -p 5432:5432 postgres
```

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

### Execute Drizzle Kit Push Command with CLI Options

Source: https://drizzle.zhcndoc.com/docs/drizzle-kit-push

This example shows how to run the `drizzle-kit push` command using CLI arguments to specify the dialect, schema path, and database URL. This method is useful for overriding or providing configuration directly during execution.

```bash
npx drizzle-kit push --dialect=postgresql --schema=./src/schema.ts --url=postgresql://user:password@host:port/dbname
```

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

### Expo SQLite Driver Setup and Usage

Source: https://drizzle.zhcndoc.com/docs/latest-releases/drizzle-orm-v0292

Guides on setting up and using the Expo SQLite driver with Drizzle ORM. Includes installation, basic usage, and configuration for Drizzle Migrations with Expo.

```typescript
import { drizzle } from "drizzle-orm/expo-sqlite";
import { openDatabaseSync } from "expo-sqlite";

const expoDb = openDatabaseSync("db.db");

const db = drizzle(expoDb);

await db.select().from(...)...
```

```typescript
db.select().from(...).then(...);
```

```typescript
db.select().from(...).all();
```

```javascript
module.exports = function(api) {
  api.cache(true);

  return {
    presets: ['babel-preset-expo'],
    plugins: [["inline-import", { "extensions": [".sql"] }]]
  };
};
```

```javascript
const { getDefaultConfig } = require('expo/metro-config');

/** @type {import('expo/metro-config').MetroConfig} */
const config = getDefaultConfig(__dirname);

config.resolver.sourceExts.push('sql');

module.exports = config;
```

```typescript
import type { Config } from 'drizzle-kit';

export default {
	schema: './db/schema.ts',
	out: './drizzle',
    dialect: 'sqlite',
	driver: 'expo',
} satisfies Config;
```

```bash
npx drizzle-kit generate
```

```typescript
import { drizzle } from "drizzle-orm/expo-sqlite";
import { openDatabaseSync } from "expo-sqlite";
import { useMigrations } from 'drizzle-orm/expo-sqlite/migrator';
import migrations from './drizzle/migrations';

const expoDb = openDatabaseSync("db.db");

const db = drizzle(expoDb);

export default function App() {
    const { success, error } = useMigrations(db, migrations);

    if (error) {
        return (
            <View>
                <Text>迁移错误: {error.message}</Text>
            </View>
        );
    }

    if (!success) {
        return (
            <View>
                <Text>迁移进行中...</Text>
            </View>
        );
    }

    return ...您的应用组件;
}
```

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

### Install @libsql/client package (npm)

Source: https://drizzle.zhcndoc.com/docs/tutorials/drizzle-with-turso

Installs the @libsql/client package using npm.

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

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

### Example Output: Similar Guides

Source: https://drizzle.zhcndoc.com/docs/guides/vector-similarity-search

An example of the JSON output returned by the 'findSimilarGuides' function. It lists four guides that are similar to the input description, including their titles, URLs, and a numerical similarity score.

```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 Drizzle and Gel Packages (bun)

Source: https://drizzle.zhcndoc.com/docs/get-started-gel

Installs the necessary Drizzle ORM and Gel packages for database interaction and the development dependency for Drizzle Kit using bun.

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

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

### Install @libsql/client package (pnpm)

Source: https://drizzle.zhcndoc.com/docs/tutorials/drizzle-with-turso

Installs the @libsql/client package using pnpm.

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

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

### Install Drizzle Seed with npm

Source: https://drizzle.zhcndoc.com/docs/seed-overview

Installs the drizzle-seed package using npm. This is the first step to start using the library for database seeding.

```bash
npm i drizzle-seed
```

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

### Install Drizzle ORM and PostgreSQL Driver (bun)

Source: https://drizzle.zhcndoc.com/docs/connect-prisma-postgres

Installs the Drizzle ORM package and the 'pg' package for Node.js PostgreSQL connectivity using bun. Also installs 'drizzle-kit' as a development dependency for schema management.

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

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

### Provide Existing LibSQL Driver to Drizzle

Source: https://drizzle.zhcndoc.com/docs/get-started/turso-new

Demonstrates how to initialize Drizzle ORM when you already have an existing `@libsql/client` driver instance. The `createClient` function is used to set up the client, which is then passed to the `drizzle` function.

```typescript
import 'dotenv/config';
import { drizzle } from 'drizzle-orm/libsql';
import { createClient } from '@libsql/client';

const client = createClient({
  url: process.env.TURSO_DATABASE_URL!,
  authToken: process.env.TURSO_AUTH_TOKEN!
});
const db = drizzle({ client });
```

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

### Install Drizzle ORM and PostgreSQL Driver (pnpm)

Source: https://drizzle.zhcndoc.com/docs/connect-prisma-postgres

Installs the Drizzle ORM package and the 'pg' package for Node.js PostgreSQL connectivity using pnpm. Also installs 'drizzle-kit' as a development dependency for schema management.

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

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

### Install Drizzle ORM and PostgreSQL Driver (yarn)

Source: https://drizzle.zhcndoc.com/docs/connect-prisma-postgres

Installs the Drizzle ORM package and the 'pg' package for Node.js PostgreSQL connectivity using yarn. Also installs 'drizzle-kit' as a development dependency for schema management.

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

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

### Install Drizzle ORM and PostgreSQL Driver (npm)

Source: https://drizzle.zhcndoc.com/docs/connect-prisma-postgres

Installs the Drizzle ORM package and the 'pg' package for Node.js PostgreSQL connectivity using npm. Also installs 'drizzle-kit' as a development dependency for schema management.

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

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

### Install express package

Source: https://drizzle.zhcndoc.com/docs/tutorials/drizzle-with-nile

Install the 'express' package to set up a web server or API framework for your application. Express simplifies handling HTTP requests and routing.

```npm
npm i express
```

```yarn
yarn add express
```

```pnpm
pnpm add express
```

```bun
bun add express
```

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

### Drizzle-Kit Configuration File Example

Source: https://drizzle.zhcndoc.com/docs/drizzle-kit-push

Example `drizzle.config.ts` file demonstrating how to configure the database dialect, schema path, and database credentials. This configuration is used by `drizzle-kit` to connect to and manage your database schema.

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

export default defineConfig({
  dialect: "postgresql",
  schema: "./src/schema.ts",
  dbCredentials: {
    url: "postgresql://user:password@host:port/dbname"
  },
});

```

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

### Example MySQL Connection URL

Source: https://drizzle.zhcndoc.com/docs/guides/mysql-local-setup

An example of a MySQL database connection URL configured for a locally running instance created with the specified Docker command. This is used to connect your application to the local MySQL server.

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

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

### Install node-postgres package

Source: https://drizzle.zhcndoc.com/docs/tutorials/drizzle-with-nile

Install the 'node-postgres' package, which is required for Drizzle ORM to connect to a PostgreSQL database like Nile. This driver facilitates database communication.

```npm
npm i node-postgres
```

```yarn
yarn add node-postgres
```

```pnpm
pnpm add node-postgres
```

```bun
bun add node-postgres
```

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

### Install Drizzle and PostgreSQL Packages

Source: https://drizzle.zhcndoc.com/docs/connect-nile

Installs the necessary Drizzle ORM packages and the postgres driver for Node.js applications. It also includes the development dependency for Drizzle Kit.

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

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

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

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

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

### Generate SQL Migrations with drizzle-kit

Source: https://drizzle.zhcndoc.com/docs/migrations

Illustrates the process of generating SQL migration files using the `drizzle-kit generate` command. This command reads previous migrations, identifies schema differences, prompts for renames if necessary, and then saves the generated SQL migration file. The output includes the directory structure for the generated migration.

```bash
┌────────────────────────┐                  
│ $ drizzle-kit generate │                  
└─┬──────────────────────┘                  
  │                                           
  └ 1. 读取先前的迁移文件夹
    2. 找到当前和先前模式之间的差异
    3. 如有必要，提示开发者进行重命名
  ┌ 4. 生成 SQL 迁移并持久保存到文件
  │    ┌─┴───────────────────────────────────────┐  
  │      📂 drizzle       
  │      └ 📂 20242409125510_premium_mister_fear
  │        ├ 📜 snapshot.json
  │        └ 📜 migration.sql
  v

```

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

### Drizzle Kit Extended Configuration (TypeScript)

Source: https://drizzle.zhcndoc.com/docs/kit-overview

An advanced Drizzle Kit configuration example. This demonstrates setting output directories, specifying drivers and database credentials, filtering extensions and schemas, configuring introspection, managing migrations, and enabling verbose logging and strict mode.

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

export default defineConfig({
  out: "./drizzle",
  dialect: "postgresql",
  schema: "./src/schema.ts",

  driver: "pglite",
  dbCredentials: {
    url: "./database/",
  },

  extensionsFilters: ["postgis"],
  schemaFilter: "public",
  tablesFilter: "*",

  introspect: {
    casing: "camel",
  },

  migrations: {
    prefix: "timestamp",
    table: "__drizzle_migrations__",
    schema: "public",
  },

  breakpoints: true,
  strict: true,
  verbose: true,
});
```

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

### Install @libsql/client package (yarn)

Source: https://drizzle.zhcndoc.com/docs/tutorials/drizzle-with-turso

Installs the @libsql/client package using yarn.

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

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

### Initialize Gel Project using pnpm

Source: https://drizzle.zhcndoc.com/docs/get-started/gel-new

Initializes a new Gel project using pnpm. This command sets up the necessary files and configurations for a Gel project. Ensure you have Node.js and pnpm installed.

```bash
pnpm gel project init
```

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

### Install Drizzle ORM and Vercel Postgres Packages (npm)

Source: https://drizzle.zhcndoc.com/docs/get-started/vercel-new

Installs the Drizzle ORM core, the Vercel Postgres driver, dotenv for environment variables, and Drizzle Kit for schema management and migrations.

```bash
npm i drizzle-orm @vercel/postgres dotenv
npm i -D drizzle-kit tsx
```

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

### Install Drizzle ORM and MySQL Dependencies

Source: https://drizzle.zhcndoc.com/docs/get-started/mysql-new

Installs the necessary Drizzle ORM packages, the `mysql2` driver for MySQL interaction, `dotenv` for environment variable management, and development dependencies like `drizzle-kit` and `tsx`.

```npm
npm i drizzle-orm mysql2 dotenv
npm i -D drizzle-kit tsx
```

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

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

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

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

### Initialize Gel Project using yarn

Source: https://drizzle.zhcndoc.com/docs/get-started/gel-new

Initializes a new Gel project using yarn. This command sets up the necessary files and configurations for a Gel project. Ensure you have Node.js and yarn installed.

```bash
yarn gel project init
```

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

### Install Dotenv Package

Source: https://drizzle.zhcndoc.com/docs/tutorials/drizzle-with-neon

Installs the 'dotenv' package, a utility for loading environment variables from a .env file into process.env. This is crucial for managing sensitive information like database connection strings.

```bash
npm i dotenv
```

```bash
yarn add dotenv
```

```bash
pnpm add dotenv
```

```bash
bun add dotenv
```

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

### Initialize Supabase Project

Source: https://drizzle.zhcndoc.com/docs/tutorials/drizzle-with-supabase-edge-functions

Initializes a new Supabase project locally. This command creates a 'supabase' folder and a 'config.toml' file, setting up the basic structure for Supabase services.

```bash
supabase init
```

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

### Run Drizzle Kit Migration Command

Source: https://drizzle.zhcndoc.com/docs/drizzle-kit-up

These commands demonstrate how to execute the `drizzle-kit up` command to apply schema migrations. The `dialect` can be specified directly via CLI options if not configured in a file. This is useful for CI/CD environments.

```bash
npx drizzle-kit up

npx drizzle-kit up --dialect=postgresql
```

```bash
yarn drizzle-kit up

yarn drizzle-kit up --dialect=postgresql
```

```bash
pnpm drizzle-kit up

pnpm drizzle-kit up --dialect=postgresql
```

```bash
bunx drizzle-kit up

bunx drizzle-kit up --dialect=postgresql
```

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

### Configure Host and Port for Drizzle Studio (bun)

Source: https://drizzle.zhcndoc.com/docs/drizzle-kit-studio

These commands demonstrate how to configure the host and port for the Drizzle Studio server when using bun. This allows customization of the server's network interface and listening port.

```bash
bunx drizzle-kit studio --port=3000
bunx drizzle-kit studio --host=0.0.0.0
bunx drizzle-kit studio --host=0.0.0.0 --port=3000
```

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

### Initialize Gel Driver with Options and Execute Query (JavaScript)

Source: https://drizzle.zhcndoc.com/docs/get-started-gel

Initializes a Drizzle database instance connected to Gel with custom connection options, including DSN and TLS security settings, and executes a 'select 1' query. Assumes the 'gel' package is installed.

```javascript
// 确保已安装 'gel' 包
import { drizzle } from "drizzle-orm/gel";

// 可以指定 gel 连接选项中的任意属性
const db = drizzle({
  connection: {
    dsn: process.env.DATABASE_URL,
    tlsSecurity: "default",
  },
});

const result = await db.execute("select 1");
```

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

### Initialize Drizzle with Existing LibSQL Client

Source: https://drizzle.zhcndoc.com/docs/get-started/sqlite-new

Initializes the Drizzle ORM instance using an already created libsql client instance. This is useful if you have pre-configured the client or need to reuse an existing connection.

```typescript
import 'dotenv/config';
import { drizzle } from 'drizzle-orm/libsql';
import { createClient } from '@libsql/client';

const client = createClient({ url: process.env.DB_FILE_NAME! });
const db = drizzle({ client });
```

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

### Install Drizzle ORM and Vercel Postgres Packages (bun)

Source: https://drizzle.zhcndoc.com/docs/get-started/vercel-new

Installs the Drizzle ORM core, the Vercel Postgres driver, dotenv for environment variables, and Drizzle Kit for schema management and migrations using bun.

```bash
bun add drizzle-orm @vercel/postgres dotenv
bun add -D drizzle-kit tsx
```

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

### Configure Host and Port for Drizzle Studio (npm)

Source: https://drizzle.zhcndoc.com/docs/drizzle-kit-studio

These commands demonstrate how to configure the host and port for the Drizzle Studio server when using npm. This allows customization of the server's network interface and listening port.

```bash
npx drizzle-kit studio --port=3000
npx drizzle-kit studio --host=0.0.0.0
npx drizzle-kit studio --host=0.0.0.0 --port=3000
```

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

### Initialize Drizzle with Existing Gel Client (JavaScript)

Source: https://drizzle.zhcndoc.com/docs/get-started-gel

Initializes a Drizzle database instance using an already created Gel client, allowing for more control over the client's lifecycle. Assumes the 'gel' package is installed.

```javascript
// 确保已安装 'gel' 包 
import { drizzle } from "drizzle-orm/gel";
import { createClient } from "gel";

const gelClient = createClient();
const db = drizzle({ client: gelClient });

const result = await db.execute('select 1');
```

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

### Install Drizzle ORM and Vercel Postgres Packages (pnpm)

Source: https://drizzle.zhcndoc.com/docs/get-started/vercel-new

Installs the Drizzle ORM core, the Vercel Postgres driver, dotenv for environment variables, and Drizzle Kit for schema management and migrations using pnpm.

```bash
pnpm add drizzle-orm @vercel/postgres dotenv
pnpm add -D drizzle-kit tsx
```

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

### Install Drizzle ORM and Vercel Postgres Packages (yarn)

Source: https://drizzle.zhcndoc.com/docs/get-started/vercel-new

Installs the Drizzle ORM core, the Vercel Postgres driver, dotenv for environment variables, and Drizzle Kit for schema management and migrations using yarn.

```bash
yarn add drizzle-orm @vercel/postgres dotenv
yarn add -D drizzle-kit tsx
```

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

### Initialize Gel Driver and Execute Query (JavaScript)

Source: https://drizzle.zhcndoc.com/docs/get-started-gel

Initializes a Drizzle database instance connected to Gel using a DATABASE_URL environment variable and executes a simple 'select 1' query. Assumes the 'gel' package is installed.

```javascript
// 确保已安装 'gel' 包
import { drizzle } from 'drizzle-orm/gel';

const db = drizzle(process.env.DATABASE_URL);
 
const result = await db.execute('select 1');
```

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

### Install Drizzle ESLint Plugin with bun

Source: https://drizzle.zhcndoc.com/docs/latest-releases/drizzle-orm-v0291

Provides the command to install the Drizzle ESLint plugin and associated TypeScript packages using bun. This setup helps catch potential errors early in the development cycle.

```bash
bun add eslint eslint-plugin-drizzle
bun add @typescript-eslint/eslint-plugin @typescript-eslint/parser
```

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

### Example Usage: Finding Similar Guides

Source: https://drizzle.zhcndoc.com/docs/guides/vector-similarity-search

Demonstrates how to call the 'findSimilarGuides' function with a sample description and logs the result. The output is an array of similar guides, each containing its name, URL, and calculated similarity score.

```typescript
const description = '使用 Drizzle ORM 的各种平台指南';

const similarGuides = await findSimilarGuides(description);

```

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

### SQLite Database Connection String

Source: https://drizzle.zhcndoc.com/docs/get-started/sqlite-new

Defines the database file name for SQLite connection using dotenv. The 'file:' prefix is required by LibSQL when specifying a local database file.

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

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

### Set Up Database Connection Variable (.env)

Source: https://drizzle.zhcndoc.com/docs/get-started/bun-sqlite-new

Demonstrates how to configure the database connection string in a .env file. For SQLite, this typically involves specifying the database file name.

```env
DB_FILE_NAME=
# Example for testing:
DB_FILE_NAME=mydb.sqlite
```

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

### Example Generated Schema for Tenants Table

Source: https://drizzle.zhcndoc.com/docs/tutorials/drizzle-with-nile

An example of a Drizzle schema definition for the 'tenants' table in Nile, generated after pulling the database schema. It defines columns like 'id', 'name', 'created', 'updated', and 'deleted' with their respective types and constraints.

```typescript
// 通过解析生成的表模式
import { pgTable, uuid, text, timestamp, varchar, vector, boolean } from "drizzle-orm/pg-core"
import { sql } from "drizzle-orm"

export const tenants = pgTable("tenants", {
	id: uuid().default(sql`public.uuid_generate_v7()`).primaryKey().notNull(),
	name: text(),
	created: timestamp({ mode: 'string' }).default(sql`LOCALTIMESTAMP`).notNull(),
	updated: timestamp({ mode: 'string' }).default(sql`LOCALTIMESTAMP`).notNull(),
	deleted: timestamp({ mode: 'string' }),
});
```

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

### Set Up Expo Project with TypeScript Template

Source: https://drizzle.zhcndoc.com/docs/get-started/expo-new

This command initializes a new Expo project with a blank TypeScript template. It's the first step in setting up a project for Expo SQLite integration with Drizzle ORM.

```bash
npx create-expo-app --template blank-typescript
```

```bash
yarn create-expo-app --template blank-typescript
```

```bash
pnpm create-expo-app --template blank-typescript
```

```bash
bunx create-expo-app --template blank-typescript
```

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

### Initialize Drizzle Connection (Direct)

Source: https://drizzle.zhcndoc.com/docs/get-started/tidb-new

Initializes a Drizzle ORM instance connected to TiDB Serverless using the DATABASE_URL from environment variables.

```typescript
import { drizzle } from 'drizzle-orm/tidb-serverless';

const db = drizzle(process.env.DATABASE_URL!);
```

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

### Start Netlify Development Server

Source: https://drizzle.zhcndoc.com/docs/tutorials/drizzle-with-netlify-edge-functions-neon

Starts the Netlify development server to test your Edge Functions locally. This command will also prompt you to configure VS Code for Edge Functions if it's your first time running it. Navigate to the `/user` route in your browser to test.

```bash
netlify dev
```
Tokens:
Raw