@naturalcycles/mysql-lib 3.14.8 → 3.16.0

package/dist/mysql.db.d.ts

@@ -1,4 +1,4 @@
-import { DBPatch, BaseCommonDB, CommonDB, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, DBQuery, RunQueryResult, CommonDBSupport, CommonDBType } from '@naturalcycles/db-lib';
+import { BaseCommonDB, CommonDB, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, CommonDBSupport, CommonDBType, DBQuery, RunQueryResult } from '@naturalcycles/db-lib';
 import { CommonLogger, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { Connection, Pool, PoolConfig, PoolConnection, QueryOptions } from 'mysql';
@@ -68,5 +68,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>;
+    patchByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, patch: Partial<ROW>): Promise<number>;
 }

package/dist/mysql.db.js

@@ -37,8 +37,9 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         this.dbType = db_lib_1.CommonDBType.relational;
         this.support = {
             ...db_lib_1.commonDBFullSupport,
-            updateSaveMethod: false,
-            transactions: false,
+            updateSaveMethod: false, // todo: can be implemented
+            transactions: false, // todo: can be implemented
+            increment: false, // todo: can be implemented
         };
         this.cfg = {
             typeCast,
@@ -157,7 +158,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
             .split(';')
             .map(s => s.trim())
             .filter(Boolean);
-        for await (const sql of queries) {
+        for (const sql of queries) {
             await this.runSQL({ sql });
         }
     }
@@ -191,12 +192,12 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         if (opt.assignGeneratedIds) {
             // Insert rows one-by-one, to get their auto-generated id
             let i = -1;
-            for await (const row of rows) {
+            for (const row of rows) {
                 i++;
                 if (row.id) {
                     // Update already existing
                     const query = new db_lib_1.DBQuery(table).filterEq('id', row.id);
-                    await this.updateByQuery(query, (0, js_lib_1._omit)(row, ['id']));
+                    await this.patchByQuery(query, (0, js_lib_1._omit)(row, ['id']));
                 }
                 else {
                     // Create new
@@ -210,18 +211,18 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         }
         if (opt.saveMethod === 'update') {
             // TODO: This fails if a combination of entities with id and without id are parsed
-            for await (const row of rows) {
+            for (const row of rows) {
                 // Update already existing
                 (0, js_lib_1._assert)(row.id, 'id is required for updating');
                 const query = new db_lib_1.DBQuery(table).filterEq('id', row.id);
-                await this.updateByQuery(query, (0, js_lib_1._omit)(row, ['id']));
+                await this.patchByQuery(query, (0, js_lib_1._omit)(row, ['id']));
             }
             return;
         }
         const verb = opt.saveMethod === 'insert' ? 'INSERT' : 'REPLACE';
         // 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) {
+        for (const sql of sqls) {
             await this.runSQL({ sql });
         }
     }
@@ -271,7 +272,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         });
         return (0, mysql_schema_util_1.mysqlTableStatsToJsonSchemaField)(table, stats, this.cfg.logger);
     }
-    async updateByQuery(q, patch) {
+    async patchByQuery(q, patch) {
         const sql = (0, query_util_1.dbQueryToSQLUpdate)(q, patch);
         if (!sql)
             return 0;

package/dist/mysqlKeyValueDB.d.ts

@@ -1,11 +1,15 @@
-/// <reference types="node" />
 import { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@naturalcycles/db-lib';
+import { StringMap } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { MysqlDB, MysqlDBCfg } from './mysql.db';
 export declare class MySQLKeyValueDB implements CommonKeyValueDB {
     cfg: MysqlDBCfg;
     constructor(cfg: MysqlDBCfg);
     db: MysqlDB;
+    support: {
+        increment: boolean;
+        count?: boolean;
+    };
     ping(): Promise<void>;
     close(): Promise<void>;
     createTable(table: string, opt?: CommonDBCreateOptions): Promise<void>;
@@ -22,4 +26,6 @@ export declare class MySQLKeyValueDB implements CommonKeyValueDB {
     beginTransaction(): Promise<void>;
     endTransaction(): Promise<void>;
     count(table: string): Promise<number>;
+    increment(_table: string, _id: string, _by?: number): Promise<number>;
+    incrementBatch(_table: string, _incrementMap: StringMap<number>): Promise<StringMap<number>>;
 }

package/dist/mysqlKeyValueDB.js

@@ -1,11 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MySQLKeyValueDB = void 0;
+const db_lib_1 = require("@naturalcycles/db-lib");
 const js_lib_1 = require("@naturalcycles/js-lib");
 const mysql_db_1 = require("./mysql.db");
 class MySQLKeyValueDB {
     constructor(cfg) {
         this.cfg = cfg;
+        this.support = {
+            ...db_lib_1.commonKeyValueDBFullSupport,
+            increment: false,
+        };
         this.db = new mysql_db_1.MysqlDB(this.cfg);
     }
     async ping() {
@@ -96,5 +101,11 @@ class MySQLKeyValueDB {
         const rows = await this.db.runSQL({ sql });
         return rows[0].cnt;
     }
+    async increment(_table, _id, _by) {
+        throw new js_lib_1.AppError('MySQLKeyValueDB.increment() is not implemented');
+    }
+    async incrementBatch(_table, _incrementMap) {
+        throw new js_lib_1.AppError('MySQLKeyValueDB.incrementBatch() is not implemented');
+    }
 }
 exports.MySQLKeyValueDB = MySQLKeyValueDB;

package/dist/query.util.d.ts

@@ -16,4 +16,4 @@ export declare function dbQueryToSQLDelete(q: DBQuery<any>): string | null;
 export declare function insertSQL(table: string, rows: Record<any, any>[], verb?: 'INSERT' | 'REPLACE', logger?: CommonLogger): string[];
 export declare function insertSQLSingle(table: string, record: Record<any, any>): string;
 export declare function insertSQLSetSingle(table: string, record: Record<any, any>): QueryOptions;
-export declare function dbQueryToSQLUpdate(q: DBQuery<any>, record: Record<any, any>): string | null;
+export declare function dbQueryToSQLUpdate(q: DBQuery<any>, patch: Record<any, any>): string | null;

package/dist/query.util.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dbQueryToSQLUpdate = exports.insertSQLSetSingle = exports.insertSQLSingle = exports.insertSQL = exports.dbQueryToSQLDelete = exports.dbQueryToSQLSelect = void 0;
+exports.dbQueryToSQLSelect = dbQueryToSQLSelect;
+exports.dbQueryToSQLDelete = dbQueryToSQLDelete;
+exports.insertSQL = insertSQL;
+exports.insertSQLSingle = insertSQLSingle;
+exports.insertSQLSetSingle = insertSQLSetSingle;
+exports.dbQueryToSQLUpdate = dbQueryToSQLUpdate;
 const tslib_1 = require("tslib");
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
@@ -25,7 +30,6 @@ function dbQueryToSQLSelect(q) {
     tokens.push(...offsetLimitTokens(q));
     return tokens.join(' ');
 }
-exports.dbQueryToSQLSelect = dbQueryToSQLSelect;
 /**
  * Returns null in "0 rows" case.
  */
@@ -40,7 +44,6 @@ function dbQueryToSQLDelete(q) {
     tokens.push(...offsetLimitTokens(q));
     return tokens.join(' ');
 }
-exports.dbQueryToSQLDelete = dbQueryToSQLDelete;
 /**
  * Returns array of sql statements to respect the max sql size.
  */
@@ -89,7 +92,6 @@ function insertSQL(table, rows, verb = 'INSERT', logger = console) {
     return sqls;
     // todo: handle "upsert" later
 }
-exports.insertSQL = insertSQL;
 function insertSQLSingle(table, record) {
     // INSERT INTO table_name (column1, column2, column3, ...)
     // VALUES (value1, value2, value3, ...);
@@ -110,15 +112,13 @@ function insertSQLSingle(table, record) {
     ];
     return tokens.join(' ');
 }
-exports.insertSQLSingle = insertSQLSingle;
 function insertSQLSetSingle(table, record) {
     return {
         sql: `INSERT INTO ${mysql.escapeId(table)} SET ?`,
         values: [record],
     };
 }
-exports.insertSQLSetSingle = insertSQLSetSingle;
-function dbQueryToSQLUpdate(q, record) {
+function dbQueryToSQLUpdate(q, patch) {
     // var sql = mysql.format('UPDATE posts SET modified = ? WHERE id = ?', [CURRENT_TIMESTAMP, 42]);
     const whereTokens = getWhereTokens(q);
     if (!whereTokens)
@@ -127,14 +127,13 @@ function dbQueryToSQLUpdate(q, record) {
         `UPDATE`,
         mysql.escapeId(q.table),
         `SET`,
-        Object.keys(record)
+        Object.keys(patch)
             .map(f => mysql.escapeId((0, mysql_schema_util_1.mapNameToMySQL)(f)) + ' = ?')
             .join(', '),
         ...whereTokens,
     ];
-    return mysql.format(tokens.join(' '), Object.values(record));
+    return mysql.format(tokens.join(' '), Object.values(patch));
 }
-exports.dbQueryToSQLUpdate = dbQueryToSQLUpdate;
 function selectTokens(q) {
     let fields = ['*'];
     if (q._selectedFieldNames) {

package/dist/schema/mysql.schema.util.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapNameFromMySQL = exports.mapNameToMySQL = exports.mysqlTableStatsToJsonSchemaField = exports.jsonSchemaToMySQLDDL = void 0;
+exports.jsonSchemaToMySQLDDL = jsonSchemaToMySQLDDL;
+exports.mysqlTableStatsToJsonSchemaField = mysqlTableStatsToJsonSchemaField;
+exports.mapNameToMySQL = mapNameToMySQL;
+exports.mapNameFromMySQL = mapNameFromMySQL;
 const tslib_1 = require("tslib");
 const mysql = tslib_1.__importStar(require("mysql"));
 /**
@@ -56,7 +59,6 @@ function jsonSchemaToMySQLDDL(table, schema, opt = {}) {
     lines.push(`) ENGINE=${engine}`);
     return lines.join('\n');
 }
-exports.jsonSchemaToMySQLDDL = jsonSchemaToMySQLDDL;
 function mysqlTableStatsToJsonSchemaField(table, stats, logger) {
     const s = {
         $id: `${table}.schema.json`,
@@ -94,7 +96,6 @@ function mysqlTableStatsToJsonSchemaField(table, stats, logger) {
     });
     return s;
 }
-exports.mysqlTableStatsToJsonSchemaField = mysqlTableStatsToJsonSchemaField;
 /**
  * Because MySQL doesn't support `.` in field names and escapes them as tableName + fieldName.
  *
@@ -103,8 +104,6 @@ exports.mysqlTableStatsToJsonSchemaField = mysqlTableStatsToJsonSchemaField;
 function mapNameToMySQL(name) {
     return name.replaceAll('.', '_dot_');
 }
-exports.mapNameToMySQL = mapNameToMySQL;
 function mapNameFromMySQL(name) {
     return name.replaceAll('_dot_', '.');
 }
-exports.mapNameFromMySQL = mapNameFromMySQL;

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@naturalcycles/mysql-lib",
   "scripts": {
-    "prepare": "husky"
+    "prepare": "husky",
+    "build": "dev-lib build",
+    "test": "dev-lib test",
+    "lint": "dev-lib lint",
+    "bt": "dev-lib bt",
+    "lbt": "dev-lib lbt"
   },
   "dependencies": {
     "@naturalcycles/db-lib": "^9.1.0",
@@ -11,8 +16,8 @@
     "mysql": "^2.17.1"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "^13.2.1",
-    "@types/node": "^20.2.3",
+    "@naturalcycles/dev-lib": "^15.18.0",
+    "@types/node": "^22.7.4",
     "dotenv": "^16.0.0",
     "jest": "^29.0.0"
   },
@@ -34,9 +39,9 @@
     "url": "https://github.com/NaturalCycles/mysql-lib"
   },
   "engines": {
-    "node": ">=18.12.0"
+    "node": ">=20.13.0"
   },
-  "version": "3.14.8",
+  "version": "3.16.0",
   "description": "MySQL client implementing CommonDB interface",
   "keywords": [
     "mysql",

package/src/mysql.db.ts

@@ -1,17 +1,16 @@
 import { Readable } from 'node:stream'
 import { promisify } from 'node:util'
 import {
-  DBPatch,
   BaseCommonDB,
   CommonDB,
   CommonDBCreateOptions,
+  commonDBFullSupport,
   CommonDBOptions,
   CommonDBSaveOptions,
-  DBQuery,
-  RunQueryResult,
   CommonDBSupport,
-  commonDBFullSupport,
   CommonDBType,
+  DBQuery,
+  RunQueryResult,
 } from '@naturalcycles/db-lib'
 import {
   _assert,
@@ -96,8 +95,9 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
 
   override support: CommonDBSupport = {
     ...commonDBFullSupport,
-    updateSaveMethod: false,
-    transactions: false,
+    updateSaveMethod: false, // todo: can be implemented
+    transactions: false, // todo: can be implemented
+    increment: false, // todo: can be implemented
   }
 
   constructor(cfg: MysqlDBCfg = {}) {
@@ -253,7 +253,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
       .map(s => s.trim())
       .filter(Boolean)
 
-    for await (const sql of queries) {
+    for (const sql of queries) {
       await this.runSQL({ sql })
     }
   }
@@ -310,12 +310,12 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
       // Insert rows one-by-one, to get their auto-generated id
 
       let i = -1
-      for await (const row of rows) {
+      for (const row of rows) {
         i++
         if (row.id) {
           // Update already existing
           const query = new DBQuery(table).filterEq('id', row.id)
-          await this.updateByQuery(query, _omit(row, ['id']))
+          await this.patchByQuery(query, _omit(row, ['id']))
         } else {
           // Create new
           const sql = insertSQL(table, [row], 'INSERT', this.cfg.logger)[0]!
@@ -331,11 +331,11 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
 
     if (opt.saveMethod === 'update') {
       // TODO: This fails if a combination of entities with id and without id are parsed
-      for await (const row of rows) {
+      for (const row of rows) {
         // Update already existing
         _assert(row.id, 'id is required for updating')
         const query = new DBQuery(table).filterEq('id', row.id)
-        await this.updateByQuery(query, _omit(row, ['id']))
+        await this.patchByQuery(query, _omit(row, ['id']))
       }
       return
     }
@@ -344,7 +344,7 @@ 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)
 
-    for await (const sql of sqls) {
+    for (const sql of sqls) {
       await this.runSQL({ sql })
     }
   }
@@ -409,9 +409,9 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     return mysqlTableStatsToJsonSchemaField<ROW>(table, stats, this.cfg.logger)
   }
 
-  override async updateByQuery<ROW extends ObjectWithId>(
+  override async patchByQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
-    patch: DBPatch<ROW>,
+    patch: Partial<ROW>,
   ): Promise<number> {
     const sql = dbQueryToSQLUpdate(q, patch)
     if (!sql) return 0

package/src/mysqlKeyValueDB.ts

@@ -1,5 +1,10 @@
-import { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@naturalcycles/db-lib'
-import { ObjectWithId, pMap } from '@naturalcycles/js-lib'
+import {
+  CommonDBCreateOptions,
+  CommonKeyValueDB,
+  commonKeyValueDBFullSupport,
+  KeyValueDBTuple,
+} from '@naturalcycles/db-lib'
+import { AppError, ObjectWithId, pMap, StringMap } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { QueryOptions } from 'mysql'
 import { MysqlDB, MysqlDBCfg } from './mysql.db'
@@ -16,6 +21,11 @@ export class MySQLKeyValueDB implements CommonKeyValueDB {
 
   db: MysqlDB
 
+  support = {
+    ...commonKeyValueDBFullSupport,
+    increment: false,
+  }
+
   async ping(): Promise<void> {
     await this.db.ping()
   }
@@ -114,4 +124,15 @@ export class MySQLKeyValueDB implements CommonKeyValueDB {
     const rows = await this.db.runSQL<{ cnt: number }[]>({ sql })
     return rows[0]!.cnt
   }
+
+  async increment(_table: string, _id: string, _by?: number): Promise<number> {
+    throw new AppError('MySQLKeyValueDB.increment() is not implemented')
+  }
+
+  async incrementBatch(
+    _table: string,
+    _incrementMap: StringMap<number>,
+  ): Promise<StringMap<number>> {
+    throw new AppError('MySQLKeyValueDB.incrementBatch() is not implemented')
+  }
 }

package/src/query.util.ts

@@ -142,7 +142,7 @@ export function insertSQLSetSingle(table: string, record: Record<any, any>): Que
   }
 }
 
-export function dbQueryToSQLUpdate(q: DBQuery<any>, record: Record<any, any>): string | null {
+export function dbQueryToSQLUpdate(q: DBQuery<any>, patch: Record<any, any>): string | null {
   // var sql = mysql.format('UPDATE posts SET modified = ? WHERE id = ?', [CURRENT_TIMESTAMP, 42]);
   const whereTokens = getWhereTokens(q)
   if (!whereTokens) return null
@@ -151,13 +151,13 @@ export function dbQueryToSQLUpdate(q: DBQuery<any>, record: Record<any, any>): s
     `UPDATE`,
     mysql.escapeId(q.table),
     `SET`,
-    Object.keys(record)
+    Object.keys(patch)
       .map(f => mysql.escapeId(mapNameToMySQL(f)) + ' = ?')
       .join(', '),
     ...whereTokens,
   ]
 
-  return mysql.format(tokens.join(' '), Object.values(record))
+  return mysql.format(tokens.join(' '), Object.values(patch))
 }
 
 function selectTokens(q: DBQuery<any>): string[] {

package/src/schema/mysql.schema.util.ts

@@ -39,7 +39,7 @@ export function jsonSchemaToMySQLDDL(
       return `id VARCHAR(255) NOT NULL`
     }
 
-    let type
+    let type: string
 
     if (s.type === 'string') {
       // can specify isoDate later