buildIndex() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects called by 1

Entity Profile

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

Dependency Diagram

graph TD
  7c20c441_cfa6_cf8b_7c30_26d754c4801b["buildIndex()"]
  9c5eee4c_4b78_a585_4038_d710de212097["MySqlDialect"]
  7c20c441_cfa6_cf8b_7c30_26d754c4801b -->|defined in| 9c5eee4c_4b78_a585_4038_d710de212097
  8ae83588_d5c3_3834_94e9_82ba6770d1a1["buildSelectQuery()"]
  8ae83588_d5c3_3834_94e9_82ba6770d1a1 -->|calls| 7c20c441_cfa6_cf8b_7c30_26d754c4801b
  style 7c20c441_cfa6_cf8b_7c30_26d754c4801b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/dialect.ts lines 265–275

	private buildIndex({
		indexes,
		indexFor,
	}: {
		indexes: string[] | undefined;
		indexFor: 'USE' | 'FORCE' | 'IGNORE';
	}): SQL | undefined {
		return indexes && indexes.length > 0
			? sql` ${sql.raw(indexFor)} INDEX (${sql.raw(indexes.join(`, `))})`
			: undefined;
	}