custom.ts — drizzle-orm Source File

Architecture documentation for custom.ts, a typescript file in the drizzle-orm codebase. 8 imports, 1 dependents.

File typescript DrizzleORM DatabaseDrivers 8 imports 1 dependents 3 functions 2 classes

Entity Profile

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

Dependency Diagram

graph LR
  2d665331_c10f_e80b_925f_d2148b29ca86["custom.ts"]
  f4f42b4c_8610_03dd_fe01_232098668127["common.ts"]
  2d665331_c10f_e80b_925f_d2148b29ca86 --> f4f42b4c_8610_03dd_fe01_232098668127
  099d7c6d_2fc4_7b20_40e3_1b8af4138fe6["PgColumn"]
  2d665331_c10f_e80b_925f_d2148b29ca86 --> 099d7c6d_2fc4_7b20_40e3_1b8af4138fe6
  2dc784c6_95e9_4e28_ec81_7caf4acbd426["column-builder.ts"]
  2d665331_c10f_e80b_925f_d2148b29ca86 --> 2dc784c6_95e9_4e28_ec81_7caf4acbd426
  05f0a280_d0c9_693a_a4bf_83cc671012d2["column.ts"]
  2d665331_c10f_e80b_925f_d2148b29ca86 --> 05f0a280_d0c9_693a_a4bf_83cc671012d2
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  2d665331_c10f_e80b_925f_d2148b29ca86 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  17418917_ff81_c4e5_90f4_f37d557e5d51["table.ts"]
  2d665331_c10f_e80b_925f_d2148b29ca86 --> 17418917_ff81_c4e5_90f4_f37d557e5d51
  be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd["sql.ts"]
  2d665331_c10f_e80b_925f_d2148b29ca86 --> be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  2d665331_c10f_e80b_925f_d2148b29ca86 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  b38cf654_48d6_41dc_6c0f_203697984d98["all.ts"]
  b38cf654_48d6_41dc_6c0f_203697984d98 --> 2d665331_c10f_e80b_925f_d2148b29ca86
  style 2d665331_c10f_e80b_925f_d2148b29ca86 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { ColumnBuilderBaseConfig, ColumnBuilderRuntimeConfig, MakeColumnConfig } from '~/column-builder.ts';
import type { ColumnBaseConfig } from '~/column.ts';
import { entityKind } from '~/entity.ts';
import type { AnyPgTable } from '~/pg-core/table.ts';
import type { SQL } from '~/sql/sql.ts';
import { type Equal, getColumnNameAndConfig } from '~/utils.ts';
import { PgColumn, PgColumnBuilder } from './common.ts';

export type ConvertCustomConfig<TName extends string, T extends Partial<CustomTypeValues>> =
	& {
		name: TName;
		dataType: 'custom';
		columnType: 'PgCustomColumn';
		data: T['data'];
		driverParam: T['driverData'];
		enumValues: undefined;
	}
	& (T['notNull'] extends true ? { notNull: true } : {})
	& (T['default'] extends true ? { hasDefault: true } : {});

export interface PgCustomColumnInnerConfig {
	customTypeValues: CustomTypeValues;
}

export class PgCustomColumnBuilder<T extends ColumnBuilderBaseConfig<'custom', 'PgCustomColumn'>>
	extends PgColumnBuilder<
		T,
		{
			fieldConfig: CustomTypeValues['config'];
			customTypeParams: CustomTypeParams<any>;
		},
		{
			pgColumnBuilderBrand: 'PgCustomColumnBuilderBrand';
		}
	>
{
	static override readonly [entityKind]: string = 'PgCustomColumnBuilder';

	constructor(
		name: T['name'],
		fieldConfig: CustomTypeValues['config'],
		customTypeParams: CustomTypeParams<any>,
	) {
		super(name, 'custom', 'PgCustomColumn');
		this.config.fieldConfig = fieldConfig;
		this.config.customTypeParams = customTypeParams;
	}

	/** @internal */
	build<TTableName extends string>(
		table: AnyPgTable<{ name: TTableName }>,
	): PgCustomColumn<MakeColumnConfig<T, TTableName>> {
		return new PgCustomColumn<MakeColumnConfig<T, TTableName>>(
			table,
			this.config as ColumnBuilderRuntimeConfig<any, any>,
		);
	}
}

export class PgCustomColumn<T extends ColumnBaseConfig<'custom', 'PgCustomColumn'>> extends PgColumn<T> {
// ... (173 more lines)

Domain

DrizzleORM

Subdomains

DatabaseDrivers

Functions

Classes

Types

Dependencies

PgColumn
column-builder.ts
column.ts
common.ts
entity.ts
sql.ts
table.ts
utils.ts

Imported By

drizzle-orm/src/pg-core/columns/all.ts

Source

View on GitHub

Frequently Asked Questions

What does custom.ts do?

custom.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 custom.ts?

custom.ts defines 3 function(s): config, customType, value.

What does custom.ts depend on?

custom.ts imports 8 module(s): PgColumn, column-builder.ts, column.ts, common.ts, entity.ts, sql.ts, table.ts, utils.ts.

What files import custom.ts?

custom.ts is imported by 1 file(s): all.ts.

Where is custom.ts in the architecture?

custom.ts is located at drizzle-orm/src/pg-core/columns/custom.ts (domain: DrizzleORM, subdomain: DatabaseDrivers, directory: drizzle-orm/src/pg-core/columns).

Analyze Your Own Codebase

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

Try Supermodel Free