buildOrderBy() — drizzle-orm Function Reference

Architecture documentation for the buildOrderBy() function in dialect.ts from the drizzle-orm codebase.

Function typescript DrizzleORM SQLDialects called by 3

Entity Profile

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

Dependency Diagram

graph TD
  1a6d3dd7_66dd_323c_34ba_58c1bebc1ede["buildOrderBy()"]
  9c5eee4c_4b78_a585_4038_d710de212097["MySqlDialect"]
  1a6d3dd7_66dd_323c_34ba_58c1bebc1ede -->|defined in| 9c5eee4c_4b78_a585_4038_d710de212097
  6603fb43_ff6f_ad94_0e94_0f152d804075["buildDeleteQuery()"]
  6603fb43_ff6f_ad94_0e94_0f152d804075 -->|calls| 1a6d3dd7_66dd_323c_34ba_58c1bebc1ede
  8f9fa658_edb5_f102_51bb_be11ee53973b["buildUpdateQuery()"]
  8f9fa658_edb5_f102_51bb_be11ee53973b -->|calls| 1a6d3dd7_66dd_323c_34ba_58c1bebc1ede
  8ae83588_d5c3_3834_94e9_82ba6770d1a1["buildSelectQuery()"]
  8ae83588_d5c3_3834_94e9_82ba6770d1a1 -->|calls| 1a6d3dd7_66dd_323c_34ba_58c1bebc1ede
  style 1a6d3dd7_66dd_323c_34ba_58c1bebc1ede fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/dialect.ts lines 261–263

	private buildOrderBy(orderBy: (MySqlColumn | SQL | SQL.Aliased)[] | undefined): SQL | undefined {
		return orderBy && orderBy.length > 0 ? sql` order by ${sql.join(orderBy, sql`, `)}` : undefined;
	}