DJS Commandsv3 docs
API ReferenceAdapters

adapter-drizzle

Drizzle/Postgres Storage adapter with explicit model mappings.

drizzleStorage(db, options)

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

options.models is required. Each enabled framework model needs a table and logical-field mapping.

import { drizzleStorage } from "@djs-commands/adapter-drizzle";
import { GuildPrefixModel } from "@djs-commands/core";

drizzleStorage(db, {
	models: {
		[GuildPrefixModel]: {
			table: guildPrefixes,
			fields: { guild_id: guildPrefixes.guildId, prefix: guildPrefixes.prefix },
		},
	},
});
interface DrizzleStorageOptions {
	models: Partial<Record<FrameworkStorageModel, DrizzleModelMapping>>;
}

interface DrizzleModelMapping {
	table: PgTable;
	fields: Record<string, unknown>;
}

Constructor validates required logical fields. It does not query the database.

Last updated on

On this page