getTableConfig() — drizzle-orm Function Reference

Architecture documentation for the getTableConfig() function in utils.ts from the drizzle-orm codebase.

Function typescript DrizzleORM RelationalQuery calls 1

Entity Profile

DrizzleORM→ RelationalQuery→ getTableConfig() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  ed42f3c3_fcef_1c8c_7642_79240513f936["getTableConfig()"]
  ae5f6568_e61c_e2e0_88cb_92eabc9ba98e["utils.ts"]
  ed42f3c3_fcef_1c8c_7642_79240513f936 -->|defined in| ae5f6568_e61c_e2e0_88cb_92eabc9ba98e
  42b48502_37af_91f7_f4c7_352a3707b187["build()"]
  ed42f3c3_fcef_1c8c_7642_79240513f936 -->|calls| 42b48502_37af_91f7_f4c7_352a3707b187
  style ed42f3c3_fcef_1c8c_7642_79240513f936 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/singlestore-core/utils.ts lines 27–61

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,
	};
}