orchid-orm 1.62.5 → 1.63.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Column, TableData, ColumnsShape, Query, SelectableFromShape, CreateManyMethodsNames, QueryHasWhere, RelationConfigBase, QueryManyTake, QueryManyTakeOptional, EmptyObject, CreateData, UpdateData, WhereArg, CreateMethodsNames, MaybeArray, JoinQueryMethod, DeleteMethodsNames, Db, IsolationLevel, TransactionOptions, AfterCommitStandaloneHook, AdapterBase, FromArg, FromResult, DbSharedOptions, QuerySchema, ShapeColumnPrimaryKeys, ShapeUniqueColumns, TableDataItemsUniqueColumns, TableDataItemsUniqueColumnTuples, UniqueConstraints, TableDataItemsUniqueConstraints, ComputedColumnsFromOptions, MapTableScopesOption, TableDataItem, ComputedOptionsFactory, RecordUnknown, ShallowSimplify, ComputedOptionsConfig, QueryOrExpression, QueryData, IsQuery, TableDataFn, DbTableOptionScopes, QueryScopes, ColumnSchemaConfig, DbSqlMethod, DefaultSchemaConfig, DefaultColumnTypes, QueryBeforeHook, QueryBeforeActionHook, QueryAfterHook, AfterHook, MergeQuery, QueryReturnType } from 'pqb';
+import { Column, TableData, ColumnsShape, Query, SelectableFromShape, CreateManyMethodsNames, QueryHasWhere, RelationConfigBase, QueryManyTake, QueryManyTakeOptional, EmptyObject, CreateData, UpdateData, WhereArg, CreateMethodsNames, MaybeArray, JoinQueryMethod, DeleteMethodsNames, Db, IsolationLevel, TransactionOptions, AfterCommitStandaloneHook, AdapterBase, FromArg, FromResult, StorageOptions, DbSharedOptions, QuerySchema, ShapeColumnPrimaryKeys, ShapeUniqueColumns, TableDataItemsUniqueColumns, TableDataItemsUniqueColumnTuples, UniqueConstraints, TableDataItemsUniqueConstraints, ComputedColumnsFromOptions, MapTableScopesOption, TableDataItem, ComputedOptionsFactory, RecordUnknown, ShallowSimplify, ComputedOptionsConfig, QueryOrExpression, QueryData, IsQuery, TableDataFn, DbTableOptionScopes, QueryScopes, ColumnSchemaConfig, DbSqlMethod, DefaultSchemaConfig, DefaultColumnTypes, QueryBeforeHook, QueryBeforeActionHook, QueryAfterHook, AfterHook, MergeQuery, QueryReturnType } from 'pqb';
 export * from 'pqb';
 
 interface RelationRefsOptions<Column extends PropertyKey = string, Shape extends Column.Shape.QueryInit = Column.Shape.QueryInit> {
@@ -211,23 +211,32 @@ type OrchidORM<T extends TableClasses = TableClasses> = {
 } & OrchidORMMethods;
 interface OrchidORMMethods {
     /**
-     * @see import('pqb').Transaction.prototype.transaction
+     * @see import('pqb').QueryTransaction.prototype.transaction
      */
     $transaction: typeof transaction;
     /**
-     * @see import('pqb').Transaction.prototype.ensureTransaction
+     * @see import('pqb').QueryTransaction.prototype.ensureTransaction
      */
     $ensureTransaction: typeof ensureTransaction;
     /**
-     * @see import('pqb').Transaction.prototype.isInTransaction
+     * @see import('pqb').QueryTransaction.prototype.isInTransaction
      */
     $isInTransaction: typeof isInTransaction;
     /**
-     * @see import('pqb').Transaction.prototype.afterCommit
+     * @see import('pqb').QueryTransaction.prototype.afterCommit
      */
     $afterCommit: typeof afterCommit;
-    $adapter: AdapterBase;
     $qb: Db;
+    $adapterNotInTransaction: AdapterBase;
+    /**
+     * Adapter is a wrapper on top of `postgres-js`, `node-postgres`, or other db driver.
+     *
+     * When in transaction, returns a db adapter object for the transaction,
+     * returns a default adapter object otherwise.
+     *
+     * Treat the adapter as implementation detail and avoid accessing it directly.
+     */
+    $getAdapter(): AdapterBase;
     /**
      * Use `$query` to perform raw SQL queries.
      *
@@ -289,6 +298,22 @@ interface OrchidORMMethods {
      * See {@link FromMethods.from}
      */
     $from<Arg extends MaybeArray<FromArg<Query>>>(arg: Arg): FromResult<FromQuery, Arg>;
+    /**
+     * `$withOptions` supports overriding `log` and `schema`.
+     *
+     * - `log`: boolean, enables or disables logging in the scope of the callback.
+     * - `schema`: set a **default** schema, note that it does not override
+     *   if you already have a schema set in the ORM config or for a specific table.
+     *
+     * ```ts
+     * await db.$withOptions({ log: true, schema: 'custom' }, async () => {
+     *   // will log this query, and will use the custom schema for this table,
+     *   // unless this table already has a configured schema.
+     *   await db.table.find(123);
+     * });
+     * ```
+     */
+    $withOptions<Result>(options: StorageOptions, cb: () => Promise<Result>): Promise<Result>;
     $close(): Promise<void>;
 }
 type OrchidOrmParam<Options> = true | null extends true ? 'Set strict: true to tsconfig' : Options;

package/dist/index.js

@@ -2258,19 +2258,19 @@ const orchidORMWithAdapter = ({
     noPrimaryKey
   };
   let adapter;
-  let transactionStorage;
+  let asyncStorage;
   let qb;
   if ("db" in options) {
     adapter = options.db.q.adapter;
-    transactionStorage = options.db.internal.transactionStorage;
+    asyncStorage = options.db.internal.asyncStorage;
     qb = options.db.qb;
   } else {
     adapter = options.adapter;
-    transactionStorage = new node_async_hooks.AsyncLocalStorage();
+    asyncStorage = new node_async_hooks.AsyncLocalStorage();
     qb = pqb._initQueryBuilder(
       adapter,
       pqb.makeColumnTypes(pqb.defaultSchemaConfig),
-      transactionStorage,
+      asyncStorage,
       commonOptions,
       options
     );
@@ -2280,7 +2280,8 @@ const orchidORMWithAdapter = ({
     $ensureTransaction: ensureTransaction,
     $isInTransaction: isInTransaction,
     $afterCommit: afterCommit,
-    $adapter: adapter,
+    $adapterNotInTransaction: adapter,
+    $getAdapter,
     $qb: qb,
     get $query() {
       return qb.query;
@@ -2290,7 +2291,8 @@ const orchidORMWithAdapter = ({
     $withRecursive: qb.withRecursive.bind(qb),
     $withSql: qb.withSql.bind(qb),
     $from: qb.from.bind(qb),
-    $close: adapter.close.bind(adapter)
+    $close: adapter.close.bind(adapter),
+    $withOptions: qb.withOptions.bind(qb)
   };
   const tableInstances = {};
   for (const key in tables) {
@@ -2319,7 +2321,7 @@ const orchidORMWithAdapter = ({
       table.table,
       table.columns.shape,
       table.types,
-      transactionStorage,
+      asyncStorage,
       options2,
       table.constructor.prototype.columns?.data ?? {}
     );
@@ -2337,10 +2339,11 @@ const orchidORMWithAdapter = ({
       Object.assign(result[key].baseQuery.q, table.q);
     }
   }
-  const db = result;
-  db.$adapter;
   return result;
 };
+function $getAdapter() {
+  return this.$qb.$getAdapter();
+}
 
 const createRepo = (table, methods) => {
   const queryMethods = {