@dbsp/adapter-pgsql 1.8.0 → 1.8.1

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { ExpressionRef, IndexInfo, TruncateOptions, VacuumOptions, AlterColumnOptions, CreateIndexOptions, DropIndexOptions, ModelIR as ModelIR$1 } from '@dbsp/core';
 export { normalizeSQL } from '@dbsp/core';
 import * as _dbsp_types from '@dbsp/types';
-import { ColumnListInput, ParamIntent, JsonAggOrderByEntry, DialectCapabilities, ModelIR, DbCasing, ColumnIR, HierarchyIR, WhereIntent, Adapter, AdapterLogger, AdapterCapabilities, PlanReport, CompiledNqlQuery, CompileOptions, CompiledQuery, CompileResultWithIncludes, SubqueryIncludeInfo, ExpressionIntent, InsertIntent, InsertFromIntent, UpdateIntent, BatchUpdateIntent, DeleteIntent, UpsertIntent, UpsertFromIntent, RecursivePlanReport, CteQueryIntent, SetOperationIntent, DumpMeta, Dump, AdapterStreamOptions, CompileOnlyAdapter, QueryIntent } from '@dbsp/types';
+import { ColumnListInput, ParamIntent, JsonAggOrderByEntry, DialectCapabilities, ModelIR, DbCasing, ColumnIR, HierarchyIR, MutationReturningItem, WhereIntent, Adapter, AdapterLogger, AdapterCapabilities, PlanReport, CompiledNqlQuery, CompileOptions, CompiledQuery, CompileResultWithIncludes, SubqueryIncludeInfo, ExpressionIntent, InsertIntent, InsertFromIntent, UpdateIntent, BatchUpdateIntent, DeleteIntent, UpsertIntent, UpsertFromIntent, RecursivePlanReport, CteQueryIntent, SetOperationIntent, DumpMeta, Dump, AdapterStreamOptions, CompileOnlyAdapter, QueryIntent } from '@dbsp/types';
 import * as _pgsql_types from '@pgsql/types';
 import { Node, OnConflictClause, ParamRef } from '@pgsql/types';
 import { Pool, PoolClient } from 'pg';
