@naturalcycles/mysql-lib 3.14.4 → 3.14.6

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,10 +1,10 @@
-import { DBPatch, BaseCommonDB, CommonDB, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, DBQuery, RunQueryResult } from '@naturalcycles/db-lib';
-import { AnyObjectWithId, CommonLogger, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId } from '@naturalcycles/js-lib';
+import { DBPatch, BaseCommonDB, CommonDB, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, DBQuery, RunQueryResult, CommonDBSupport, CommonDBType } from '@naturalcycles/db-lib';
+import { AnyPartialObjectWithId, CommonLogger, JsonSchemaObject, JsonSchemaRootObject, PartialObjectWithId, Saved } from '@naturalcycles/js-lib';
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { Connection, Pool, PoolConfig, PoolConnection, QueryOptions } from 'mysql';
 export interface MysqlDBOptions extends CommonDBOptions {
 }
-export interface MysqlDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId> extends CommonDBSaveOptions<ROW> {
+export interface MysqlDBSaveOptions<ROW extends PartialObjectWithId = AnyPartialObjectWithId> extends CommonDBSaveOptions<ROW> {
 }
 /**
  * @default false / undefined
@@ -24,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;
@@ -40,22 +42,22 @@ 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: ROW['id'][], opt?: MysqlDBOptions): Promise<ROW[]>;
-    runQuery<ROW extends ObjectWithId, OUT = ROW>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): Promise<RunQueryResult<OUT>>;
+    getByIds<ROW extends PartialObjectWithId>(table: string, ids: string[], opt?: MysqlDBOptions): Promise<Saved<ROW>[]>;
+    runQuery<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): Promise<RunQueryResult<Saved<ROW>>>;
     runSQL<RESULT>(q: QueryOptions): Promise<RESULT>;
     /**
      * Allows to run semicolon-separated "SQL file".
      * E.g "ddl reset script".
      */
     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 Partial<ObjectWithId>>(table: string, rowsInput: ROW[], opt?: MysqlDBSaveOptions<ROW>): Promise<void>;
+    runQueryCount<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
+    streamQuery<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): ReadableTyped<Saved<ROW>>;
+    saveBatch<ROW extends PartialObjectWithId>(table: string, rowsInput: ROW[], opt?: MysqlDBSaveOptions<ROW>): Promise<void>;
     /**
      * Limitation: always returns [], regardless of which rows are actually deleted
      */
-    deleteByIds<ROW extends ObjectWithId>(table: string, ids: ROW['id'][], _opt?: MysqlDBOptions): Promise<number>;
-    deleteByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
+    deleteByIds(table: string, ids: string[], _opt?: MysqlDBOptions): Promise<number>;
+    deleteByQuery<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, _opt?: CommonDBOptions): Promise<number>;
     /**
      * Use with caution!
      */
