Home / File/ common.ts — drizzle-orm Source File

common.ts — drizzle-orm Source File

Architecture documentation for common.ts, a typescript file in the drizzle-orm codebase. 11 imports, 27 dependents.

File typescript DrizzleORM RelationalQuery 11 imports 27 dependents 1 functions 4 classes

Entity Profile

Dependency Diagram

graph LR
  a74dd48d_d5e3_6bb4_19c7_1954c9126816["common.ts"]
  8e96cfe7_b09e_acd6_1e9a_cf73dc90a16f["indexes.ts"]
  a74dd48d_d5e3_6bb4_19c7_1954c9126816 --> 8e96cfe7_b09e_acd6_1e9a_cf73dc90a16f
  5e3c0547_7886_5214_200c_e8f15e9f3900["unique-constraint.ts"]
  a74dd48d_d5e3_6bb4_19c7_1954c9126816 --> 5e3c0547_7886_5214_200c_e8f15e9f3900
  fc7f15db_a49e_7c9c_2d95_cd63662ede21["uniqueKeyName"]
  a74dd48d_d5e3_6bb4_19c7_1954c9126816 --> fc7f15db_a49e_7c9c_2d95_cd63662ede21
  2dc784c6_95e9_4e28_ec81_7caf4acbd426["column-builder.ts"]
  a74dd48d_d5e3_6bb4_19c7_1954c9126816 --> 2dc784c6_95e9_4e28_ec81_7caf4acbd426
  05f0a280_d0c9_693a_a4bf_83cc671012d2["column.ts"]
  a74dd48d_d5e3_6bb4_19c7_1954c9126816 --> 05f0a280_d0c9_693a_a4bf_83cc671012d2
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  a74dd48d_d5e3_6bb4_19c7_1954c9126816 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  a74dd48d_d5e3_6bb4_19c7_1954c9126816 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  320cce7b_df15_0568_fc78_45db5f1e1b3c["foreign-keys.ts"]
  a74dd48d_d5e3_6bb4_19c7_1954c9126816 --> 320cce7b_df15_0568_fc78_45db5f1e1b3c
  c1a47e5e_63aa_1ab2_abac_86e509f63e7c["table.ts"]
  a74dd48d_d5e3_6bb4_19c7_1954c9126816 --> c1a47e5e_63aa_1ab2_abac_86e509f63e7c
  be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd["sql.ts"]
  a74dd48d_d5e3_6bb4_19c7_1954c9126816 --> be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd
  60baeebf_dfcb_74c0_06dd_4c46c78668fe["tracing-utils.ts"]
  a74dd48d_d5e3_6bb4_19c7_1954c9126816 --> 60baeebf_dfcb_74c0_06dd_4c46c78668fe
  62bbdf4d_cbc6_bb65_8d8d_d1a9807ab620["bigint.ts"]
  62bbdf4d_cbc6_bb65_8d8d_d1a9807ab620 --> a74dd48d_d5e3_6bb4_19c7_1954c9126816
  e5c9b8ef_d760_345f_c691_226de7d20135["bigintT.ts"]
  e5c9b8ef_d760_345f_c691_226de7d20135 --> a74dd48d_d5e3_6bb4_19c7_1954c9126816
  853585a6_b0d2_46f6_3244_2bc1fef902e3["boolean.ts"]
  853585a6_b0d2_46f6_3244_2bc1fef902e3 --> a74dd48d_d5e3_6bb4_19c7_1954c9126816
  style a74dd48d_d5e3_6bb4_19c7_1954c9126816 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type {
	ColumnBuilderBase,
	ColumnBuilderBaseConfig,
	ColumnBuilderExtraConfig,
	ColumnBuilderRuntimeConfig,
	ColumnDataType,
	HasGenerated,
	MakeColumnConfig,
} from '~/column-builder.ts';
import { ColumnBuilder } from '~/column-builder.ts';
import type { ColumnBaseConfig } from '~/column.ts';
import { Column } from '~/column.ts';
import { entityKind } from '~/entity.ts';
import type { Simplify, Update } from '~/utils.ts';

import type { ForeignKey, UpdateDeleteAction } from '~/gel-core/foreign-keys.ts';
import { ForeignKeyBuilder } from '~/gel-core/foreign-keys.ts';
import type { AnyGelTable, GelTable } from '~/gel-core/table.ts';
import type { SQL } from '~/sql/sql.ts';
import { iife } from '~/tracing-utils.ts';
import type { GelIndexOpClass } from '../indexes.ts';
import { uniqueKeyName } from '../unique-constraint.ts';

export interface ReferenceConfig {
	ref: () => GelColumn;
	actions: {
		onUpdate?: UpdateDeleteAction;
		onDelete?: UpdateDeleteAction;
	};
}

export interface GelColumnBuilderBase<
	T extends ColumnBuilderBaseConfig<ColumnDataType, string> = ColumnBuilderBaseConfig<ColumnDataType, string>,
	TTypeConfig extends object = object,
> extends ColumnBuilderBase<T, TTypeConfig & { dialect: 'gel' }> {}

export abstract class GelColumnBuilder<
	T extends ColumnBuilderBaseConfig<ColumnDataType, string> = ColumnBuilderBaseConfig<ColumnDataType, string>,
	TRuntimeConfig extends object = object,
	TTypeConfig extends object = object,
	TExtraConfig extends ColumnBuilderExtraConfig = ColumnBuilderExtraConfig,
> extends ColumnBuilder<T, TRuntimeConfig, TTypeConfig & { dialect: 'gel' }, TExtraConfig>
	implements GelColumnBuilderBase<T, TTypeConfig>
{
	private foreignKeyConfigs: ReferenceConfig[] = [];

	static override readonly [entityKind]: string = 'GelColumnBuilder';

	array<TSize extends number | undefined = undefined>(size?: TSize): GelArrayBuilder<
		& {
			name: T['name'];
			dataType: 'array';
			columnType: 'GelArray';
			data: T['data'][];
			driverParam: T['driverParam'][] | string;
			enumValues: T['enumValues'];
			size: TSize;
			baseBuilder: T;
		}
		& (T extends { notNull: true } ? { notNull: true } : {})
// ... (273 more lines)

Domain

Subdomains

Functions

Dependencies

Frequently Asked Questions

What does common.ts do?
common.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 common.ts?
common.ts defines 1 function(s): GelColumn.
What does common.ts depend on?
common.ts imports 11 module(s): column-builder.ts, column.ts, entity.ts, foreign-keys.ts, indexes.ts, sql.ts, table.ts, tracing-utils.ts, and 3 more.
What files import common.ts?
common.ts is imported by 27 file(s): bigint.ts, bigintT.ts, boolean.ts, bytes.ts, custom.ts, date-duration.ts, date.common.ts, decimal.ts, and 19 more.
Where is common.ts in the architecture?
common.ts is located at drizzle-orm/src/gel-core/columns/common.ts (domain: DrizzleORM, subdomain: RelationalQuery, directory: drizzle-orm/src/gel-core/columns).

Analyze Your Own Codebase

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

Try Supermodel Free