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 DatabaseDrivers

Entity Profile

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/src/pg-core/indexes.ts lines 245–247

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/pg-core/indexes.ts.
Where is index() defined?
index() is defined in drizzle-orm/src/pg-core/indexes.ts at line 245.

Analyze Your Own Codebase

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

Try Supermodel Free