@naturalcycles/mysql-lib 3.11.0 → 3.12.0

package/dist/mysql.db.d.ts

@@ -4,7 +4,7 @@ import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { Connection, Pool, PoolConfig, PoolConnection, QueryOptions } from 'mysql';
 export interface MysqlDBOptions extends CommonDBOptions {
 }
-export interface MysqlDBSaveOptions<ROW extends ObjectWithId = AnyObjectWithId> extends CommonDBSaveOptions<ROW> {
+export interface MysqlDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId> extends CommonDBSaveOptions<ROW> {
 }
 /**
  * @default false / undefined
@@ -40,7 +40,7 @@ export declare class MysqlDB extends BaseCommonDB implements CommonDB {
      * Be careful to manage this connection yourself (open, release, etc).
      */
     createSingleConnection(): Promise<Connection>;
-    getByIds<ROW extends ObjectWithId>(table: string, ids: string[], opt?: MysqlDBOptions): Promise<ROW[]>;
+    getByIds<ROW extends ObjectWithId>(table: string, ids: ROW['id'][], opt?: MysqlDBOptions): Promise<ROW[]>;
     runQuery<ROW extends ObjectWithId, OUT = ROW>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): Promise<RunQueryResult<OUT>>;
     runSQL<RESULT>(q: QueryOptions): Promise<RESULT>;
     /**
@@ -50,11 +50,11 @@ export declare class MysqlDB extends BaseCommonDB implements CommonDB {
     runSQLString(s: string): Promise<void>;
     runQueryCount<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
     streamQuery<ROW extends ObjectWithId, OUT = ROW>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): ReadableTyped<OUT>;
-    saveBatch<ROW extends ObjectWithId>(table: string, _rows: ROW[], _opt?: MysqlDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends Partial<ObjectWithId>>(table: string, rowsInput: ROW[], opt?: MysqlDBSaveOptions<ROW>): Promise<void>;
     /**
      * Limitation: always returns [], regardless of which rows are actually deleted
      */
