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

utils.ts — drizzle-orm Source File

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

File typescript DrizzleORM QueryBuilders 12 imports 4 dependents 2 functions

Entity Profile

Dependency Diagram

graph LR
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e["utils.ts"]
  e43c7978_6183_5be1_2adb_a463e29db8ba["indexes.ts"]
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e --> e43c7978_6183_5be1_2adb_a463e29db8ba
  e4539660_0f3f_e471_6c22_959cc0f3cb63["IndexBuilder"]
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e --> e4539660_0f3f_e471_6c22_959cc0f3cb63
  23f0730e_a6b8_4342_cdc4_6f458b4467d7["primary-keys.ts"]
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e --> 23f0730e_a6b8_4342_cdc4_6f458b4467d7
  d24d916d_8ace_3689_b8a9_79e3148b8507["PrimaryKeyBuilder"]
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e --> d24d916d_8ace_3689_b8a9_79e3148b8507
  3c5f95cc_22b6_3d0d_d9be_3e274450e9e7["table.ts"]
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e --> 3c5f95cc_22b6_3d0d_d9be_3e274450e9e7
  2f757dbf_c4e6_7cc5_451a_b72c48bbed4c["SingleStoreTable"]
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e --> 2f757dbf_c4e6_7cc5_451a_b72c48bbed4c
  b9679e1e_3f87_26cc_50d3_ac82b21fefe5["unique-constraint.ts"]
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e --> b9679e1e_3f87_26cc_50d3_ac82b21fefe5
  3b688710_2347_3398_93b0_67661186b081["UniqueConstraintBuilder"]
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e --> 3b688710_2347_3398_93b0_67661186b081
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd["sql.ts"]
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e --> be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd
  4d55618d_fa7b_8e54_edb2_b85ae393d95b["subquery.ts"]
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e --> 4d55618d_fa7b_8e54_edb2_b85ae393d95b
  1fd6ac27_a0fb_a054_a358_c8766c3fcbd7["table.ts"]
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e --> 1fd6ac27_a0fb_a054_a358_c8766c3fcbd7
  a48944c4_ea91_ad5b_6028_9e0244f4093d["delete.ts"]
  a48944c4_ea91_ad5b_6028_9e0244f4093d --> ae5f6568_e61c_e2e0_88cb_92eabc9ba98e
  442ef410_0a6c_ba64_9e82_83d5b7e37c62["insert.ts"]
  442ef410_0a6c_ba64_9e82_83d5b7e37c62 --> ae5f6568_e61c_e2e0_88cb_92eabc9ba98e
  style ae5f6568_e61c_e2e0_88cb_92eabc9ba98e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { is } from '~/entity.ts';
import { SQL } from '~/sql/sql.ts';
import { Subquery } from '~/subquery.ts';
import { Table } from '~/table.ts';
import type { Index } from './indexes.ts';
import { IndexBuilder } from './indexes.ts';
import type { PrimaryKey } from './primary-keys.ts';
import { PrimaryKeyBuilder } from './primary-keys.ts';
import { SingleStoreTable } from './table.ts';
import { type UniqueConstraint, UniqueConstraintBuilder } from './unique-constraint.ts';
/* import { SingleStoreViewConfig } from './view-common.ts';
import type { SingleStoreView } from './view.ts'; */

export function extractUsedTable(table: SingleStoreTable | Subquery | SQL): string[] {
	if (is(table, SingleStoreTable)) {
		return [`${table[Table.Symbol.BaseName]}`];
	}
	if (is(table, Subquery)) {
		return table._.usedTables ?? [];
	}
	if (is(table, SQL)) {
		return table.usedTables ?? [];
	}
	return [];
}

export function getTableConfig(table: SingleStoreTable) {
	const columns = Object.values(table[SingleStoreTable.Symbol.Columns]);
	const indexes: Index[] = [];
	const primaryKeys: PrimaryKey[] = [];
	const uniqueConstraints: UniqueConstraint[] = [];
	const name = table[Table.Symbol.Name];
	const schema = table[Table.Symbol.Schema];
	const baseName = table[Table.Symbol.BaseName];

	const extraConfigBuilder = table[SingleStoreTable.Symbol.ExtraConfigBuilder];

	if (extraConfigBuilder !== undefined) {
		const extraConfig = extraConfigBuilder(table[SingleStoreTable.Symbol.Columns]);
		const extraValues = Array.isArray(extraConfig) ? extraConfig.flat(1) as any[] : Object.values(extraConfig);
		for (const builder of Object.values(extraValues)) {
			if (is(builder, IndexBuilder)) {
				indexes.push(builder.build(table));
			} else if (is(builder, UniqueConstraintBuilder)) {
				uniqueConstraints.push(builder.build(table));
			} else if (is(builder, PrimaryKeyBuilder)) {
				primaryKeys.push(builder.build(table));
			}
		}
	}

	return {
		columns,
		indexes,
		primaryKeys,
		uniqueConstraints,
		name,
		schema,
		baseName,
	};
}

/* export function getViewConfig<
	TName extends string = string,
	TExisting extends boolean = boolean,
>(view: SingleStoreView<TName, TExisting>) {
	return {
		...view[ViewBaseConfig],
		...view[SingleStoreViewConfig],
	};
} */

Domain

Subdomains

Frequently Asked Questions

What does utils.ts do?
utils.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleORM domain, QueryBuilders subdomain.
What functions are defined in utils.ts?
utils.ts defines 2 function(s): extractUsedTable, getTableConfig.
What does utils.ts depend on?
utils.ts imports 12 module(s): IndexBuilder, PrimaryKeyBuilder, SingleStoreTable, UniqueConstraintBuilder, entity.ts, indexes.ts, primary-keys.ts, sql.ts, and 4 more.
What files import utils.ts?
utils.ts is imported by 4 file(s): delete.ts, insert.ts, select.ts, update.ts.
Where is utils.ts in the architecture?
utils.ts is located at drizzle-orm/src/singlestore-core/utils.ts (domain: DrizzleORM, subdomain: QueryBuilders, directory: drizzle-orm/src/singlestore-core).

Analyze Your Own Codebase

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

Try Supermodel Free