extractUsedTable() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers called by 3

Entity Profile

DrizzleORM→ DatabaseDrivers→ extractUsedTable() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  0233f895_0081_faa0_ff5a_5f45a56e9cc3["extractUsedTable()"]
  ce49a5a3_688d_ddce_fd32_28428e51cae2["utils.ts"]
  0233f895_0081_faa0_ff5a_5f45a56e9cc3 -->|defined in| ce49a5a3_688d_ddce_fd32_28428e51cae2
  b6a77973_57ea_cd48_67a3_59bcdf2fd900["_prepare()"]
  b6a77973_57ea_cd48_67a3_59bcdf2fd900 -->|calls| 0233f895_0081_faa0_ff5a_5f45a56e9cc3
  f5b5654b_74de_3eb2_aff2_55d831b2c94f["_prepare()"]
  f5b5654b_74de_3eb2_aff2_55d831b2c94f -->|calls| 0233f895_0081_faa0_ff5a_5f45a56e9cc3
  e5a5b03c_5c66_4927_31d0_4cd2a33f2d3b["_prepare()"]
  e5a5b03c_5c66_4927_31d0_4cd2a33f2d3b -->|calls| 0233f895_0081_faa0_ff5a_5f45a56e9cc3
  style 0233f895_0081_faa0_ff5a_5f45a56e9cc3 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/utils.ts lines 67–78

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