withFriends() — drizzle-orm Function Reference

Architecture documentation for the withFriends() function in select.ts from the drizzle-orm codebase.

Function typescript DrizzleORM DatabaseDrivers

Entity Profile

DrizzleORM→ DatabaseDrivers→ withFriends() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  a6f9b802_bfff_4dd7_ce66_128ea289e313["withFriends()"]
  e0590ec9_eee4_a25d_2bbf_54c94ac5420f["select.ts"]
  a6f9b802_bfff_4dd7_ce66_128ea289e313 -->|defined in| e0590ec9_eee4_a25d_2bbf_54c94ac5420f
  style a6f9b802_bfff_4dd7_ce66_128ea289e313 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/type-tests/pg/select.ts lines 1004–1016

	function withFriends<T extends PgSelect>(qb: T) {
		const friends = alias(users, 'friends');
		const friends2 = alias(users, 'friends2');
		const friends3 = alias(users, 'friends3');
		const friends4 = alias(users, 'friends4');
		const friends5 = alias(users, 'friends5');
		return qb
			.leftJoin(friends, sql`true`)
			.leftJoin(friends2, sql`true`)
			.leftJoin(friends3, sql`true`)
			.leftJoin(friends4, sql`true`)
			.leftJoin(friends5, sql`true`);
	}