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
  12f2fc59_81fe_9fd7_6c94_f0768f309695["getTableConfig()"]
  9cb8488e_0ece_edef_af6a_5851d56cddda["utils.ts"]
  12f2fc59_81fe_9fd7_6c94_f0768f309695 -->|defined in| 9cb8488e_0ece_edef_af6a_5851d56cddda
  91a8a4e9_2fd5_8c6e_dcd1_05ecaac8e339["build()"]
  12f2fc59_81fe_9fd7_6c94_f0768f309695 -->|calls| 91a8a4e9_2fd5_8c6e_dcd1_05ecaac8e339
  style 12f2fc59_81fe_9fd7_6c94_f0768f309695 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/gel-core/utils.ts lines 19–65

export function getTableConfig<TTable extends GelTable>(table: TTable) {
	const columns = Object.values(table[Table.Symbol.Columns]);
	const indexes: Index[] = [];
	const checks: Check[] = [];
	const primaryKeys: PrimaryKey[] = [];
	const foreignKeys: ForeignKey[] = Object.values(table[GelTable.Symbol.InlineForeignKeys]);
	const uniqueConstraints: UniqueConstraint[] = [];
	const name = table[Table.Symbol.Name];
	const schema = table[Table.Symbol.Schema];
	const policies: GelPolicy[] = [];
	const enableRLS: boolean = table[GelTable.Symbol.EnableRLS];

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

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

	return {
		columns,
		indexes,
		foreignKeys,
		checks,
		primaryKeys,
		uniqueConstraints,
		name,
		schema,
		policies,
		enableRLS,
	};
}