$count() — drizzle-orm Function Reference

Architecture documentation for the $count() function in db.ts from the drizzle-orm codebase.

Function typescript DrizzleORM DatabaseDrivers called by 1

Entity Profile

DrizzleORM→ DatabaseDrivers→ $count() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  41d4d9ab_8f73_38df_b085_0e6bc0f6afee["$count()"]
  7b170b6b_8109_4580_dc12_4da0d59d8d8d["PgDatabase"]
  41d4d9ab_8f73_38df_b085_0e6bc0f6afee -->|defined in| 7b170b6b_8109_4580_dc12_4da0d59d8d8d
  99f2c80b_960e_3f9d_a9fe_c8c1b4967d81["withReplicas()"]
  99f2c80b_960e_3f9d_a9fe_c8c1b4967d81 -->|calls| 41d4d9ab_8f73_38df_b085_0e6bc0f6afee
  style 41d4d9ab_8f73_38df_b085_0e6bc0f6afee fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/db.ts lines 150–155

	$count(
		source: PgTable | PgViewBase | SQL | SQLWrapper,
		filters?: SQL<unknown>,
	) {
		return new PgCountBuilder({ source, filters, session: this.session });
	}