drizzle-orm Architecture Docs
Home / Type/ Config Type — drizzle-orm Architecture

Config Type — drizzle-orm Architecture

Architecture documentation for the Config type/interface in index.ts from the drizzle-orm codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  a8b19a9a_df49_4a60_dc6c_49ae67decd28["Config"]
  614b7cb0_0961_b6db_a581_7f7f04396b99["index.ts"]
  a8b19a9a_df49_4a60_dc6c_49ae67decd28 -->|defined in| 614b7cb0_0961_b6db_a581_7f7f04396b99
  style a8b19a9a_df49_4a60_dc6c_49ae67decd28 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/index.ts lines 109–255

export type Config =
	& {
		dialect: Dialect;
		out?: string;
		breakpoints?: boolean;
		tablesFilter?: string | string[];
		extensionsFilters?: 'postgis'[];
		schemaFilter?: string | string[];
		schema?: string | string[];
		verbose?: boolean;
		strict?: boolean;
		casing?: 'camelCase' | 'snake_case';
		migrations?: {
			table?: string;
			schema?: string;
			prefix?: Prefix;
		};
		introspect?: {
			casing: 'camel' | 'preserve';
		};
		entities?: {
			roles?: boolean | { provider?: 'supabase' | 'neon' | string & {}; exclude?: string[]; include?: string[] };
		};
	}
	& (
		| {
			dialect: Verify<Dialect, 'turso'>;
			dbCredentials: {
				url: string;
				authToken?: string;
			};
		}
		| {
			dialect: Verify<Dialect, 'sqlite'>;
			dbCredentials: {
				url: string;
			};
		}
		| {
			dialect: Verify<Dialect, 'postgresql'>;
			dbCredentials:
				| ({
					host: string;
					port?: number;
					user?: string;
					password?: string;
					database: string;
					ssl?:
						| boolean
						| 'require'
						| 'allow'
						| 'prefer'
						| 'verify-full'
						| ConnectionOptions;
				} & {})
				| {
					url: string;
				};
		}
		| {
			dialect: Verify<Dialect, 'postgresql'>;
			driver: Verify<Driver, 'aws-data-api'>;
			dbCredentials: {
				database: string;
				secretArn: string;
				resourceArn: string;
			};
		}
		| {
			dialect: Verify<Dialect, 'postgresql'>;
			driver: Verify<Driver, 'pglite'>;
			dbCredentials: {
				url: string;
			};
		}
		| {
			dialect: Verify<Dialect, 'mysql'>;
			dbCredentials:
				| {
					host: string;
					port?: number;

Defined In

Source

Frequently Asked Questions

What is the Config type?
Config is a type/interface in the drizzle-orm codebase, defined in drizzle-kit/src/index.ts.
Where is Config defined?
Config is defined in drizzle-kit/src/index.ts at line 109.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free