with() — drizzle-orm Function Reference

Architecture documentation for the with() function in query-builder.ts from the drizzle-orm codebase.

Function typescript DrizzleORM QueryBuilders calls 3

Entity Profile

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

Dependency Diagram

graph TD
  fde8c649_dc90_d878_0a1b_88f6d51dc402["with()"]
  f585ea4c_943c_c202_a5e3_d32a1f49db0c["QueryBuilder"]
  fde8c649_dc90_d878_0a1b_88f6d51dc402 -->|defined in| f585ea4c_943c_c202_a5e3_d32a1f49db0c
  c07c9dfa_81d0_1c35_0f87_58ab89ce4655["select()"]
  fde8c649_dc90_d878_0a1b_88f6d51dc402 -->|calls| c07c9dfa_81d0_1c35_0f87_58ab89ce4655
  63694535_6c03_2c90_0f93_461b6a530b24["getDialect()"]
  fde8c649_dc90_d878_0a1b_88f6d51dc402 -->|calls| 63694535_6c03_2c90_0f93_461b6a530b24
  31c708a1_b0e6_b765_bdf4_4f4593d858a6["selectDistinct()"]
  fde8c649_dc90_d878_0a1b_88f6d51dc402 -->|calls| 31c708a1_b0e6_b765_bdf4_4f4593d858a6
  style fde8c649_dc90_d878_0a1b_88f6d51dc402 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/singlestore-core/query-builders/query-builder.ts lines 48–83

	with(...queries: WithSubquery[]) {
		const self = this;

		function select(): SingleStoreSelectBuilder<undefined, never, 'qb'>;
		function select<TSelection extends SelectedFields>(
			fields: TSelection,
		): SingleStoreSelectBuilder<TSelection, never, 'qb'>;
		function select<TSelection extends SelectedFields>(
			fields?: TSelection,
		): SingleStoreSelectBuilder<TSelection | undefined, never, 'qb'> {
			return new SingleStoreSelectBuilder({
				fields: fields ?? undefined,
				session: undefined,
				dialect: self.getDialect(),
				withList: queries,
			});
		}

		function selectDistinct(): SingleStoreSelectBuilder<undefined, never, 'qb'>;
		function selectDistinct<TSelection extends SelectedFields>(
			fields: TSelection,
		): SingleStoreSelectBuilder<TSelection, never, 'qb'>;
		function selectDistinct<TSelection extends SelectedFields>(
			fields?: TSelection,
		): SingleStoreSelectBuilder<TSelection | undefined, never, 'qb'> {
			return new SingleStoreSelectBuilder({
				fields: fields ?? undefined,
				session: undefined,
				dialect: self.getDialect(),
				withList: queries,
				distinct: true,
			});
		}

		return { select, selectDistinct };
	}