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
  f7dd2c37_417b_278b_849c_704ab86db787["withFriends()"]
  1b29b8f2_7157_9d62_ee9d_e1c3725e1a73["select.ts"]
  f7dd2c37_417b_278b_849c_704ab86db787 -->|defined in| 1b29b8f2_7157_9d62_ee9d_e1c3725e1a73
  style f7dd2c37_417b_278b_849c_704ab86db787 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/type-tests/singlestore/select.ts lines 680–692

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