checks.ts — drizzle-orm Source File

Architecture documentation for checks.ts, a typescript file in the drizzle-orm codebase. 3 imports, 2 dependents.

File typescript DrizzleORM RelationalQuery 3 imports 2 dependents 1 functions 2 classes

Entity Profile

DrizzleORM→ RelationalQuery→ checks.ts — drizzle-orm Source File

Dependency Diagram

graph LR
  171b1831_b7c8_175e_cfcd_84202c037834["checks.ts"]
  cbe7af57_41be_454d_306f_02d0e6f81949["table.ts"]
  171b1831_b7c8_175e_cfcd_84202c037834 --> cbe7af57_41be_454d_306f_02d0e6f81949
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  171b1831_b7c8_175e_cfcd_84202c037834 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  944a2bed_8787_5f43_03e5_9a3b696c293c["index.ts"]
  171b1831_b7c8_175e_cfcd_84202c037834 --> 944a2bed_8787_5f43_03e5_9a3b696c293c
  cbe7af57_41be_454d_306f_02d0e6f81949["table.ts"]
  cbe7af57_41be_454d_306f_02d0e6f81949 --> 171b1831_b7c8_175e_cfcd_84202c037834
  9cb8488e_0ece_edef_af6a_5851d56cddda["utils.ts"]
  9cb8488e_0ece_edef_af6a_5851d56cddda --> 171b1831_b7c8_175e_cfcd_84202c037834
  style 171b1831_b7c8_175e_cfcd_84202c037834 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { entityKind } from '~/entity.ts';
import type { SQL } from '~/sql/index.ts';
import type { GelTable } from './table.ts';

export class CheckBuilder {
	static readonly [entityKind]: string = 'GelCheckBuilder';

	protected brand!: 'GelConstraintBuilder';

	constructor(public name: string, public value: SQL) {}

	/** @internal */
	build(table: GelTable): Check {
		return new Check(table, this);
	}
}

export class Check {
	static readonly [entityKind]: string = 'GelCheck';

	readonly name: string;
	readonly value: SQL;

	constructor(public table: GelTable, builder: CheckBuilder) {
		this.name = builder.name;
		this.value = builder.value;
	}
}

export function check(name: string, value: SQL): CheckBuilder {
	return new CheckBuilder(name, value);
}