@@ -1368,6 +1368,8 @@ interface InsertConfig {
     values: unknown[][];
     /** Columns to return (RETURNING clause) */
     returning?: string[];
+    /** Alias-aware RETURNING projection items */
+    returningItems?: readonly MutationReturningItem[];
     /** Subquery for INSERT ... SELECT */
     selectQuery?: Node;
     /** Column database types for type-cast emission (e.g. range types) */
@@ -1388,6 +1390,8 @@ interface UpdateConfig {
     where?: Decision[];
     /** Columns to return (RETURNING clause) */
     returning?: string[];
+    /** Alias-aware RETURNING projection items */
+    returningItems?: readonly MutationReturningItem[];
     /** Column database types for type-cast emission (e.g. range types) */
     columnTypes?: Record<string, string>;
 }
@@ -1401,6 +1405,8 @@ interface DeleteConfig {
     where?: Decision[];
     /** Columns to return (RETURNING clause) */
     returning?: string[];
+    /** Alias-aware RETURNING projection items */
+    returningItems?: readonly MutationReturningItem[];
 }
 /**
  * Compile an INSERT statement from configuration.
@@ -1469,6 +1475,8 @@ interface UpsertConfig {
     useExcluded?: boolean;
     /** Columns to return (RETURNING clause) */
     returning?: string[];
+    /** Alias-aware RETURNING projection items */
+    returningItems?: readonly MutationReturningItem[];
     /** Optional column type hints for unnest casting (schema-driven) */
     columnTypes?: Record<string, string>;
     /**

package/dist/index.js

@@ -14033,12 +14033,48 @@ init_handlers();
 init_param_intent();
 init_param_ref();
 import { isSqlRaw } from "@dbsp/core";
-import { isParamIntent as isParamIntent7 } from "@dbsp/types";
-function buildReturningList(columns, tableRef, ctx) {
-  if (!columns || columns.length === 0) return void 0;
+import {
+  isParamIntent as isParamIntent7
+} from "@dbsp/types";
+function buildReturningList(columns, tableRef, ctx, returningItems) {
   const { naming } = ctx;
+  if (returningItems !== void 0) {
+    const returning = columns ?? [];
+    if (returningItems.length !== returning.length) {
+      throw new Error(
+        `Invalid mutation RETURNING items: returningItems length (${returningItems.length}) must match returning length (${returning.length}).`
+      );
+    }
+    if (returning.includes("*") || returningItems.some((item) => item.output === "*" || item.source === "*")) {
+      throw new Error(
+        "Invalid mutation RETURNING items: star RETURNING cannot carry alias-aware returningItems."
+      );
+    }
+    if (returningItems.length === 0) return void 0;
+    const emittedOutputs = /* @__PURE__ */ new Map();
+    return returningItems.map((item, index) => {
+      if (item.output !== returning[index]) {
+        throw new Error(
+          `Invalid mutation RETURNING items: returningItems[${index}].output '${item.output}' must match returning[${index}] '${returning[index]}'.`
+        );
+      }
+      const emittedOutput = naming.toDatabase(item.output);
+      const previousOutput = emittedOutputs.get(emittedOutput);
+      if (previousOutput !== void 0) {
+        throw new Error(
+          `Duplicate mutation RETURNING output after database naming: '${emittedOutput}' from '${previousOutput}' and '${item.output}'.`
+        );
+      }
+      emittedOutputs.set(emittedOutput, item.output);
+      return resTarget(
+        columnRef(item.source, tableRef, ctx.schema, naming),
+        emittedOutput
+      );
+    });
+  }
+  if (!columns || columns.length === 0) return void 0;
   return columns.map(
-    (col) => resTarget(
+    (col) => col === "*" ? starTarget() : resTarget(
       columnRef(col, tableRef, ctx.schema, naming),
       naming.toDatabase(col)
     )
@@ -14057,7 +14093,12 @@ function compileInsert(config, ctx, state) {
       return valueToNode(val, state, dbType);
     })
   );
-  const returningList = buildReturningList(config.returning, dbTable, ctx);
+  const returningList = buildReturningList(
+    config.returning,
+    dbTable,
+    ctx,
+    config.returningItems
+  );
   const options = {
     table: config.table,
     columns: dbColumns,
@@ -14096,7 +14137,12 @@ function compileUnnestInsert(config, ctx, state) {
       targetList
     }
   };
-  const returningList = buildReturningList(config.returning, dbTable, ctx);
+  const returningList = buildReturningList(
+    config.returning,
+    dbTable,
+    ctx,
+    config.returningItems
+  );
   const options = {
     table: config.table,
     columns: columns.map((c) => naming.toDatabase(c)),
@@ -14135,7 +14181,12 @@ function compileUpdate(config, ctx, state) {
       };
     }
   }
-  const returningList = buildReturningList(config.returning, tableAlias, ctx);
+  const returningList = buildReturningList(
+    config.returning,
+    tableAlias,
+    ctx,
+    config.returningItems
+  );
   const options = {
     table: config.table,
     set: setClause,
@@ -14205,7 +14256,12 @@ function compileUnnestUpdate(config, ctx, state) {
       args: [matchWhere, config.whereGuard]
     }
   } : matchWhere;
-  const returningList = buildReturningList(config.returning, dbTable, ctx);
+  const returningList = buildReturningList(
+    config.returning,
+    dbTable,
+    ctx,
+    config.returningItems
+  );
   const options = {
     table,
     set: setClause,
@@ -14238,7 +14294,12 @@ function compileDelete(config, ctx, state) {
       };
     }
   }
