@naturalcycles/mysql-lib 4.6.0 → 4.8.0

package/dist/mysql.db.d.ts

@@ -1,9 +1,9 @@
 import type { CommonDB, CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions, CommonDBSupport, RunQueryResult } from '@naturalcycles/db-lib';
 import { BaseCommonDB, DBQuery } from '@naturalcycles/db-lib';
-import type { JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib/json-schema';
 import type { CommonLogger } from '@naturalcycles/js-lib/log';
 import type { ObjectWithId } from '@naturalcycles/js-lib/types';
-import type { ReadableTyped } from '@naturalcycles/nodejs-lib/stream';
+import type { JsonSchema } from '@naturalcycles/nodejs-lib/ajv';
+import { Pipeline } from '@naturalcycles/nodejs-lib/stream';
 import type { Connection, Pool, PoolConfig, PoolConnection, QueryOptions } from 'mysql';
 export interface MysqlDBOptions extends CommonDBOptions {
 }
@@ -54,7 +54,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>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): ReadableTyped<ROW>;
+    streamQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, _opt?: MysqlDBOptions): Pipeline<ROW>;
     saveBatch<ROW extends ObjectWithId>(table: string, rowsInput: ROW[], opt?: MysqlDBSaveOptions<ROW>): Promise<void>;
     /**
      * Limitation: always returns [], regardless of which rows are actually deleted
@@ -68,8 +68,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 ObjectWithId>(table: string, schema: JsonSchema<ROW>, opt?: CommonDBCreateOptions): Promise<void>;
     getTables(): Promise<string[]>;
-    getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
+    getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchema<ROW>>;
     patchByQuery<ROW extends ObjectWithId>(q: DBQuery<ROW>, patch: Partial<ROW>): Promise<number>;
 }

package/dist/mysql.db.js

@@ -1,5 +1,4 @@
 import { __decorate } from "tslib";
-import { Readable, Transform } from 'node:stream';
 import { promisify } from 'node:util';
 import { BaseCommonDB, commonDBFullSupport, CommonDBType, DBQuery } from '@naturalcycles/db-lib';
 import { _Memo } from '@naturalcycles/js-lib/decorators/memo.decorator.js';
@@ -7,6 +6,7 @@ import { _assert } from '@naturalcycles/js-lib/error/assert.js';
 import { commonLoggerPrefix } from '@naturalcycles/js-lib/log';
 import { _filterUndefinedValues, _mapKeys, _mapValues, _omit } from '@naturalcycles/js-lib/object';
 import { white } from '@naturalcycles/nodejs-lib/colors';
+import { Pipeline } from '@naturalcycles/nodejs-lib/stream';
 import * as mysql from 'mysql';
 import { dbQueryToSQLDelete, dbQueryToSQLSelect, dbQueryToSQLUpdate, insertSQL, } from './query.util.js';
 import { jsonSchemaToMySQLDDL, mapNameFromMySQL, mysqlTableStatsToJsonSchemaField, } from './schema/mysql.schema.util.js';
@@ -170,7 +170,7 @@ export class MysqlDB extends BaseCommonDB {
     streamQuery(q, _opt = {}) {
         const sql = dbQueryToSQLSelect(q);
         if (!sql) {
-            return Readable.from([]);
+            return Pipeline.fromArray([]);
         }
         if (this.cfg.logSQL)
             this.cfg.logger.log(`stream: ${sql}`);
@@ -178,15 +178,7 @@ export class MysqlDB extends BaseCommonDB {
         // return (this.pool().query(sql).stream() as ReadableTyped<ROW>).map(row =>
         //   _filterUndefinedValues(row, true),
         // )
-        return this.pool()
-            .query(sql)
-            .stream()
-            .pipe(new Transform({
-            objectMode: true,
-            transform(row, _encoding, cb) {
-                cb(null, _filterUndefinedValues(row, { mutate: true }));
-            },
-        }));
+        return Pipeline.from(this.pool().query(sql).stream()).mapSync(row => _filterUndefinedValues(row, { mutate: true }));
     }
     // SAVE
     async saveBatch(table, rowsInput, opt = {}) {

package/dist/mysqlKeyValueDB.d.ts

@@ -1,6 +1,6 @@
 import type { CommonDBCreateOptions } from '@naturalcycles/db-lib';
 import type { CommonKeyValueDB, IncrementTuple, KeyValueDBTuple } from '@naturalcycles/db-lib/kv';
-import type { ReadableTyped } from '@naturalcycles/nodejs-lib/stream';
+import { Pipeline } from '@naturalcycles/nodejs-lib/stream';
 import type { MysqlDBCfg } from './mysql.db.js';
 import { MysqlDB } from './mysql.db.js';
 export declare class MySQLKeyValueDB implements CommonKeyValueDB {
@@ -18,9 +18,9 @@ export declare class MySQLKeyValueDB implements CommonKeyValueDB {
     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>;
+    streamIds(table: string, limit?: number): Pipeline<string>;
+    streamValues(table: string, limit?: number): Pipeline<Buffer>;
+    streamEntries(table: string, limit?: number): Pipeline<KeyValueDBTuple>;
     beginTransaction(): Promise<void>;
     endTransaction(): Promise<void>;
     count(table: string): Promise<number>;

package/dist/mysqlKeyValueDB.js

@@ -1,7 +1,7 @@
-import { Transform } from 'node:stream';
 import { commonKeyValueDBFullSupport } from '@naturalcycles/db-lib/kv';
 import { AppError } from '@naturalcycles/js-lib/error/error.util.js';
 import { pMap } from '@naturalcycles/js-lib/promise/pMap.js';
+import { Pipeline } from '@naturalcycles/nodejs-lib/stream';
 import { MysqlDB } from './mysql.db.js';
 export class MySQLKeyValueDB {
     cfg;
@@ -70,16 +70,7 @@ export class MySQLKeyValueDB {
             this.db.cfg.logger.log(`stream: ${sql}`);
         // todo: this is nice, but `mysql` package uses `readable-stream@2` which is not compatible with `node:stream` iterable helpers
         // return (this.db.pool().query(sql).stream() as ReadableTyped<ObjectWithId>).map(row => row.id)
-        return this.db
-            .pool()
-            .query(sql)
-            .stream()
-            .pipe(new Transform({
-            objectMode: true,
-            transform(row, _encoding, cb) {
-                cb(null, row.id);
-            },
-        }));
+        return Pipeline.from(this.db.pool().query(sql).stream()).mapSync(r => r.id);
     }
     streamValues(table, limit) {
         let sql = `SELECT v FROM ${table}`;
@@ -87,7 +78,7 @@ export class MySQLKeyValueDB {
             sql += ` LIMIT ${limit}`;
         if (this.cfg.logSQL)
             this.db.cfg.logger.log(`stream: ${sql}`);
-        return this.db.pool().query(sql).stream().map(row => row.v);
+        return Pipeline.from(this.db.pool().query(sql).stream()).mapSync(row => row.v);
     }
     streamEntries(table, limit) {
         let sql = `SELECT id,v FROM ${table}`;
@@ -95,10 +86,7 @@ export class MySQLKeyValueDB {
             sql += ` LIMIT ${limit}`;
         if (this.cfg.logSQL)
             this.db.cfg.logger.log(`stream: ${sql}`);
-        return this.db.pool().query(sql).stream().map(row => [
-            row.id,
-            row.v,
-        ]);
+        return Pipeline.from(this.db.pool().query(sql).stream()).mapSync(row => [row.id, row.v]);
     }
     async beginTransaction() {
         await this.db.runSQL({ sql: `BEGIN TRANSACTION` });

package/dist/query.util.js

@@ -41,7 +41,7 @@ export function dbQueryToSQLDelete(q) {
 export 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
+    // oxlint-disable-next-line unicorn/no-array-reduce
     const fieldSet = rows.reduce((set, row) => {
         for (const field of Object.keys(row)) {
             set.add(field);

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

@@ -1,6 +1,6 @@
-import type { JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib/json-schema';
 import type { CommonLogger } from '@naturalcycles/js-lib/log';
 import type { AnyObject } from '@naturalcycles/js-lib/types';
+import type { JsonSchema } from '@naturalcycles/nodejs-lib/ajv';
 export interface MySQLTableStats {
     Field: string;
     Type: string;
@@ -15,8 +15,8 @@ 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 extends AnyObject = any>(table: string, stats: MySQLTableStats[], logger: CommonLogger): JsonSchemaRootObject<T>;
+export declare function jsonSchemaToMySQLDDL(table: string, schema: JsonSchema<any>, opt?: MySQLSchemaOptions): string;
+export declare function mysqlTableStatsToJsonSchemaField<T extends AnyObject = any>(table: string, stats: MySQLTableStats[], logger: CommonLogger): JsonSchema<T>;
 /**
  * Because MySQL doesn't support `.` in field names and escapes them as tableName + fieldName.
  *

package/package.json

@@ -38,7 +38,7 @@
   "engines": {
     "node": ">=22.12.0"
   },
-  "version": "4.6.0",
+  "version": "4.8.0",
   "description": "MySQL client implementing CommonDB interface",
   "keywords": [
     "mysql",

package/src/mysql.db.ts

@@ -1,4 +1,3 @@
-import { Readable, Transform } from 'node:stream'
 import { promisify } from 'node:util'
 import type {
   CommonDB,
@@ -11,13 +10,13 @@ import type {
 import { BaseCommonDB, commonDBFullSupport, CommonDBType, DBQuery } from '@naturalcycles/db-lib'
 import { _Memo } from '@naturalcycles/js-lib/decorators/memo.decorator.js'
 import { _assert } from '@naturalcycles/js-lib/error/assert.js'
-import type { JsonSchemaObject, JsonSchemaRootObject } from '@naturalcycles/js-lib/json-schema'
 import type { CommonLogger } from '@naturalcycles/js-lib/log'
 import { commonLoggerPrefix } from '@naturalcycles/js-lib/log'
 import { _filterUndefinedValues, _mapKeys, _mapValues, _omit } from '@naturalcycles/js-lib/object'
 import type { ObjectWithId } from '@naturalcycles/js-lib/types'
+import type { JsonSchema } from '@naturalcycles/nodejs-lib/ajv'
 import { white } from '@naturalcycles/nodejs-lib/colors'
-import type { ReadableTyped } from '@naturalcycles/nodejs-lib/stream'
+import { Pipeline } from '@naturalcycles/nodejs-lib/stream'
 import type {
   Connection,
   OkPacket,
@@ -269,10 +268,10 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
   override streamQuery<ROW extends ObjectWithId>(
     q: DBQuery<ROW>,
     _opt: MysqlDBOptions = {},
-  ): ReadableTyped<ROW> {
+  ): Pipeline<ROW> {
     const sql = dbQueryToSQLSelect(q)
     if (!sql) {
-      return Readable.from([])
+      return Pipeline.fromArray([])
     }
 
     if (this.cfg.logSQL) this.cfg.logger.log(`stream: ${sql}`)
@@ -281,17 +280,9 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
     // return (this.pool().query(sql).stream() as ReadableTyped<ROW>).map(row =>
     //   _filterUndefinedValues(row, true),
     // )
-    return this.pool()
-      .query(sql)
-      .stream()
-      .pipe(
-        new Transform({
-          objectMode: true,
-          transform(row: ROW, _encoding, cb) {
-            cb(null, _filterUndefinedValues(row, { mutate: true }))
-          },
-        }),
-      )
+    return Pipeline.from<ROW>(this.pool().query(sql).stream()).mapSync(row =>
+      _filterUndefinedValues(row, { mutate: true }),
+    )
   }
 
   // SAVE
@@ -395,7 +386,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
    */
   override async createTable<ROW extends ObjectWithId>(
     table: string,
-    schema: JsonSchemaObject<ROW>,
+    schema: JsonSchema<ROW>,
     opt: CommonDBCreateOptions = {},
   ): Promise<void> {
     if (opt.dropIfExists) await this.dropTable(table)
@@ -410,9 +401,7 @@ export class MysqlDB extends BaseCommonDB implements CommonDB {
       .filter(Boolean)
   }
 
-  override async getTableSchema<ROW extends ObjectWithId>(
-    table: string,
-  ): Promise<JsonSchemaRootObject<ROW>> {
+  override async getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchema<ROW>> {
     const stats = await this.runSQL<MySQLTableStats[]>({
       sql: `describe ${mysql.escapeId(table)}`,
     })

package/src/mysqlKeyValueDB.ts

@@ -1,11 +1,10 @@
-import { Transform } from 'node:stream'
 import type { CommonDBCreateOptions } from '@naturalcycles/db-lib'
 import type { CommonKeyValueDB, IncrementTuple, KeyValueDBTuple } from '@naturalcycles/db-lib/kv'
 import { commonKeyValueDBFullSupport } from '@naturalcycles/db-lib/kv'
 import { AppError } from '@naturalcycles/js-lib/error/error.util.js'
 import { pMap } from '@naturalcycles/js-lib/promise/pMap.js'
 import type { ObjectWithId } from '@naturalcycles/js-lib/types'
-import type { ReadableTyped } from '@naturalcycles/nodejs-lib/stream'
+import { Pipeline } from '@naturalcycles/nodejs-lib/stream'
 import type { QueryOptions } from 'mysql'
 import type { MysqlDBCfg } from './mysql.db.js'
 import { MysqlDB } from './mysql.db.js'
@@ -83,44 +82,32 @@ export class MySQLKeyValueDB implements CommonKeyValueDB {
     })
   }
 
-  streamIds(table: string, limit?: number): ReadableTyped<string> {
+  streamIds(table: string, limit?: number): Pipeline<string> {
     let sql = `SELECT id FROM ${table}`
     if (limit) sql += ` LIMIT ${limit}`
     if (this.cfg.logSQL) this.db.cfg.logger.log(`stream: ${sql}`)
 
     // todo: this is nice, but `mysql` package uses `readable-stream@2` which is not compatible with `node:stream` iterable helpers
     // return (this.db.pool().query(sql).stream() as ReadableTyped<ObjectWithId>).map(row => row.id)
-    return this.db
-      .pool()
-      .query(sql)
-      .stream()
-      .pipe(
-        new Transform({
-          objectMode: true,
-          transform(row: ObjectWithId, _encoding, cb) {
-            cb(null, row.id)
-          },
-        }),
-      )
-  }
-
-  streamValues(table: string, limit?: number): ReadableTyped<Buffer> {
+    return Pipeline.from<ObjectWithId>(this.db.pool().query(sql).stream()).mapSync(r => r.id)
+  }
+
+  streamValues(table: string, limit?: number): Pipeline<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() as ReadableTyped<{ v: Buffer }>).map(row => row.v)
+    return Pipeline.from<{ v: Buffer }>(this.db.pool().query(sql).stream()).mapSync(row => row.v)
   }
 
