Setup Type — drizzle-orm Architecture

Architecture documentation for the Setup type/interface in studio.ts from the drizzle-orm codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  c2eed6ef_05bf_6dc4_0ce0_33c22f4758bd["Setup"]
  82de12f8_a8ca_9d38_8da8_9ac945d81e01["studio.ts"]
  c2eed6ef_05bf_6dc4_0ce0_33c22f4758bd -->|defined in| 82de12f8_a8ca_9d38_8da8_9ac945d81e01
  style c2eed6ef_05bf_6dc4_0ce0_33c22f4758bd fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/serializer/studio.ts lines 54–80

export type Setup = {
	dbHash: string;
	dialect: 'postgresql' | 'mysql' | 'sqlite' | 'singlestore';
	packageName:
		| '@aws-sdk/client-rds-data'
		| 'pglite'
		| 'pg'
		| 'postgres'
		| '@vercel/postgres'
		| '@neondatabase/serverless'
		| 'gel'
		| 'mysql2'
		| '@planetscale/database'
		| 'd1-http'
		| 'd1'
		| '@libsql/client'
		| 'better-sqlite3';
	driver?: 'aws-data-api' | 'd1-http' | 'd1' | 'turso' | 'pglite';
	databaseName?: string; // for planetscale (driver remove database name from connection string)
	proxy: Proxy;
	transactionProxy: TransactionProxy;
	customDefaults: CustomDefault[];
	schema: Record<string, Record<string, AnyTable<any>>>;
	relations: Record<string, Relations>;
	casing?: CasingType;
	schemaFiles?: SchemaFile[];
};

Defined In

drizzle-kit/src/serializer/studio.ts

Source

View on GitHub

Frequently Asked Questions

What is the Setup type?

Setup is a type/interface in the drizzle-orm codebase, defined in drizzle-kit/src/serializer/studio.ts.

Where is Setup defined?

Setup is defined in drizzle-kit/src/serializer/studio.ts at line 54.

Analyze Your Own Codebase

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

Try Supermodel Free