@naturalcycles/mysql-lib 3.10.0 → 3.11.2

package/dist/mysql.db.d.ts

@@ -1,10 +1,10 @@
 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';
-import { Connection, Pool, PoolConfig, PoolConnection, QueryOptions, TypeCast } from 'mysql';
+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
@@ -23,7 +23,6 @@ export interface MysqlDBCfg extends PoolConfig {
      */
     logger?: CommonLogger;
 }
-export declare const typeCast: TypeCast;
 export declare class MysqlDB extends BaseCommonDB implements CommonDB {
     constructor(cfg?: MysqlDBCfg);
     cfg: MysqlDBCfg & {
@@ -41,16 +40,21 @@ 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>;
+    /**
+     * 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 ObjectWithId>(table: string, _rows: ROW[], _opt?: MysqlDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends Partial<ObjectWithId>>(table: string, _rows: 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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MysqlDB = exports.typeCast = void 0;
+exports.MysqlDB = void 0;
 const tslib_1 = require("tslib");
 const stream_1 = require("stream");
 const util_1 = require("util");
@@ -31,12 +31,11 @@ const typeCast = (field, next) => {
     }
     return next();
 };
-exports.typeCast = typeCast;
 class MysqlDB extends db_lib_1.BaseCommonDB {
     constructor(cfg = {}) {
         super();
         this.cfg = {
-            typeCast: exports.typeCast,
+            typeCast,
             // charset: 'utf8mb4', // for emoji support
             // host: 'localhost',
             // user: MYSQL_USER,
@@ -139,6 +138,19 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
             });
         });
     }
+    /**
+     * Allows to run semicolon-separated "SQL file".
+     * E.g "ddl reset script".
+     */
+    async runSQLString(s) {
+        const queries = s
+            .split(';')
+            .map(s => s.trim())
+            .filter(Boolean);
+        for await (const sql of queries) {
+            await this.runSQL({ sql });
+        }
+    }
     async runQueryCount(q, _opt) {
         const { rows } = await this.runQuery(q.select(['count(*) as _count']));
         return rows[0]._count;
@@ -159,7 +171,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         }));
     }
     // SAVE
-    async saveBatch(table, _rows, _opt) {
+    async saveBatch(table, _rows, opt = {}) {
         if (!_rows.length)
             return;
         // Stringify object values
@@ -167,7 +179,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
             return v && typeof v === 'object' && !Buffer.isBuffer(v) ? JSON.stringify(v) : v;
         }));
         // 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, opt.saveMethod === 'insert' ? 'INSERT' : 'REPLACE', this.cfg.logger);
         for await (const sql of sqls) {
             await this.runSQL({ sql });
         }
@@ -215,7 +227,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/dist/mysqlKeyValueDB.d.ts

