@naturalcycles/mysql-lib 3.9.2 → 3.11.1

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 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, jsonSchemaToMySQLDDL, getDBAdapter };
+export { MysqlDB, MySQLKeyValueDB, jsonSchemaToMySQLDDL, getDBAdapter };

package/dist/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDBAdapter = exports.jsonSchemaToMySQLDDL = exports.MysqlDB = void 0;
+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");
 Object.defineProperty(exports, "jsonSchemaToMySQLDDL", { enumerable: true, get: function () { return mysql_schema_util_1.jsonSchemaToMySQLDDL; } });

package/dist/mysql.db.d.ts

@@ -40,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>;
     /**
      * 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

@@ -138,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;
@@ -214,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

@@ -0,0 +1,25 @@
+/// <reference types="node" />
+import { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@naturalcycles/db-lib';
+import { ReadableTyped } from '@naturalcycles/nodejs-lib';
+import { MysqlDB, MysqlDBCfg } from './mysql.db';
+export declare class MySQLKeyValueDB implements CommonKeyValueDB {
+    cfg: MysqlDBCfg;
+    constructor(cfg: MysqlDBCfg);
+    db: MysqlDB;
+    ping(): Promise<void>;
+    close(): Promise<void>;
+    createTable(table: string, opt?: CommonDBCreateOptions): Promise<void>;
+    getByIds(table: string, ids: string[]): Promise<KeyValueDBTuple[]>;
+    /**
+     * Use with caution!
+     */
+    dropTable(table: string): Promise<void>;
+    deleteByIds(table: string, ids: string[]): Promise<void>;
+    saveBatch(table: string, entries: KeyValueDBTuple[]): Promise<void>;
+    streamIds(table: string, limit?: number): ReadableTyped<string>;
+    streamValues(table: string, limit?: number): ReadableTyped<Buffer>;
+    streamEntries(table: string, limit?: number): ReadableTyped<KeyValueDBTuple>;
+    beginTransaction(): Promise<void>;
+    endTransaction(): Promise<void>;
+    count(table: string): Promise<number>;
+}

