@naturalcycles/datastore-lib 3.31.1 → 3.32.0

package/dist/datastore.db.d.ts

@@ -1,6 +1,6 @@
 import { Transaction } from '@google-cloud/datastore';
 import type { Datastore, Key, Query } from '@google-cloud/datastore';
-import { BaseCommonDB, CommonDB, CommonDBOptions, CommonDBSaveOptions, CommonDBSupport, DBQuery, DBTransaction, DBTransactionFn, RunQueryResult } from '@naturalcycles/db-lib';
+import { BaseCommonDB, CommonDB, CommonDBOptions, CommonDBSaveOptions, CommonDBSupport, DBQuery, DBTransaction, DBTransactionFn, RunQueryResult, CommonDBTransactionOptions } from '@naturalcycles/db-lib';
 import { ObjectWithId, JsonSchemaObject, JsonSchemaRootObject, CommonLogger } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { DatastoreDBCfg, DatastoreDBOptions, DatastoreDBSaveOptions, DatastoreDBStreamOptions, DatastorePayload, DatastorePropertyStats, DatastoreStats } from './datastore.model';
@@ -38,7 +38,7 @@ export declare class DatastoreDB extends BaseCommonDB implements CommonDB {
      * regardless if they were actually deleted or not.
      */
     deleteByIds(table: string, ids: string[], opt?: DatastoreDBOptions): Promise<number>;
-    runInTransaction(fn: DBTransactionFn): Promise<void>;
+    runInTransaction(fn: DBTransactionFn, opt?: CommonDBTransactionOptions): Promise<void>;
     getAllStats(): Promise<DatastoreStats[]>;
     /**
      * Returns undefined e.g when Table is non-existing
@@ -64,8 +64,7 @@ export declare class DatastoreDB extends BaseCommonDB implements CommonDB {
 export declare class DatastoreDBTransaction implements DBTransaction {
     db: DatastoreDB;
     tx: Transaction;
-    private constructor();
-    static create(db: DatastoreDB): Promise<DatastoreDBTransaction>;
+    constructor(db: DatastoreDB, tx: Transaction);
     rollback(): Promise<void>;
     getByIds<ROW extends ObjectWithId>(table: string, ids: string[], opt?: CommonDBOptions | undefined): Promise<ROW[]>;
     saveBatch<ROW extends Partial<ObjectWithId>>(table: string, rows: ROW[], opt?: CommonDBSaveOptions<ROW> | undefined): Promise<void>;

package/dist/datastore.db.js

@@ -214,14 +214,19 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
         async (batch) => await (opt.tx?.tx || this.ds()).delete(batch));
         return ids.length;
     }
-    async runInTransaction(fn) {
-        const tx = await DatastoreDBTransaction.create(this);
+    async runInTransaction(fn, opt = {}) {
+        const { readOnly } = opt;
+        const datastoreTx = this.ds().transaction({
+            readOnly,
+        });
         try {
+            await datastoreTx.run();
+            const tx = new DatastoreDBTransaction(this, datastoreTx);
             await fn(tx);
-            await tx.tx.commit();
+            await datastoreTx.commit();
         }
         catch (err) {
-            await tx.tx.rollback();
+            await datastoreTx.rollback();
             throw err;
         }
     }
@@ -387,11 +392,6 @@ class DatastoreDBTransaction {
         this.db = db;
         this.tx = tx;
     }
-    static async create(db) {
-        const tx = db.ds().transaction();
-        await tx.run();
-        return new DatastoreDBTransaction(db, tx);
-    }
     async rollback() {
         await this.tx.rollback();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/datastore-lib",
-  "version": "3.31.1",
+  "version": "3.32.0",
   "description": "Opinionated library to work with Google Datastore",
   "scripts": {
     "prepare": "husky install"

package/src/datastore.db.ts

@@ -13,6 +13,7 @@ import {
   DBTransaction,
   DBTransactionFn,
   RunQueryResult,
+  CommonDBTransactionOptions,
 } from '@naturalcycles/db-lib'
 import {
   ObjectWithId,
@@ -361,14 +362,22 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
     return ids.length
   }
 
-  override async runInTransaction(fn: DBTransactionFn): Promise<void> {
-    const tx = await DatastoreDBTransaction.create(this)
+  override async runInTransaction(
+    fn: DBTransactionFn,
+    opt: CommonDBTransactionOptions = {},
+  ): Promise<void> {
+    const { readOnly } = opt
+    const datastoreTx = this.ds().transaction({
+      readOnly,
+    })
 
     try {
+      await datastoreTx.run()
+      const tx = new DatastoreDBTransaction(this, datastoreTx)
       await fn(tx)
-      await tx.tx.commit()
+      await datastoreTx.commit()
     } catch (err) {
-      await tx.tx.rollback()
+      await datastoreTx.rollback()
       throw err
     }
   }
@@ -549,17 +558,11 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
  * https://cloud.google.com/datastore/docs/concepts/transactions#datastore-datastore-transactional-update-nodejs
  */
 export class DatastoreDBTransaction implements DBTransaction {
-  private constructor(
+  constructor(
     public db: DatastoreDB,
     public tx: Transaction,
   ) {}
 
-  static async create(db: DatastoreDB): Promise<DatastoreDBTransaction> {
-    const tx = db.ds().transaction()
-    await tx.run()
-    return new DatastoreDBTransaction(db, tx)
-  }
-
   async rollback(): Promise<void> {
     await this.tx.rollback()
   }