drizzle-orm Architecture Docs
Home / Class/ IndexBuilderOn Class — drizzle-orm Architecture

IndexBuilderOn Class — drizzle-orm Architecture

Architecture documentation for the IndexBuilderOn class in indexes.ts from the drizzle-orm codebase.

Class typescript DrizzleORM

Entity Profile

Dependency Diagram

graph TD
  01612b83_6b2d_b959_eac9_2da2cc980c14["IndexBuilderOn"]
  a5a9f725_34b6_8a98_a70a_5e7133d7ec60["indexes.ts"]
  01612b83_6b2d_b959_eac9_2da2cc980c14 -->|defined in| a5a9f725_34b6_8a98_a70a_5e7133d7ec60
  d22e7d33_fd64_9e44_8dd4_33c23837ac28["constructor()"]
  01612b83_6b2d_b959_eac9_2da2cc980c14 -->|method| d22e7d33_fd64_9e44_8dd4_33c23837ac28
  163c7d9d_f3da_3c5a_db58_432d9d5b96f4["on()"]
  01612b83_6b2d_b959_eac9_2da2cc980c14 -->|method| 163c7d9d_f3da_3c5a_db58_432d9d5b96f4

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/indexes.ts lines 34–42

export class IndexBuilderOn {
	static readonly [entityKind]: string = 'MySqlIndexBuilderOn';

	constructor(private name: string, private unique: boolean) {}

	on(...columns: [IndexColumn, ...IndexColumn[]]): IndexBuilder {
		return new IndexBuilder(this.name, columns, this.unique);
	}
}

Domain

Defined In

Source

Frequently Asked Questions

What is the IndexBuilderOn class?
IndexBuilderOn is a class in the drizzle-orm codebase, defined in drizzle-orm/src/mysql-core/indexes.ts.
Where is IndexBuilderOn defined?
IndexBuilderOn is defined in drizzle-orm/src/mysql-core/indexes.ts at line 34.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free