users() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/type-tests/mysql/tables.ts lines 66–81

	(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`),
		legalAge: check('legalAge', sql`${users.age1} > 18`),
		usersClassFK: foreignKey({ columns: [users.subClass], foreignColumns: [classes.subClass] }),
		usersClassComplexFK: foreignKey({
			columns: [users.class, users.subClass],
			foreignColumns: [classes.class, classes.subClass],
		}),
		pk: primaryKey(users.age1, users.class),
	}),