-  const returningList = buildReturningList(config.returning, tableAlias, ctx);
+  const returningList = buildReturningList(
+    config.returning,
+    tableAlias,
+    ctx,
+    config.returningItems
+  );
   const options = {
     table: config.table,
     naming
@@ -14318,7 +14379,8 @@ function compileInsertFrom(config, ctx, state) {
   const returningList = buildReturningList(
     config.returning,
     config.targetTable,
-    ctx
+    ctx,
+    config.returningItems
   );
   const options = {
     table: config.targetTable,
@@ -14399,7 +14461,8 @@ function compileUpsertFrom(config, ctx, state) {
   const returningList = buildReturningList(
     config.returning,
     config.targetTable,
-    ctx
+    ctx,
+    config.returningItems
   );
   const conflictInfer = {
     indexElems: config.conflictColumns.map((col) => ({
@@ -14636,7 +14699,12 @@ function compileUpsert(config, ctx, state) {
     }
   }));
   const onConflict = buildOnConflictClause(config, ctx, state);
-  const returningList = buildReturningList(config.returning, dbTable, ctx);
+  const returningList = buildReturningList(
+    config.returning,
+    dbTable,
+    ctx,
+    config.returningItems
+  );
   return {
     InsertStmt: {
       relation: {
@@ -14686,7 +14754,12 @@ function compileUnnestUpsert(config, ctx, state) {
     }
   };
   const onConflict = buildOnConflictClause(config, ctx, state);
-  const returningList = buildReturningList(config.returning, dbTable, ctx);
+  const returningList = buildReturningList(
+    config.returning,
+    dbTable,
+    ctx,
+    config.returningItems
+  );
   return {
     InsertStmt: {
       relation: {
@@ -16563,6 +16636,7 @@ function compileInsert2(intent, options, deps) {
     columns,
     values,
     ...intent.returning && { returning: [...intent.returning] },
+    ...intent.returningItems && { returningItems: intent.returningItems },
     ...columnTypes && { columnTypes }
   };
   const maxBatchSize = options?.maxBatchSize;
@@ -16609,7 +16683,8 @@ function compileInsertFrom2(intent, options, deps) {
     ...intent.columns && { columns: [...intent.columns] },
     ...resolvedWhere && { where: [whereIntentAsDecision(resolvedWhere)] },
     ...intent.limit !== void 0 && { limit: intent.limit },
-    ...intent.returning && { returning: [...intent.returning] }
+    ...intent.returning && { returning: [...intent.returning] },
+    ...intent.returningItems && { returningItems: intent.returningItems }
   };
   const ast = compileInsertFrom(config, ctx, state);
   const sql = deparseQuoted(ast);
@@ -16647,6 +16722,7 @@ function compileUpdate2(intent, options, deps) {
     })),
     ...resolvedWhere && { where: [whereIntentAsDecision(resolvedWhere)] },
     ...intent.returning && { returning: [...intent.returning] },
+    ...intent.returningItems && { returningItems: intent.returningItems },
     ...columnTypes && { columnTypes }
   };
   const ast = compileUpdate(config, ctx, state);
@@ -16728,6 +16804,7 @@ function compileBatchUpdate(intent, _options, deps) {
     columnArrays,
     ...scalarSet && { scalarSet },
     ...intent.returning && { returning: [...intent.returning] },
+    ...intent.returningItems && { returningItems: intent.returningItems },
     ...columnTypes && { columnTypes },
     ...whereGuard !== void 0 && { whereGuard }
   };
@@ -16757,7 +16834,8 @@ function compileDelete2(intent, options, deps) {
   const config = {
     table: intent.table,
     ...resolvedWhere && { where: [whereIntentAsDecision(resolvedWhere)] },
-    ...intent.returning && { returning: [...intent.returning] }
+    ...intent.returning && { returning: [...intent.returning] },
+    ...intent.returningItems && { returningItems: intent.returningItems }
   };
   const ast = compileDelete(config, ctx, state);
   const sql = deparseQuoted(ast);
@@ -16827,6 +16905,7 @@ function compileUpsert2(intent, options, deps) {
     conflictAction,
     ...updateColumns && { updateColumns },
     ...intent.returning && { returning: [...intent.returning] },
+    ...intent.returningItems && { returningItems: intent.returningItems },
     ...columnTypes && { columnTypes },
     ...hasRawExprs && { updateExpressions: rawExprs },
     ...resolvedActionWhere && {
@@ -16894,7 +16973,8 @@ function compileUpsertFrom2(intent, options, deps) {
     ...columns && { columns },
     ...resolvedWhere && { where: [whereIntentAsDecision(resolvedWhere)] },
     ...intent.limit !== void 0 && { limit: intent.limit },
-    ...intent.returning && { returning: [...intent.returning] }
+    ...intent.returning && { returning: [...intent.returning] },
+    ...intent.returningItems && { returningItems: intent.returningItems }
   };
   const ast = compileUpsertFrom(config, ctx, state);
   const sql = deparseQuoted(ast);
@@ -18550,13 +18630,29 @@ function compileTypedNqlRuntimeBindingCte(name, binding, naming, parameterOffset
     parameters
   };
 }
-function compileNqlRuntimeBindingCte(name, binding, naming, parameterOffset, sourceTable, schemaName, model) {
+function compileNqlRuntimeBindingCte(name, binding, naming, parameterOffset, sourceTable, schemaName, model, returningItems) {
+  if (returningItems !== void 0) {
+    if (returningItems.length !== binding.columns.length || returningItems.some((item, i) => item.output !== binding.columns[i])) {
+      throw new Error(
+        `NQL runtime binding '${name}' has returningItems desynced from its projected columns.`
+      );
+    }
+  }
+  const sourceColumnFor = (output) => returningItems?.find((item) => item.output === output)?.source ?? output;
   if (binding.columns.length === 0) {
     throw new Error(
       `NQL runtime binding '${name}' cannot be materialized without projected columns.`
     );
   }
   const cteName = quoteIdent2(emittedBindName(name, naming), "alias");
+  const emittedColumnNames = binding.columns.map(
+    (column) => naming.toDatabase(column)
+  );
+  if (new Set(emittedColumnNames).size !== emittedColumnNames.length) {
+    throw new Error(
+      `NQL runtime binding '${name}' emits duplicate column names after database naming.`
+    );
+  }
   const columnSql = binding.columns.map((column) => quoteIdent2(naming.toDatabase(column), "column")).join(", ");
   if (binding.columnTypes !== void 0) {
     return compileTypedNqlRuntimeBindingCte(
@@ -18573,7 +18669,9 @@ function compileNqlRuntimeBindingCte(name, binding, naming, parameterOffset, sou
       `NQL runtime binding '${name}' cannot materialize a typed relation because its source table is unavailable.`
     );
   }
-  const projectedColumns = binding.columns.map((column) => quoteIdent2(naming.toDatabase(column), "column")).join(", ");
+  const projectedColumns = binding.columns.map(
+    (column) => quoteIdent2(naming.toDatabase(sourceColumnFor(column)), "column")
+  ).join(", ");
   const sourceAnchorSql = `SELECT ${projectedColumns} FROM ${qualifyTableIdent(sourceTable, schemaName, naming)} WHERE false`;
   if (binding.rows.length === 0) {
     return {
@@ -18584,7 +18682,7 @@ function compileNqlRuntimeBindingCte(name, binding, naming, parameterOffset, sou
   assertRuntimeBindingValuesParameterCount(name, binding, parameterOffset);
   const columnTypes = resolveRuntimeBindingColumnTypes(
     name,
-    binding,
+    { ...binding, columns: binding.columns.map(sourceColumnFor) },
     model,
     sourceTable
   );
@@ -18847,7 +18945,8 @@ var PgsqlAdapter = class _PgsqlAdapter {
           parameters.length,
           runtimeBindingSourceTable(bundle, name),
           deps.schemaName,
-          deps.model
+          deps.model,
+          bundle.mutationBindings?.get(name)?.returningItems
         );
         ctes.push(compiledRuntimeBinding.cte);
         parameters.push(...compiledRuntimeBinding.parameters);