@naturalcycles/mysql-lib 3.11.2 → 3.12.2

package/dist/mysql.db.d.ts

@@ -50,7 +50,7 @@ export declare class MysqlDB extends BaseCommonDB implements CommonDB {
     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, _rows: ROW[], opt?: MysqlDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends Partial<ObjectWithId>>(table: string, rowsInput: ROW[], opt?: MysqlDBSaveOptions<ROW>): Promise<void>;
     /**
      * Limitation: always returns [], regardless of which rows are actually deleted
      */

package/dist/mysql.db.js

@@ -116,6 +116,11 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
     // QUERY
     async runQuery(q, _opt = {}) {
         const sql = (0, query_util_1.dbQueryToSQLSelect)(q);
+        if (!sql) {
+            return {
+                rows: [],
+            };
+        }
         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) {
@@ -157,6 +162,9 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
     }
     streamQuery(q, _opt = {}) {
         const sql = (0, query_util_1.dbQueryToSQLSelect)(q);
+        if (!sql) {
+            return stream_1.Readable.from([]);
+        }
         if (this.cfg.logSQL)
             this.cfg.logger.log(`stream: ${sql}`);
         // return this.streamSQL(sql, opt)
@@ -171,15 +179,28 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         }));
     }
     // SAVE
-    async saveBatch(table, _rows, opt = {}) {
-        if (!_rows.length)
+    async saveBatch(table, rowsInput, opt = {}) {
+        if (!rowsInput.length)
             return;
         // Stringify object values
-        const rows = _rows.map(row => (0, js_lib_1._mapValues)(row, (_k, v) => {
+        const rows = rowsInput.map(row => (0, js_lib_1._mapValues)(row, (_k, v) => {
             return v && typeof v === 'object' && !Buffer.isBuffer(v) ? JSON.stringify(v) : v;
         }));
+        const verb = opt.saveMethod === 'insert' ? 'INSERT' : 'REPLACE';
+        if (opt.assignGeneratedIds) {
+            // Insert rows one-by-one, to get their auto-generated id
+            let i = -1;
+            for await (const row of rows) {
+                i++;
+                const sql = (0, query_util_1.insertSQL)(table, [row], verb, this.cfg.logger)[0];
+                const { insertId } = await this.runSQL({ sql });
+                // Mutate the input row with insertIt
+                rowsInput[i].id = insertId;
+            }
+            return;
+        }
         // inserts are split into multiple sentenses to respect the max_packet_size (1Mb usually)
-        const sqls = (0, query_util_1.insertSQL)(table, rows, opt.saveMethod === 'insert' ? 'INSERT' : 'REPLACE', this.cfg.logger);
+        const sqls = (0, query_util_1.insertSQL)(table, rows, verb, this.cfg.logger);
         for await (const sql of sqls) {
             await this.runSQL({ sql });
         }
@@ -192,13 +213,17 @@ class MysqlDB extends db_lib_1.BaseCommonDB {
         if (!ids.length)
             return 0;
         const sql = (0, query_util_1.dbQueryToSQLDelete)(new db_lib_1.DBQuery(table).filterEq('id', ids));
-        const res = await this.runSQL({ sql });
-        return res.affectedRows;
+        if (!sql)
+            return 0;
+        const { affectedRows } = await this.runSQL({ sql });
+        return affectedRows;
     }
     async deleteByQuery(q, _opt) {
         const sql = (0, query_util_1.dbQueryToSQLDelete)(q);
-        const res = await this.runSQL({ sql });
-        return res.affectedRows;
+        if (!sql)
+            return 0;
+        const { affectedRows } = await this.runSQL({ sql });
+        return affectedRows;
     }
     /**
      * Use with caution!

package/dist/query.util.d.ts

@@ -1,12 +1,19 @@
 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 `null` if it detects that 0 rows will be returned,
+ * e.g when `IN ()` (empty array) is used.
+ */
+export declare function dbQueryToSQLSelect(q: DBQuery<any>): string | null;
+/**
+ * Returns null in "0 rows" case.
+ */
+export declare function dbQueryToSQLDelete(q: DBQuery<any>): string | null;
 /**
  * Returns array of sql statements to respect the max sql size.
  */
 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;
+export declare function dbQueryToSQLUpdate(q: DBQuery<any>, record: Record<any, any>): string | null;

package/dist/query.util.js

@@ -7,10 +7,17 @@ const mysql = 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
+/**
+ * Returns `null` if it detects that 0 rows will be returned,
+ * e.g when `IN ()` (empty array) is used.
+ */
 function dbQueryToSQLSelect(q) {
     const tokens = selectTokens(q);
     // filters
-    tokens.push(...whereTokens(q));
+    const whereTokens = getWhereTokens(q);
+    if (!whereTokens)
+        return null;
+    tokens.push(...whereTokens);
     // order
     tokens.push(...groupOrderTokens(q));
     // offset/limit
@@ -18,10 +25,16 @@ function dbQueryToSQLSelect(q) {
     return tokens.join(' ');
 }
 exports.dbQueryToSQLSelect = dbQueryToSQLSelect;
+/**
+ * Returns null in "0 rows" case.
+ */
 function dbQueryToSQLDelete(q) {
     const tokens = [`DELETE FROM`, mysql.escapeId(q.table)];
     // filters
-    tokens.push(...whereTokens(q));
+    const whereTokens = getWhereTokens(q);
+    if (!whereTokens)
+        return null;
+    tokens.push(...whereTokens);
     // offset/limit
     tokens.push(...offsetLimitTokens(q));
     return tokens.join(' ');
@@ -106,6 +119,9 @@ function insertSQLSetSingle(table, record) {
 exports.insertSQLSetSingle = insertSQLSetSingle;
 function dbQueryToSQLUpdate(q, record) {
     // var sql = mysql.format('UPDATE posts SET modified = ? WHERE id = ?', [CURRENT_TIMESTAMP, 42]);
+    const whereTokens = getWhereTokens(q);
+    if (!whereTokens)
+        return null;
     const tokens = [
         `UPDATE`,
         mysql.escapeId(q.table),
@@ -113,7 +129,7 @@ function dbQueryToSQLUpdate(q, record) {
         Object.keys(record)
             .map(f => mysql.escapeId((0, mysql_schema_util_1.mapNameToMySQL)(f)) + ' = ?')
             .join(', '),
-        ...whereTokens(q),
+        ...whereTokens,
     ];
     return mysql.format(tokens.join(' '), Object.values(record));
 }
@@ -156,10 +172,14 @@ function groupOrderTokens(q) {
 const OP_MAP = {
     '==': '=',
 };
-function whereTokens(q) {
+/**
+ * Returns `null` for "guaranteed 0 rows" cases.
+ */
+function getWhereTokens(q) {
     if (!q._filters.length)
         return [];
-    return [
+    let returnNull = false;
+    const tokens = [
         `WHERE`,
         q._filters
             .map(f => {
@@ -172,6 +192,8 @@ function whereTokens(q) {
             }
             if (Array.isArray(f.val)) {
                 // special case for arrays
+                if (!f.val.length)
+                    returnNull = true;
                 return `${mysql.escapeId((0, mysql_schema_util_1.mapNameToMySQL)(f.name))} IN (${mysql.escape(f.val)})`;
             }
             return [
@@ -182,4 +204,7 @@ function whereTokens(q) {
         })
             .join(' AND '),
     ];
+    if (returnNull)
+        return null;
+    return tokens;
 }

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

@@ -1,4 +1,4 @@
-import { CommonLogger, JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib';
+import { AnyObject, 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[], logger: CommonLogger): JsonSchemaRootObject<T>;
+export declare function mysqlTableStatsToJsonSchemaField<T extends AnyObject = any>(table: string, stats: MySQLTableStats[], logger: CommonLogger): JsonSchemaRootObject<T>;
 /**
  * Because MySQL doesn't support `.` in field names and escapes them as tableName + fieldName.
  *

package/package.json

@@ -11,10 +11,10 @@
     "mysql": "^2.17.1"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "^12.7.5",
-    "@types/node": "^17.0.5",
+    "@naturalcycles/dev-lib": "^13.2.1",
+    "@types/node": "^18.7.13",
     "dotenv": "^16.0.0",
-    "jest": "^27.2.4"
+    "jest": "^29.0.0"
   },
   "files": [
     "dist",
@@ -36,7 +36,7 @@
   "engines": {
     "node": ">=14.15.0"
   },
-  "version": "3.11.2",
+  "version": "3.12.2",
   "description": "MySQL client implementing CommonDB interface",
   "keywords": [
     "mysql",

package/src/mysql.db.ts

@@ -1,4 +1,4 @@
-import { Transform } from 'stream'
+import { Readable, Transform } from 'stream'
 import { promisify } from 'util'
 import {
   BaseCommonDB,
@@ -23,7 +23,15 @@ import {
 } from '@naturalcycles/js-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 {
+  Connection,
+  OkPacket,
+  Pool,
+  PoolConfig,
+  PoolConnection,
+  QueryOptions,
+  TypeCast,
+} from 'mysql'
 import * as mysql from 'mysql'
 import { dbQueryToSQLDelete, dbQueryToSQLSelect, insertSQL } from './query.util'
 import {
@@ -191,6 +199,12 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     _opt: MysqlDBOptions = {},
   ): Promise<RunQueryResult<OUT>> {
     const sql = dbQueryToSQLSelect(q)
+    if (!sql) {
+      return {
+        rows: [],
+      }
+    }
+
     const rows = (await this.runSQL<ROW[]>({ sql })).map(
       row => _mapKeys(_filterUndefinedValues(row, true), k => mapNameFromMySQL(k)) as any,
     )
@@ -246,6 +260,9 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     _opt: MysqlDBOptions = {},
   ): ReadableTyped<OUT> {
     const sql = dbQueryToSQLSelect(q)
+    if (!sql) {
+      return Readable.from([])
+    }
 
     if (this.cfg.logSQL) this.cfg.logger.log(`stream: ${sql}`)
 
@@ -266,25 +283,38 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   // SAVE
   override async saveBatch<ROW extends Partial<ObjectWithId>>(
     table: string,
-    _rows: ROW[],
+    rowsInput: ROW[],
     opt: MysqlDBSaveOptions<ROW> = {},
   ): Promise<void> {
-    if (!_rows.length) return
+    if (!rowsInput.length) return
 
     // Stringify object values
-    const rows = _rows.map(row =>
+    const rows = rowsInput.map(row =>
       _mapValues(row, (_k, v) => {
         return v && typeof v === 'object' && !Buffer.isBuffer(v) ? JSON.stringify(v) : v
       }),
     )
 
+    const verb = opt.saveMethod === 'insert' ? 'INSERT' : 'REPLACE'
+
+    if (opt.assignGeneratedIds) {
+      // Insert rows one-by-one, to get their auto-generated id
+
+      let i = -1
+      for await (const row of rows) {
+        i++
+        const sql = insertSQL(table, [row], verb, this.cfg.logger)[0]!
+        const { insertId } = await this.runSQL<OkPacket>({ sql })
+
+        // Mutate the input row with insertIt
+        rowsInput[i]!.id = insertId
+      }
+
+      return
+    }
+
     // inserts are split into multiple sentenses to respect the max_packet_size (1Mb usually)
-    const sqls = insertSQL(
-      table,
-      rows,
-      opt.saveMethod === 'insert' ? 'INSERT' : 'REPLACE',
-      this.cfg.logger,
-    )
+    const sqls = insertSQL(table, rows, verb, this.cfg.logger)
 
     for await (const sql of sqls) {
       await this.runSQL({ sql })
@@ -302,8 +332,10 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   ): Promise<number> {
     if (!ids.length) return 0
     const sql = dbQueryToSQLDelete(new DBQuery(table).filterEq('id', ids))
-    const res = await this.runSQL<any>({ sql })
-    return res.affectedRows
+    if (!sql) return 0
+
+    const { affectedRows } = await this.runSQL<OkPacket>({ sql })
+    return affectedRows
   }
 
   override async deleteByQuery<ROW extends ObjectWithId>(
@@ -311,8 +343,9 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     _opt?: CommonDBOptions,
   ): Promise<number> {
     const sql = dbQueryToSQLDelete(q)
-    const res = await this.runSQL<any>({ sql })
-    return res.affectedRows
+    if (!sql) return 0
+    const { affectedRows } = await this.runSQL<OkPacket>({ sql })
+    return affectedRows
   }
 
   /**

package/src/query.util.ts

@@ -1,5 +1,4 @@
-import { DBQuery } from '@naturalcycles/db-lib'
-import { DBQueryFilterOperator } from '@naturalcycles/db-lib/src/query/dbQuery'
+import { DBQuery, DBQueryFilterOperator } from '@naturalcycles/db-lib'
 import { _hb, CommonLogger } from '@naturalcycles/js-lib'
 import { white, yellow } from '@naturalcycles/nodejs-lib/dist/colors'
 import { QueryOptions } from 'mysql'
@@ -9,11 +8,17 @@ import { mapNameToMySQL } from './schema/mysql.schema.util'
 const MAX_PACKET_SIZE = 1024 * 1024 // 1Mb
 const MAX_ROW_SIZE = 800 * 1024 // 1Mb - margin
 
-export function dbQueryToSQLSelect(q: DBQuery<any>): string {
+/**
+ * Returns `null` if it detects that 0 rows will be returned,
+ * e.g when `IN ()` (empty array) is used.
+ */
+export function dbQueryToSQLSelect(q: DBQuery<any>): string | null {
   const tokens = selectTokens(q)
 
   // filters
-  tokens.push(...whereTokens(q))
+  const whereTokens = getWhereTokens(q)
+  if (!whereTokens) return null
+  tokens.push(...whereTokens)
 
   // order
   tokens.push(...groupOrderTokens(q))
@@ -24,11 +29,16 @@ export function dbQueryToSQLSelect(q: DBQuery<any>): string {
   return tokens.join(' ')
 }
 
-export function dbQueryToSQLDelete(q: DBQuery<any>): string {
+/**
+ * Returns null in "0 rows" case.
+ */
+export function dbQueryToSQLDelete(q: DBQuery<any>): string | null {
   const tokens = [`DELETE FROM`, mysql.escapeId(q.table)]
 
   // filters
-  tokens.push(...whereTokens(q))
+  const whereTokens = getWhereTokens(q)
+  if (!whereTokens) return null
+  tokens.push(...whereTokens)
 
   // offset/limit
   tokens.push(...offsetLimitTokens(q))
@@ -132,8 +142,11 @@ export function insertSQLSetSingle(table: string, record: Record<any, any>): Que
   }
 }
 
-export function dbQueryToSQLUpdate(q: DBQuery<any>, record: Record<any, any>): string {
+export function dbQueryToSQLUpdate(q: DBQuery<any>, record: 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
+
   const tokens = [
     `UPDATE`,
     mysql.escapeId(q.table),
@@ -141,7 +154,7 @@ export function dbQueryToSQLUpdate(q: DBQuery<any>, record: Record<any, any>): s
     Object.keys(record)
       .map(f => mysql.escapeId(mapNameToMySQL(f)) + ' = ?')
       .join(', '),
-    ...whereTokens(q),
+    ...whereTokens,
   ]
 
   return mysql.format(tokens.join(' '), Object.values(record))
@@ -200,10 +213,15 @@ const OP_MAP: Partial<Record<DBQueryFilterOperator, string>> = {
   '==': '=',
 }
 
-function whereTokens(q: DBQuery): string[] {
+/**
+ * Returns `null` for "guaranteed 0 rows" cases.
+ */
+function getWhereTokens(q: DBQuery): string[] | null {
   if (!q._filters.length) return []
 
-  return [
+  let returnNull = false
+
+  const tokens = [
     `WHERE`,
     q._filters
       .map(f => {
@@ -218,6 +236,8 @@ function whereTokens(q: DBQuery): string[] {
 
         if (Array.isArray(f.val)) {
           // special case for arrays
+          if (!f.val.length) returnNull = true
+
           return `${mysql.escapeId(mapNameToMySQL(f.name as string))} IN (${mysql.escape(f.val)})`
         }
 
@@ -229,4 +249,8 @@ function whereTokens(q: DBQuery): string[] {
       })
       .join(' AND '),
   ]
+
+  if (returnNull) return null
+
+  return tokens
 }

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

@@ -1,4 +1,5 @@
 import {
+  AnyObject,
   CommonLogger,
   JsonSchemaBoolean,
   JsonSchemaNumber,
@@ -79,7 +80,7 @@ export function jsonSchemaToMySQLDDL(
   return lines.join('\n')
 }
 
-export function mysqlTableStatsToJsonSchemaField<T = any>(
+export function mysqlTableStatsToJsonSchemaField<T extends AnyObject = any>(
   table: string,
   stats: MySQLTableStats[],
   logger: CommonLogger,
@@ -93,7 +94,7 @@ export function mysqlTableStatsToJsonSchemaField<T = any>(
   }
 
   stats.forEach(stat => {
-    const name = stat.Field
+    const name = stat.Field as keyof T
     const t = stat.Type.toLowerCase()
     const notNull = stat.Null?.toUpperCase() !== 'YES'
     if (notNull) {
@@ -112,7 +113,7 @@ export function mysqlTableStatsToJsonSchemaField<T = any>(
       s.properties[name] = { type: 'number' } as JsonSchemaNumber
     } else {
       logger.log(s)
-      throw new Error(`Unknown mysql field type ${name} ${stat.Type}`)
+      throw new Error(`Unknown mysql field type ${name as string} ${stat.Type}`)
     }
   })