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 SQLDialects 4 imports 3 dependents 2 functions 3 classes

Entity Profile

Dependency Diagram

graph LR
  45366305_acee_28e7_392a_dc8de75a63d3["unique-constraint.ts"]
  a4c1e5cb_a206_4786_985b_0e0a35ddd536["common.ts"]
  45366305_acee_28e7_392a_dc8de75a63d3 --> a4c1e5cb_a206_4786_985b_0e0a35ddd536
  64ae061d_ed9a_c5f9_235a_3f31995a8d54["table.ts"]
  45366305_acee_28e7_392a_dc8de75a63d3 --> 64ae061d_ed9a_c5f9_235a_3f31995a8d54
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  45366305_acee_28e7_392a_dc8de75a63d3 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  05fb227e_0b02_2bf4_175f_8e70216a34a7["table.utils.ts"]
  45366305_acee_28e7_392a_dc8de75a63d3 --> 05fb227e_0b02_2bf4_175f_8e70216a34a7
  a4c1e5cb_a206_4786_985b_0e0a35ddd536["common.ts"]
  a4c1e5cb_a206_4786_985b_0e0a35ddd536 --> 45366305_acee_28e7_392a_dc8de75a63d3
  64ae061d_ed9a_c5f9_235a_3f31995a8d54["table.ts"]
  64ae061d_ed9a_c5f9_235a_3f31995a8d54 --> 45366305_acee_28e7_392a_dc8de75a63d3
  5eb95521_a13c_5ed6_36c8_8869eb8138fc["utils.ts"]
  5eb95521_a13c_5ed6_36c8_8869eb8138fc --> 45366305_acee_28e7_392a_dc8de75a63d3
  style 45366305_acee_28e7_392a_dc8de75a63d3 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { entityKind } from '~/entity.ts';
import { TableName } from '~/table.utils.ts';
import type { SQLiteColumn } from './columns/common.ts';
import type { SQLiteTable } from './table.ts';

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

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

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

	/** @internal */
	columns: SQLiteColumn[];

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

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

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

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

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

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

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

	readonly columns: SQLiteColumn[];
	readonly name?: string;

	constructor(readonly table: SQLiteTable, columns: SQLiteColumn[], name?: string) {
		this.columns = columns;
		this.name = name ?? uniqueKeyName(this.table, this.columns.map((column) => column.name));
	}

	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, SQLDialects 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): common.ts, entity.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/sqlite-core/unique-constraint.ts (domain: DrizzleORM, subdomain: SQLDialects, directory: drizzle-orm/src/sqlite-core).

Analyze Your Own Codebase

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

Try Supermodel Free