from() — drizzle-orm Function Reference

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

Function typescript DrizzleORM QueryBuilders calls 1

Entity Profile

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

Dependency Diagram

graph TD
  18d2df07_b990_ea59_4e05_8f22679dc948["from()"]
  d7052361_ed2a_2558_f6d4_aa828e7f99ec["PgSelectBuilder"]
  18d2df07_b990_ea59_4e05_8f22679dc948 -->|defined in| d7052361_ed2a_2558_f6d4_aa828e7f99ec
  f5ae4a94_1ac2_f45d_458e_2e4d05137160["setToken()"]
  18d2df07_b990_ea59_4e05_8f22679dc948 -->|calls| f5ae4a94_1ac2_f45d_458e_2e4d05137160
  style 18d2df07_b990_ea59_4e05_8f22679dc948 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/query-builders/select.ts lines 109–150

	from<TFrom extends PgTable | Subquery | PgViewBase | SQL>(
		source: TableLikeHasEmptySelection<TFrom> extends true ? DrizzleTypeError<
				"Cannot reference a data-modifying statement subquery if it doesn't contain a `returning` clause"
			>
			: TFrom,
	): CreatePgSelectFromBuilderMode<
		TBuilderMode,
		GetSelectTableName<TFrom>,
		TSelection extends undefined ? GetSelectTableSelection<TFrom> : TSelection,
		TSelection extends undefined ? 'single' : 'partial'
	> {
		const isPartialSelect = !!this.fields;
		const src = source as TFrom;

		let fields: SelectedFields;
		if (this.fields) {
			fields = this.fields;
		} else if (is(src, Subquery)) {
			// This is required to use the proxy handler to get the correct field values from the subquery
			fields = Object.fromEntries(
				Object.keys(src._.selectedFields).map((
					key,
				) => [key, src[key as unknown as keyof typeof src] as unknown as SelectedFields[string]]),
			);
		} else if (is(src, PgViewBase)) {
			fields = src[ViewBaseConfig].selectedFields as SelectedFields;
		} else if (is(src, SQL)) {
			fields = {};
		} else {
			fields = getTableColumns<PgTable>(src);
		}

		return (new PgSelectBase({
			table: src,
			fields,
			isPartialSelect,
			session: this.session,
			dialect: this.dialect,
			withList: this.withList,
			distinct: this.distinct,
		}).setToken(this.authToken)) as any;
	}