Home / File/ unique-constraint.ts — drizzle-orm Source File

unique-constraint.ts — drizzle-orm Source File

Architecture documentation for unique-constraint.ts, a typescript file in the drizzle-orm codebase. 4 imports, 3 dependents.

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

Entity Profile

Dependency Diagram

graph LR
  5e3c0547_7886_5214_200c_e8f15e9f3900["unique-constraint.ts"]
  a2e1e4f4_2b6e_c197_a707_793466cb421f["index.ts"]
  5e3c0547_7886_5214_200c_e8f15e9f3900 --> a2e1e4f4_2b6e_c197_a707_793466cb421f
  cbe7af57_41be_454d_306f_02d0e6f81949["table.ts"]
  5e3c0547_7886_5214_200c_e8f15e9f3900 --> cbe7af57_41be_454d_306f_02d0e6f81949
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  5e3c0547_7886_5214_200c_e8f15e9f3900 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  05fb227e_0b02_2bf4_175f_8e70216a34a7["table.utils.ts"]
  5e3c0547_7886_5214_200c_e8f15e9f3900 --> 05fb227e_0b02_2bf4_175f_8e70216a34a7
  a74dd48d_d5e3_6bb4_19c7_1954c9126816["common.ts"]
  a74dd48d_d5e3_6bb4_19c7_1954c9126816 --> 5e3c0547_7886_5214_200c_e8f15e9f3900
  cbe7af57_41be_454d_306f_02d0e6f81949["table.ts"]
  cbe7af57_41be_454d_306f_02d0e6f81949 --> 5e3c0547_7886_5214_200c_e8f15e9f3900
  9cb8488e_0ece_edef_af6a_5851d56cddda["utils.ts"]
  9cb8488e_0ece_edef_af6a_5851d56cddda --> 5e3c0547_7886_5214_200c_e8f15e9f3900
  style 5e3c0547_7886_5214_200c_e8f15e9f3900 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { entityKind } from '~/entity.ts';
import { TableName } from '~/table.utils.ts';
import type { GelColumn } from './columns/index.ts';
import type { GelTable } from './table.ts';

export function unique(name?: string): UniqueOnConstraintBuilder {
	return new UniqueOnConstraintBuilder(name);
}

export function uniqueKeyName(table: GelTable, columns: string[]) {
	return `${table[TableName]}_${columns.join('_')}_unique`;
}

export class UniqueConstraintBuilder {
	static readonly [entityKind]: string = 'GelUniqueConstraintBuilder';

	/** @internal */
	columns: GelColumn[];
	/** @internal */
	nullsNotDistinctConfig = false;

	constructor(
		columns: GelColumn[],
		private name?: string,
	) {
		this.columns = columns;
	}

	nullsNotDistinct() {
		this.nullsNotDistinctConfig = true;
		return this;
	}

	/** @internal */
	build(table: GelTable): UniqueConstraint {
		return new UniqueConstraint(table, this.columns, this.nullsNotDistinctConfig, this.name);
	}
}

export class UniqueOnConstraintBuilder {
	static readonly [entityKind]: string = 'GelUniqueOnConstraintBuilder';

	/** @internal */
	name?: string;

	constructor(
		name?: string,
	) {
		this.name = name;
	}

	on(...columns: [GelColumn, ...GelColumn[]]) {
		return new UniqueConstraintBuilder(columns, this.name);
	}
}

export class UniqueConstraint {
	static readonly [entityKind]: string = 'GelUniqueConstraint';

	readonly columns: GelColumn[];
	readonly name?: string;
	readonly nullsNotDistinct: boolean = false;

	constructor(readonly table: GelTable, columns: GelColumn[], nullsNotDistinct: boolean, name?: string) {
		this.columns = columns;
		this.name = name ?? uniqueKeyName(this.table, this.columns.map((column) => column.name));
		this.nullsNotDistinct = nullsNotDistinct;
	}

	getName() {
		return this.name;
	}
}

Domain

Subdomains

Dependencies

Frequently Asked Questions

What does unique-constraint.ts do?
unique-constraint.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleORM domain, RelationalQuery subdomain.
What functions are defined in unique-constraint.ts?
unique-constraint.ts defines 2 function(s): unique, uniqueKeyName.
What does unique-constraint.ts depend on?
unique-constraint.ts imports 4 module(s): entity.ts, index.ts, table.ts, table.utils.ts.
What files import unique-constraint.ts?
unique-constraint.ts is imported by 3 file(s): common.ts, table.ts, utils.ts.
Where is unique-constraint.ts in the architecture?
unique-constraint.ts is located at drizzle-orm/src/gel-core/unique-constraint.ts (domain: DrizzleORM, subdomain: RelationalQuery, directory: drizzle-orm/src/gel-core).

Analyze Your Own Codebase

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

Try Supermodel Free