package/dist/mysqlKeyValueDB.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MySQLKeyValueDB = void 0;
+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 = cfg;
+        this.db = new mysql_db_1.MysqlDB(this.cfg);
+    }
+    async ping() {
+        await this.db.ping();
+    }
+    async close() {
+        await this.db.close();
+    }
+    async createTable(table, opt = {}) {
+        if (opt.dropIfExists)
+            await this.dropTable(table);
+        // On blob sizes: https://tableplus.com/blog/2019/10/tinyblob-blob-mediumblob-longblob.html
+        // LONGBLOB supports up to 4gb
+        // MEDIUMBLOB up to 16Mb
+        const sql = `create table ${table} (id VARCHAR(64) PRIMARY KEY, v LONGBLOB NOT NULL)`;
+        this.db.cfg.logger.log(sql);
+        await this.db.runSQL({ sql });
+    }
+    async getByIds(table, ids) {
+        if (!ids.length)
+            return [];
+        const sql = `SELECT id,v FROM ${table} where id in (${ids.map(id => `"${id}"`).join(',')})`;
+        const rows = await this.db.runSQL({ sql });
+        return rows.map(({ id, v }) => [id, v]);
+    }
+    /**
+     * Use with caution!
+     */
+    async dropTable(table) {
+        await this.db.runSQL({ sql: `DROP TABLE IF EXISTS ${table}` });
+    }
+    async deleteByIds(table, ids) {
+        const sql = `DELETE FROM ${table} WHERE id in (${ids.map(id => `"${id}"`).join(',')})`;
+        if (this.cfg.logSQL)
+            this.db.cfg.logger.log(sql);
+        await this.db.runSQL({ sql });
+    }
+    async saveBatch(table, entries) {
+        const statements = entries.map(([id, buf]) => {
+            return {
+                sql: `INSERT INTO ${table} (id, v) VALUES (?, ?)`,
+                values: [id, buf],
+            };
+        });
+        await (0, js_lib_1.pMap)(statements, async (statement) => {
+            if (this.cfg.debug)
+                this.db.cfg.logger.log(statement.sql);
+            await this.db.runSQL(statement);
+        });
+    }
+    streamIds(table, limit) {
+        let sql = `SELECT id FROM ${table}`;
+        if (limit)
+            sql += ` LIMIT ${limit}`;
+        if (this.cfg.logSQL)
+            this.db.cfg.logger.log(`stream: ${sql}`);
+        return this.db
+            .pool()
+            .query(sql)
+            .stream()
+            .pipe(new stream_1.Transform({
+            objectMode: true,
+            transform(row, _, cb) {
+                cb(null, row.id);
+            },
+        }));
+    }
+    streamValues(table, limit) {
+        let sql = `SELECT v FROM ${table}`;
+        if (limit)
+            sql += ` LIMIT ${limit}`;
+        if (this.cfg.logSQL)
+            this.db.cfg.logger.log(`stream: ${sql}`);
+        return this.db
+            .pool()
+            .query(sql)
+            .stream()
+            .pipe(new stream_1.Transform({
+            objectMode: true,
+            transform(row, _, cb) {
+                cb(null, row.v);
+            },
+        }));
+    }
+    streamEntries(table, limit) {
+        let sql = `SELECT id,v FROM ${table}`;
+        if (limit)
+            sql += ` LIMIT ${limit}`;
+        if (this.cfg.logSQL)
+            this.db.cfg.logger.log(`stream: ${sql}`);
+        return this.db
+            .pool()
+            .query(sql)
+            .stream()
+            .pipe(new stream_1.Transform({
+            objectMode: true,
+            transform(row, _, cb) {
+                cb(null, [row.id, row.v]);
+            },
+        }));
+    }
+    async beginTransaction() {
+        await this.db.runSQL({ sql: `BEGIN TRANSACTION` });
+    }
+    async endTransaction() {
+        await this.db.runSQL({ sql: `END TRANSACTION` });
+    }
+    async count(table) {
+        const sql = `SELECT count(*) as cnt FROM ${table}`;
+        if (this.cfg.logSQL)
+            this.db.cfg.logger.log(sql);
+        const rows = await this.db.runSQL({ sql });
+        return rows[0].cnt;
+    }
+}
+exports.MySQLKeyValueDB = MySQLKeyValueDB;

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.9.2",
+  "version": "3.11.1",
   "description": "MySQL client implementing CommonDB interface",
   "keywords": [
     "mysql",

package/src/index.ts

@@ -1,7 +1,8 @@
 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, jsonSchemaToMySQLDDL, getDBAdapter }
+export { MysqlDB, MySQLKeyValueDB, jsonSchemaToMySQLDDL, getDBAdapter }

package/src/mysql.db.ts

@@ -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,
@@ -275,7 +290,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

