drizzle-orm Architecture Docs
Home / File/ schema.types.ts — drizzle-orm Source File

schema.types.ts — drizzle-orm Source File

Architecture documentation for schema.types.ts, a typescript file in the drizzle-orm codebase. 5 imports, 1 dependents.

File typescript ValidationAdapters 5 imports 1 dependents

Entity Profile

Dependency Diagram

graph LR
  b0f80f81_d8ca_1927_f5f8_c8088fb077bb["schema.types.ts"]
  b348fe74_e713_8049_1ace_8787b971fb49["column.types.ts"]
  b0f80f81_d8ca_1927_f5f8_c8088fb077bb --> b348fe74_e713_8049_1ace_8787b971fb49
  224d090d_0385_ea0a_7fbe_57b37e55038e["schema.types.internal.ts"]
  b0f80f81_d8ca_1927_f5f8_c8088fb077bb --> 224d090d_0385_ea0a_7fbe_57b37e55038e
  26760edf_9a0c_0204_77e6_f8bffa96e354["typebox"]
  b0f80f81_d8ca_1927_f5f8_c8088fb077bb --> 26760edf_9a0c_0204_77e6_f8bffa96e354
  690f7dfc_0aea_9ee8_d6e7_26bbb3689031["drizzle-orm"]
  b0f80f81_d8ca_1927_f5f8_c8088fb077bb --> 690f7dfc_0aea_9ee8_d6e7_26bbb3689031
  53497908_16e7_977d_e97d_7414884a88a6["pg-core"]
  b0f80f81_d8ca_1927_f5f8_c8088fb077bb --> 53497908_16e7_977d_e97d_7414884a88a6
  8dacc372_d6d5_e273_f9e6_3a10af9bc4a7["schema.ts"]
  8dacc372_d6d5_e273_f9e6_3a10af9bc4a7 --> b0f80f81_d8ca_1927_f5f8_c8088fb077bb
  style b0f80f81_d8ca_1927_f5f8_c8088fb077bb fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type * as t from '@sinclair/typebox';
import type { Table, View } from 'drizzle-orm';
import type { PgEnum } from 'drizzle-orm/pg-core';
import type { EnumValuesToEnum } from './column.types.ts';
import type { BuildRefine, BuildSchema, NoUnknownKeys } from './schema.types.internal.ts';

export interface CreateSelectSchema {
	<TTable extends Table>(table: TTable): BuildSchema<'select', TTable['_']['columns'], undefined>;
	<
		TTable extends Table,
		TRefine extends BuildRefine<TTable['_']['columns']>,
	>(
		table: TTable,
		refine?: NoUnknownKeys<TRefine, TTable['$inferSelect']>,
	): BuildSchema<'select', TTable['_']['columns'], TRefine>;

	<TView extends View>(view: TView): BuildSchema<'select', TView['_']['selectedFields'], undefined>;
	<
		TView extends View,
		TRefine extends BuildRefine<TView['_']['selectedFields']>,
	>(
		view: TView,
		refine: NoUnknownKeys<TRefine, TView['$inferSelect']>,
	): BuildSchema<'select', TView['_']['selectedFields'], TRefine>;

	<TEnum extends PgEnum<any>>(enum_: TEnum): t.TEnum<EnumValuesToEnum<TEnum['enumValues']>>;
}

export interface CreateInsertSchema {
	<TTable extends Table>(table: TTable): BuildSchema<'insert', TTable['_']['columns'], undefined>;
	<
		TTable extends Table,
		TRefine extends BuildRefine<Pick<TTable['_']['columns'], keyof TTable['$inferInsert']>>,
	>(
		table: TTable,
		refine?: NoUnknownKeys<TRefine, TTable['$inferInsert']>,
	): BuildSchema<'insert', TTable['_']['columns'], TRefine>;
}

export interface CreateUpdateSchema {
	<TTable extends Table>(table: TTable): BuildSchema<'update', TTable['_']['columns'], undefined>;
	<
		TTable extends Table,
		TRefine extends BuildRefine<Pick<TTable['_']['columns'], keyof TTable['$inferInsert']>>,
	>(
		table: TTable,
		refine?: TRefine,
	): BuildSchema<'update', TTable['_']['columns'], TRefine>;
}

export interface CreateSchemaFactoryOptions {
	typeboxInstance?: any;
}

Domain

Types

Dependencies

Imported By

Source

Frequently Asked Questions

What does schema.types.ts do?
schema.types.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the ValidationAdapters domain.
What does schema.types.ts depend on?
schema.types.ts imports 5 module(s): column.types.ts, drizzle-orm, pg-core, schema.types.internal.ts, typebox.
What files import schema.types.ts?
schema.types.ts is imported by 1 file(s): schema.ts.
Where is schema.types.ts in the architecture?
schema.types.ts is located at drizzle-typebox/src/schema.types.ts (domain: ValidationAdapters, directory: drizzle-typebox/src).

Analyze Your Own Codebase

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

Try Supermodel Free