@naturalcycles/mysql-lib 3.12.3 → 3.13.0

package/dist/mysql.db.d.ts

@@ -1,3 +1,4 @@
+import { DBPatch } from '@naturalcycles/db-lib';
 import { BaseCommonDB, CommonDB, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, DBQuery, RunQueryResult } from '@naturalcycles/db-lib';
 import { AnyObjectWithId, CommonLogger, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
@@ -66,4 +67,5 @@ export declare class MysqlDB extends BaseCommonDB implements CommonDB {
     createTable<ROW extends ObjectWithId>(table: string, schema: JsonSchemaObject<ROW>, opt?: CommonDBCreateOptions): Promise<void>;
     getTables(): Promise<string[]>;
     getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
+    updateByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, patch: DBPatch<ROW>): Promise<number>;
 }

package/dist/mysql.db.js

@@ -74,7 +74,6 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
     }
     async close() {
         const pool = this.pool();
-        // eslint-disable-next-line @typescript-eslint/await-thenable
         await (0, node_util_1.promisify)(pool.end.bind(pool))();
         this.cfg.logger.log('closed');
     }
@@ -184,10 +183,15 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
             return;
         // Stringify object values
         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;
+            if (v && typeof v === 'object' && !Buffer.isBuffer(v)) {
+                // This is to avoid implicit Date stringification and mismatch: it gets saved as Date, but loaded as String
+                (0, js_lib_1._assert)(!(v instanceof Date), 'mysql-lib does not support Date values, please stringify them before passing');
+                return JSON.stringify(v);
+            }
+            return v;
         }));
         const verb = opt.saveMethod === 'insert' ? 'INSERT' : 'REPLACE';
-        if (opt.assignGeneratedIds) {
+        if (opt.assignGeneratedIds && opt.saveMethod !== 'update') {
             // Insert rows one-by-one, to get their auto-generated id
             let i = -1;
             for await (const row of rows) {
@@ -200,9 +204,18 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
             return;
         }
         // inserts are split into multiple sentenses to respect the max_packet_size (1Mb usually)
-        const sqls = (0, query_util_1.insertSQL)(table, rows, verb, this.cfg.logger);
-        for await (const sql of sqls) {
-            await this.runSQL({ sql });
+        if (opt.saveMethod === 'update') {
+            for await (const row of rows) {
+                (0, js_lib_1._assert)(row.id, 'Cannot update without providing an id');
+                const query = new db_lib_1.DBQuery(table).filterEq('id', row.id);
+                await this.updateByQuery(query, (0, js_lib_1._omit)(row, ['id']));
+            }
+        }
+        else {
+            const sqls = (0, query_util_1.insertSQL)(table, rows, verb, this.cfg.logger);
+            for await (const sql of sqls) {
+                await this.runSQL({ sql });
+            }
         }
     }
     // DELETE
@@ -251,6 +264,13 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         });
         return (0, mysql_schema_util_1.mysqlTableStatsToJsonSchemaField)(table, stats, this.cfg.logger);
     }