-  streamEntries(table: string, limit?: number): ReadableTyped<KeyValueDBTuple> {
+  streamEntries(table: string, limit?: number): Pipeline<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() as ReadableTyped<KeyValueObject>).map(row => [
-      row.id,
-      row.v,
-    ])
+    return Pipeline.from<{ id: string; v: Buffer }>(this.db.pool().query(sql).stream()).mapSync(
+      row => [row.id, row.v],
+    )
   }
 
   async beginTransaction(): Promise<void> {

package/src/query.util.ts

@@ -60,7 +60,7 @@ export function insertSQL(
   // INSERT INTO table_name (column1, column2, column3, ...)
   // VALUES (value1, value2, value3, ...);
 
-  // eslint-disable-next-line unicorn/no-array-reduce
+  // oxlint-disable-next-line unicorn/no-array-reduce
   const fieldSet = rows.reduce((set: Set<string>, row) => {
     for (const field of Object.keys(row)) {
       set.add(field)

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

@@ -1,12 +1,6 @@
-import type {
-  JsonSchemaBoolean,
-  JsonSchemaNumber,
-  JsonSchemaObject,
-  JsonSchemaRootObject,
-  JsonSchemaString,
-} from '@naturalcycles/js-lib/json-schema'
 import type { CommonLogger } from '@naturalcycles/js-lib/log'
 import type { AnyObject } from '@naturalcycles/js-lib/types'
+import type { JsonSchema } from '@naturalcycles/nodejs-lib/ajv'
 import * as mysql from 'mysql'
 
 export interface MySQLTableStats {
@@ -27,14 +21,14 @@ export interface MySQLSchemaOptions {
  */
 export function jsonSchemaToMySQLDDL(
   table: string,
-  schema: JsonSchemaObject<any>,
+  schema: JsonSchema<any>,
   opt: MySQLSchemaOptions = {},
 ): string {
   const { engine = 'InnoDB' } = opt
 
   const lines: string[] = [`CREATE TABLE ${mysql.escapeId(table)} (`]
 
-  const innerLines = Object.entries(schema.properties).map(([k, s]) => {
+  const innerLines = Object.entries(schema.properties!).map(([k, s]) => {
     if (k === 'id') {
       return `id VARCHAR(255) NOT NULL`
     }
@@ -47,7 +41,7 @@ export function jsonSchemaToMySQLDDL(
     } else if (s.type === 'integer') {
       type = 'INT(11)'
     } else if (s.type === 'number') {
-      if (['unixTimestamp', 'int32'].includes((s as JsonSchemaNumber).format!)) {
+      if (['unixTimestamp', 'int32'].includes((s as JsonSchema<number>).format!)) {
         type = 'INT(11)'
       } else {
         type = 'FLOAT(11)'
@@ -84,8 +78,8 @@ export function mysqlTableStatsToJsonSchemaField<T extends AnyObject = any>(
   table: string,
   stats: MySQLTableStats[],
   logger: CommonLogger,
-): JsonSchemaRootObject<T> {
-  const s: JsonSchemaRootObject<T> = {
+): JsonSchema<T> {
+  const s: JsonSchema<T> = {
     $id: `${table}.schema.json`,
     type: 'object',
     properties: {} as any,
@@ -98,19 +92,19 @@ export function mysqlTableStatsToJsonSchemaField<T extends AnyObject = any>(
     const t = stat.Type.toLowerCase()
     const notNull = stat.Null?.toUpperCase() !== 'YES'
     if (notNull) {
-      s.required.push(name as any)
+      s.required!.push(name as any)
     }
 
     if (t.includes('text') || t.includes('char')) {
-      s.properties[name] = { type: 'string' } as JsonSchemaString
+      s.properties![name] = { type: 'string' } as JsonSchema<T[keyof T]>
     } else if (t.includes('lob')) {
-      s.properties[name] = { instanceof: 'Buffer' }
+      s.properties![name] = { instanceof: 'Buffer' }
     } else if (t.startsWith('tinyint') || t.includes('(1)')) {
-      s.properties[name] = { type: 'boolean' } as JsonSchemaBoolean
+      s.properties![name] = { type: 'boolean' } as JsonSchema<T[keyof T]>
     } else if (t === 'int' || t.startsWith('int(')) {
-      s.properties[name] = { type: 'integer' } as JsonSchemaNumber
+      s.properties![name] = { type: 'integer' } as JsonSchema<T[keyof T]>
     } else if (t.startsWith('float')) {
-      s.properties[name] = { type: 'number' } as JsonSchemaNumber
+      s.properties![name] = { type: 'number' } as JsonSchema<T[keyof T]>
     } else {
       logger.log(s)
       throw new Error(`Unknown mysql field type ${name as string} ${stat.Type}`)