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

Relationship Graph

Source Code

drizzle-orm/type-tests/geldb/tables.ts lines 81–97

	(users) => [
		uniqueIndex('usersAge1Idx').on(users.class.asc().nullsFirst(), sql``),
		index('usersAge2Idx').on(sql``),
		uniqueIndex('uniqueClass')
			.using('btree', users.class.desc().op('text_ops'), users.subClass.nullsLast())
			.where(sql`${users.class} is not null`)
			.concurrently(),
		check('legalAge', sql`${users.age1} > 18`),
		foreignKey({ columns: [users.subClass], foreignColumns: [classes.subClass] })
			.onUpdate('cascade')
			.onDelete('cascade'),
		foreignKey({
			columns: [users.class, users.subClass],
			foreignColumns: [classes.class, classes.subClass],
		}),
		primaryKey({ columns: [users.age1, users.class] }),
	],