@@ -3,8 +3,8 @@ import { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@natur
 import { ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { MysqlDB, MysqlDBCfg } from './mysql.db';
 export declare class MySQLKeyValueDB implements CommonKeyValueDB {
-    constructor(cfg?: MysqlDBCfg);
     cfg: MysqlDBCfg;
+    constructor(cfg: MysqlDBCfg);
     db: MysqlDB;
     ping(): Promise<void>;
     close(): Promise<void>;

package/dist/mysqlKeyValueDB.js

@@ -5,11 +5,8 @@ const stream_1 = require("stream");
 const js_lib_1 = require("@naturalcycles/js-lib");
 const mysql_db_1 = require("./mysql.db");
 class MySQLKeyValueDB {
-    constructor(cfg = {}) {
-        this.cfg = {
-            typeCast: mysql_db_1.typeCast,
-            ...cfg,
-        };
+    constructor(cfg) {
+        this.cfg = cfg;
         this.db = new mysql_db_1.MysqlDB(this.cfg);
     }
     async ping() {

package/dist/query.util.js

@@ -12,7 +12,7 @@ function dbQueryToSQLSelect(q) {
     // filters
     tokens.push(...whereTokens(q));
     // order
-    tokens.push(...orderTokens(q));
+    tokens.push(...groupOrderTokens(q));
     // offset/limit
     tokens.push(...offsetLimitTokens(q));
     return tokens.join(' ');
@@ -124,7 +124,13 @@ function selectTokens(q) {
         fields = q._selectedFieldNames.length ? q._selectedFieldNames : ['id'];
     }
     // We don't do `escapeId` cause it'll ruin e.g SELECT `count *` FROM ...
-    return [`SELECT`, fields.map(f => (0, mysql_schema_util_1.mapNameToMySQL)(f)).join(', '), `FROM`, mysql.escapeId(q.table)];
+    return [
+        `SELECT`,
+        q._distinct && 'DISTINCT',
+        fields.map(f => (0, mysql_schema_util_1.mapNameToMySQL)(f)).join(', '),
+        `FROM`,
+        mysql.escapeId(q.table),
+    ].filter(Boolean);
 }
 function offsetLimitTokens(q) {
     const tokens = [];
@@ -137,13 +143,15 @@ function offsetLimitTokens(q) {
     }
     return tokens;
 }
-function orderTokens(q) {
-    if (!q._orders.length)
-        return [];
-    return [
-        `ORDER BY`,
-        q._orders.map(o => `\`${o.name}\` ${o.descending ? 'DESC' : 'ASC'}`).join(', '),
-    ];
+function groupOrderTokens(q) {
+    const t = [];
+    if (q._groupByFieldNames?.length) {
+        t.push(`GROUP BY`, q._groupByFieldNames.map(c => `\`${c}\``).join(', '));
+    }
+    if (q._orders.length) {
+        t.push(`ORDER BY`, q._orders.map(o => `\`${o.name}\` ${o.descending ? 'DESC' : 'ASC'}`).join(', '));
+    }
+    return t;
 }
 const OP_MAP = {
     '==': '=',

package/package.json

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

package/src/mysql.db.ts

@@ -34,7 +34,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> {}
 
 /**
@@ -60,7 +60,7 @@ export interface MysqlDBCfg extends PoolConfig {
 const BOOLEAN_TYPES = new Set(['TINY', 'TINYINT', 'INT'])
 const BOOLEAN_BIT_TYPES = new Set(['BIT'])
 
-export const typeCast: TypeCast = (field, next) => {
+const typeCast: TypeCast = (field, next) => {
   // cast to boolean
   if (field.length === 1) {
     if (BOOLEAN_BIT_TYPES.has(field.type)) {
@@ -176,7 +176,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 []
@@ -218,6 +218,21 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     })
   }
 
+  /**
+   * Allows to run semicolon-separated "SQL file".
+   * E.g "ddl reset script".
+   */
+  async runSQLString(s: string): Promise<void> {
+    const queries = s
+      .split(';')
+      .map(s => s.trim())
+      .filter(Boolean)
+
+    for await (const sql of queries) {
+      await this.runSQL({ sql })
+    }
+  }
+
   override async runQueryCount<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     _opt?: CommonDBOptions,
@@ -249,10 +264,10 @@ 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>,
+    opt: MysqlDBSaveOptions<ROW> = {},
   ): Promise<void> {
     if (!_rows.length) return
 
@@ -264,7 +279,12 @@ 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, 'REPLACE', this.cfg.logger)
+    const sqls = insertSQL(
+      table,
+      rows,
+      opt.saveMethod === 'insert' ? 'INSERT' : 'REPLACE',
+      this.cfg.logger,
+    )
 
     for await (const sql of sqls) {
       await this.runSQL({ sql })
@@ -275,7 +295,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 })

package/src/mysqlKeyValueDB.ts

@@ -3,7 +3,7 @@ import { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@natur
 import { pMap } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { QueryOptions } from 'mysql'
-import { MysqlDB, MysqlDBCfg, typeCast } from './mysql.db'
+import { MysqlDB, MysqlDBCfg } from './mysql.db'
 
 interface KeyValueObject {
   id: string
@@ -11,17 +11,10 @@ interface KeyValueObject {
 }
 
 export class MySQLKeyValueDB implements CommonKeyValueDB {
-  constructor(cfg: MysqlDBCfg = {}) {
-    this.cfg = {
-      typeCast,
-      ...cfg,
-    }
-
+  constructor(public cfg: MysqlDBCfg) {
     this.db = new MysqlDB(this.cfg)
   }
 
-  cfg: MysqlDBCfg
-
   db: MysqlDB
 
   async ping(): Promise<void> {

package/src/query.util.ts

@@ -16,7 +16,7 @@ export function dbQueryToSQLSelect(q: DBQuery<any>): string {
   tokens.push(...whereTokens(q))
 
   // order
-  tokens.push(...orderTokens(q))
+  tokens.push(...groupOrderTokens(q))
 
   // offset/limit
   tokens.push(...offsetLimitTokens(q))
@@ -155,7 +155,13 @@ function selectTokens(q: DBQuery): string[] {
   }
 
   // We don't do `escapeId` cause it'll ruin e.g SELECT `count *` FROM ...
-  return [`SELECT`, fields.map(f => mapNameToMySQL(f)).join(', '), `FROM`, mysql.escapeId(q.table)]
+  return [
+    `SELECT`,
+    q._distinct && ('DISTINCT' as any),
+    fields.map(f => mapNameToMySQL(f)).join(', '),
+    `FROM`,
+    mysql.escapeId(q.table),
+  ].filter(Boolean)
 }
 
 function offsetLimitTokens(q: DBQuery<any>): string[] {
@@ -173,12 +179,21 @@ function offsetLimitTokens(q: DBQuery<any>): string[] {
   return tokens
 }
 
-function orderTokens(q: DBQuery): string[] {
-  if (!q._orders.length) return []
-  return [
-    `ORDER BY`,
-    q._orders.map(o => `\`${o.name}\` ${o.descending ? 'DESC' : 'ASC'}`).join(', '),
-  ]
+function groupOrderTokens(q: DBQuery): string[] {
+  const t: string[] = []
+
+  if (q._groupByFieldNames?.length) {
+    t.push(`GROUP BY`, q._groupByFieldNames.map(c => `\`${c}\``).join(', '))
+  }
+
+  if (q._orders.length) {
+    t.push(
+      `ORDER BY`,
+      q._orders.map(o => `\`${o.name}\` ${o.descending ? 'DESC' : 'ASC'}`).join(', '),
+    )
+  }
+
+  return t
 }
 
 const OP_MAP: Partial<Record<DBQueryFilterOperator, string>> = {