drizzle-orm Architecture Docs
Home / File/ table.ts — drizzle-orm Source File

table.ts — drizzle-orm Source File

Architecture documentation for table.ts, a typescript file in the drizzle-orm codebase. 12 imports, 17 dependents.

File typescript DrizzleORM DatabaseDrivers 12 imports 17 dependents 4 functions 1 classes

Entity Profile

Dependency Diagram

graph LR
  2d5c8884_973c_561c_def6_5e394ea36d1a["table.ts"]
  3bdeabbe_470c_395a_6e44_2d024fc8ee9d["checks.ts"]
  2d5c8884_973c_561c_def6_5e394ea36d1a --> 3bdeabbe_470c_395a_6e44_2d024fc8ee9d
  b38cf654_48d6_41dc_6c0f_203697984d98["all.ts"]
  2d5c8884_973c_561c_def6_5e394ea36d1a --> b38cf654_48d6_41dc_6c0f_203697984d98
  ea1ef90c_4d8f_98dc_2d20_4e57f6ad3e71["getPgColumnBuilders"]
  2d5c8884_973c_561c_def6_5e394ea36d1a --> ea1ef90c_4d8f_98dc_2d20_4e57f6ad3e71
  f4f42b4c_8610_03dd_fe01_232098668127["common.ts"]
  2d5c8884_973c_561c_def6_5e394ea36d1a --> f4f42b4c_8610_03dd_fe01_232098668127
  b9d8b4e3_8c35_6c97_3af0_a74313048074["foreign-keys.ts"]
  2d5c8884_973c_561c_def6_5e394ea36d1a --> b9d8b4e3_8c35_6c97_3af0_a74313048074
  a406baef_d8bd_9bc9_efcd_e7c1450622b0["indexes.ts"]
  2d5c8884_973c_561c_def6_5e394ea36d1a --> a406baef_d8bd_9bc9_efcd_e7c1450622b0
  85575027_808b_f07e_b2a8_8d47e8b3189b["policies.ts"]
  2d5c8884_973c_561c_def6_5e394ea36d1a --> 85575027_808b_f07e_b2a8_8d47e8b3189b
  87a357d2_c2ec_b04d_8912_3b8be2a92815["primary-keys.ts"]
  2d5c8884_973c_561c_def6_5e394ea36d1a --> 87a357d2_c2ec_b04d_8912_3b8be2a92815
  85e88cbd_e923_5f37_9238_698bcacc84af["unique-constraint.ts"]
  2d5c8884_973c_561c_def6_5e394ea36d1a --> 85e88cbd_e923_5f37_9238_698bcacc84af
  2dc784c6_95e9_4e28_ec81_7caf4acbd426["column-builder.ts"]
  2d5c8884_973c_561c_def6_5e394ea36d1a --> 2dc784c6_95e9_4e28_ec81_7caf4acbd426
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  2d5c8884_973c_561c_def6_5e394ea36d1a --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  1fd6ac27_a0fb_a054_a358_c8766c3fcbd7["table.ts"]
  2d5c8884_973c_561c_def6_5e394ea36d1a --> 1fd6ac27_a0fb_a054_a358_c8766c3fcbd7
  584dca9e_3f86_20cf_b04b_53125472a01c["alias.ts"]
  584dca9e_3f86_20cf_b04b_53125472a01c --> 2d5c8884_973c_561c_def6_5e394ea36d1a
  3bdeabbe_470c_395a_6e44_2d024fc8ee9d["checks.ts"]
  3bdeabbe_470c_395a_6e44_2d024fc8ee9d --> 2d5c8884_973c_561c_def6_5e394ea36d1a
  c7b6df8c_83b6_2bcf_02a5_1506f5d83b53["bigserial.ts"]
  c7b6df8c_83b6_2bcf_02a5_1506f5d83b53 --> 2d5c8884_973c_561c_def6_5e394ea36d1a
  style 2d5c8884_973c_561c_def6_5e394ea36d1a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { BuildColumns, BuildExtraConfigColumns } from '~/column-builder.ts';
import { entityKind } from '~/entity.ts';
import { Table, type TableConfig as TableConfigBase, type UpdateTableConfig } from '~/table.ts';
import type { CheckBuilder } from './checks.ts';
import { getPgColumnBuilders, type PgColumnsBuilders } from './columns/all.ts';
import type { ExtraConfigColumn, PgColumn, PgColumnBuilder, PgColumnBuilderBase } from './columns/common.ts';
import type { ForeignKey, ForeignKeyBuilder } from './foreign-keys.ts';
import type { AnyIndexBuilder } from './indexes.ts';
import type { PgPolicy } from './policies.ts';
import type { PrimaryKeyBuilder } from './primary-keys.ts';
import type { UniqueConstraintBuilder } from './unique-constraint.ts';

export type PgTableExtraConfigValue =
	| AnyIndexBuilder
	| CheckBuilder
	| ForeignKeyBuilder
	| PrimaryKeyBuilder
	| UniqueConstraintBuilder
	| PgPolicy;

export type PgTableExtraConfig = Record<
	string,
	PgTableExtraConfigValue
>;

export type TableConfig = TableConfigBase<PgColumn>;

/** @internal */
export const InlineForeignKeys = Symbol.for('drizzle:PgInlineForeignKeys');
/** @internal */
export const EnableRLS = Symbol.for('drizzle:EnableRLS');

export class PgTable<T extends TableConfig = TableConfig> extends Table<T> {
	static override readonly [entityKind]: string = 'PgTable';

	/** @internal */
	static override readonly Symbol = Object.assign({}, Table.Symbol, {
		InlineForeignKeys: InlineForeignKeys as typeof InlineForeignKeys,
		EnableRLS: EnableRLS as typeof EnableRLS,
	});

	/**@internal */
	[InlineForeignKeys]: ForeignKey[] = [];

	/** @internal */
	[EnableRLS]: boolean = false;

	/** @internal */
	override [Table.Symbol.ExtraConfigBuilder]: ((self: Record<string, PgColumn>) => PgTableExtraConfig) | undefined =
		undefined;

	/** @internal */
	override [Table.Symbol.ExtraConfigColumns]: Record<string, ExtraConfigColumn> = {};
}

export type AnyPgTable<TPartial extends Partial<TableConfig> = {}> = PgTable<UpdateTableConfig<TableConfig, TPartial>>;

export type PgTableWithColumns<T extends TableConfig> =
	& PgTable<T>
	& {
// ... (193 more lines)

Domain

Subdomains

Functions

Classes

Types

Dependencies

Imported By

Source

Frequently Asked Questions

What does table.ts do?
table.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleORM domain, DatabaseDrivers subdomain.
What functions are defined in table.ts?
table.ts defines 4 function(s): Omit, pgTable, pgTableCreator, pgTableWithSchema.
What does table.ts depend on?
table.ts imports 12 module(s): all.ts, checks.ts, column-builder.ts, common.ts, entity.ts, foreign-keys.ts, getPgColumnBuilders, indexes.ts, and 4 more.
What files import table.ts?
table.ts is imported by 17 file(s): alias.ts, bigserial.ts, checks.ts, cidr.ts, count.ts, foreign-keys.ts, indexes.ts, inet.ts, and 9 more.
Where is table.ts in the architecture?
table.ts is located at drizzle-orm/src/pg-core/table.ts (domain: DrizzleORM, subdomain: DatabaseDrivers, directory: drizzle-orm/src/pg-core).

Analyze Your Own Codebase

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

Try Supermodel Free