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

Relationship Graph

Source Code

drizzle-orm/type-tests/pg/tables.ts lines 106–122

	(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(users.age1, users.class),
	],