@bitblit/ratchet-rdbms 6.0.145-alpha → 6.0.147-alpha

package/lib/rds-data-api/model/rds-data-api-connection-config.d.ts

@@ -3,4 +3,6 @@ export interface RdsDataApiConnectionConfig {
     resourceArn: string;
     secretArn: string;
     database: string;
+    maximumWaitForDbResumeInMillis?: number;
+    dbResumePingTimeMillis?: number;
 }

package/lib/rds-data-api/rds-data-api-database-access.d.ts

@@ -8,6 +8,9 @@ export declare class RdsDataApiDatabaseAccess implements DatabaseAccess {
     private cfg;
     private _currentTransactionId;
     constructor(client: RDSDataClient, cfg: RdsDataApiConnectionConfig);
+    private get maxWaitForResumingDatabase();
+    private get dbResumePingTimeMillis();
+    sendWithDatabaseWait(cmd: any): Promise<any>;
     beginTransaction(): Promise<void>;
     close(): Promise<boolean>;
     commitTransaction(): Promise<void>;

package/lib/rds-data-api/rds-data-api-database-access.js

@@ -1,6 +1,8 @@
-import { BeginTransactionCommand, CommitTransactionCommand, ExecuteStatementCommand, RollbackTransactionCommand } from "@aws-sdk/client-rds-data";
+import { BeginTransactionCommand, CommitTransactionCommand, DatabaseResumingException, ExecuteStatementCommand, RollbackTransactionCommand } from "@aws-sdk/client-rds-data";
 import { Logger } from "@bitblit/ratchet-common/logger/logger";
 import SqlString from 'sqlstring';
+import { PromiseRatchet } from "@bitblit/ratchet-common/lang/promise-ratchet";
+import { ErrorRatchet } from "@bitblit/ratchet-common/lang/error-ratchet";
 export class RdsDataApiDatabaseAccess {
     client;
     cfg;
@@ -9,8 +11,37 @@ export class RdsDataApiDatabaseAccess {
         this.client = client;
         this.cfg = cfg;
     }
+    get maxWaitForResumingDatabase() {
+        return this?.cfg?.maximumWaitForDbResumeInMillis ?? 0;
+    }
+    get dbResumePingTimeMillis() {
+        return this?.cfg?.dbResumePingTimeMillis ?? 1_000;
+    }
+    async sendWithDatabaseWait(cmd) {
+        const startTime = Date.now();
+        let rval;
+        do {
+            try {
+                rval = await this.client.send(cmd);
+            }
+            catch (err) {
+                if (err instanceof DatabaseResumingException) {
+                    Logger.debug('Database was resuming - waiting %d ms before retry : %s', this.dbResumePingTimeMillis, err);
+                    await PromiseRatchet.wait(this.dbResumePingTimeMillis);
+                }
+                else {
+                    throw err;
+                }
+            }
+        } while (!rval && Date.now() - startTime < this.maxWaitForResumingDatabase);
+        if (!rval) {
+            Logger.error('Timed out waiting for db to start');
+            throw ErrorRatchet.fErr('Timed out waiting for db to start');
+        }
+        return rval;
+    }
     async beginTransaction() {
-        const tmp = await this.client.send(new BeginTransactionCommand({ resourceArn: 'ss', secretArn: 'yy' }));
+        const tmp = await this.sendWithDatabaseWait(new BeginTransactionCommand({ resourceArn: this.cfg.resourceArn, secretArn: this.cfg.secretArn }));
         this._currentTransactionId = tmp.transactionId;
         Logger.info('Started transaction %s', this._currentTransactionId);
     }
@@ -23,7 +54,7 @@ export class RdsDataApiDatabaseAccess {
     }
     async commitTransaction() {
         if (this._currentTransactionId) {
-            const out = await this.client.send(new CommitTransactionCommand({ resourceArn: this.cfg.resourceArn, secretArn: this.cfg.secretArn, transactionId: this._currentTransactionId }));
+            const out = await this.sendWithDatabaseWait(new CommitTransactionCommand({ resourceArn: this.cfg.resourceArn, secretArn: this.cfg.secretArn, transactionId: this._currentTransactionId }));
             Logger.info('Commit transaction %s returned %j', this._currentTransactionId, out);
             this._currentTransactionId = null;
         }
@@ -37,7 +68,7 @@ export class RdsDataApiDatabaseAccess {
     }
     async modify(query, fields) {
         const params = RdsDataApiDatabaseAccess.toSqlParameters(fields);
-        const tmp = await this.client.send(new ExecuteStatementCommand({ resourceArn: this.cfg.resourceArn, secretArn: this.cfg.secretArn, database: this.cfg.database, sql: query, parameters: params, includeResultMetadata: true }));
+        const tmp = await this.sendWithDatabaseWait(new ExecuteStatementCommand({ resourceArn: this.cfg.resourceArn, secretArn: this.cfg.secretArn, database: this.cfg.database, sql: query, parameters: params, includeResultMetadata: true }));
         const rval = {
             results: {
                 changedRows: tmp.numberOfRecordsUpdated,

package/lib/rds-data-api/rds-data-api-database-access.js.map

@@ -1 +1 @@
-{"version":3,"file":"rds-data-api-database-access.js","sourceRoot":"","sources":["../../src/rds-data-api/rds-data-api-database-access.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,uBAAuB,EAEvB,wBAAwB,EAAkC,uBAAuB,EAElE,0BAA0B,EAC1C,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,uCAAuC,CAAC;AAE/D,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,MAAM,OAAO,wBAAwB;IAKzB;IACA;IAJF,qBAAqB,CAAS;IAEtC,YACU,MAAqB,EACrB,GAA+B;QAD/B,WAAM,GAAN,MAAM,CAAe;QACrB,QAAG,GAAH,GAAG,CAA4B;IACtC,CAAC;IAEG,KAAK,CAAC,gBAAgB;QAC3B,MAAM,GAAG,GAAkC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,EAAC,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;QACrI,IAAI,CAAC,qBAAqB,GAAG,GAAG,CAAC,aAAa,CAAC;QAC/C,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;IACpE,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;YACtE,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACnC,CAAC;QACD,OAAO,IAAI,CAAC;IAEd,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAmC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,wBAAwB,CAAC,EAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,CAAC,qBAAqB,EAAC,CAAC,CAAC,CAAC;YAChN,MAAM,CAAC,IAAI,CAAC,mCAAmC,EAAE,IAAI,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;YAClF,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,KAAU;QACtB,MAAM,IAAI,GAAW,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,MAA2B;QAC5D,MAAM,MAAM,GAAmB,wBAAwB,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAChF,MAAM,GAAG,GAAkC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,EAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,qBAAqB,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;QAC5P,MAAM,IAAI,GAAkC;YAC1C,OAAO,EAAE;gBACP,WAAW,EAAE,GAAG,CAAC,sBAAsB;gBAGvC,YAAY,EAAE,GAAG,CAAC,sBAAsB;aAIzC;YACD,MAAM,EAAE,GAAG,CAAC,cAAc;SAC3B,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAGM,MAAM,CAAC,eAAe,CAAC,MAA2B;QACvD,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;YAC/C,IAAI,KAAU,CAAC;YACf,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACjB,KAAK,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;YAC3B,CAAC;iBAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAEnC,KAAK,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC;YAC7B,CAAC;iBAAM,IAAI,OAAO,GAAG,KAAK,SAAS,EAAE,CAAC;gBACpC,KAAK,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC;YAChC,CAAC;iBAAM,IAAI,GAAG,YAAY,IAAI,EAAE,CAAC;gBAC/B,KAAK,GAAG,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;YACpE,CAAC;iBAAM,CAAC;gBAEN,KAAK,GAAG,EAAE,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACvC,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,KAAY;QACrC,IAAI,IAAI,GAAQ,IAAI,CAAC;QACrB,IAAI,KAAK,CAAC,MAAM,EAAG,CAAC;YAAC,IAAI,GAAC,IAAI,CAAA;QAAA,CAAC;aAC1B,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YAAA,IAAI,GAAE,KAAK,CAAC,WAAW,CAAC;QAAA,CAAC;aAC/D,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAAA,IAAI,GAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAAA,CAAC;aACxE,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YAAA,IAAI,GAAE,KAAK,CAAC,WAAW,CAAC;QAAA,CAAC;aAC/D,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAAA,IAAI,GAAE,KAAK,CAAC,SAAS,CAAC;QAAA,CAAC;aAC3D,IAAI,KAAK,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YAAA,IAAI,GAAE,KAAK,CAAC,cAAc,CAAC,CAAA;QAAA,CAAC;QAAA,CAAC;QACzE,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,MAAM,CAAC,YAAY,CACxB,MAAqC;QAErC,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;QAC3C,IAAI,CAAC,OAAO,IAAI,CAAC,cAAc;YAAE,OAAO,EAAE,CAAC;QAE3C,MAAM,IAAI,GAAQ,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACpC,MAAM,GAAG,GAAM,EAAO,CAAC;YACvB,GAAG,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gBACvB,MAAM,IAAI,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE,CAAC;gBACjD,GAAG,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,KAAK,CAAI,KAAa,EAAE,MAA2B;QAC9D,MAAM,MAAM,GAAmB,wBAAwB,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAEhF,MAAM,IAAI,GAAkC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,EAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,qBAAqB,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;QAC7P,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QACjE,MAAM,OAAO,GAAQ,wBAAwB,CAAC,YAAY,CAAI,IAAI,CAAC,CAAC;QAEpE,MAAM,IAAI,GAAsB;YAC9B,OAAO,EAAE,OAAY;YACrB,MAAM,EAAE,IAAI,CAAC,cAAc,IAAI,EAAE;SAClC,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,mBAAmB;QAC9B,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAqC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,0BAA0B,CAAC,EAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,CAAC,qBAAqB,EAAC,CAAC,CAAC,CAAC;YACpN,MAAM,CAAC,IAAI,CAAC,qCAAqC,EAAE,IAAI,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;YACpF,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;QAC7E,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,cAAwB;QAClD,MAAM,MAAM,GAAwB,MAAM,IAAI,CAAC,KAAK,CAAM,yBAAyB,EAAE,EAAE,CAAC,CAAC;QACzF,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,IAAI,GAAW,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACvF,OAAO,IAAI,CAAC;IACd,CAAC;CAqBF"}
+{"version":3,"file":"rds-data-api-database-access.js","sourceRoot":"","sources":["../../src/rds-data-api/rds-data-api-database-access.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,uBAAuB,EAEvB,wBAAwB,EACxB,yBAAyB,EAAE,uBAAuB,EAEnC,0BAA0B,EAC1C,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,uCAAuC,CAAC;AAE/D,OAAO,SAAS,MAAM,WAAW,CAAC;AAGlC,OAAO,EAAE,cAAc,EAAE,MAAM,8CAA8C,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,MAAM,4CAA4C,CAAC;AAE1E,MAAM,OAAO,wBAAwB;IAKzB;IACA;IAJF,qBAAqB,CAAS;IAEtC,YACU,MAAqB,EACrB,GAA+B;QAD/B,WAAM,GAAN,MAAM,CAAe;QACrB,QAAG,GAAH,GAAG,CAA4B;IACtC,CAAC;IAEJ,IAAY,0BAA0B;QACpC,OAAO,IAAI,EAAE,GAAG,EAAE,8BAA8B,IAAI,CAAC,CAAC;IACxD,CAAC;IAED,IAAY,sBAAsB;QAChC,OAAO,IAAI,EAAE,GAAG,EAAE,sBAAsB,IAAI,KAAK,CAAC;IACpD,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,GAAQ;QACxC,MAAM,SAAS,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;QACrC,IAAI,IAAS,CAAC;QACd,GAAG,CAAC;YACF,IAAI,CAAC;gBACH,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,GAAG,YAAY,yBAAyB,EAAE,CAAC;oBAC7C,MAAM,CAAC,KAAK,CAAC,yDAAyD,EAAE,IAAI,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC;oBAC1G,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;gBACzD,CAAC;qBAAM,CAAC;oBACN,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;QACH,CAAC,QAAQ,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAC,SAAS,GAAG,IAAI,CAAC,0BAA0B,EAAC;QACzE,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;YAClD,MAAM,YAAY,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAGM,KAAK,CAAC,gBAAgB;QAC3B,MAAM,GAAG,GAAkC,MAAM,IAAI,CAAC,oBAAoB,CAAC,IAAI,uBAAuB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,EAAC,CAAC,CAAC,CAAA;QAC5K,IAAI,CAAC,qBAAqB,GAAG,GAAG,CAAC,aAAa,CAAC;QAC/C,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;IACpE,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;YACtE,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACnC,CAAC;QACD,OAAO,IAAI,CAAC;IAEd,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAmC,MAAM,IAAI,CAAC,oBAAoB,CAAC,IAAI,wBAAwB,CAAC,EAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,CAAC,qBAAqB,EAAC,CAAC,CAAC,CAAA;YACxN,MAAM,CAAC,IAAI,CAAC,mCAAmC,EAAE,IAAI,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;YAClF,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,KAAU;QACtB,MAAM,IAAI,GAAW,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,MAA2B;QAC5D,MAAM,MAAM,GAAmB,wBAAwB,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAChF,MAAM,GAAG,GAAkC,MAAM,IAAI,CAAC,oBAAoB,CAAC,IAAI,uBAAuB,CAAC,EAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,qBAAqB,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;QACrQ,MAAM,IAAI,GAAkC;YAC1C,OAAO,EAAE;gBACP,WAAW,EAAE,GAAG,CAAC,sBAAsB;gBAGvC,YAAY,EAAE,GAAG,CAAC,sBAAsB;aAIzC;YACD,MAAM,EAAE,GAAG,CAAC,cAAc;SAC3B,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAGM,MAAM,CAAC,eAAe,CAAC,MAA2B;QACvD,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;YAC/C,IAAI,KAAU,CAAC;YACf,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACjB,KAAK,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;YAC3B,CAAC;iBAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAEnC,KAAK,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC;YAC7B,CAAC;iBAAM,IAAI,OAAO,GAAG,KAAK,SAAS,EAAE,CAAC;gBACpC,KAAK,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC;YAChC,CAAC;iBAAM,IAAI,GAAG,YAAY,IAAI,EAAE,CAAC;gBAC/B,KAAK,GAAG,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;YACpE,CAAC;iBAAM,CAAC;gBAEN,KAAK,GAAG,EAAE,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACvC,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,KAAY;QACrC,IAAI,IAAI,GAAQ,IAAI,CAAC;QACrB,IAAI,KAAK,CAAC,MAAM,EAAG,CAAC;YAAC,IAAI,GAAC,IAAI,CAAA;QAAA,CAAC;aAC1B,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YAAA,IAAI,GAAE,KAAK,CAAC,WAAW,CAAC;QAAA,CAAC;aAC/D,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAAA,IAAI,GAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAAA,CAAC;aACxE,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YAAA,IAAI,GAAE,KAAK,CAAC,WAAW,CAAC;QAAA,CAAC;aAC/D,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAAA,IAAI,GAAE,KAAK,CAAC,SAAS,CAAC;QAAA,CAAC;aAC3D,IAAI,KAAK,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YAAA,IAAI,GAAE,KAAK,CAAC,cAAc,CAAC,CAAA;QAAA,CAAC;QAAA,CAAC;QACzE,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,MAAM,CAAC,YAAY,CACxB,MAAqC;QAErC,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;QAC3C,IAAI,CAAC,OAAO,IAAI,CAAC,cAAc;YAAE,OAAO,EAAE,CAAC;QAE3C,MAAM,IAAI,GAAQ,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACpC,MAAM,GAAG,GAAM,EAAO,CAAC;YACvB,GAAG,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gBACvB,MAAM,IAAI,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE,CAAC;gBACjD,GAAG,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,KAAK,CAAI,KAAa,EAAE,MAA2B;QAC9D,MAAM,MAAM,GAAmB,wBAAwB,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAEhF,MAAM,IAAI,GAAkC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,EAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,qBAAqB,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;QAC7P,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QACjE,MAAM,OAAO,GAAQ,wBAAwB,CAAC,YAAY,CAAI,IAAI,CAAC,CAAC;QAEpE,MAAM,IAAI,GAAsB;YAC9B,OAAO,EAAE,OAAY;YACrB,MAAM,EAAE,IAAI,CAAC,cAAc,IAAI,EAAE;SAClC,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,mBAAmB;QAC9B,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAqC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,0BAA0B,CAAC,EAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,CAAC,qBAAqB,EAAC,CAAC,CAAC,CAAC;YACpN,MAAM,CAAC,IAAI,CAAC,qCAAqC,EAAE,IAAI,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;YACpF,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;QAC7E,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,cAAwB;QAClD,MAAM,MAAM,GAAwB,MAAM,IAAI,CAAC,KAAK,CAAM,yBAAyB,EAAE,EAAE,CAAC,CAAC;QACzF,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,IAAI,GAAW,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACvF,OAAO,IAAI,CAAC;IACd,CAAC;CAqBF"}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@bitblit/ratchet-rdbms",
-  "version": "6.0.145-alpha",
+  "version": "6.0.147-alpha",
   "description": "Ratchet tooling for working with relational databases",
   "sideEffects": false,
   "type": "module",
   "files": [
+    "src/**",
     "lib/**",
     "bin/**"
   ],
@@ -47,7 +48,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@bitblit/ratchet-common": "6.0.145-alpha"
+    "@bitblit/ratchet-common": "6.0.147-alpha"
   },
   "optionalDependencies": {
     "@aws-sdk/client-rds-data": "3.922.0",
@@ -60,7 +61,7 @@
   },
   "peerDependencies": {
     "@aws-sdk/client-rds-data": "^3.922.0",
-    "@bitblit/ratchet-common": "6.0.145-alpha",
+    "@bitblit/ratchet-common": "6.0.147-alpha",
     "better-sqlite3": "^12.4.1",
     "get-port": "^7.1.0",
     "mysql2": "^3.15.3",

package/src/build/ratchet-rdbms-info.ts

@@ -0,0 +1,19 @@
+import { BuildInformation } from '@bitblit/ratchet-common/build/build-information';
+
+export class RatchetRdbmsInfo {
+  // Empty constructor prevents instantiation
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  private constructor() {}
+
+  public static buildInformation(): BuildInformation {
+    const val: BuildInformation = {
+      version: 'LOCAL-SNAPSHOT',
+      hash: 'LOCAL-HASH',
+      branch: 'LOCAL-BRANCH',
+      tag: 'LOCAL-TAG',
+      timeBuiltISO: 'LOCAL-TIME-ISO',
+      notes: 'LOCAL-NOTES',
+    };
+    return val;
+  }
+}

package/src/model/connection-and-tunnel.ts

@@ -0,0 +1,7 @@
+import { SshTunnelContainer } from './ssh/ssh-tunnel-container.js';
+
+export interface ConnectionAndTunnel<T, R> {
+  config: R;
+  db: T;
+  ssh: SshTunnelContainer;
+}

package/src/model/database-access-provider.ts

@@ -0,0 +1,11 @@
+import { DatabaseAccess } from './database-access.js';
+import { QueryDefaults } from './query-defaults.js';
+
+export interface DatabaseAccessProvider {
+  /**
+   * @param name if omitted, returns the default connection
+   */
+  getDatabaseAccess(name?: string): Promise<DatabaseAccess | undefined>;
+  clearDatabaseAccessCache(): Promise<boolean>;
+  createNonPooledDatabaseAccess?(queryDefaults: QueryDefaults, additionalConfig?: Record<string, any>): Promise<DatabaseAccess | undefined>;
+}

package/src/model/database-access.ts

@@ -0,0 +1,30 @@
+// Represents the object used to actually talk to the database, such
+// as a Connection object in mysql/maria, an HTTP wrapper for an HTTP db,
+// or a AsyncDatabase object in sqlite.  Usually it'll be a wrapper around
+// the actual object to act as an adapter
+import { RequestResults } from './request-results.js';
+import { ModifyResults } from './modify-results.js';
+import { DatabaseRequestType } from './database-request-type.js';
+
+// T = Class of the connection
+// R = Class of any extra connection configuration props
+// S = Class of the object returned by a query (data)
+export interface DatabaseAccess {
+  // Force the connection closed
+  close(): Promise<boolean>;
+  escape(value: any): string;
+
+  testConnection(logTestResults?: boolean): Promise<number>; // Should be a fast test like 'select 1'
+
+  preQuery?(): Promise<void>;
+  query<S>(query: string, fields: Record<string, any>): Promise<RequestResults<S>>;
+  modify(query: string, fields: Record<string, any>): Promise<RequestResults<ModifyResults>>;
+  // TODO: Handle DDL specially?
+  onRequestSuccessOnly?(type: DatabaseRequestType): Promise<void>;
+  onRequestFailureOnly?(type: DatabaseRequestType): Promise<void>;
+  onRequestSuccessOrFailure?(type: DatabaseRequestType): Promise<void>;
+
+  beginTransaction?(): Promise<void>;
+  commitTransaction?(): Promise<void>;
+  rollbackTransaction?(): Promise<void>;
+}

package/src/model/database-config-list.ts

@@ -0,0 +1,3 @@
+export interface DatabaseConfigList<T> {
+  dbList: T[];
+}

package/src/model/database-request-type.ts

@@ -0,0 +1,6 @@
+export enum DatabaseRequestType {
+  Query = 'Query', // eg Select
+  Modify = 'Modify', // eg Insert/Update/Delete
+  Definition = 'Definition', // eg, DDL
+  Meta = 'Meta', // eg - set transation isolation level
+}

package/src/model/group-by-count-result.ts

@@ -0,0 +1,4 @@
+export interface GroupByCountResult {
+  groupByField: string;
+  count: number;
+}

package/src/model/modify-results.ts

@@ -0,0 +1,9 @@
+export interface ModifyResults {
+  changedRows: number;
+  insertId?: number;
+  fieldCount?: number;
+  affectedRows?: number;
+  info?: string;
+  serverStatus?: number;
+  warningStatus?: number;
+}

package/src/model/named-parameter-database-service-config.ts

@@ -0,0 +1,13 @@
+import { QueryTextProvider } from './query-text-provider.js';
+import { DatabaseAccessProvider } from './database-access-provider.js';
+import { QueryDefaults } from './query-defaults.js';
+import { LoggerInstance } from '@bitblit/ratchet-common/logger/logger-instance';
+
+export interface NamedParameterDatabaseServiceConfig {
+  serviceName: string;
+  queryProvider: QueryTextProvider;
+  connectionProvider: DatabaseAccessProvider;
+  queryDefaults: QueryDefaults;
+  longQueryTimeMs: number;
+  logger?: LoggerInstance;
+}

package/src/model/paginated-results.ts

@@ -0,0 +1,5 @@
+export interface PaginatedResults<T> {
+  results: T[];
+  nextPageToken: string;
+  prevPageToken: string;
+}

package/src/model/pagination-bounds.ts

@@ -0,0 +1,12 @@
+/**
+ * Defines the bounds of a paginator.
+ *
+ * Returns the min and max values for the column specified and the total count - can
+ * be used to roughly predict page values
+ */
+export interface PaginationBounds<T> {
+  cn: string;
+  min: T;
+  max: T;
+  count: number;
+}

package/src/model/paginator.ts

@@ -0,0 +1,20 @@
+import { SortDirection } from './sort-direction.js';
+import { JwtTokenBase } from '@bitblit/ratchet-common/jwt/jwt-token-base';
+
+/**
+ * Defines a paginator.
+ *
+ * Field names are short in here because this gets serialized when passed back and forth.  They are:
+ * cn: ColumnName (required)
+ * min: min value for that column (optional)
+ * max: max value for that column (optional)
+ * s: sort direction for the column (optional, defaults to Asc)
+ * l: limit (optional)
+ */
+export interface Paginator<T> extends JwtTokenBase {
+  cn: string;
+  min?: T;
+  max?: T;
+  s?: SortDirection;
+  l?: number;
+}

package/src/model/query-defaults.ts

@@ -0,0 +1,4 @@
+export interface QueryDefaults {
+  databaseName: string;
+  timeoutMS: number;
+}

package/src/model/query-text-provider.ts

@@ -0,0 +1,4 @@
+export interface QueryTextProvider {
+  fetchQuery(queryDottedPath: string): string;
+  fetchAllQueries(): Record<string, string>;
+}

package/src/model/request-results.ts

@@ -0,0 +1,4 @@
+export interface RequestResults<R> {
+  results: R;
+  fields?: Record<string, any>[];
+}

package/src/model/simple-query-text-provider.ts

@@ -0,0 +1,18 @@
+import { QueryTextProvider } from './query-text-provider.js';
+import { StringRatchet } from '@bitblit/ratchet-common/lang/string-ratchet';
+
+export class SimpleQueryTextProvider implements QueryTextProvider {
+  constructor(private values: Record<string, string>) {}
+
+  public fetchQuery(queryDottedPath: string): string {
+    let rval: string = null;
+    if (StringRatchet.trimToNull(queryDottedPath)) {
+      rval = (this.values ?? {})[queryDottedPath];
+    }
+    return rval;
+  }
+
+  public fetchAllQueries(): Record<string, string> {
+    return Object.assign({}, this.values ?? {});
+  }
+}

package/src/model/sort-direction.ts

@@ -0,0 +1,4 @@
+export enum SortDirection {
+  Asc = 'Asc',
+  Desc = 'Desc',
+}

package/src/model/ssh/ssh-tunnel-config.ts

@@ -0,0 +1,8 @@
+export interface SshTunnelConfig {
+  forceLocalPort?: number;
+  keepAlive: boolean;
+  username: string;
+  host: string;
+  port: number;
+  privateKey: string;
+}

package/src/model/ssh/ssh-tunnel-container.ts

@@ -0,0 +1,13 @@
+import type { ListenOptions, Server } from 'net';
+import type { ConnectConfig, Connection } from 'ssh2';
+import * as TunnelSsh from 'tunnel-ssh';
+
+export interface SshTunnelContainer {
+  tunnelOptions: TunnelSsh.TunnelOptions;
+  serverOptions: ListenOptions;
+  sshOptions: ConnectConfig;
+  forwardOptions: TunnelSsh.ForwardOptions;
+  server: Server;
+  localPort: number;
+  connection?: Connection;
+}

package/src/model/transaction-isolation-level.ts

@@ -0,0 +1,4 @@
+export enum TransactionIsolationLevel {
+  Default = 'Default',
+  ReadUncommitted = 'READ UNCOMMITTED',
+}

package/src/mysql/model/mysql-db-config.ts

@@ -0,0 +1,14 @@
+import { SshTunnelConfig } from '../../model/ssh/ssh-tunnel-config.js';
+
+export interface MysqlDbConfig {
+  label: string;
+  host: string;
+  port: number;
+  user: string;
+  password: string;
+  database: string;
+  sshTunnelConfig?: SshTunnelConfig;
+
+  ssl?: string | Record<string, any>;
+  decimalNumbers?: boolean;
+}

package/src/mysql/model/mysql-master-status.ts

@@ -0,0 +1,6 @@
+export interface MysqlMasterStatus {
+  File: string;
+  Position: number;
+  Binlog_Do_DB: string;
+  Binlog_Ignore_DB: string;
+}

package/src/mysql/model/mysql-slave-status.ts

@@ -0,0 +1,52 @@
+export interface MysqlSlaveStatus {
+  Slave_IO_State: string;
+  Master_Host: string;
+  Master_User: string;
+  Master_Port: number;
+  Connect_Retry: number;
+  Master_Log_File: string;
+  Read_Master_Log_Pos: number;
+  Relay_Log_File: string;
+  Relay_Log_Pos: number;
+  Relay_Master_Log_File: string;
+  Slave_IO_Running: string;
+  Slave_SQL_Running: string;
+  Replicate_Do_DB: string;
+  Replicate_Ignore_DB: string;
+  Replicate_Do_Table: string;
+  Replicate_Ignore_Table: string;
+  Replicate_Wild_Do_Table: string;
+  Replicate_Wild_Ignore_Table: string;
+  Last_Errno: number;
+  Last_Error: string;
+  Skip_Counter: number;
+  Exec_Master_Log_Pos: number;
+  Relay_Log_Space: number;
+  Until_Condition: string;
+  Until_Log_File: string;
+  Until_Log_Pos: number;
+  Master_SSL_Allowed: string;
+  Master_SSL_CA_File: string;
+  Master_SSL_CA_Path: string;
+  Master_SSL_Cert: string;
+  Master_SSL_Cipher: string;
+  Master_SSL_Key: string;
+  Seconds_Behind_Master: number;
+  Master_SSL_Verify_Server_Cert: string;
+  Last_IO_Errno: number;
+  Last_IO_Error: string;
+  Last_SQL_Errno: number;
+  Last_SQL_Error: string;
+  Replicate_Ignore_Server_Ids: string;
+  Master_Server_Id: number;
+  Master_SSL_Crl: string;
+  Master_SSL_Crlpath: string;
+  Using_Gtid: string;
+  Gtid_IO_Pos: string;
+  Replicate_Do_Domain_Ids: string;
+  Replicate_Ignore_Domain_Ids: string;
+  Parallel_Mode: string;
+  SQL_Delay: number;
+  SQL_Remaining_Delay: string;
+  Slave_SQL_Running_State: string;
+}

package/src/mysql/mysql-style-database-access.ts

@@ -0,0 +1,85 @@
+import { Connection, ConnectionOptions, FieldPacket, RowDataPacket } from 'mysql2/promise';
+import { DatabaseAccess } from '../model/database-access.js';
+import { RequestResults } from '../model/request-results.js';
+import { ModifyResults } from '../model/modify-results.js';
+import { DatabaseRequestType } from '../model/database-request-type.js';
+import { Logger } from '@bitblit/ratchet-common/logger/logger';
+
+export class MysqlStyleDatabaseAccess implements DatabaseAccess {
+  constructor(
+    private _connection: Connection,
+    private _connectionOptions: ConnectionOptions,
+  ) {}
+
+  public async testConnection(logTestResults?: boolean): Promise<number | null> {
+    if (logTestResults) {
+      Logger.info('Running connection test');
+    }
+
+    const res: RequestResults<any> = await this.query('SELECT UNIX_TIMESTAMP(now())*1000 AS test', {});
+    const rows = res.results as { test: number }[];
+    const timestamp = rows.length === 1 ? rows[0].test : null;
+    if (logTestResults) {
+      Logger.info('Test returned : %j', timestamp);
+    }
+    return timestamp;
+  }
+
+  public getRawDatabase(): Connection {
+    return this._connection;
+  }
+
+  public getRawDatabaseConfig(): ConnectionOptions {
+    return this._connectionOptions;
+  }
+
+  public testConnectionQueryString(): string {
+    return 'SELECT UNIX_TIMESTAMP(now())*1000 AS test';
+  }
+
+  public async close(): Promise<boolean> {
+    return Promise.resolve(false);
+  }
+
+  public escape(query: any): string {
+    return this._connection.escape(query);
+  }
+
+  public async preQuery(): Promise<void> {
+    this._connection.config.namedPlaceholders = true;
+  }
+
+  public async query<R>(query, fields): Promise<RequestResults<R>> {
+    const [rows, outFields] = await this._connection.query(query, fields);
+
+    const castRows: RowDataPacket[] = rows as RowDataPacket[];
+    const castFields: FieldPacket[] = outFields;
+
+    const rval: RequestResults<R> = {
+      results: castRows as R,
+      fields: castFields,
+    };
+
+    return rval;
+  }
+
+  public async modify(query: string, fields: Record<string, any>): Promise<RequestResults<ModifyResults>> {
+    const tmp: RequestResults<ModifyResults> = await this.query(query, fields);
+    return tmp;
+  }
+
+  public async onRequestSuccessOrFailure(_type: DatabaseRequestType): Promise<void> {
+    this._connection.config.namedPlaceholders = false;
+  }
+
+  /*
+  public async onQueryFailureOnly(): Promise<void> {
+    return Promise.resolve(undefined);
+  }
+
+  public async onQuerySuccessOnly(): Promise<void> {
+    return Promise.resolve(undefined);
+  }
+
+   */
+}