@naturalcycles/db-lib 8.39.0 → 8.40.0

package/dist/commondao/common.dao.js

@@ -28,6 +28,7 @@ class CommonDao {
             logLevel: isGAE || isCI ? common_dao_model_1.CommonDaoLogLevel.NONE : common_dao_model_1.CommonDaoLogLevel.OPERATIONS,
             idType: 'string',
             createId: true,
+            assignGeneratedIds: false,
             created: true,
             updated: true,
             logger: console,
@@ -450,7 +451,7 @@ class CommonDao {
      */
     async save(bm, opt = {}) {
         this.requireWriteAccess();
-        const idWasGenerated = !bm.id;
+        const idWasGenerated = !bm.id && this.cfg.createId;
         this.assignIdCreatedUpdated(bm, opt); // mutates
         const dbm = await this.bmToDBM(bm, opt);
         const table = opt.table || this.cfg.table;
@@ -463,6 +464,7 @@ class CommonDao {
         const started = this.logSaveStarted(op, bm, table);
         await this.cfg.db.saveBatch(table, [dbm], {
             excludeFromIndexes: this.cfg.excludeFromIndexes,
+            assignGeneratedIds: this.cfg.assignGeneratedIds,
             ...opt,
         });
         this.logSaveResult(started, op, table);
@@ -496,7 +498,7 @@ class CommonDao {
         // assigning id in case it misses the id
         // will override/set `updated` field, unless opts.preserveUpdated is set
         if (!opt.raw) {
-            const idWasGenerated = !dbm.id;
+            const idWasGenerated = !dbm.id && this.cfg.createId;
             this.assignIdCreatedUpdated(dbm, opt); // mutates
             dbm = this.anyToDBM(dbm, opt);
             if (opt.ensureUniqueId && idWasGenerated)
@@ -509,6 +511,7 @@ class CommonDao {
         const started = this.logSaveStarted(op, dbm, table);
         await this.cfg.db.saveBatch(table, [dbm], {
             excludeFromIndexes: this.cfg.excludeFromIndexes,
+            assignGeneratedIds: this.cfg.assignGeneratedIds,
             ...opt,
         });
         this.logSaveResult(started, op, table);
@@ -531,6 +534,7 @@ class CommonDao {
         const started = this.logSaveStarted(op, bms, table);
         await this.cfg.db.saveBatch(table, dbms, {
             excludeFromIndexes: this.cfg.excludeFromIndexes,
+            assignGeneratedIds: this.cfg.assignGeneratedIds,
             ...opt,
         });
         this.logSaveResult(started, op, table);
@@ -555,6 +559,7 @@ class CommonDao {
         const started = this.logSaveStarted(op, dbms, table);
         await this.cfg.db.saveBatch(table, dbms, {
             excludeFromIndexes: this.cfg.excludeFromIndexes,
+            assignGeneratedIds: this.cfg.assignGeneratedIds,
             ...opt,
         });
         this.logSaveResult(started, op, table);

package/dist/commondao/common.dao.model.d.ts

@@ -86,6 +86,11 @@ export interface CommonDaoCfg<BM extends Partial<ObjectWithId<ID>>, DBM extends
      * Useful e.g when your DB is generating ids by itself (e.g mysql auto_increment).
      */
     createId?: boolean;
+    /**
+     * See the same option in CommonDB.
+     * Defaults to false normally.
+     */
+    assignGeneratedIds?: boolean;
     /**
      * Defaults to true
      * Set to false to disable `created` field management.

package/dist/db.model.d.ts

@@ -19,6 +19,13 @@ export interface CommonDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObje
      * Default is `upsert`
      */
     saveMethod?: CommonDBSaveMethod;
+    /**
+     * Only applicable to tables where id is "auto-generated by DB", e.g `auto_increment` in MySQL.
+     * By default it's false, so, auto-generated id will NOT be assigned/returned.
+     * Setting it to true will assign and return auto-generated id (on all rows, one by one).
+     * It's not true by default, because getting auto-generated id incurs an overhead of doing extra call (e.g LAST_INSERT_ID() in MySQL).
+     */
+    assignGeneratedIds?: boolean;
 }
 export declare type CommonDBStreamOptions = CommonDBOptions;
 export interface CommonDBCreateOptions extends CommonDBOptions {

package/package.json

@@ -42,7 +42,7 @@
   "engines": {
     "node": ">=14.15"
   },
-  "version": "8.39.0",
+  "version": "8.40.0",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

package/src/commondao/common.dao.model.ts

@@ -119,6 +119,12 @@ export interface CommonDaoCfg<
    */
   createId?: boolean
 
+  /**
+   * See the same option in CommonDB.
+   * Defaults to false normally.
+   */
+  assignGeneratedIds?: boolean
+
   /**
    * Defaults to true
    * Set to false to disable `created` field management.

package/src/commondao/common.dao.ts

@@ -73,6 +73,7 @@ export class CommonDao<
       logLevel: isGAE || isCI ? CommonDaoLogLevel.NONE : CommonDaoLogLevel.OPERATIONS,
       idType: 'string',
       createId: true,
+      assignGeneratedIds: false,
       created: true,
       updated: true,
       logger: console,
@@ -609,7 +610,7 @@ export class CommonDao<
    */
   async save(bm: Unsaved<BM>, opt: CommonDaoSaveOptions<DBM> = {}): Promise<Saved<BM>> {
     this.requireWriteAccess()
-    const idWasGenerated = !bm.id
+    const idWasGenerated = !bm.id && this.cfg.createId
     this.assignIdCreatedUpdated(bm, opt) // mutates
     const dbm = await this.bmToDBM(bm as BM, opt)
     const table = opt.table || this.cfg.table
@@ -621,6 +622,7 @@ export class CommonDao<
     const started = this.logSaveStarted(op, bm, table)
     await this.cfg.db.saveBatch(table, [dbm], {
       excludeFromIndexes: this.cfg.excludeFromIndexes,
+      assignGeneratedIds: this.cfg.assignGeneratedIds,
       ...opt,
     })
 
@@ -667,7 +669,7 @@ export class CommonDao<
     // assigning id in case it misses the id
     // will override/set `updated` field, unless opts.preserveUpdated is set
     if (!opt.raw) {
-      const idWasGenerated = !dbm.id
+      const idWasGenerated = !dbm.id && this.cfg.createId
       this.assignIdCreatedUpdated(dbm, opt) // mutates
       dbm = this.anyToDBM(dbm, opt)
       if (opt.ensureUniqueId && idWasGenerated) await this.ensureUniqueId(table, dbm)
@@ -679,6 +681,7 @@ export class CommonDao<
     const started = this.logSaveStarted(op, dbm, table)
     await this.cfg.db.saveBatch(table, [dbm], {
       excludeFromIndexes: this.cfg.excludeFromIndexes,
+      assignGeneratedIds: this.cfg.assignGeneratedIds,
       ...opt,
     })
     this.logSaveResult(started, op, table)
@@ -706,6 +709,7 @@ export class CommonDao<
 
     await this.cfg.db.saveBatch(table, dbms, {
       excludeFromIndexes: this.cfg.excludeFromIndexes,
+      assignGeneratedIds: this.cfg.assignGeneratedIds,
       ...opt,
     })
 
@@ -736,6 +740,7 @@ export class CommonDao<
 
     await this.cfg.db.saveBatch(table, dbms, {
       excludeFromIndexes: this.cfg.excludeFromIndexes,
+      assignGeneratedIds: this.cfg.assignGeneratedIds,
       ...opt,
     })
 

package/src/db.model.ts

@@ -24,6 +24,14 @@ export interface CommonDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObje
    * Default is `upsert`
    */
   saveMethod?: CommonDBSaveMethod
+
+  /**
+   * Only applicable to tables where id is "auto-generated by DB", e.g `auto_increment` in MySQL.
+   * By default it's false, so, auto-generated id will NOT be assigned/returned.
+   * Setting it to true will assign and return auto-generated id (on all rows, one by one).
+   * It's not true by default, because getting auto-generated id incurs an overhead of doing extra call (e.g LAST_INSERT_ID() in MySQL).
+   */
+  assignGeneratedIds?: boolean
 }
 
 export type CommonDBStreamOptions = CommonDBOptions