drizzle-orm Architecture Docs
Home / Function/ index() — drizzle-orm Function Reference

index() — drizzle-orm Function Reference

Architecture documentation for the index() function in indexes.ts from the drizzle-orm codebase.

Function typescript DrizzleORM RelationalQuery

Entity Profile

Dependency Diagram

graph TD
  b09aa93c_563c_c4c8_5280_eec655f06b21["index()"]
  8e96cfe7_b09e_acd6_1e9a_cf73dc90a16f["indexes.ts"]
  b09aa93c_563c_c4c8_5280_eec655f06b21 -->|defined in| 8e96cfe7_b09e_acd6_1e9a_cf73dc90a16f
  style b09aa93c_563c_c4c8_5280_eec655f06b21 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/gel-core/indexes.ts lines 253–255

export function index(name?: string): IndexBuilderOn {
	return new IndexBuilderOn(false, name);
}

Domain

Subdomains

Defined In

Source

Frequently Asked Questions

What does index() do?
index() is a function in the drizzle-orm codebase, defined in drizzle-orm/src/gel-core/indexes.ts.
Where is index() defined?
index() is defined in drizzle-orm/src/gel-core/indexes.ts at line 253.

Analyze Your Own Codebase

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

Try Supermodel Free