metal-orm 1.0.85 → 1.0.87

package/src/query-builder/select.ts

@@ -68,7 +68,7 @@ import { SelectCTEFacet } from './select/cte-facet.js';
 import { SelectSetOpFacet } from './select/setop-facet.js';
 import { SelectRelationFacet } from './select/relation-facet.js';
 import { buildFilterParameters, extractSchema, SchemaOptions, OpenApiSchemaBundle } from '../openapi/index.js';
-import { hasParamOperandsInQuery } from '../core/ast/ast-validation.js';
+import { findFirstParamOperandName } from '../core/ast/ast-validation.js';
 
 type ColumnSelectionValue =
   | ColumnDef
@@ -82,10 +82,14 @@ type SelectionValueType<TValue> =
   TValue extends ColumnDef ? ColumnToTs<TValue> :
   unknown;
 
-type SelectionResult<TSelection extends Record<string, ColumnSelectionValue>> = {
-  [K in keyof TSelection]: SelectionValueType<TSelection[K]>;
-};
-
+type SelectionResult<TSelection extends Record<string, ColumnSelectionValue>> = {
+  [K in keyof TSelection]: SelectionValueType<TSelection[K]>;
+};
+
+type ParamOperandCompileOptions = {
+  allowParamOperands?: boolean;
+};
+
 type SelectionFromKeys<
   TTable extends TableDef,
   K extends keyof TTable['columns'] & string
@@ -732,9 +736,9 @@ export class SelectQueryBuilder<T = EntityInstance<TableDef>, TTable extends Tab
    */
   private validateNoParamOperands(): void {
     const ast = this.context.hydration.applyToAst(this.context.state.ast);
-    const hasParams = hasParamOperandsInQuery(ast);
-    if (hasParams) {
-      throw new Error('Cannot execute query containing Param operands. Param proxies are only for schema generation (getSchema()). If you need real parameters, use literal values.');
+    const paramName = findFirstParamOperandName(ast);
+    if (paramName) {
+      throw new Error(`Cannot execute query containing Param operand "${paramName}". Param proxies are only for schema generation (getSchema()). If you need real parameters, use literal values.`);
     }
   }
 
@@ -1109,10 +1113,18 @@ export class SelectQueryBuilder<T = EntityInstance<TableDef>, TTable extends Tab
    *   .compile('postgres');
    * console.log(compiled.sql); // SELECT "id", "name" FROM "users" WHERE "active" = true
    */
-  compile(dialect: SelectDialectInput): CompiledQuery {
-    const resolved = resolveDialectInput(dialect);
-    return resolved.compileSelect(this.getAST());
-  }
+  compile(dialect: SelectDialectInput, options?: ParamOperandCompileOptions): CompiledQuery {
+    const resolved = resolveDialectInput(dialect);
+    const ast = this.getAST();
+    if (!options?.allowParamOperands) {
+      const paramName = findFirstParamOperandName(ast);
+      if (paramName) {
+        throw new Error(`Cannot compile query containing Param operand "${paramName}". Param proxies are only for schema generation (getSchema()). If you need real parameters, use literal values.`);
+      }
+      return resolved.compileSelect(ast);
+    }
+    return resolved.compileSelectWithOptions(ast, { allowParams: true });
+  }
 
   /**
    * Converts the query to SQL string for a specific dialect
@@ -1124,9 +1136,9 @@ export class SelectQueryBuilder<T = EntityInstance<TableDef>, TTable extends Tab
    *   .toSql('postgres');
    * console.log(sql); // SELECT "id", "name" FROM "users" WHERE "active" = true
    */
-  toSql(dialect: SelectDialectInput): string {
-    return this.compile(dialect).sql;
-  }
+  toSql(dialect: SelectDialectInput, options?: ParamOperandCompileOptions): string {
+    return this.compile(dialect, options).sql;
+  }
 
   /**
    * Gets hydration plan for query