+    async updateByQuery(q, patch) {
+        const sql = (0, query_util_1.dbQueryToSQLUpdate)(q, patch);
+        if (!sql)
+            return 0;
+        const { affectedRows } = await this.runSQL({ sql });
+        return affectedRows;
+    }
 }
 tslib_1.__decorate([
     (0, js_lib_1._Memo)()

package/dist/mysqlKeyValueDB.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MySQLKeyValueDB = void 0;
-const stream_1 = require("stream");
+const node_stream_1 = require("node:stream");
 const js_lib_1 = require("@naturalcycles/js-lib");
 const mysql_db_1 = require("./mysql.db");
 class MySQLKeyValueDB {
@@ -67,7 +67,7 @@ class MySQLKeyValueDB {
             .pool()
             .query(sql)
             .stream()
-            .pipe(new stream_1.Transform({
+            .pipe(new node_stream_1.Transform({
             objectMode: true,
             transform(row, _, cb) {
                 cb(null, row.id);
@@ -84,7 +84,7 @@ class MySQLKeyValueDB {
             .pool()
             .query(sql)
             .stream()
-            .pipe(new stream_1.Transform({
+            .pipe(new node_stream_1.Transform({
             objectMode: true,
             transform(row, _, cb) {
                 cb(null, row.v);
@@ -101,7 +101,7 @@ class MySQLKeyValueDB {
             .pool()
             .query(sql)
             .stream()
-            .pipe(new stream_1.Transform({
+            .pipe(new node_stream_1.Transform({
             objectMode: true,
             transform(row, _, cb) {
                 cb(null, [row.id, row.v]);

package/package.json

@@ -34,9 +34,9 @@
     "url": "https://github.com/NaturalCycles/mysql-lib"
   },
   "engines": {
-    "node": ">=14.15.0"
+    "node": ">=16.15.0"
   },
-  "version": "3.12.3",
+  "version": "3.13.0",
   "description": "MySQL client implementing CommonDB interface",
   "keywords": [
     "mysql",

package/src/mysql.db.ts

@@ -1,5 +1,6 @@
 import { Readable, Transform } from 'node:stream'
 import { promisify } from 'node:util'
+import { DBPatch } from '@naturalcycles/db-lib'
 import {
   BaseCommonDB,
   CommonDB,
@@ -10,10 +11,12 @@ import {
   RunQueryResult,
 } from '@naturalcycles/db-lib'
 import {
+  _assert,
   _filterUndefinedValues,
   _mapKeys,
   _mapValues,
   _Memo,
+  _omit,
   AnyObjectWithId,
   CommonLogger,
   commonLoggerPrefix,
@@ -33,7 +36,7 @@ import {
   TypeCast,
 } from 'mysql'
 import * as mysql from 'mysql'
-import { dbQueryToSQLDelete, dbQueryToSQLSelect, insertSQL } from './query.util'
+import { dbQueryToSQLDelete, dbQueryToSQLSelect, dbQueryToSQLUpdate, insertSQL } from './query.util'
 import {
   jsonSchemaToMySQLDDL,
   mapNameFromMySQL,
@@ -143,7 +146,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
 
   async close(): Promise<void> {
     const pool = this.pool()
-    // eslint-disable-next-line @typescript-eslint/await-thenable
+
     await promisify(pool.end.bind(pool))()
     this.cfg.logger.log('closed')
   }
@@ -291,13 +294,21 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     // Stringify object values
     const rows = rowsInput.map(row =>
       _mapValues(row, (_k, v) => {
-        return v && typeof v === 'object' && !Buffer.isBuffer(v) ? JSON.stringify(v) : v
+        if (v && typeof v === 'object' && !Buffer.isBuffer(v)) {
+          // This is to avoid implicit Date stringification and mismatch: it gets saved as Date, but loaded as String
+          _assert(
+            !(v instanceof Date),
+            'mysql-lib does not support Date values, please stringify them before passing',
+          )
+          return JSON.stringify(v)
+        }
+        return v
       }),
     )
 
     const verb = opt.saveMethod === 'insert' ? 'INSERT' : 'REPLACE'
 
-    if (opt.assignGeneratedIds) {
+    if (opt.assignGeneratedIds && opt.saveMethod !== 'update') {
       // Insert rows one-by-one, to get their auto-generated id
 
       let i = -1
@@ -314,10 +325,18 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     }
 
     // inserts are split into multiple sentenses to respect the max_packet_size (1Mb usually)
-    const sqls = insertSQL(table, rows, verb, this.cfg.logger)
+    if (opt.saveMethod === 'update') {
+      for await (const row of rows) {
+        _assert(row.id, 'Cannot update without providing an id')
+        const query = new DBQuery(table).filterEq('id', row.id)
+        await this.updateByQuery(query, _omit(row, ['id']))
+      }
+    } else {
+      const sqls = insertSQL(table, rows, verb, this.cfg.logger)
 
-    for await (const sql of sqls) {
-      await this.runSQL({ sql })
+      for await (const sql of sqls) {
+        await this.runSQL({ sql })
+      }
     }
   }
 
@@ -384,4 +403,15 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
 
     return mysqlTableStatsToJsonSchemaField<ROW>(table, stats, this.cfg.logger)
   }
+
+  override async updateByQuery<ROW extends ObjectWithId>(
+    q: DBQuery<ROW>,
+    patch: DBPatch<ROW>,
+  ): Promise<number> {
+    const sql = dbQueryToSQLUpdate(q, patch)
+    if (!sql) return 0
+
+    const { affectedRows } = await this.runSQL<OkPacket>({ sql })
+    return affectedRows
+  }
 }

package/src/mysqlKeyValueDB.ts

@@ -1,4 +1,4 @@
-import { Transform } from 'stream'
+import { Transform } from 'node:stream'
 import { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@naturalcycles/db-lib'
 import { pMap } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'