-    deleteByIds(table: string, ids: string[], _opt?: MysqlDBOptions): Promise<number>;
+    deleteByIds<ROW extends ObjectWithId>(table: string, ids: ROW['id'][], _opt?: MysqlDBOptions): Promise<number>;
     deleteByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
     /**
      * Use with caution!

package/dist/mysql.db.js

@@ -171,15 +171,28 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         }));
     }
     // SAVE
-    async saveBatch(table, _rows, _opt) {
-        if (!_rows.length)
+    async saveBatch(table, rowsInput, opt = {}) {
+        if (!rowsInput.length)
             return;
         // Stringify object values
-        const rows = _rows.map(row => (0, js_lib_1._mapValues)(row, (_k, v) => {
+        const rows = rowsInput.map(row => (0, js_lib_1._mapValues)(row, (_k, v) => {
             return v && typeof v === 'object' && !Buffer.isBuffer(v) ? JSON.stringify(v) : v;
         }));
+        const verb = opt.saveMethod === 'insert' ? 'INSERT' : 'REPLACE';
+        if (opt.assignGeneratedIds) {
+            // Insert rows one-by-one, to get their auto-generated id
+            let i = -1;
+            for await (const row of rows) {
+                i++;
+                const sql = (0, query_util_1.insertSQL)(table, [row], verb, this.cfg.logger)[0];
+                const { insertId } = await this.runSQL({ sql });
+                // Mutate the input row with insertIt
+                rowsInput[i].id = insertId;
+            }
+            return;
+        }
         // inserts are split into multiple sentenses to respect the max_packet_size (1Mb usually)
-        const sqls = (0, query_util_1.insertSQL)(table, rows, 'REPLACE', this.cfg.logger);
+        const sqls = (0, query_util_1.insertSQL)(table, rows, verb, this.cfg.logger);
         for await (const sql of sqls) {
             await this.runSQL({ sql });
         }
@@ -227,7 +240,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         return (0, mysql_schema_util_1.mysqlTableStatsToJsonSchemaField)(table, stats, this.cfg.logger);
     }
 }
-(0, tslib_1.__decorate)([
+tslib_1.__decorate([
     (0, js_lib_1._Memo)()
 ], MysqlDB.prototype, "pool", null);
 exports.MysqlDB = MysqlDB;

package/package.json

@@ -13,8 +13,8 @@
   "devDependencies": {
     "@naturalcycles/dev-lib": "^12.7.5",
     "@types/node": "^17.0.5",
-    "dotenv": "^14.1.0",
-    "jest": "^27.2.4"
+    "dotenv": "^16.0.0",
+    "jest": "^28.1.0"
   },
   "files": [
     "dist",
@@ -36,7 +36,7 @@
   "engines": {
     "node": ">=14.15.0"
   },
-  "version": "3.11.0",
+  "version": "3.12.0",
   "description": "MySQL client implementing CommonDB interface",
   "keywords": [
     "mysql",

package/src/mysql.db.ts

@@ -23,7 +23,15 @@ import {
 } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { white } from '@naturalcycles/nodejs-lib/dist/colors'
-import { Connection, Pool, PoolConfig, PoolConnection, QueryOptions, TypeCast } from 'mysql'
+import {
+  Connection,
+  OkPacket,
+  Pool,
+  PoolConfig,
+  PoolConnection,
+  QueryOptions,
+  TypeCast,
+} from 'mysql'
 import * as mysql from 'mysql'
 import { dbQueryToSQLDelete, dbQueryToSQLSelect, insertSQL } from './query.util'
 import {
@@ -34,7 +42,7 @@ import {
 } from './schema/mysql.schema.util'
 
 export interface MysqlDBOptions extends CommonDBOptions {}
-export interface MysqlDBSaveOptions<ROW extends ObjectWithId = AnyObjectWithId>
+export interface MysqlDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId>
   extends CommonDBSaveOptions<ROW> {}
 
 /**
@@ -176,7 +184,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   // GET
   override async getByIds<ROW extends ObjectWithId>(
     table: string,
-    ids: string[],
+    ids: ROW['id'][],
     opt: MysqlDBOptions = {},
   ): Promise<ROW[]> {
     if (!ids.length) return []
@@ -264,22 +272,40 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   }
 
   // SAVE
-  override async saveBatch<ROW extends ObjectWithId>(
+  override async saveBatch<ROW extends Partial<ObjectWithId>>(
     table: string,
-    _rows: ROW[],
-    _opt?: MysqlDBSaveOptions<ROW>,
+    rowsInput: ROW[],
+    opt: MysqlDBSaveOptions<ROW> = {},
   ): Promise<void> {
-    if (!_rows.length) return
+    if (!rowsInput.length) return
 
     // Stringify object values
-    const rows = _rows.map(row =>
+    const rows = rowsInput.map(row =>
       _mapValues(row, (_k, v) => {
         return v && typeof v === 'object' && !Buffer.isBuffer(v) ? JSON.stringify(v) : v
       }),
     )
 
+    const verb = opt.saveMethod === 'insert' ? 'INSERT' : 'REPLACE'
+
+    if (opt.assignGeneratedIds) {
+      // Insert rows one-by-one, to get their auto-generated id
+
+      let i = -1
+      for await (const row of rows) {
+        i++
+        const sql = insertSQL(table, [row], verb, this.cfg.logger)[0]!
+        const { insertId } = await this.runSQL<OkPacket>({ sql })
+
+        // Mutate the input row with insertIt
+        rowsInput[i]!.id = insertId
+      }
+
+      return
+    }
+
     // inserts are split into multiple sentenses to respect the max_packet_size (1Mb usually)
-    const sqls = insertSQL(table, rows, 'REPLACE', this.cfg.logger)
+    const sqls = insertSQL(table, rows, verb, this.cfg.logger)
 
     for await (const sql of sqls) {
       await this.runSQL({ sql })
@@ -290,7 +316,11 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   /**
    * Limitation: always returns [], regardless of which rows are actually deleted
    */
-  override async deleteByIds(table: string, ids: string[], _opt?: MysqlDBOptions): Promise<number> {
+  override async deleteByIds<ROW extends ObjectWithId>(
+    table: string,
+    ids: ROW['id'][],
+    _opt?: MysqlDBOptions,
+  ): Promise<number> {
     if (!ids.length) return 0
     const sql = dbQueryToSQLDelete(new DBQuery(table).filterEq('id', ids))
     const res = await this.runSQL<any>({ sql })