getTableConfig() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects calls 1

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/utils.ts lines 34–76

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

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

	if (extraConfigBuilder !== undefined) {
		const extraConfig = extraConfigBuilder(table[MySqlTable.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, 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));
			}
		}
	}

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