withFriends() — drizzle-orm Function Reference

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

Function typescript DrizzleORM QueryBuilders

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/type-tests/geldb/select.ts lines 946–958

	function withFriends<T extends GelSelect>(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`);
	}