from() — drizzle-orm Function Reference

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

Function typescript DrizzleORM QueryBuilders

Entity Profile

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

Dependency Diagram

graph TD
  b30d1bdb_2d0b_82ab_7019_ce1295f87b2a["from()"]
  57f40dd9_546c_0b0c_379a_15d332ab8556["SingleStoreSelectBuilder"]
  b30d1bdb_2d0b_82ab_7019_ce1295f87b2a -->|defined in| 57f40dd9_546c_0b0c_379a_15d332ab8556
  style b30d1bdb_2d0b_82ab_7019_ce1295f87b2a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/singlestore-core/query-builders/select.ts lines 90–130

	from<TFrom extends SingleStoreTable | Subquery | SQL>( // | SingleStoreViewBase
		source: TFrom,
	): CreateSingleStoreSelectFromBuilderMode<
		TBuilderMode,
		GetSelectTableName<TFrom>,
		TSelection extends undefined ? GetSelectTableSelection<TFrom> : TSelection,
		TSelection extends undefined ? 'single' : 'partial',
		TPreparedQueryHKT
	> {
		const isPartialSelect = !!this.fields;

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

		return new SingleStoreSelectBase(
			{
				table: source,
				fields,
				isPartialSelect,
				session: this.session,
				dialect: this.dialect,
				withList: this.withList,
				distinct: this.distinct,
			},
		) as any;
	}