withFriends() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/type-tests/mysql/select.ts lines 611–623

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