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
  05a4464c_b137_3d56_0f64_434dce6f7bad["users()"]
  87dcb46e_0d95_8341_e760_d59ef620c68d["tables.ts"]
  05a4464c_b137_3d56_0f64_434dce6f7bad -->|defined in| 87dcb46e_0d95_8341_e760_d59ef620c68d
  style 05a4464c_b137_3d56_0f64_434dce6f7bad fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/type-tests/sqlite/tables.ts lines 42–62

	(users) => ({
		usersAge1Idx: uniqueIndex('usersAge1Idx').on(users.class),
		usersAge2Idx: index('usersAge2Idx').on(users.class),
		uniqueClass: uniqueIndex('uniqueClass')
			.on(users.class, users.subClass)
			.where(
				sql`${users.class} is not null`,
			),
		uniqueClassEvenBetterThanPrisma: uniqueIndex('uniqueClass')
			.on(users.class, users.subClass)
			.where(
				sql`${users.class} is not null`,
			),
		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),
	}),