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

BuildSchema Type — drizzle-orm Architecture

Architecture documentation for the BuildSchema type/interface in schema.types.internal.ts from the drizzle-orm codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  c82113d7_884b_ae1c_64d1_51312b9a6690["BuildSchema"]
  d530d59d_be0a_6412_1cd0_197b9709fc36["schema.types.internal.ts"]
  c82113d7_884b_ae1c_64d1_51312b9a6690 -->|defined in| d530d59d_be0a_6412_1cd0_197b9709fc36
  style c82113d7_884b_ae1c_64d1_51312b9a6690 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-arktype/src/schema.types.internal.ts lines 43–63

export type BuildSchema<
	TType extends 'select' | 'insert' | 'update',
	TColumns extends Record<string, any>,
	TRefinements extends Record<string, any> | undefined,
> = type.instantiate<
	Simplify<
		{
			readonly [K in keyof TColumns as ColumnIsGeneratedAlwaysAs<TColumns[K]> extends true ? never : K]:
				TColumns[K] extends infer TColumn extends Column
					? IsRefinementDefined<TRefinements, K> extends true
						? HandleRefinement<TType, TRefinements[K & keyof TRefinements], TColumn>
					: HandleColumn<TType, TColumn>
					: TColumns[K] extends infer TNested extends SelectedFieldsFlat<Column> | Table | View ? BuildSchema<
							TType,
							GetSelection<TNested>,
							TRefinements extends object ? TRefinements[K & keyof TRefinements] : undefined
						>
					: any;
		}
	>
>;

Defined In

Source

Frequently Asked Questions

What is the BuildSchema type?
BuildSchema is a type/interface in the drizzle-orm codebase, defined in drizzle-arktype/src/schema.types.internal.ts.
Where is BuildSchema defined?
BuildSchema is defined in drizzle-arktype/src/schema.types.internal.ts at line 43.

Analyze Your Own Codebase

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

Try Supermodel Free