@naturalcycles/mysql-lib 3.8.0 → 3.9.2

package/dist/mysql.db.d.ts

@@ -1,10 +1,10 @@
-import { BaseCommonDB, BaseDBEntity, CommonDB, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, DBQuery, ObjectWithId, RunQueryResult } from '@naturalcycles/db-lib';
-import { JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-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';
 import { Connection, Pool, PoolConfig, PoolConnection, QueryOptions } from 'mysql';
 export interface MysqlDBOptions extends CommonDBOptions {
 }
-export interface MysqlDBSaveOptions extends CommonDBSaveOptions {
+export interface MysqlDBSaveOptions<ROW extends ObjectWithId = AnyObjectWithId> extends CommonDBSaveOptions<ROW> {
 }
 /**
  * @default false / undefined
@@ -18,10 +18,16 @@ export interface MysqlDBCfg extends PoolConfig {
      * If true - will emit logs of connection events.
      */
     debugConnections?: boolean;
+    /**
+     * Default to `console`
+     */
+    logger?: CommonLogger;
 }
 export declare class MysqlDB extends BaseCommonDB implements CommonDB {
     constructor(cfg?: MysqlDBCfg);
-    cfg: MysqlDBCfg;
+    cfg: MysqlDBCfg & {
+        logger: CommonLogger;
+    };
     ping(): Promise<void>;
     pool(): Pool;
     close(): Promise<void>;
@@ -39,7 +45,7 @@ export declare class MysqlDB extends BaseCommonDB implements CommonDB {
     runSQL<RESULT>(q: QueryOptions): Promise<RESULT>;
     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 BaseDBEntity>(table: string, _rows: ROW[], _opt?: MysqlDBSaveOptions): Promise<void>;
+    saveBatch<ROW extends ObjectWithId>(table: string, _rows: ROW[], _opt?: MysqlDBSaveOptions<ROW>): Promise<void>;
     /**
      * Limitation: always returns [], regardless of which rows are actually deleted
      */
@@ -52,7 +58,7 @@ export declare class MysqlDB extends BaseCommonDB implements CommonDB {
     /**
      * dropIfExists=true needed as a safety check
      */
-    createTable(table: string, schema: JsonSchemaObject, opt?: CommonDBCreateOptions): Promise<void>;
+    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>>;
 }

package/dist/mysql.db.js

@@ -6,12 +6,10 @@ const stream_1 = require("stream");
 const util_1 = require("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 colors_1 = require("@naturalcycles/nodejs-lib/dist/colors");
 const mysql = require("mysql");
 const query_util_1 = require("./query.util");
 const mysql_schema_util_1 = require("./schema/mysql.schema.util");
-const log = (0, nodejs_lib_1.Debug)('nc:mysql-lib');
 const BOOLEAN_TYPES = new Set(['TINY', 'TINYINT', 'INT']);
 const BOOLEAN_BIT_TYPES = new Set(['BIT']);
 const typeCast = (field, next) => {
@@ -44,6 +42,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
             // password: MYSQL_PW,
             // database: MYSQL_DB,
             ...cfg,
+            logger: (0, js_lib_1.commonLoggerPrefix)(cfg.logger || console, '[mysql]'),
         };
     }
     async ping() {
@@ -52,31 +51,32 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
     }
     pool() {
         const pool = mysql.createPool(this.cfg);
-        const { host, database } = this.cfg;
-        log(`connected to ${(0, colors_1.white)(host + '/' + database)}`);
+        const { host, database, logger } = this.cfg;
+        logger.log(`connected to ${(0, colors_1.white)(host + '/' + database)}`);
         if (this.cfg.debugConnections) {
             pool.on('acquire', con => {
-                log(`acquire(${con.threadId})`);
+                logger.log(`acquire(${con.threadId})`);
             });
             pool.on('connection', con => {
-                log(`connection(${con.threadId})`);
+                logger.log(`connection(${con.threadId})`);
             });
             pool.on('enqueue', () => {
-                log(`enqueue`);
+                logger.log(`enqueue`);
             });
             pool.on('release', con => {
-                log(`release(${con.threadId})`);
+                logger.log(`release(${con.threadId})`);
             });
         }
         pool.on('error', err => {
-            log.error(`error`, err);
+            logger.error(err);
         });
         return pool;
     }
     async close() {
         const pool = this.pool();
         // eslint-disable-next-line @typescript-eslint/await-thenable
-        await (0, util_1.promisify)(pool.end.bind(pool));
+        await (0, util_1.promisify)(pool.end.bind(pool))();
+        this.cfg.logger.log('closed');
     }
     /**
      * Be careful to always call `con.release()` when you get connection with this method.
@@ -94,14 +94,14 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         await (0, util_1.promisify)(con.connect.bind(con))();
         const { threadId } = con;
         if (this.cfg.debugConnections) {
-            log(`createSingleConnection(${threadId})`);
-            con.on('connect', () => log(`createSingleConnection(${threadId}).connect`));
-            con.on('drain', () => log(`createSingleConnection(${threadId}).drain`));
-            con.on('enqueue', () => log(`createSingleConnection(${threadId}).enqueue`));
-            con.on('end', () => log(`createSingleConnection(${threadId}).end`));
+            this.cfg.logger.log(`createSingleConnection(${threadId})`);
+            con.on('connect', () => this.cfg.logger.log(`createSingleConnection(${threadId}).connect`));
+            con.on('drain', () => this.cfg.logger.log(`createSingleConnection(${threadId}).drain`));
+            con.on('enqueue', () => this.cfg.logger.log(`createSingleConnection(${threadId}).enqueue`));
+            con.on('end', () => this.cfg.logger.log(`createSingleConnection(${threadId}).end`));
         }
         con.on('error', err => {
-            log.error(`createSingleConnection(${threadId}).error`, err);
+            this.cfg.logger.error(`createSingleConnection(${threadId}).error`, err);
         });
         return con;
     }
@@ -116,14 +116,20 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
     // QUERY
     async runQuery(q, _opt = {}) {
         const sql = (0, query_util_1.dbQueryToSQLSelect)(q);
-        const rows = await this.runSQL({ sql });
+        const rows = (await this.runSQL({ sql })).map(row => (0, js_lib_1._mapKeys)((0, js_lib_1._filterUndefinedValues)(row, true), k => (0, mysql_schema_util_1.mapNameFromMySQL)(k)));
+        // edge case where 0 fields are selected
+        if (q._selectedFieldNames?.length === 0) {
+            return {
+                rows: rows.map(_ => ({})),
+            };
+        }
         return {
-            rows: rows.map(r => (0, js_lib_1._mapKeys)((0, js_lib_1._filterNullishValues)(r, true), k => (0, mysql_schema_util_1.mapNameFromMySQL)(k))),
+            rows,
         };
     }
     async runSQL(q) {
         if (this.cfg.logSQL)
-            log(q.sql, q.values);
+            this.cfg.logger.log(...[q.sql, q.values].filter(Boolean));
         return await new Promise((resolve, reject) => {
             this.pool().query(q, (err, res) => {
                 if (err)
@@ -139,7 +145,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
     streamQuery(q, _opt = {}) {
         const sql = (0, query_util_1.dbQueryToSQLSelect)(q);
         if (this.cfg.logSQL)
-            log(`stream: ${sql}`);
+            this.cfg.logger.log(`stream: ${sql}`);
         // return this.streamSQL(sql, opt)
         return this.pool()
             .query(sql)
@@ -147,7 +153,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
             .pipe(new stream_1.Transform({
             objectMode: true,
             transform(row, _encoding, cb) {
-                cb(null, (0, js_lib_1._filterNullishValues)(row, true));
+                cb(null, (0, js_lib_1._filterUndefinedValues)(row, true));
             },
         }));
     }
@@ -156,11 +162,11 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         if (!_rows.length)
             return;
         // Stringify object values
-        const rows = _rows.map(row => (0, js_lib_1._mapValues)(row, v => {
+        const rows = _rows.map(row => (0, js_lib_1._mapValues)(row, (_k, v) => {
             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);
+        const sqls = (0, query_util_1.insertSQL)(table, rows, 'REPLACE', this.cfg.logger);
         for await (const sql of sqls) {
             await this.runSQL({ sql });
         }
@@ -205,7 +211,7 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         const stats = await this.runSQL({
             sql: `describe ${mysql.escapeId(table)}`,
         });
-        return (0, mysql_schema_util_1.mysqlTableStatsToJsonSchemaField)(table, stats);
+        return (0, mysql_schema_util_1.mysqlTableStatsToJsonSchemaField)(table, stats, this.cfg.logger);
     }
 }
 (0, tslib_1.__decorate)([

package/dist/query.util.d.ts

@@ -1,11 +1,12 @@
 import { DBQuery } from '@naturalcycles/db-lib';
+import { CommonLogger } from '@naturalcycles/js-lib';
 import { QueryOptions } from 'mysql';
 export declare function dbQueryToSQLSelect(q: DBQuery<any>): string;
 export declare function dbQueryToSQLDelete(q: DBQuery<any>): string;
 /**
  * Returns array of sql statements to respect the max sql size.
  */
-export declare function insertSQL(table: string, records: Record<any, any>[], verb?: 'INSERT' | 'REPLACE'): string[];
+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;

package/dist/query.util.js

@@ -30,12 +30,12 @@ exports.dbQueryToSQLDelete = dbQueryToSQLDelete;
 /**
  * Returns array of sql statements to respect the max sql size.
  */
-function insertSQL(table, records, verb = 'INSERT') {
+function insertSQL(table, rows, verb = 'INSERT', logger = console) {
     // INSERT INTO table_name (column1, column2, column3, ...)
     // VALUES (value1, value2, value3, ...);
     // eslint-disable-next-line unicorn/no-array-reduce
-    const fieldSet = records.reduce((set, rec) => {
-        Object.keys(rec).forEach(field => set.add(field));
+    const fieldSet = rows.reduce((set, row) => {
+        Object.keys(row).forEach(field => set.add(field));
         return set;
     }, new Set());
     const fields = [...fieldSet];
@@ -46,7 +46,7 @@ function insertSQL(table, records, verb = 'INSERT') {
         `(` + [...fields].map(f => mysql.escapeId((0, mysql_schema_util_1.mapNameToMySQL)(f))).join(',') + `)`,
         `VALUES\n`,
     ].join(' ');
-    const valueRows = records.map(rec => {
+    const valueRows = rows.map(rec => {
         return `(` + fields.map(k => mysql.escape(rec[k])).join(',') + `)`;
     });
     const full = start + valueRows.join(',\n');
@@ -71,7 +71,7 @@ function insertSQL(table, records, verb = 'INSERT') {
     if (sql) {
         sqls.push(sql); // last one
     }
-    console.log(`${(0, colors_1.white)(table)} large sql query (${(0, colors_1.yellow)((0, js_lib_1._hb)(full.length))}) was split into ${(0, colors_1.yellow)(sqls.length)} chunks`);
+    logger.log(`${(0, colors_1.white)(table)} large sql query (${(0, colors_1.yellow)((0, js_lib_1._hb)(full.length))}) was split into ${(0, colors_1.yellow)(sqls.length)} chunks`);
     return sqls;
     // todo: handle "upsert" later
 }

package/dist/schema/mysql.schema.util.d.ts

@@ -1,4 +1,4 @@
-import { JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib';
+import { CommonLogger, JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib';
 export interface MySQLTableStats {
     Field: string;
     Type: string;
@@ -14,7 +14,7 @@ export interface MySQLSchemaOptions {
  * It currently skips nullability and declares everything as "DEFAULT NULL".
  */
 export declare function jsonSchemaToMySQLDDL(table: string, schema: JsonSchemaObject<any>, opt?: MySQLSchemaOptions): string;
-export declare function mysqlTableStatsToJsonSchemaField<T = any>(table: string, stats: MySQLTableStats[]): JsonSchemaRootObject<T>;
+export declare function mysqlTableStatsToJsonSchemaField<T = any>(table: string, stats: MySQLTableStats[], logger: CommonLogger): JsonSchemaRootObject<T>;
 /**
  * Because MySQL doesn't support `.` in field names and escapes them as tableName + fieldName.
  *

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

@@ -56,7 +56,7 @@ function jsonSchemaToMySQLDDL(table, schema, opt = {}) {
     return lines.join('\n');
 }
 exports.jsonSchemaToMySQLDDL = jsonSchemaToMySQLDDL;
-function mysqlTableStatsToJsonSchemaField(table, stats) {
+function mysqlTableStatsToJsonSchemaField(table, stats, logger) {
     const s = {
         $id: `${table}.schema.json`,
         type: 'object',
@@ -80,14 +80,14 @@ function mysqlTableStatsToJsonSchemaField(table, stats) {
         else if (t.startsWith('tinyint') || t.includes('(1)')) {
             s.properties[name] = { type: 'boolean' };
         }
-        else if (t.startsWith('int(')) {
+        else if (t === 'int' || t.startsWith('int(')) {
             s.properties[name] = { type: 'integer' };
         }
         else if (t.startsWith('float')) {
             s.properties[name] = { type: 'number' };
         }
         else {
-            console.log(s);
+            logger.log(s);
             throw new Error(`Unknown mysql field type ${name} ${stat.Type}`);
         }
     });

package/package.json

@@ -3,9 +3,6 @@
   "scripts": {
     "prepare": "husky install"
   },
-  "peerDependencies": {
-    "@naturalcycles/db-lib": ">=7.0.0"
-  },
   "dependencies": {
     "@naturalcycles/db-lib": "^8.16.2",
     "@naturalcycles/js-lib": "^14.47.0",
@@ -15,7 +12,7 @@
   },
   "devDependencies": {
     "@naturalcycles/dev-lib": "^12.7.5",
-    "@types/node": "^16.10.2",
+    "@types/node": "^17.0.5",
     "dotenv": "^10.0.0",
     "jest": "^27.2.4"
   },
@@ -39,7 +36,7 @@
   "engines": {
     "node": ">=14.15.0"
   },
-  "version": "3.8.0",
+  "version": "3.9.2",
   "description": "MySQL client implementing CommonDB interface",
   "keywords": [
     "mysql",

package/readme.md

@@ -3,12 +3,33 @@
 > MySQL client implementing CommonDB interface
 
 [![npm](https://img.shields.io/npm/v/@naturalcycles/mysql-lib/latest.svg)](https://www.npmjs.com/package/@naturalcycles/mysql-lib)
-[![](https://circleci.com/gh/NaturalCycles/mysql-lib.svg?style=shield&circle-token=123)](https://circleci.com/gh/NaturalCycles/mysql-lib)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 
-# Packaging
+# Quick start
 
-- `engines.node >= 10.13`: Latest Node.js LTS
-- `main: dist/index.js`: commonjs, es2018
-- `types: dist/index.d.ts`: typescript types
-- `/src` folder with source `*.ts` files included
+todo
+
+# Develop
+
+Install MySQL server+client on Mac:
+
+```shell
+
+brew install mysql
+
+# start
+
+mysql.server start
+
+# secure
+
+mysql_secure_installation
+
+# connect
+
+mysql -uroot
+
+# Default options are read from the following files in the given order:
+# /etc/my.cnf /etc/mysql/my.cnf /opt/homebrew/etc/my.cnf ~/.my.cnf
+
+```

package/src/mysql.db.ts

@@ -2,24 +2,26 @@ import { Transform } from 'stream'
 import { promisify } from 'util'
 import {
   BaseCommonDB,
-  BaseDBEntity,
   CommonDB,
   CommonDBCreateOptions,
   CommonDBOptions,
   CommonDBSaveOptions,
   DBQuery,
-  ObjectWithId,
   RunQueryResult,
 } from '@naturalcycles/db-lib'
 import {
-  _filterNullishValues,
+  _filterUndefinedValues,
   _mapKeys,
   _mapValues,
   _Memo,
+  AnyObjectWithId,
+  CommonLogger,
+  commonLoggerPrefix,
   JsonSchemaObject,
   JsonSchemaRootObject,
+  ObjectWithId,
 } from '@naturalcycles/js-lib'
-import { Debug, ReadableTyped } from '@naturalcycles/nodejs-lib'
+import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { white } from '@naturalcycles/nodejs-lib/dist/colors'
 import { Connection, Pool, PoolConfig, PoolConnection, QueryOptions, TypeCast } from 'mysql'
 import * as mysql from 'mysql'
@@ -32,7 +34,8 @@ import {
 } from './schema/mysql.schema.util'
 
 export interface MysqlDBOptions extends CommonDBOptions {}
-export interface MysqlDBSaveOptions extends CommonDBSaveOptions {}
+export interface MysqlDBSaveOptions<ROW extends ObjectWithId = AnyObjectWithId>
+  extends CommonDBSaveOptions<ROW> {}
 
 /**
  * @default false / undefined
@@ -47,9 +50,12 @@ export interface MysqlDBCfg extends PoolConfig {
    * If true - will emit logs of connection events.
    */
   debugConnections?: boolean
-}
 
-const log = Debug('nc:mysql-lib')
+  /**
+   * Default to `console`
+   */
+  logger?: CommonLogger
+}
 
 const BOOLEAN_TYPES = new Set(['TINY', 'TINYINT', 'INT'])
 const BOOLEAN_BIT_TYPES = new Set(['BIT'])
@@ -85,10 +91,11 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
       // password: MYSQL_PW,
       // database: MYSQL_DB,
       ...cfg,
+      logger: commonLoggerPrefix(cfg.logger || console, '[mysql]'),
     }
   }
 
-  cfg!: MysqlDBCfg
+  cfg: MysqlDBCfg & { logger: CommonLogger }
 
   override async ping(): Promise<void> {
     const con = await this.getConnection()
@@ -98,29 +105,29 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   @_Memo()
   pool(): Pool {
     const pool = mysql.createPool(this.cfg)
-    const { host, database } = this.cfg
-    log(`connected to ${white(host + '/' + database)}`)
+    const { host, database, logger } = this.cfg
+    logger.log(`connected to ${white(host + '/' + database)}`)
 
     if (this.cfg.debugConnections) {
       pool.on('acquire', con => {
-        log(`acquire(${con.threadId})`)
+        logger.log(`acquire(${con.threadId})`)
       })
 
       pool.on('connection', con => {
-        log(`connection(${con.threadId})`)
+        logger.log(`connection(${con.threadId})`)
       })
 
       pool.on('enqueue', () => {
-        log(`enqueue`)
+        logger.log(`enqueue`)
       })
 
       pool.on('release', con => {
-        log(`release(${con.threadId})`)
+        logger.log(`release(${con.threadId})`)
       })
     }
 
     pool.on('error', err => {
-      log.error(`error`, err)
+      logger.error(err)
     })
 
     return pool
@@ -129,7 +136,8 @@ 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))
+    await promisify(pool.end.bind(pool))()
+    this.cfg.logger.log('closed')
   }
 
   /**
@@ -150,16 +158,16 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     const { threadId } = con
 
     if (this.cfg.debugConnections) {
-      log(`createSingleConnection(${threadId})`)
+      this.cfg.logger.log(`createSingleConnection(${threadId})`)
 
-      con.on('connect', () => log(`createSingleConnection(${threadId}).connect`))
-      con.on('drain', () => log(`createSingleConnection(${threadId}).drain`))
-      con.on('enqueue', () => log(`createSingleConnection(${threadId}).enqueue`))
-      con.on('end', () => log(`createSingleConnection(${threadId}).end`))
+      con.on('connect', () => this.cfg.logger.log(`createSingleConnection(${threadId}).connect`))
+      con.on('drain', () => this.cfg.logger.log(`createSingleConnection(${threadId}).drain`))
+      con.on('enqueue', () => this.cfg.logger.log(`createSingleConnection(${threadId}).enqueue`))
+      con.on('end', () => this.cfg.logger.log(`createSingleConnection(${threadId}).end`))
     }
 
     con.on('error', err => {
-      log.error(`createSingleConnection(${threadId}).error`, err)
+      this.cfg.logger.error(`createSingleConnection(${threadId}).error`, err)
     })
 
     return con
@@ -183,14 +191,24 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     _opt: MysqlDBOptions = {},
   ): Promise<RunQueryResult<OUT>> {
     const sql = dbQueryToSQLSelect(q)
-    const rows = await this.runSQL<ROW[]>({ sql })
+    const rows = (await this.runSQL<ROW[]>({ sql })).map(
+      row => _mapKeys(_filterUndefinedValues(row, true), k => mapNameFromMySQL(k)) as any,
+    )
+
+    // edge case where 0 fields are selected
+    if (q._selectedFieldNames?.length === 0) {
+      return {
+        rows: rows.map(_ => ({} as any)),
+      }
+    }
+
     return {
-      rows: rows.map(r => _mapKeys(_filterNullishValues(r, true), k => mapNameFromMySQL(k)) as any),
+      rows,
     }
   }
 
   async runSQL<RESULT>(q: QueryOptions): Promise<RESULT> {
-    if (this.cfg.logSQL) log(q.sql, q.values)
+    if (this.cfg.logSQL) this.cfg.logger.log(...[q.sql, q.values].filter(Boolean))
 
     return await new Promise<RESULT>((resolve, reject) => {
       this.pool().query(q, (err, res) => {
@@ -204,7 +222,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     q: DBQuery<ROW>,
     _opt?: CommonDBOptions,
   ): Promise<number> {
-    const { rows } = await this.runQuery(q.select(['count(*) as _count']))
+    const { rows } = await this.runQuery(q.select(['count(*) as _count' as any]))
     return (rows[0] as any)._count
   }
 
@@ -214,7 +232,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   ): ReadableTyped<OUT> {
     const sql = dbQueryToSQLSelect(q)
 
-    if (this.cfg.logSQL) log(`stream: ${sql}`)
+    if (this.cfg.logSQL) this.cfg.logger.log(`stream: ${sql}`)
 
     // return this.streamSQL(sql, opt)
     return this.pool()
@@ -224,29 +242,29 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
         new Transform({
           objectMode: true,
           transform(row, _encoding, cb) {
-            cb(null, _filterNullishValues(row, true))
+            cb(null, _filterUndefinedValues(row, true))
           },
         }),
       )
   }
 
   // SAVE
-  override async saveBatch<ROW extends BaseDBEntity>(
+  override async saveBatch<ROW extends ObjectWithId>(
     table: string,
     _rows: ROW[],
-    _opt?: MysqlDBSaveOptions,
+    _opt?: MysqlDBSaveOptions<ROW>,
   ): Promise<void> {
     if (!_rows.length) return
 
     // Stringify object values
     const rows = _rows.map(row =>
-      _mapValues(row, v => {
+      _mapValues(row, (_k, v) => {
         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 = insertSQL(table, rows)
+    const sqls = insertSQL(table, rows, 'REPLACE', this.cfg.logger)
 
     for await (const sql of sqls) {
       await this.runSQL({ sql })
@@ -283,9 +301,9 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   /**
    * dropIfExists=true needed as a safety check
    */
-  override async createTable(
+  override async createTable<ROW extends ObjectWithId>(
     table: string,
-    schema: JsonSchemaObject,
+    schema: JsonSchemaObject<ROW>,
     opt: CommonDBCreateOptions = {},
   ): Promise<void> {
     if (opt.dropIfExists) await this.dropTable(table)
@@ -307,6 +325,6 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
       sql: `describe ${mysql.escapeId(table)}`,
     })
 
-    return mysqlTableStatsToJsonSchemaField<ROW>(table, stats)
+    return mysqlTableStatsToJsonSchemaField<ROW>(table, stats, this.cfg.logger)
   }
 }

package/src/query.util.ts

@@ -1,6 +1,6 @@
 import { DBQuery } from '@naturalcycles/db-lib'
 import { DBQueryFilterOperator } from '@naturalcycles/db-lib/src/query/dbQuery'
-import { _hb } from '@naturalcycles/js-lib'
+import { _hb, CommonLogger } from '@naturalcycles/js-lib'
 import { white, yellow } from '@naturalcycles/nodejs-lib/dist/colors'
 import { QueryOptions } from 'mysql'
 import * as mysql from 'mysql'
@@ -41,15 +41,16 @@ export function dbQueryToSQLDelete(q: DBQuery<any>): string {
  */
 export function insertSQL(
   table: string,
-  records: Record<any, any>[],
+  rows: Record<any, any>[],
   verb: 'INSERT' | 'REPLACE' = 'INSERT',
+  logger: CommonLogger = console,
 ): string[] {
   // INSERT INTO table_name (column1, column2, column3, ...)
   // VALUES (value1, value2, value3, ...);
 
   // eslint-disable-next-line unicorn/no-array-reduce
-  const fieldSet = records.reduce((set: Set<string>, rec) => {
-    Object.keys(rec).forEach(field => set.add(field))
+  const fieldSet = rows.reduce((set: Set<string>, row) => {
+    Object.keys(row).forEach(field => set.add(field))
     return set
   }, new Set<string>())
   const fields = [...fieldSet]
@@ -62,7 +63,7 @@ export function insertSQL(
     `VALUES\n`,
   ].join(' ')
 
-  const valueRows = records.map(rec => {
+  const valueRows = rows.map(rec => {
     return `(` + fields.map(k => mysql.escape(rec[k])).join(',') + `)`
   })
 
@@ -90,7 +91,7 @@ export function insertSQL(
     sqls.push(sql) // last one
   }
 
-  console.log(
+  logger.log(
     `${white(table)} large sql query (${yellow(_hb(full.length))}) was split into ${yellow(
       sqls.length,
     )} chunks`,
@@ -146,11 +147,11 @@ export function dbQueryToSQLUpdate(q: DBQuery<any>, record: Record<any, any>): s
   return mysql.format(tokens.join(' '), Object.values(record))
 }
 
-function selectTokens(q: DBQuery<any>): string[] {
+function selectTokens(q: DBQuery): string[] {
   let fields = ['*']
 
   if (q._selectedFieldNames) {
-    fields = q._selectedFieldNames.length ? q._selectedFieldNames : ['id']
+    fields = q._selectedFieldNames.length ? (q._selectedFieldNames as string[]) : ['id']
   }
 
   // We don't do `escapeId` cause it'll ruin e.g SELECT `count *` FROM ...
@@ -172,7 +173,7 @@ function offsetLimitTokens(q: DBQuery<any>): string[] {
   return tokens
 }
 
-function orderTokens(q: DBQuery<any>): string[] {
+function orderTokens(q: DBQuery): string[] {
   if (!q._orders.length) return []
   return [
     `ORDER BY`,
@@ -184,7 +185,7 @@ const OP_MAP: Partial<Record<DBQueryFilterOperator, string>> = {
   '==': '=',
 }
 
-function whereTokens(q: DBQuery<any>): string[] {
+function whereTokens(q: DBQuery): string[] {
   if (!q._filters.length) return []
 
   return [
@@ -195,18 +196,18 @@ function whereTokens(q: DBQuery<any>): string[] {
           // special treatment
 
           return [
-            mysql.escapeId(mapNameToMySQL(f.name)),
+            mysql.escapeId(mapNameToMySQL(f.name as string)),
             f.op === '==' ? 'IS NULL' : 'IS NOT NULL',
           ].join(' ')
         }
 
         if (Array.isArray(f.val)) {
           // special case for arrays
-          return `${mysql.escapeId(mapNameToMySQL(f.name))} IN (${mysql.escape(f.val)})`
+          return `${mysql.escapeId(mapNameToMySQL(f.name as string))} IN (${mysql.escape(f.val)})`
         }
 
         return [
-          mysql.escapeId(mapNameToMySQL(f.name)),
+          mysql.escapeId(mapNameToMySQL(f.name as string)),
           OP_MAP[f.op] || f.op,
           mysql.escape(f.val),
         ].join(' ')

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

@@ -1,4 +1,5 @@
 import {
+  CommonLogger,
   JsonSchemaBoolean,
   JsonSchemaNumber,
   JsonSchemaObject,
@@ -81,6 +82,7 @@ export function jsonSchemaToMySQLDDL(
 export function mysqlTableStatsToJsonSchemaField<T = any>(
   table: string,
   stats: MySQLTableStats[],
+  logger: CommonLogger,
 ): JsonSchemaRootObject<T> {
   const s: JsonSchemaRootObject<T> = {
     $id: `${table}.schema.json`,
@@ -104,12 +106,12 @@ export function mysqlTableStatsToJsonSchemaField<T = any>(
       s.properties[name] = { instanceof: 'Buffer' }
     } else if (t.startsWith('tinyint') || t.includes('(1)')) {
       s.properties[name] = { type: 'boolean' } as JsonSchemaBoolean
-    } else if (t.startsWith('int(')) {
+    } else if (t === 'int' || t.startsWith('int(')) {
       s.properties[name] = { type: 'integer' } as JsonSchemaNumber
     } else if (t.startsWith('float')) {
       s.properties[name] = { type: 'number' } as JsonSchemaNumber
     } else {
-      console.log(s)
+      logger.log(s)
       throw new Error(`Unknown mysql field type ${name} ${stat.Type}`)
     }
   })

package/CHANGELOG.md

@@ -1,198 +0,0 @@
-# [3.8.0](https://github.com/NaturalCycles/mysql-lib/compare/v3.7.1...v3.8.0) (2021-10-04)
-
-
-### Features
-
-* modernize ([6e8f0a2](https://github.com/NaturalCycles/mysql-lib/commit/6e8f0a254a67902cbc185f034f58cd4f6885449d))
-
-## [3.7.1](https://github.com/NaturalCycles/mysql-lib/compare/v3.7.0...v3.7.1) (2020-06-03)
-
-
-### Bug Fixes
-
-* modernize ([517f695](https://github.com/NaturalCycles/mysql-lib/commit/517f6952feb15059730f4f7443a295bf596053fc))
-
-# [3.7.0](https://github.com/NaturalCycles/mysql-lib/compare/v3.6.0...v3.7.0) (2020-04-08)
-
-
-### Features
-
-* modernize ([e0e2890](https://github.com/NaturalCycles/mysql-lib/commit/e0e2890cb31e88fcbdae63c417d6cc5c6a52d4e8))
-
-# [3.6.0](https://github.com/NaturalCycles/mysql-lib/compare/v3.5.2...v3.6.0) (2020-03-01)
-
-
-### Features
-
-* deps ([008aa10](https://github.com/NaturalCycles/mysql-lib/commit/008aa10d059734d76c2354553a8dc35c8117b3b2))
-
-## [3.5.2](https://github.com/NaturalCycles/mysql-lib/compare/v3.5.1...v3.5.2) (2019-11-20)
-
-
-### Bug Fixes
-
-* BIT typecast to boolean correctly ([0bc815e](https://github.com/NaturalCycles/mysql-lib/commit/0bc815e025a33ab9fae5405c8b97dd53aae392ca))
-
-## [3.5.1](https://github.com/NaturalCycles/mysql-lib/compare/v3.5.0...v3.5.1) (2019-11-20)
-
-
-### Bug Fixes
-
-* correctly type-cast booleans with value=NULL ([e208b4c](https://github.com/NaturalCycles/mysql-lib/commit/e208b4ca16f700b6ed7bf95c872f68f934894992))
-
-# [3.5.0](https://github.com/NaturalCycles/mysql-lib/compare/v3.4.0...v3.5.0) (2019-11-09)
-
-
-### Features
-
-* implement getDBAdapter. Allow empty (default) configuration ([bcf12dc](https://github.com/NaturalCycles/mysql-lib/commit/bcf12dc9360f525749f9bb10965046b4c56d849a))
-
-# [3.4.0](https://github.com/NaturalCycles/mysql-lib/compare/v3.3.1...v3.4.0) (2019-11-09)
-
-
-### Features
-
-* auto JSON.stringify objects (and arrays) ([0d9aaed](https://github.com/NaturalCycles/mysql-lib/commit/0d9aaedf8f2920a51dacf13b6723eb98c61b34c3))
-
-## [3.3.1](https://github.com/NaturalCycles/mysql-lib/compare/v3.3.0...v3.3.1) (2019-11-09)
-
-
-### Bug Fixes
-
-* use LONGBLOB for binary columns ([ae4facc](https://github.com/NaturalCycles/mysql-lib/commit/ae4facc76bc03b8aafa5141199a98bef530f6913))
-
-# [3.3.0](https://github.com/NaturalCycles/mysql-lib/compare/v3.2.1...v3.3.0) (2019-11-09)
-
-
-### Features
-
-* mapNameToMySQL ([c4bf40c](https://github.com/NaturalCycles/mysql-lib/commit/c4bf40cd6aefaf78219a2588ec803cf74004bc07))
-
-## [3.2.1](https://github.com/NaturalCycles/mysql-lib/compare/v3.2.0...v3.2.1) (2019-11-09)
-
-
-### Bug Fixes
-
-* createTable() ([7983085](https://github.com/NaturalCycles/mysql-lib/commit/7983085017562a4e4a8f7dd38eb41ae6b9fc30ed))
-
-# [3.2.0](https://github.com/NaturalCycles/mysql-lib/compare/v3.1.0...v3.2.0) (2019-11-09)
-
-
-### Bug Fixes
-
-* emoji support ([1262fc4](https://github.com/NaturalCycles/mysql-lib/commit/1262fc4d9ad39c818833b5cfc31b3a65979cdea0))
-
-
-### Features
-
-* auto split long sql queries ([c7c780f](https://github.com/NaturalCycles/mysql-lib/commit/c7c780f295d7ded9f418509f3160a512ec54c7e7))
-
-# [3.1.0](https://github.com/NaturalCycles/mysql-lib/compare/v3.0.0...v3.1.0) (2019-11-08)
-
-
-### Features
-
-* commonSchemaToMySQLDDL ([09168c5](https://github.com/NaturalCycles/mysql-lib/commit/09168c563cbb629ca47121a1aac6a125dd23c144))
-* implement getTables(), getTableSchema() ([20a7746](https://github.com/NaturalCycles/mysql-lib/commit/20a7746c8c4c88dfca8365d1e8d2decce3f47efa))
-
-# [3.0.0](https://github.com/NaturalCycles/mysql-lib/compare/v2.0.2...v3.0.0) (2019-11-02)
-
-
-### Features
-
-* adapt to db-lib@3 ([7d13f54](https://github.com/NaturalCycles/mysql-lib/commit/7d13f540c92dd59b014d1a502c1bff937fad567f))
-
-
-### BREAKING CHANGES
-
-* ^^^
-
-## [2.0.2](https://github.com/NaturalCycles/mysql-lib/compare/v2.0.1...v2.0.2) (2019-10-20)
-
-
-### Bug Fixes
-
-* adopt to db-lib ([6da7d78](https://github.com/NaturalCycles/mysql-lib/commit/6da7d78))
-
-## [2.0.1](https://github.com/NaturalCycles/mysql-lib/compare/v2.0.0...v2.0.1) (2019-10-19)
-
-
-### Bug Fixes
-
-* use Readable ([a0d09c1](https://github.com/NaturalCycles/mysql-lib/commit/a0d09c1))
-
-# [2.0.0](https://github.com/NaturalCycles/mysql-lib/compare/v1.7.1...v2.0.0) (2019-10-18)
-
-
-### Features
-
-* implement CommonDB 2.0 ([9de0e9f](https://github.com/NaturalCycles/mysql-lib/commit/9de0e9f))
-
-
-### BREAKING CHANGES
-
-* ^^^
-
-## [1.7.1](https://github.com/NaturalCycles/mysql-lib/compare/v1.7.0...v1.7.1) (2019-10-18)
-
-
-### Bug Fixes
-
-* pin @types/hapi__joi ([3e3cf5a](https://github.com/NaturalCycles/mysql-lib/commit/3e3cf5a))
-
-# [1.7.0](https://github.com/NaturalCycles/mysql-lib/compare/v1.6.0...v1.7.0) (2019-09-30)
-
-
-### Features
-
-* tiny change to use pool.query inst of getConnection() ([6ffe1b4](https://github.com/NaturalCycles/mysql-lib/commit/6ffe1b4))
-
-# [1.6.0](https://github.com/NaturalCycles/mysql-lib/compare/v1.5.0...v1.6.0) (2019-09-30)
-
-
-### Features
-
-* offset ([78710a1](https://github.com/NaturalCycles/mysql-lib/commit/78710a1))
-
-# [1.5.0](https://github.com/NaturalCycles/mysql-lib/compare/v1.4.0...v1.5.0) (2019-09-30)
-
-
-### Features
-
-* testing simpler streamSQL impl ([0887aa3](https://github.com/NaturalCycles/mysql-lib/commit/0887aa3))
-
-# [1.4.0](https://github.com/NaturalCycles/mysql-lib/compare/v1.3.0...v1.4.0) (2019-09-30)
-
-
-### Features
-
-* stream to use it's own separate connection ([43615f3](https://github.com/NaturalCycles/mysql-lib/commit/43615f3))
-
-# [1.3.0](https://github.com/NaturalCycles/mysql-lib/compare/v1.2.0...v1.3.0) (2019-09-30)
-
-
-### Features
-
-* cfg.debugConnections ([70218ba](https://github.com/NaturalCycles/mysql-lib/commit/70218ba))
-
-# [1.2.0](https://github.com/NaturalCycles/mysql-lib/compare/v1.1.0...v1.2.0) (2019-09-28)
-
-
-### Features
-
-* add BIT cast to boolean ([899cce4](https://github.com/NaturalCycles/mysql-lib/commit/899cce4))
-
-# [1.1.0](https://github.com/NaturalCycles/mysql-lib/compare/v1.0.0...v1.1.0) (2019-09-21)
-
-
-### Features
-
-* modernize, implement saveBatch ([5595b6a](https://github.com/NaturalCycles/mysql-lib/commit/5595b6a))
-
-# 1.0.0 (2019-06-03)
-
-
-### Features
-
-* first version ([02620fb](https://github.com/NaturalCycles/mysql-lib/commit/02620fb))
-* init project by create-module ([eee50b7](https://github.com/NaturalCycles/mysql-lib/commit/eee50b7))