oak-db 3.3.14 → 4.0.1

package/README.md

@@ -1,3 +1,7 @@
 # oak-db
 
-oak-db
+oak-db
+
+## Docs
+
+- [Schema Migration Guide](./docs/schema-migration.md)

package/lib/MySQL/connector.d.ts

@@ -1,6 +1,10 @@
-import mysql, { Pool } from 'mysql2/promise';
+import mysql, { Pool, PoolConnection } from 'mysql2/promise';
 import { TxnOption } from 'oak-domain/lib/types';
+import { EntityDict, StorageSchema } from 'oak-domain/lib/types';
+import { EntityDict as BaseEntityDict } from 'oak-domain/lib/base-app-domain';
 import { MySQLConfiguration } from './types/Configuration';
+import { MySqlTranslator } from './translator';
+import { MigrationPlanningOptions, Plan, SchemaInspectionResult } from '../types/migration';
 export declare class MySqlConnector {
     pool: Pool;
     configuration: MySQLConfiguration;
@@ -10,6 +14,10 @@ export declare class MySqlConnector {
     disconnect(): Promise<void>;
     startTransaction(option?: TxnOption): Promise<string>;
     exec(sql: string, txn?: string): Promise<[mysql.RowDataPacket[] | mysql.RowDataPacket[][] | mysql.OkPacket | mysql.OkPacket[] | mysql.ResultSetHeader, mysql.FieldPacket[]]>;
+    withConnection<T>(handler: (connection: PoolConnection) => Promise<T>): Promise<T>;
+    readSchema<ED extends EntityDict & BaseEntityDict>(translator: MySqlTranslator<ED>): Promise<StorageSchema<ED>>;
+    inspectSchema<ED extends EntityDict & BaseEntityDict>(translator: MySqlTranslator<ED>): Promise<SchemaInspectionResult<ED>>;
+    diffSchema<ED extends EntityDict & BaseEntityDict>(currentSchema: StorageSchema<ED>, targetSchema: StorageSchema<ED>, translator: MySqlTranslator<ED>, options?: MigrationPlanningOptions): Plan<ED>;
     commitTransaction(txn: string): Promise<void>;
     rollbackTransaction(txn: string): Promise<void>;
 }

package/lib/MySQL/connector.js

@@ -5,6 +5,7 @@ const tslib_1 = require("tslib");
 const promise_1 = tslib_1.__importDefault(require("mysql2/promise"));
 const uuid_1 = require("uuid");
 const assert_1 = tslib_1.__importDefault(require("assert"));
+const migration_1 = require("./migration");
 class MySqlConnector {
     pool;
     configuration;
@@ -52,6 +53,29 @@ class MySqlConnector {
             return result;
         }
     }
+    async withConnection(handler) {
+        const connection = await this.pool.getConnection();
+        try {
+            return await handler(connection);
+        }
+        finally {
+            try {
+                connection.release();
+            }
+            catch {
+                // The caller may destroy the connection when the session becomes unusable.
+            }
+        }
+    }
+    async readSchema(translator) {
+        return (0, migration_1.readMySqlSchema)(this, translator);
+    }
+    async inspectSchema(translator) {
+        return (0, migration_1.inspectMySqlSchema)(this, translator);
+    }
+    diffSchema(currentSchema, targetSchema, translator, options) {
+        return (0, migration_1.buildMySqlMigrationPlan)(currentSchema, targetSchema, translator, options);
+    }
     async commitTransaction(txn) {
         const connection = this.txnDict[txn];
         (0, assert_1.default)(connection);

package/lib/MySQL/migration.d.ts

@@ -0,0 +1,10 @@
+import { EntityDict } from 'oak-domain/lib/types';
+import { EntityDict as BaseEntityDict } from 'oak-domain/lib/base-app-domain';
+import { MigrationSchema, MigrationPlanningOptions, Plan, SchemaInspectionResult } from '../types/migration';
+import { MySqlConnector } from './connector';
+import { MySqlTranslator } from './translator';
+type MySqlMigrationEntityDict = EntityDict & BaseEntityDict;
+export declare function readMySqlSchema<ED extends MySqlMigrationEntityDict>(connector: MySqlConnector, translator: MySqlTranslator<ED>): Promise<MigrationSchema<ED>>;
+export declare function inspectMySqlSchema<ED extends MySqlMigrationEntityDict>(connector: MySqlConnector, translator: MySqlTranslator<ED>): Promise<SchemaInspectionResult<ED>>;
+export declare function buildMySqlMigrationPlan<ED extends MySqlMigrationEntityDict>(currentSchema: MigrationSchema<ED>, targetSchema: MigrationSchema<ED>, translator: MySqlTranslator<ED>, options?: MigrationPlanningOptions): Plan<ED>;
+export {};