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 DatabaseDrivers 3 imports 2 dependents 1 functions 2 classes

Entity Profile

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

Dependency Diagram

graph LR
  3bdeabbe_470c_395a_6e44_2d024fc8ee9d["checks.ts"]
  2d5c8884_973c_561c_def6_5e394ea36d1a["table.ts"]
  3bdeabbe_470c_395a_6e44_2d024fc8ee9d --> 2d5c8884_973c_561c_def6_5e394ea36d1a
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  3bdeabbe_470c_395a_6e44_2d024fc8ee9d --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  944a2bed_8787_5f43_03e5_9a3b696c293c["index.ts"]
  3bdeabbe_470c_395a_6e44_2d024fc8ee9d --> 944a2bed_8787_5f43_03e5_9a3b696c293c
  2d5c8884_973c_561c_def6_5e394ea36d1a["table.ts"]
  2d5c8884_973c_561c_def6_5e394ea36d1a --> 3bdeabbe_470c_395a_6e44_2d024fc8ee9d
  ce49a5a3_688d_ddce_fd32_28428e51cae2["utils.ts"]
  ce49a5a3_688d_ddce_fd32_28428e51cae2 --> 3bdeabbe_470c_395a_6e44_2d024fc8ee9d
  style 3bdeabbe_470c_395a_6e44_2d024fc8ee9d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

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

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

	protected brand!: 'PgConstraintBuilder';

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

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

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

	readonly name: string;
	readonly value: SQL;

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

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