prepare() — drizzle-orm Function Reference

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

Function typescript DrizzleORM QueryBuilders

Entity Profile

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

Dependency Diagram

graph TD
  82c31159_aa19_0643_f14a_7a47166e5897["prepare()"]
  c4d31510_f8fd_97bc_162b_af107bcf063e["MySqlSelectBase"]
  82c31159_aa19_0643_f14a_7a47166e5897 -->|defined in| c4d31510_f8fd_97bc_162b_af107bcf063e
  style 82c31159_aa19_0643_f14a_7a47166e5897 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/query-builders/select.ts lines 1128–1142

	prepare(): MySqlSelectPrepare<this> {
		if (!this.session) {
			throw new Error('Cannot execute a query on a query builder. Please use a database instance instead.');
		}
		const fieldsList = orderSelectedFields<MySqlColumn>(this.config.fields);
		const query = this.session.prepareQuery<
			MySqlPreparedQueryConfig & { execute: SelectResult<TSelection, TSelectMode, TNullabilityMap>[] },
			TPreparedQueryHKT
		>(this.dialect.sqlToQuery(this.getSQL()), fieldsList, undefined, undefined, undefined, {
			type: 'select',
			tables: [...this.usedTables],
		}, this.cacheConfig);
		query.joinsNotNullableMap = this.joinsNotNullableMap;
		return query as MySqlSelectPrepare<this>;
	}