@naturalcycles/mysql-lib 3.14.3 → 3.14.5

package/dist/index.d.ts

@@ -1,6 +1,3 @@
-import { getDBAdapter } from './dbAdapter';
-import { MysqlDB, MysqlDBCfg, MysqlDBOptions, MysqlDBSaveOptions } from './mysql.db';
-import { MySQLKeyValueDB } from './mysqlKeyValueDB';
-import { jsonSchemaToMySQLDDL } from './schema/mysql.schema.util';
-export type { MysqlDBCfg, MysqlDBOptions, MysqlDBSaveOptions };
-export { MysqlDB, MySQLKeyValueDB, jsonSchemaToMySQLDDL, getDBAdapter };
+export * from './mysql.db';
+export * from './mysqlKeyValueDB';
+export { jsonSchemaToMySQLDDL } from './schema/mysql.schema.util';

package/dist/index.js

@@ -1,11 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDBAdapter = exports.jsonSchemaToMySQLDDL = exports.MySQLKeyValueDB = exports.MysqlDB = void 0;
-const dbAdapter_1 = require("./dbAdapter");
-Object.defineProperty(exports, "getDBAdapter", { enumerable: true, get: function () { return dbAdapter_1.getDBAdapter; } });
-const mysql_db_1 = require("./mysql.db");
-Object.defineProperty(exports, "MysqlDB", { enumerable: true, get: function () { return mysql_db_1.MysqlDB; } });
-const mysqlKeyValueDB_1 = require("./mysqlKeyValueDB");
-Object.defineProperty(exports, "MySQLKeyValueDB", { enumerable: true, get: function () { return mysqlKeyValueDB_1.MySQLKeyValueDB; } });
-const mysql_schema_util_1 = require("./schema/mysql.schema.util");
+exports.jsonSchemaToMySQLDDL = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./mysql.db"), exports);
+tslib_1.__exportStar(require("./mysqlKeyValueDB"), exports);
+var mysql_schema_util_1 = require("./schema/mysql.schema.util");
 Object.defineProperty(exports, "jsonSchemaToMySQLDDL", { enumerable: true, get: function () { return mysql_schema_util_1.jsonSchemaToMySQLDDL; } });

package/dist/mysql.db.d.ts