@@ -0,0 +1,148 @@
+import { Transform } from 'stream'
+import { CommonDBCreateOptions, CommonKeyValueDB, KeyValueDBTuple } from '@naturalcycles/db-lib'
+import { pMap } from '@naturalcycles/js-lib'
+import { ReadableTyped } from '@naturalcycles/nodejs-lib'
+import { QueryOptions } from 'mysql'
+import { MysqlDB, MysqlDBCfg } from './mysql.db'
+
+interface KeyValueObject {
+  id: string
+  v: Buffer
+}
+
+export class MySQLKeyValueDB implements CommonKeyValueDB {
+  constructor(public cfg: MysqlDBCfg) {
+    this.db = new MysqlDB(this.cfg)
+  }
+
+  db: MysqlDB
+
+  async ping(): Promise<void> {
+    await this.db.ping()
+  }
+
+  async close(): Promise<void> {
+    await this.db.close()
+  }
+
+  async createTable(table: string, opt: CommonDBCreateOptions = {}): Promise<void> {
+    if (opt.dropIfExists) await this.dropTable(table)
+
+    // On blob sizes: https://tableplus.com/blog/2019/10/tinyblob-blob-mediumblob-longblob.html
+    // LONGBLOB supports up to 4gb
+    // MEDIUMBLOB up to 16Mb
+    const sql = `create table ${table} (id VARCHAR(64) PRIMARY KEY, v LONGBLOB NOT NULL)`
+    this.db.cfg.logger.log(sql)
+    await this.db.runSQL({ sql })
+  }
+
+  async getByIds(table: string, ids: string[]): Promise<KeyValueDBTuple[]> {
+    if (!ids.length) return []
+
+    const sql = `SELECT id,v FROM ${table} where id in (${ids.map(id => `"${id}"`).join(',')})`
+
+    const rows = await this.db.runSQL<KeyValueObject[]>({ sql })
+
+    return rows.map(({ id, v }) => [id, v])
+  }
+
+  /**
+   * Use with caution!
+   */
+  async dropTable(table: string): Promise<void> {
+    await this.db.runSQL({ sql: `DROP TABLE IF EXISTS ${table}` })
+  }
+
+  async deleteByIds(table: string, ids: string[]): Promise<void> {
+    const sql = `DELETE FROM ${table} WHERE id in (${ids.map(id => `"${id}"`).join(',')})`
+    if (this.cfg.logSQL) this.db.cfg.logger.log(sql)
+    await this.db.runSQL({ sql })
+  }
+
+  async saveBatch(table: string, entries: KeyValueDBTuple[]): Promise<void> {
+    const statements: QueryOptions[] = entries.map(([id, buf]) => {
+      return {
+        sql: `INSERT INTO ${table} (id, v) VALUES (?, ?)`,
+        values: [id, buf],
+      }
+    })
+
+    await pMap(statements, async statement => {
+      if (this.cfg.debug) this.db.cfg.logger.log(statement.sql)
+      await this.db.runSQL(statement)
+    })
+  }
+
+  streamIds(table: string, limit?: number): ReadableTyped<string> {
+    let sql = `SELECT id FROM ${table}`
+    if (limit) sql += ` LIMIT ${limit}`
+    if (this.cfg.logSQL) this.db.cfg.logger.log(`stream: ${sql}`)
+
+    return this.db
+      .pool()
+      .query(sql)
+      .stream()
+      .pipe(
+        new Transform({
+          objectMode: true,
+          transform(row, _, cb) {
+            cb(null, row.id)
+          },
+        }),
+      )
+  }
+
+  streamValues(table: string, limit?: number): ReadableTyped<Buffer> {
+    let sql = `SELECT v FROM ${table}`
+    if (limit) sql += ` LIMIT ${limit}`
+    if (this.cfg.logSQL) this.db.cfg.logger.log(`stream: ${sql}`)
+
+    return this.db
+      .pool()
+      .query(sql)
+      .stream()
+      .pipe(
+        new Transform({
+          objectMode: true,
+          transform(row, _, cb) {
+            cb(null, row.v)
+          },
+        }),
+      )
+  }
+
+  streamEntries(table: string, limit?: number): ReadableTyped<KeyValueDBTuple> {
+    let sql = `SELECT id,v FROM ${table}`
+    if (limit) sql += ` LIMIT ${limit}`
+    if (this.cfg.logSQL) this.db.cfg.logger.log(`stream: ${sql}`)
+
+    return this.db
+      .pool()
+      .query(sql)
+      .stream()
+      .pipe(
+        new Transform({
+          objectMode: true,
+          transform(row, _, cb) {
+            cb(null, [row.id, row.v])
+          },
+        }),
+      )
+  }
+
+  async beginTransaction(): Promise<void> {
+    await this.db.runSQL({ sql: `BEGIN TRANSACTION` })
+  }
+
+  async endTransaction(): Promise<void> {
+    await this.db.runSQL({ sql: `END TRANSACTION` })
+  }
+
+  async count(table: string): Promise<number> {
+    const sql = `SELECT count(*) as cnt FROM ${table}`
+    if (this.cfg.logSQL) this.db.cfg.logger.log(sql)
+
+    const rows = await this.db.runSQL<{ cnt: number }[]>({ sql })
+    return rows[0]!.cnt
+  }
+}

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>> = {