with() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects calls 3

Entity Profile

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

Dependency Diagram

graph TD
  bc9c1bfa_5d66_ec03_7aff_509eb90539d3["with()"]
  dee3e8ac_d7af_d07c_18f4_417182ce53f3["QueryBuilder"]
  bc9c1bfa_5d66_ec03_7aff_509eb90539d3 -->|defined in| dee3e8ac_d7af_d07c_18f4_417182ce53f3
  7ae54d28_15e5_83bb_326a_989d6878f163["select()"]
  bc9c1bfa_5d66_ec03_7aff_509eb90539d3 -->|calls| 7ae54d28_15e5_83bb_326a_989d6878f163
  fdc0c859_068c_5ce9_e13c_53a3fafb56fd["getDialect()"]
  bc9c1bfa_5d66_ec03_7aff_509eb90539d3 -->|calls| fdc0c859_068c_5ce9_e13c_53a3fafb56fd
  2ca2c85c_c504_cb0f_8af6_6b4f9f11b4c0["selectDistinct()"]
  bc9c1bfa_5d66_ec03_7aff_509eb90539d3 -->|calls| 2ca2c85c_c504_cb0f_8af6_6b4f9f11b4c0
  style bc9c1bfa_5d66_ec03_7aff_509eb90539d3 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

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

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

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

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

		return { select, selectDistinct };
	}