@@ -63,8 +65,8 @@ export declare class MysqlDB extends BaseCommonDB implements CommonDB {
     /**
      * dropIfExists=true needed as a safety check
      */
-    createTable<ROW extends ObjectWithId>(table: string, schema: JsonSchemaObject<ROW>, opt?: CommonDBCreateOptions): Promise<void>;
+    createTable<ROW extends PartialObjectWithId>(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>;
+    getTableSchema<ROW extends PartialObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
+    updateByQuery<ROW extends PartialObjectWithId>(q: DBQuery<ROW>, patch: DBPatch<ROW>): Promise<number>;
 }

package/dist/mysql.db.js

@@ -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

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.4",
+  "version": "3.14.6",
   "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

@@ -9,6 +9,9 @@ import {
   CommonDBSaveOptions,
   DBQuery,
   RunQueryResult,
+  CommonDBSupport,
+  commonDBFullSupport,
+  CommonDBType,
 } from '@naturalcycles/db-lib'
 import {
   _assert,
@@ -17,12 +20,13 @@ import {
   _mapValues,
   _Memo,
   _omit,
-  AnyObjectWithId,
+  AnyPartialObjectWithId,
   CommonLogger,
   commonLoggerPrefix,
   JsonSchemaObject,
   JsonSchemaRootObject,
-  ObjectWithId,
+  PartialObjectWithId,
+  Saved,
 } from '@naturalcycles/js-lib'
 import { ReadableTyped, white } from '@naturalcycles/nodejs-lib'
 import {
@@ -44,7 +48,7 @@ import {
 } from './schema/mysql.schema.util'
 
 export interface MysqlDBOptions extends CommonDBOptions {}
-export interface MysqlDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId>
+export interface MysqlDBSaveOptions<ROW extends PartialObjectWithId = AnyPartialObjectWithId>
   extends CommonDBSaveOptions<ROW> {}
 
 /**
@@ -91,6 +95,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 = {
@@ -184,11 +196,11 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   }
 
   // GET
-  override async getByIds<ROW extends ObjectWithId>(
+  override async getByIds<ROW extends PartialObjectWithId>(
     table: string,
-    ids: ROW['id'][],
+    ids: string[],
     opt: MysqlDBOptions = {},
-  ): Promise<ROW[]> {
+  ): Promise<Saved<ROW>[]> {
     if (!ids.length) return []
     const q = new DBQuery<ROW>(table).filterEq('id', ids)
     const { rows } = await this.runQuery(q, opt)
@@ -196,10 +208,10 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   }
 
   // QUERY
-  override async runQuery<ROW extends ObjectWithId, OUT = ROW>(
+  override async runQuery<ROW extends PartialObjectWithId>(
     q: DBQuery<ROW>,
     _opt: MysqlDBOptions = {},
-  ): Promise<RunQueryResult<OUT>> {
+  ): Promise<RunQueryResult<Saved<ROW>>> {
     const sql = dbQueryToSQLSelect(q)
     if (!sql) {
       return {
@@ -249,7 +261,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     }
   }
 
-  override async runQueryCount<ROW extends ObjectWithId>(
+  override async runQueryCount<ROW extends PartialObjectWithId>(
     q: DBQuery<ROW>,
     _opt?: CommonDBOptions,
   ): Promise<number> {
@@ -257,10 +269,10 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     return (rows[0] as any)._count
   }
 
-  override streamQuery<ROW extends ObjectWithId, OUT = ROW>(
+  override streamQuery<ROW extends PartialObjectWithId>(
     q: DBQuery<ROW>,
     _opt: MysqlDBOptions = {},
-  ): ReadableTyped<OUT> {
+  ): ReadableTyped<Saved<ROW>> {
     const sql = dbQueryToSQLSelect(q)
     if (!sql) {
       return Readable.from([])
@@ -283,7 +295,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   }
 
   // SAVE
-  override async saveBatch<ROW extends Partial<ObjectWithId>>(
+  override async saveBatch<ROW extends PartialObjectWithId>(
     table: string,
     rowsInput: ROW[],
     opt: MysqlDBSaveOptions<ROW> = {},
@@ -352,11 +364,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   /**
    * Limitation: always returns [], regardless of which rows are actually deleted
    */
-  async deleteByIds<ROW extends ObjectWithId>(
-    table: string,
-    ids: ROW['id'][],
-    _opt?: MysqlDBOptions,
-  ): Promise<number> {
+  override async deleteByIds(table: string, ids: string[], _opt?: MysqlDBOptions): Promise<number> {
     if (!ids.length) return 0
     const sql = dbQueryToSQLDelete(new DBQuery(table).filterEq('id', ids))
     if (!sql) return 0
@@ -365,7 +373,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     return affectedRows
   }
 
-  override async deleteByQuery<ROW extends ObjectWithId>(
+  override async deleteByQuery<ROW extends PartialObjectWithId>(
     q: DBQuery<ROW>,
     _opt?: CommonDBOptions,
   ): Promise<number> {
@@ -385,7 +393,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   /**
    * dropIfExists=true needed as a safety check
    */
-  override async createTable<ROW extends ObjectWithId>(
+  override async createTable<ROW extends PartialObjectWithId>(
     table: string,
     schema: JsonSchemaObject<ROW>,
     opt: CommonDBCreateOptions = {},
@@ -402,7 +410,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
       .filter(Boolean)
   }
 
-  override async getTableSchema<ROW extends ObjectWithId>(
+  override async getTableSchema<ROW extends PartialObjectWithId>(
     table: string,
   ): Promise<JsonSchemaRootObject<ROW>> {
     const stats = await this.runSQL<MySQLTableStats[]>({
@@ -412,7 +420,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     return mysqlTableStatsToJsonSchemaField<ROW>(table, stats, this.cfg.logger)
   }
 
-  override async updateByQuery<ROW extends ObjectWithId>(
+  override async updateByQuery<ROW extends PartialObjectWithId>(
     q: DBQuery<ROW>,
     patch: DBPatch<ROW>,
   ): Promise<number> {

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)
-}