column.types.ts — drizzle-orm Source File

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

File typescript ValidationAdapters 3 imports 1 dependents

Entity Profile

ValidationAdapters→ column.types.ts — drizzle-orm Source File

Dependency Diagram

graph LR
  2c5e5814_b2ae_7e07_7c6b_6bb520b5f82a["column.types.ts"]
  6926d326_babb_b38d_98de_f0d261e6df93["utils.ts"]
  2c5e5814_b2ae_7e07_7c6b_6bb520b5f82a --> 6926d326_babb_b38d_98de_f0d261e6df93
  4859a2e0_4bd3_506a_e7e6_bf4316983bb5["arktype"]
  2c5e5814_b2ae_7e07_7c6b_6bb520b5f82a --> 4859a2e0_4bd3_506a_e7e6_bf4316983bb5
  690f7dfc_0aea_9ee8_d6e7_26bbb3689031["drizzle-orm"]
  2c5e5814_b2ae_7e07_7c6b_6bb520b5f82a --> 690f7dfc_0aea_9ee8_d6e7_26bbb3689031
  d530d59d_be0a_6412_1cd0_197b9709fc36["schema.types.internal.ts"]
  d530d59d_be0a_6412_1cd0_197b9709fc36 --> 2c5e5814_b2ae_7e07_7c6b_6bb520b5f82a
  style 2c5e5814_b2ae_7e07_7c6b_6bb520b5f82a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { Type, type } from 'arktype';
import type { Column } from 'drizzle-orm';
import type { Json } from './utils.ts';

export type ArktypeNullable<TSchema> = Type<type.infer<TSchema> | null>;

export type ArktypeOptional<TSchema> = [Type<type.infer<TSchema>>, '?'];

export type GetArktypeType<
	TColumn extends Column,
> = TColumn['_']['columnType'] extends
	'PgJson' | 'PgJsonb' | 'MySqlJson' | 'SingleStoreJson' | 'SQLiteTextJson' | 'SQLiteBlobJson'
	? unknown extends TColumn['_']['data'] ? Type<Json> : Type<TColumn['_']['data']>
	: Type<TColumn['_']['data']>;

type HandleSelectColumn<
	TSchema,
	TColumn extends Column,
> = TColumn['_']['notNull'] extends true ? TSchema
	: ArktypeNullable<TSchema>;

type HandleInsertColumn<
	TSchema,
	TColumn extends Column,
> = TColumn['_']['notNull'] extends true ? TColumn['_']['hasDefault'] extends true ? ArktypeOptional<TSchema>
	: TSchema
	: ArktypeOptional<ArktypeNullable<TSchema>>;

type HandleUpdateColumn<
	TSchema,
	TColumn extends Column,
> = TColumn['_']['notNull'] extends true ? ArktypeOptional<TSchema>
	: ArktypeOptional<ArktypeNullable<TSchema>>;

export type HandleColumn<
	TType extends 'select' | 'insert' | 'update',
	TColumn extends Column,
> = TType extends 'select' ? HandleSelectColumn<GetArktypeType<TColumn>, TColumn>
	: TType extends 'insert' ? HandleInsertColumn<GetArktypeType<TColumn>, TColumn>
	: TType extends 'update' ? HandleUpdateColumn<GetArktypeType<TColumn>, TColumn>
	: GetArktypeType<TColumn>;