buildSelection() — drizzle-orm Function Reference

Architecture documentation for the buildSelection() function in dialect.ts from the drizzle-orm codebase.

Function typescript DrizzleORM DatabaseDrivers called by 4

Entity Profile

DrizzleORM→ DatabaseDrivers→ buildSelection() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  e700cd38_c0c8_fbeb_26a9_7fbf17216117["buildSelection()"]
  3977a3fd_2f08_73b1_4df4_3d0fd1858514["PgDialect"]
  e700cd38_c0c8_fbeb_26a9_7fbf17216117 -->|defined in| 3977a3fd_2f08_73b1_4df4_3d0fd1858514
  a2e40eaa_bf7f_0455_dd07_c8fd2cf636b4["buildDeleteQuery()"]
  a2e40eaa_bf7f_0455_dd07_c8fd2cf636b4 -->|calls| e700cd38_c0c8_fbeb_26a9_7fbf17216117
  51652aaf_93cd_307b_be64_ec6b5cfd33e6["buildUpdateQuery()"]
  51652aaf_93cd_307b_be64_ec6b5cfd33e6 -->|calls| e700cd38_c0c8_fbeb_26a9_7fbf17216117
  9a7f35b1_0b1e_f3ac_68cb_233ef6bc00a0["buildSelectQuery()"]
  9a7f35b1_0b1e_f3ac_68cb_233ef6bc00a0 -->|calls| e700cd38_c0c8_fbeb_26a9_7fbf17216117
  60bfe461_a9dc_4322_6fda_a22d548a71a9["buildInsertQuery()"]
  60bfe461_a9dc_4322_6fda_a22d548a71a9 -->|calls| e700cd38_c0c8_fbeb_26a9_7fbf17216117
  style e700cd38_c0c8_fbeb_26a9_7fbf17216117 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/dialect.ts lines 211–277

	private buildSelection(
		fields: SelectedFieldsOrdered,
		{ isSingleTable = false }: { isSingleTable?: boolean } = {},
	): SQL {
		const columnsLen = fields.length;

		const chunks = fields
			.flatMap(({ field }, i) => {
				const chunk: SQLChunk[] = [];

				if (is(field, SQL.Aliased) && field.isSelectionField) {
					chunk.push(sql.identifier(field.fieldAlias));
				} else if (is(field, SQL.Aliased) || is(field, SQL)) {
					const query = is(field, SQL.Aliased) ? field.sql : field;

					if (isSingleTable) {
						chunk.push(
							new SQL(
								query.queryChunks.map((c) => {
									if (is(c, PgColumn)) {
										return sql.identifier(this.casing.getColumnCasing(c));
									}
									return c;
								}),
							),
						);
					} else {
						chunk.push(query);
					}

					if (is(field, SQL.Aliased)) {
						chunk.push(sql` as ${sql.identifier(field.fieldAlias)}`);
					}
				} else if (is(field, Column)) {
					if (isSingleTable) {
						chunk.push(sql.identifier(this.casing.getColumnCasing(field)));
					} else {
						chunk.push(field);
					}
				} else if (is(field, Subquery)) {
					const entries = Object.entries(field._.selectedFields) as [string, SQL.Aliased | Column | SQL][];

					if (entries.length === 1) {
						const entry = entries[0]![1];

						const fieldDecoder = is(entry, SQL)
							? entry.decoder
							: is(entry, Column)
							? { mapFromDriverValue: (v: any) => entry.mapFromDriverValue(v) }
							: entry.sql.decoder;

						if (fieldDecoder) {
							field._.sql.decoder = fieldDecoder;
						}
					}
					chunk.push(field);
				}

				if (i < columnsLen - 1) {
					chunk.push(sql`, `);
				}

				return chunk;
			});

		return sql.join(chunks);
	}