pqb 0.62.1 → 0.63.0

package/dist/index.d.ts

@@ -252,6 +252,11 @@ declare abstract class QueryError<T extends PickQueryShape = PickQueryShape> ext
     get columns(): { [K in keyof T["shape"]]?: true | undefined; };
 }
 
+interface SqlSessionState {
+    role?: string;
+    setConfig?: Record<string, string | number | boolean>;
+}
+
 /**
  * Generic result returning from query methods.
  */
@@ -342,6 +347,7 @@ interface AdapterTransactionOptions {
     locals?: {
         [ConfigName: string]: string | number;
     };
+    sqlSessionState?: SqlSessionState;
 }
 type TransactionArgs<Result> = [
     cbOrOptions: undefined | AdapterTransactionOptions | ((adapter: TransactionAdapterBase) => Promise<Result>),
@@ -366,8 +372,8 @@ interface AdapterBase {
     getHost(): string;
     getSchema(): QuerySchema | undefined;
     connect?(): Promise<unknown>;
-    query<T extends QueryResultRow = QueryResultRow>(text: string, values?: unknown[], startingSavepoint?: string, releasingSavepoint?: string): Promise<QueryResult<T>>;
-    arrays<R extends any[] = any[]>(text: string, values?: unknown[], startingSavepoint?: string, releasingSavepoint?: string): Promise<QueryArraysResult<R>>;
+    query<T extends QueryResultRow = QueryResultRow>(text: string, values?: unknown[], startingSavepoint?: string, releasingSavepoint?: string, sqlSessionState?: SqlSessionState): Promise<QueryResult<T>>;
+    arrays<R extends any[] = any[]>(text: string, values?: unknown[], startingSavepoint?: string, releasingSavepoint?: string, sqlSessionState?: SqlSessionState): Promise<QueryArraysResult<R>>;
     /**
      * Run a transaction
      *
@@ -4149,7 +4155,7 @@ declare class QueryWithSchema {
     withSchema<T>(this: T, schema: QuerySchema | undefined): T;
 }
 
-interface AsyncState {
+interface AsyncState extends SqlSessionState {
     transactionAdapter?: TransactionAdapterBase;
     transactionId?: number;
     afterCommit?: TransactionAfterCommitHook[];
@@ -4158,7 +4164,7 @@ interface AsyncState {
     catchI?: number;
     schema?: QuerySchema;
 }
-interface StorageOptions {
+interface StorageOptions extends SqlSessionState {
     log?: boolean;
     schema?: QuerySchema;
 }
@@ -5161,7 +5167,9 @@ declare abstract class ExpressionTypeMethod {
 }
 
 type IsolationLevel = 'SERIALIZABLE' | 'REPEATABLE READ' | 'READ COMMITTED' | 'READ UNCOMMITTED';
-interface TransactionOptions extends StorageOptions {
+interface TransactionOptions {
+    log?: boolean;
+    schema?: QuerySchema;
     level?: IsolationLevel;
     readOnly?: boolean;
     deferrable?: boolean;
@@ -9768,6 +9776,7 @@ interface QueryHelper<T extends PickQueryTableMetaShapeTableAs, Args extends any
     args: Args;
     result: Result;
 }
+type QueryHelperResult<T extends QueryHelper<PickQueryTableMetaShapeTableAs, any[], MergeQueryArg>> = T['result'];
 interface NarrowTypeSelf extends PickQueryResultReturnType {
     returnType: undefined | 'all' | 'one' | 'oneOrThrow' | 'value' | 'valueOrThrow' | 'pluck';
 }
@@ -10900,4 +10909,4 @@ declare const testTransaction: {
 };
 
 export { ArrayColumn, BigIntColumn, BigSerialColumn, BitColumn, BitVaryingColumn, BooleanColumn, BoxColumn, ByteaColumn, CidrColumn, CircleColumn, CitextColumn, Column, ColumnsShape, CustomTypeColumn, DateBaseColumn, DateColumn, DateTimeBaseClass, DateTimeTzBaseClass, Db, DecimalColumn, DefaultPrivileges, DomainColumn, DoublePrecisionColumn, DynamicRawSQL, EnumColumn, Expression, InetColumn, IntegerBaseColumn, IntegerColumn, IntervalColumn, JSONColumn, JSONTextColumn, LimitedTextBaseColumn, LineColumn, LsegColumn, MacAddr8Column, MacAddrColumn, MoneyColumn, NotFoundError, NumberAsStringBaseColumn, NumberBaseColumn, Operators, OrchidOrmInternalError, PathColumn, PointColumn, PolygonColumn, PostgisGeographyPointColumn, QueryError, QueryHookUtils, QueryHooks, RawSql, RealColumn, SerialColumn, SmallIntColumn, SmallSerialColumn, StringColumn$1 as StringColumn, TableData, TextBaseColumn, TextColumn, TimeColumn, TimestampColumn, TimestampTZColumn, TsQueryColumn, TsVectorColumn, UUIDColumn, UnknownColumn, VarCharColumn, VirtualColumn, XMLColumn, _appendQuery, _clone, _createDbSqlMethod, _hookSelectColumns, _initQueryBuilder, _orCreate, _prependWith, _queryCreate, _queryCreateMany, _queryCreateManyFrom, _queryDefaults, _queryDelete, _queryFindBy, _queryFindByOptional, _queryHookAfterCreate, _queryHookAfterUpdate, _queryInsert, _queryInsertMany, _queryJoinOn, _queryRows, _querySelect, _queryTake, _queryTakeOptional, _queryUpdate, _queryUpdateOrThrow, _queryUpsert, _queryWhere, _queryWhereExists, _queryWhereIn, addCode, addTopCte, addTopCteSql, applyMixins, assignDbDataToColumn, backtickQuote, cloneQueryBaseUnscoped, codeToString, colors, columnsShapeToCode, constraintInnerToCode, consumeColumnName, copyTableData, createDbWithAdapter, deepCompare, defaultSchemaConfig, emptyArray, emptyObject, escapeForMigration, escapeString, excludeInnerToCode, exhaustive, getCallerFilePath, getClonedQueryData, getColumnBaseType, getColumnInfo, getColumnTypes, getFreeAlias, getFreeSetAlias, getImportPath, getPrimaryKeys, getQueryAs, getQuerySchema, getShapeFromSelect, getSqlText, getStackTrace, getSupportedDefaultPrivileges, indexInnerToCode, isExpression, isQueryReturnsAll, isRawSQL, logColors, logParamToLogObject, makeColumnNullable, makeColumnTypes, makeColumnsByType, noop, objectHasValues, omit, parseTableData, parseTableDataInput, pathToLog, pick, pluralize, prepareSubQueryForSql, primaryKeyInnerToCode, pushQueryOnForOuter, pushQueryValueImmutable, pushTableDataCode, quoteObjectKey, quoteTableWithSchema, raw, rawSqlToCode, referencesArgsToCode, returnArg, setColumnData, setColumnEncode, setColumnParse, setColumnParseNull, setConnectRetryConfig, setCurrentColumnName, setDataValue, setDefaultLanguage, setFreeAlias, setQueryObjectValueImmutable, singleQuote, snakeCaseKey, tableDataMethods, testTransaction, toArray, toCamelCase, toPascalCase, toSnakeCase, wrapAdapterFnWithConnectRetry };
-export type { AdapterBase, AdapterConfigBase, AfterCommitStandaloneHook, AfterHook, ArrayColumnValue, ArrayData, AsyncState, BaseNumberData, Code, Codes, ColumnFromDbParams, ColumnSchemaConfig, ColumnSchemaGetterColumns, ColumnSchemaGetterTableClass, ColumnToCodeCtx, ColumnTypeSchemaArg, ColumnsByType, ComputedColumnsFromOptions, ComputedOptionsConfig, ComputedOptionsFactory, CreateCtx, CreateData, CreateManyMethodsNames, CreateMethodsNames, CreateSelf, DateColumnData, DbDomainArg, DbExtension, DbOptions, DbResult, DbSharedOptions, DbSqlMethod, DbStructureDomainsMap, DbTableOptionScopes, DbTableOptions, DecimalColumnData, DefaultColumnTypes, DefaultSchemaConfig, DeleteMethodsNames, EmptyObject, EmptyTuple, FromArg, FromResult, GeneratorIgnore, HookSelectValue, IsQuery, IsolationLevel, JoinQueryMethod, JoinedShapes, MapTableScopesOption, MaybeArray, MaybePromise, MergeQuery, NoPrimaryKeyOption, NonUniqDataItem, NumberColumnData, OperatorsArray, OperatorsJson, OperatorsOrdinalText, Ord, PickQueryInputType, PickQueryInternal, PickQueryQ, PickQueryRelations, PickQuerySelectableRelations, PickQueryShape, Query, QueryAfterHook, QueryArraysResult, QueryBeforeActionHook, QueryBeforeHook, QueryData, QueryHasWhere, QueryInternal, QueryLogObject, QueryLogOptions, QueryLogger, QueryManyTake, QueryManyTakeOptional, QueryOrExpression, QueryResult, QueryResultRow, QueryReturnType, QuerySchema, QueryScopes, RawSqlBase, RecordKeyTrue, RecordOptionalString, RecordString, RecordStringOrNumber, RecordUnknown, RelationConfigBase, RelationJoinQuery, RelationsBase, SearchWeight, SelectableFromShape, SerialColumnData, ShallowSimplify, ShapeColumnPrimaryKeys, ShapeUniqueColumns, SingleSql, SingleSqlItem, Sql, SqlFn, StorageOptions, StringData, TableDataFn, TableDataInput, TableDataItem, TableDataItemsUniqueColumnTuples, TableDataItemsUniqueColumns, TableDataItemsUniqueConstraints, TableDataMethods, TemplateLiteralArgs, Timestamps, TransactionAdapterBase, TransactionArgs, TransactionOptions, UniqueConstraints, UniqueTableDataItem, UpdateData, UpsertData, UpsertThis, WhereArg };
+export type { AdapterBase, AdapterConfigBase, AfterCommitStandaloneHook, AfterHook, ArrayColumnValue, ArrayData, AsyncState, BaseNumberData, Code, Codes, ColumnFromDbParams, ColumnSchemaConfig, ColumnSchemaGetterColumns, ColumnSchemaGetterTableClass, ColumnToCodeCtx, ColumnTypeSchemaArg, ColumnsByType, ComputedColumnsFromOptions, ComputedOptionsConfig, ComputedOptionsFactory, CreateCtx, CreateData, CreateManyMethodsNames, CreateMethodsNames, CreateSelf, DateColumnData, DbDomainArg, DbExtension, DbOptions, DbResult, DbSharedOptions, DbSqlMethod, DbStructureDomainsMap, DbTableOptionScopes, DbTableOptions, DecimalColumnData, DefaultColumnTypes, DefaultSchemaConfig, DeleteMethodsNames, EmptyObject, EmptyTuple, FromArg, FromResult, GeneratorIgnore, HookSelectValue, IsQuery, IsolationLevel, JoinQueryMethod, JoinedShapes, MapTableScopesOption, MaybeArray, MaybePromise, MergeQuery, NoPrimaryKeyOption, NonUniqDataItem, NumberColumnData, OperatorsArray, OperatorsJson, OperatorsOrdinalText, Ord, PickQueryInputType, PickQueryInternal, PickQueryQ, PickQueryRelations, PickQuerySelectableRelations, PickQueryShape, Query, QueryAfterHook, QueryArraysResult, QueryBeforeActionHook, QueryBeforeHook, QueryData, QueryHasWhere, QueryHelperResult, QueryInternal, QueryLogObject, QueryLogOptions, QueryLogger, QueryManyTake, QueryManyTakeOptional, QueryOrExpression, QueryResult, QueryResultRow, QueryReturnType, QuerySchema, QueryScopes, RawSqlBase, RecordKeyTrue, RecordOptionalString, RecordString, RecordStringOrNumber, RecordUnknown, RelationConfigBase, RelationJoinQuery, RelationsBase, SearchWeight, SelectableFromShape, SerialColumnData, ShallowSimplify, ShapeColumnPrimaryKeys, ShapeUniqueColumns, SingleSql, SingleSqlItem, Sql, SqlFn, SqlSessionState, StorageOptions, StringData, TableDataFn, TableDataInput, TableDataItem, TableDataItemsUniqueColumnTuples, TableDataItemsUniqueColumns, TableDataItemsUniqueConstraints, TableDataMethods, TemplateLiteralArgs, Timestamps, TransactionAdapterBase, TransactionArgs, TransactionOptions, UniqueConstraints, UniqueTableDataItem, UpdateData, UpsertData, UpsertThis, WhereArg };

package/dist/index.js

@@ -3975,6 +3975,14 @@ class UnhandledTypeError extends OrchidOrmInternalError {
     super(query, `Unhandled type: ${JSON.stringify(value)} received`);
   }
 }
+class NestedSqlSessionError extends OrchidOrmInternalError {
+  constructor(query) {
+    super(
+      query,
+      "Cannot nest SQL session scopes. Outer scope already has role or setConfig defined."
+    );
+  }
+}
 
 const escape = (value, migration, nested) => {
   const type = typeof value;
@@ -4071,15 +4079,53 @@ class QueryLog {
   }
 }
 
-const processStorageOptions = (query, options) => {
+const hasSqlSessionContextOptions = (options) => {
+  return options.role !== void 0 || options.setConfig !== void 0;
+};
+const hasActiveSqlSessionContext = (state) => {
+  if (!state) return false;
+  return state.role !== void 0 || state.setConfig !== void 0;
+};
+const sqlSessionContextNormalizeSetConfig = (setConfig) => {
+  return Object.fromEntries(
+    Object.entries(setConfig).map(([key, value]) => [key, String(value)])
+  );
+};
+const sqlSessionContextSetStorageOptions = (query, state, options, result) => {
+  if (hasSqlSessionContextOptions(options) && hasActiveSqlSessionContext(state)) {
+    throw new NestedSqlSessionError(query);
+  }
+  if (options.role !== void 0) {
+    result.role = options.role;
+  }
+  if (options.setConfig) {
+    result.setConfig = sqlSessionContextNormalizeSetConfig(options.setConfig);
+  }
+};
+const sqlSessionContextMergeStorageState = (state, options) => {
+  if (!options) return state;
+  return {
+    role: options.role ?? state?.role,
+    setConfig: options.setConfig ?? state?.setConfig
+  };
+};
+const sqlSessionContextGetStateFromAsyncState = (state) => {
+  return state?.role || state?.setConfig ? state : void 0;
+};
+
+const processStorageOptions = (query, state, options) => {
   let log;
   if (options.log !== void 0 && !query.q.log) {
     log = logParamToLogObject(query.q.logger, options.log);
   }
-  return log || "schema" in options ? {
-    log,
-    schema: options.schema
-  } : void 0;
+  const result = {};
+  if (log) result.log = log;
+  if ("schema" in options) result.schema = options.schema;
+  sqlSessionContextSetStorageOptions(query, state, options, result);
+  if (result.log === void 0 && result.schema === void 0 && result.role === void 0 && result.setConfig === void 0) {
+    return void 0;
+  }
+  return result;
 };
 let currentDefaultSchema;
 const setCurrentDefaultSchema = (schema) => {
@@ -4089,14 +4135,15 @@ const getQuerySchema$1 = (query) => query.q.schema || currentDefaultSchema;
 class QueryStorage {
   async withOptions(options, cb) {
     const state = this.internal.asyncStorage.getStore();
-    const opts = processStorageOptions(this, options);
-    return this.internal.asyncStorage.run(
-      {
-        ...state,
-        ...opts
-      },
-      cb
-    );
+    const opts = processStorageOptions(this, state, options);
+    const sqlSessionState = sqlSessionContextMergeStorageState(state, opts);
+    const newState = opts ? {
+      ...state,
+      log: opts.log ?? state?.log,
+      schema: opts.schema ?? state?.schema,
+      ...sqlSessionState
+    } : void 0;
+    return !opts ? state ? this.internal.asyncStorage.run(state, cb) : cb() : this.internal.asyncStorage.run(newState, cb);
   }
 }
 
@@ -4146,7 +4193,7 @@ class QueryTransaction {
     const sql = {
       values: emptyArray
     };
-    const opts = processStorageOptions(this, options);
+    const opts = processStorageOptions(this, void 0, options);
     const log = opts?.log || this.q.log;
     let logData;
     let state = this.internal.asyncStorage.getStore();
@@ -4948,7 +4995,8 @@ const then = async (q, adapter, state, beforeHooks, afterHooks, afterSaveHooks,
         method,
         sql,
         startingSavepoint,
-        releasingSavepoint
+        releasingSavepoint,
+        sqlSessionContextGetStateFromAsyncState(state)
       );
       const { runAfterQuery } = sql;
       if (log) {
@@ -4994,7 +5042,8 @@ const then = async (q, adapter, state, beforeHooks, afterHooks, afterSaveHooks,
             queryMethod,
             sql,
             i === 0 ? startingSavepoint : void 0,
-            i === last ? releasingSavepoint : void 0
+            i === last ? releasingSavepoint : void 0,
+            sqlSessionContextGetStateFromAsyncState(state)
           );
           if (queryResult) {
             queryResult.rowCount += result2.rowCount;
@@ -5286,12 +5335,13 @@ const then = async (q, adapter, state, beforeHooks, afterHooks, afterSaveHooks,
 const setCatchingSavepoint = (catchTrx) => {
   return catchTrx ? `s${catchTrx.catchI = (catchTrx.catchI || 0) + 1}` : void 0;
 };
-const execQuery = (adapter, method, sql, startingSavepoint, releasingSavepoint) => {
+const execQuery = (adapter, method, sql, startingSavepoint, releasingSavepoint, sqlSessionState) => {
   return adapter[method](
     sql.text,
     sql.values,
     startingSavepoint,
-    releasingSavepoint
+    releasingSavepoint,
+    sqlSessionState
   ).then((result) => {
     if (result.rowCount && !result.rows.length) {
       result.rows.length = result.rowCount;
@@ -15801,7 +15851,14 @@ const performQuery = async (q, args, method) => {
   let logData;
   if (log) logData = log.beforeQuery(sql);
   try {
-    const result = await (trx?.transactionAdapter || q.adapterNotInTransaction)[method](sql.text, sql.values);
+    const adapter = trx?.transactionAdapter || q.adapterNotInTransaction;
+    const result = await adapter[method](
+      sql.text,
+      sql.values,
+      void 0,
+      void 0,
+      sqlSessionContextGetStateFromAsyncState(trx)
+    );
     if (log) log.afterQuery(sql, logData);
     return result;
   } catch (err) {