getSQL() — drizzle-orm Function Reference

Architecture documentation for the getSQL() function in query.ts from the drizzle-orm codebase.

Function typescript DrizzleORM SQLDialects called by 4

Entity Profile

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

Dependency Diagram

graph TD
  99e67617_129f_d3c8_e928_0b7a61b52ed9["getSQL()"]
  765d2955_5987_484a_db1f_a5727e426ad2["SQLiteRelationalQuery"]
  99e67617_129f_d3c8_e928_0b7a61b52ed9 -->|defined in| 765d2955_5987_484a_db1f_a5727e426ad2
  7aa1e133_803c_8614_dde4_b88e3702b5a8["run()"]
  7aa1e133_803c_8614_dde4_b88e3702b5a8 -->|calls| 99e67617_129f_d3c8_e928_0b7a61b52ed9
  e5881113_8325_4fad_1edf_507c769fa31f["all()"]
  e5881113_8325_4fad_1edf_507c769fa31f -->|calls| 99e67617_129f_d3c8_e928_0b7a61b52ed9
  4127d8f5_0011_a277_4962_2970d4765de0["get()"]
  4127d8f5_0011_a277_4962_2970d4765de0 -->|calls| 99e67617_129f_d3c8_e928_0b7a61b52ed9
  00f24df6_58eb_5e6d_d5b6_f743143ee711["values()"]
  00f24df6_58eb_5e6d_d5b6_f743143ee711 -->|calls| 99e67617_129f_d3c8_e928_0b7a61b52ed9
  style 99e67617_129f_d3c8_e928_0b7a61b52ed9 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/sqlite-core/query-builders/query.ts lines 129–139

	getSQL(): SQL {
		return this.dialect.buildRelationalQuery({
			fullSchema: this.fullSchema,
			schema: this.schema,
			tableNamesMap: this.tableNamesMap,
			table: this.table,
			tableConfig: this.tableConfig,
			queryConfig: this.config,
			tableAlias: this.tableConfig.tsName,
		}).sql as SQL;
	}