adapter-drizzle

bun add @djs-commands/core @djs-commands/adapter-drizzle drizzle-orm pg

For setup (migrations, drizzle.config, etc.) see Adapter Cookbook → Drizzle.

`drizzleStorage(db, options?)`

function drizzleStorage(
	db: NodePgDatabase,
	options?: DrizzleStorageOptions,
): Storage;

Returns a Storage implementation backed by Drizzle. Pass to createCommandHandler as storage.

import { drizzleStorage } from "@djs-commands/adapter-drizzle";
import { drizzle } from "drizzle-orm/node-postgres";
import { Pool } from "pg";

const pool = new Pool({ connectionString: process.env.DATABASE_URL });
const db = drizzle(pool);

createCommandHandler({
	client,
	commands: [...],
	storage: drizzleStorage(db),
});

The dispatcher reads/writes guild_prefix, disabled_commands, and channel_locks automatically — you don't write any code for the framework models, just make sure the tables exist.

`DrizzleStorageOptions`

interface DrizzleStorageOptions {
	tables?: Partial<{
		guildPrefix: typeof guildPrefix;
		disabledCommands: typeof disabledCommands;
		channelLocks: typeof channelLocks;
	}>;
}

Override one or more table objects (rename columns, add fields, share with your app's schema):

import { drizzleStorage } from "@djs-commands/adapter-drizzle";
import { myGuildPrefixTable } from "./schema";

drizzleStorage(db, {
	tables: { guildPrefix: myGuildPrefixTable },
});

Schema exports

import {
	guildPrefix,
	disabledCommands,
	channelLocks,
} from "@djs-commands/adapter-drizzle/schema";

The three built-in Drizzle table objects. Re-export from your own schema file so drizzle-kit picks them up:

src/db/schema.ts

export { channelLocks, disabledCommands, guildPrefix } from "@djs-commands/adapter-drizzle/schema";

Row types

import type {
	GuildPrefixRow,
	DisabledCommandRow,
	ChannelLockRow,
} from "@djs-commands/adapter-drizzle";

Re-exports of the framework's row types — same shapes used by Storage helpers like getGuildPrefix.

Last updated on

drizzleStorage(db, options?)

DrizzleStorageOptions

Schema exports

Row types

On this page

`drizzleStorage(db, options?)`

`DrizzleStorageOptions`