users() — drizzle-orm Function Reference

Architecture documentation for the users() function in tables.ts from the drizzle-orm codebase.

Function typescript DrizzleORM DatabaseDrivers

Entity Profile

DrizzleORM→ DatabaseDrivers→ users() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  78078626_d997_9e51_8ddc_183cfc8d1b23["users()"]
  42a3f195_439f_04bb_e0a7_1cdfc016e10c["tables.ts"]
  78078626_d997_9e51_8ddc_183cfc8d1b23 -->|defined in| 42a3f195_439f_04bb_e0a7_1cdfc016e10c
  style 78078626_d997_9e51_8ddc_183cfc8d1b23 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/type-tests/singlestore/tables.ts lines 63–72

	(users) => ({
		usersAge1Idx: uniqueIndex('usersAge1Idx').on(users.class),
		usersAge2Idx: index('usersAge2Idx').on(users.class),
		uniqueClass: uniqueIndex('uniqueClass')
			.on(users.class, users.subClass)
			.lock('default')
			.algorithm('copy')
			.using(`btree`),
		pk: primaryKey(users.age1, users.class),
	}),