prepare() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects calls 1 called by 1

Entity Profile

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

Dependency Diagram

graph TD
  d9a2e9f1_72dd_6389_6ef7_378d724acd45["prepare()"]
  97e93111_9d48_b41c_c8c3_586a25b127c9["MySqlRelationalQuery"]
  d9a2e9f1_72dd_6389_6ef7_378d724acd45 -->|defined in| 97e93111_9d48_b41c_c8c3_586a25b127c9
  9e5f50b0_23c1_cf72_80af_ecc8b20d9473["execute()"]
  9e5f50b0_23c1_cf72_80af_ecc8b20d9473 -->|calls| d9a2e9f1_72dd_6389_6ef7_378d724acd45
  31e0e982_9584_6e29_b686_65a7fb1faabe["_toSQL()"]
  d9a2e9f1_72dd_6389_6ef7_378d724acd45 -->|calls| 31e0e982_9584_6e29_b686_65a7fb1faabe
  style d9a2e9f1_72dd_6389_6ef7_378d724acd45 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/query-builders/query.ts lines 99–112

	prepare() {
		const { query, builtQuery } = this._toSQL();
		return this.session.prepareQuery(
			builtQuery,
			undefined,
			(rawRows) => {
				const rows = rawRows.map((row) => mapRelationalRow(this.schema, this.tableConfig, row, query.selection));
				if (this.queryMode === 'first') {
					return rows[0] as TResult;
				}
				return rows as TResult;
			},
		) as PreparedQueryKind<TPreparedQueryHKT, MySqlPreparedQueryConfig & { execute: TResult }, true>;
	}