Add GitHub Actions workflow for Node.js with Webpack

[Ghostv13-dev]

orm.drizzle.team
Drizzle ORM - SQLite
5 - 6 minutes
Get Started with Drizzle and D1

This guide assumes familiarity with:

dotenv - package for managing environment variables - [read here](https://www.npmjs.com/package/dotenv)
tsx - package for running TypeScript files - [read here](https://tsx.hirok.io/)
Cloudflare D1 - Serverless SQL database to query from your Workers and Pages projects - [read here](https://developers.cloudflare.com/d1/)
wrangler - Cloudflare Developer Platform command-line interface - [read here](https://developers.cloudflare.com/workers/wrangler)

Basic file structure

This is the basic file structure of the project. In the src/db directory, we have table definition in schema.ts. In drizzle folder there are sql migration file and snapshots.

📦
├ 📂 drizzle
├ 📂 src
│ ├ 📂 db
│ │ └ 📜 schema.ts
│ └ 📜 index.ts
├ 📜 .env
├ 📜 drizzle.config.ts
├ 📜 package.json
└ 📜 tsconfig.json

Step 1 - Install required packages

npm i drizzle-orm@rc wrangler dotenv
npm i -D drizzle-kit@rc tsx

yarn add drizzle-orm@rc wrangler dotenv
yarn add -D drizzle-kit@rc tsx

pnpm add drizzle-orm@rc wrangler dotenv
pnpm add -D drizzle-kit@rc tsx

bun add drizzle-orm@rc wrangler dotenv
bun add -D drizzle-kit@rc tsx

Step 2 - Setup wrangler.toml

You would need to have a wrangler.toml file for D1 database and will look something like this:

name = "YOUR PROJECT NAME"
main = "src/index.ts"
compatibility_date = "2022-11-07"
node_compat = true

[[ d1_databases ]]
binding = "DB"
database_name = "YOUR DB NAME"
database_id = "YOUR DB ID"
migrations_dir = "drizzle"

Step 3 - Connect Drizzle ORM to the database

import { drizzle } from 'drizzle-orm/d1';

export interface Env {
<BINDING_NAME>: D1Database;
}
export default {
async fetch(request: Request, env: Env) {
const db = drizzle(env.<BINDING_NAME>);
},
};

Step 4 - Generate wrangler types

npx wrangler types

yarn wrangler types

pnpm wrangler types

bunx wrangler types

The output of this command will be a worker-configuration.d.ts file.
Step 5 - Create a table

Create a schema.ts file in the src/db directory and declare your table:

import { int, sqliteTable, text } from "drizzle-orm/sqlite-core";

export const usersTable = sqliteTable("users_table", {
id: int().primaryKey({ autoIncrement: true }),
name: text().notNull(),
age: int().notNull(),
email: text().notNull().unique(),
});

Step 6 - Setup Drizzle config file

Drizzle config - a configuration file that is used by Drizzle Kit and contains all the information about your database connection, migration folder and schema files.

Create a drizzle.config.ts file in the root of your project and add the following content:

import 'dotenv/config';
import { defineConfig } from 'drizzle-kit';

export default defineConfig({
out: './drizzle',
schema: './src/db/schema.ts',
dialect: 'sqlite',
driver: 'd1-http',
dbCredentials: {
accountId: process.env.CLOUDFLARE_ACCOUNT_ID!,
databaseId: process.env.CLOUDFLARE_DATABASE_ID!,
token: process.env.CLOUDFLARE_D1_TOKEN!,
},
});

tips

You can check our tutorial on how to get env variables from CloudFlare
Step 7 - Applying changes to the database

You can directly apply changes to your database using the drizzle-kit push command. This is a convenient method for quickly testing new schema designs or modifications in a local development environment, allowing for rapid iterations without the need to manage migration files:

npx drizzle-kit push

Read more about the push command in documentation.

Tips

Alternatively, you can generate migrations using the drizzle-kit generate command and then apply them using the drizzle-kit migrate command:

Generate migrations:

npx drizzle-kit generate

Apply migrations:

npx drizzle-kit migrate

Read more about migration process in documentation.
Step 8 - Seed and Query the database

import { drizzle } from 'drizzle-orm/d1';

export interface Env {
<BINDING_NAME>: D1Database;
}
export default {
async fetch(request: Request, env: Env) {
const db = drizzle(env.<BINDING_NAME>);
const result = await db.select().from(users).all()
return Response.json(result);
},
};

Step 9 - Run index.ts file

To run any TypeScript files, you have several options, but let’s stick with one: using tsx

You’ve already installed tsx, so we can run our queries now

Run index.ts script

npx tsx src/index.ts

yarn tsx src/index.ts

pnpm tsx src/index.ts

bunx tsx src/index.ts

tips

We suggest using bun to run TypeScript files. With bun, such scripts can be executed without issues or additional settings, regardless of whether your project is configured with CommonJS (CJS), ECMAScript Modules (ESM), or any other module format. To run a script with bun, use the following command:

bun src/index.ts

If you don’t have bun installed, check the Bun installation docs

[Ghostv13-dev]

download.json