@@ -1,5 +1,4 @@
-import { DBPatch } from '@naturalcycles/db-lib';
-import { BaseCommonDB, CommonDB, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, DBQuery, RunQueryResult } from '@naturalcycles/db-lib';
+import { DBPatch, BaseCommonDB, CommonDB, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, DBQuery, RunQueryResult, CommonDBSupport, CommonDBType } from '@naturalcycles/db-lib';
 import { AnyObjectWithId, CommonLogger, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { Connection, Pool, PoolConfig, PoolConnection, QueryOptions } from 'mysql';
@@ -25,6 +24,8 @@ export interface MysqlDBCfg extends PoolConfig {
     logger?: CommonLogger;
 }
 export declare class MysqlDB extends BaseCommonDB implements CommonDB {
+    dbType: CommonDBType;
+    support: CommonDBSupport;
     constructor(cfg?: MysqlDBCfg);
     cfg: MysqlDBCfg & {
         logger: CommonLogger;

package/dist/mysql.db.js

@@ -7,7 +7,7 @@ const node_util_1 = require("node:util");
 const db_lib_1 = require("@naturalcycles/db-lib");
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const mysql = require("mysql");
+const mysql = tslib_1.__importStar(require("mysql"));
 const query_util_1 = require("./query.util");
 const mysql_schema_util_1 = require("./schema/mysql.schema.util");
 const BOOLEAN_TYPES = new Set(['TINY', 'TINYINT', 'INT']);
@@ -34,6 +34,12 @@ const typeCast = (field, next) => {
 class MysqlDB extends db_lib_1.BaseCommonDB {
     constructor(cfg = {}) {
         super();
+        this.dbType = db_lib_1.CommonDBType.relational;
+        this.support = {
+            ...db_lib_1.commonDBFullSupport,
+            updateSaveMethod: false,
+            transactions: false,
+        };
         this.cfg = {
             typeCast,
             // charset: 'utf8mb4', // for emoji support
@@ -205,7 +211,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
                     const sql = (0, query_util_1.insertSQL)(table, [row], 'INSERT', this.cfg.logger)[0];
                     const { insertId } = await this.runSQL({ sql });
                     // Mutate the input row with insertIt
-                    rowsInput[i].id = insertId;
+                    rowsInput[i].id = insertId; // this is because we no longer support number ids in CommonDB
                 }
             }
             return;

package/dist/query.util.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dbQueryToSQLUpdate = exports.insertSQLSetSingle = exports.insertSQLSingle = exports.insertSQL = exports.dbQueryToSQLDelete = exports.dbQueryToSQLSelect = void 0;
+const tslib_1 = require("tslib");
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const mysql = require("mysql");
+const mysql = tslib_1.__importStar(require("mysql"));
 const mysql_schema_util_1 = require("./schema/mysql.schema.util");
 const MAX_PACKET_SIZE = 1024 * 1024; // 1Mb
 const MAX_ROW_SIZE = 800 * 1024; // 1Mb - margin

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

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapNameFromMySQL = exports.mapNameToMySQL = exports.mysqlTableStatsToJsonSchemaField = exports.jsonSchemaToMySQLDDL = void 0;
-const mysql = require("mysql");
+const tslib_1 = require("tslib");
+const mysql = tslib_1.__importStar(require("mysql"));
 /**
  * It currently skips nullability and declares everything as "DEFAULT NULL".
  */

package/package.json

@@ -4,7 +4,7 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "@naturalcycles/db-lib": "^8.16.2",
+    "@naturalcycles/db-lib": "^9.1.0",
     "@naturalcycles/js-lib": "^14.47.0",
     "@naturalcycles/nodejs-lib": "^13.1.0",
     "@types/mysql": "^2.15.19",
@@ -36,7 +36,7 @@
   "engines": {
     "node": ">=16.15.0"
   },
-  "version": "3.14.3",
+  "version": "3.14.5",
   "description": "MySQL client implementing CommonDB interface",
   "keywords": [
     "mysql",

package/src/index.ts

@@ -1,8 +1,3 @@
-import { getDBAdapter } from './dbAdapter'
-import { MysqlDB, MysqlDBCfg, MysqlDBOptions, MysqlDBSaveOptions } from './mysql.db'
-import { MySQLKeyValueDB } from './mysqlKeyValueDB'
-import { jsonSchemaToMySQLDDL } from './schema/mysql.schema.util'
-
-export type { MysqlDBCfg, MysqlDBOptions, MysqlDBSaveOptions }
-
-export { MysqlDB, MySQLKeyValueDB, jsonSchemaToMySQLDDL, getDBAdapter }
+export * from './mysql.db'
+export * from './mysqlKeyValueDB'
+export { jsonSchemaToMySQLDDL } from './schema/mysql.schema.util'

package/src/mysql.db.ts

@@ -1,7 +1,7 @@
 import { Readable, Transform } from 'node:stream'
 import { promisify } from 'node:util'
-import { DBPatch } from '@naturalcycles/db-lib'
 import {
+  DBPatch,
   BaseCommonDB,
   CommonDB,
   CommonDBCreateOptions,
@@ -9,6 +9,9 @@ import {
   CommonDBSaveOptions,
   DBQuery,
   RunQueryResult,
+  CommonDBSupport,
+  commonDBFullSupport,
+  CommonDBType,
 } from '@naturalcycles/db-lib'
 import {
   _assert,
@@ -24,8 +27,7 @@ import {
   JsonSchemaRootObject,
   ObjectWithId,
 } from '@naturalcycles/js-lib'
-import { ReadableTyped } from '@naturalcycles/nodejs-lib'
-import { white } from '@naturalcycles/nodejs-lib'
+import { ReadableTyped, white } from '@naturalcycles/nodejs-lib'
 import {
   Connection,
   OkPacket,
@@ -92,6 +94,14 @@ const typeCast: TypeCast = (field, next) => {
 }
 
 export class MysqlDB extends BaseCommonDB implements CommonDB {
+  override dbType = CommonDBType.relational
+
+  override support: CommonDBSupport = {
+    ...commonDBFullSupport,
+    updateSaveMethod: false,
+    transactions: false,
+  }
+
   constructor(cfg: MysqlDBCfg = {}) {
     super()
     this.cfg = {
@@ -322,7 +332,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
           const { insertId } = await this.runSQL<OkPacket>({ sql })
 
           // Mutate the input row with insertIt
-          rowsInput[i]!.id = insertId
+          rowsInput[i]!.id = insertId as any // this is because we no longer support number ids in CommonDB
         }
       }
 
@@ -353,7 +363,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   /**
    * Limitation: always returns [], regardless of which rows are actually deleted
    */
-  async deleteByIds<ROW extends ObjectWithId>(
+  override async deleteByIds<ROW extends ObjectWithId>(
     table: string,
     ids: ROW['id'][],
     _opt?: MysqlDBOptions,

package/dist/dbAdapter.d.ts

@@ -1,2 +0,0 @@
-import { MysqlDB } from './mysql.db';
-export declare function getDBAdapter(cfgStr?: string): MysqlDB;

package/dist/dbAdapter.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDBAdapter = void 0;
-const mysql_db_1 = require("./mysql.db");
-function getDBAdapter(cfgStr = '{}') {
-    const cfg = JSON.parse(cfgStr);
-    return new mysql_db_1.MysqlDB(cfg);
-}
-exports.getDBAdapter = getDBAdapter;

package/src/dbAdapter.ts

@@ -1,6 +0,0 @@
-import { MysqlDB } from './mysql.db'
-
-export function getDBAdapter(cfgStr: string = '{}'): MysqlDB {
-  const cfg = JSON.parse(cfgStr)
-  return new MysqlDB(cfg)
-}