dbgate-api 5.5.4-alpha.1 → 5.5.4-alpha.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dbgate-api",
   "main": "src/index.js",
-  "version": "5.5.4-alpha.1",
+  "version": "5.5.4-alpha.3",
   "homepage": "https://dbgate.org/",
   "repository": {
     "type": "git",
@@ -26,10 +26,10 @@
     "compare-versions": "^3.6.0",
     "cors": "^2.8.5",
     "cross-env": "^6.0.3",
-    "dbgate-datalib": "^5.5.4-alpha.1",
+    "dbgate-datalib": "^5.5.4-alpha.3",
     "dbgate-query-splitter": "^4.10.5",
-    "dbgate-sqltree": "^5.5.4-alpha.1",
-    "dbgate-tools": "^5.5.4-alpha.1",
+    "dbgate-sqltree": "^5.5.4-alpha.3",
+    "dbgate-tools": "^5.5.4-alpha.3",
     "debug": "^4.3.4",
     "diff": "^5.0.0",
     "diff2html": "^3.4.13",
@@ -75,7 +75,7 @@
   "devDependencies": {
     "@types/fs-extra": "^9.0.11",
     "@types/lodash": "^4.14.149",
-    "dbgate-types": "^5.5.4-alpha.1",
+    "dbgate-types": "^5.5.4-alpha.3",
     "env-cmd": "^10.1.0",
     "node-loader": "^1.0.2",
     "nodemon": "^2.0.2",

package/src/currentVersion.js

@@ -1,5 +1,5 @@
 
 module.exports = { 
-  version: '5.5.4-alpha.1',
-  buildTime: '2024-10-01T07:21:08.626Z'
+  version: '5.5.4-alpha.3',
+  buildTime: '2024-10-01T09:09:17.169Z'
 };

package/src/shell/dataDuplicator.js

@@ -19,32 +19,39 @@ async function dataDuplicator({
   systemConnection,
 }) {
   if (!driver) driver = requireEngineDriver(connection);
-  const pool = systemConnection || (await connectUtility(driver, connection, 'write'));
+  
+  const dbhan = systemConnection || (await connectUtility(driver, connection, 'write'));
 
-  logger.info(`Connected.`);
+  try {
+    logger.info(`Connected.`);
 
-  if (!analysedStructure) {
-    analysedStructure = await driver.analyseFull(pool);
-  }
+    if (!analysedStructure) {
+      analysedStructure = await driver.analyseFull(dbhan);
+    }
 
-  const dupl = new DataDuplicator(
-    pool,
-    driver,
-    analysedStructure,
-    items.map(item => ({
-      name: item.name,
-      operation: item.operation,
-      matchColumns: item.matchColumns,
-      openStream:
-        item.openStream ||
-        (() => jsonLinesReader({ fileName: path.join(resolveArchiveFolder(archive), `${item.name}.jsonl`) })),
-    })),
-    stream,
-    copyStream,
-    options
-  );
+    const dupl = new DataDuplicator(
+      dbhan,
+      driver,
+      analysedStructure,
+      items.map(item => ({
+        name: item.name,
+        operation: item.operation,
+        matchColumns: item.matchColumns,
+        openStream:
+          item.openStream ||
+          (() => jsonLinesReader({ fileName: path.join(resolveArchiveFolder(archive), `${item.name}.jsonl`) })),
+      })),
+      stream,
+      copyStream,
+      options
+    );
 
-  await dupl.run();
+    await dupl.run();
+  } finally {
+    if (!systemConnection) {
+      await driver.close(dbhan);
+    }
+  }
 }
 
 module.exports = dataDuplicator;

package/src/shell/dumpDatabase.js

@@ -27,15 +27,23 @@ async function dumpDatabase({
   logger.info(`Dumping database`);
 
   if (!driver) driver = requireEngineDriver(connection);
-  const pool = systemConnection || (await connectUtility(driver, connection, 'read', { forceRowsAsObjects: true }));
-  logger.info(`Connected.`);
 
-  const dumper = await driver.createBackupDumper(pool, {
-    outputFile,
-    databaseName,
-    schemaName,
-  });
-  await doDump(dumper);
+  const dbhan = systemConnection || (await connectUtility(driver, connection, 'read', { forceRowsAsObjects: true }));
+
+  try {
+    logger.info(`Connected.`);
+
+    const dumper = await driver.createBackupDumper(dbhan, {
+      outputFile,
+      databaseName,
+      schemaName,
+    });
+    await doDump(dumper);
+  } finally {
+    if (!systemConnection) {
+      await driver.close(dbhan);
+    }
+  }
 }
 
 module.exports = dumpDatabase;

package/src/shell/executeQuery.js

@@ -8,10 +8,17 @@ async function executeQuery({ connection = undefined, systemConnection = undefin
   logger.info({ sql }, `Execute query`);
 
   if (!driver) driver = requireEngineDriver(connection);
-  const pool = systemConnection || (await connectUtility(driver, connection, 'script'));
-  logger.info(`Connected.`);
+  const dbhan = systemConnection || (await connectUtility(driver, connection, 'script'));
 
-  await driver.script(pool, sql);
+  try {
+    logger.info(`Connected.`);
+
+    await driver.script(dbhan, sql);
+  } finally {
+    if (!systemConnection) {
+      await driver.close(dbhan);
+    }
+  }
 }
 
 module.exports = executeQuery;

package/src/shell/generateDeploySql.js

@@ -21,41 +21,49 @@ async function generateDeploySql({
 }) {
   if (!driver) driver = requireEngineDriver(connection);
 
-  const pool = systemConnection || (await connectUtility(driver, connection, 'read'));
-  if (!analysedStructure) {
-    analysedStructure = await driver.analyseFull(pool);
-  }
+  const dbhan = systemConnection || (await connectUtility(driver, connection, 'read'));
+
+  try {
+    if (!analysedStructure) {
+      analysedStructure = await driver.analyseFull(dbhan);
+    }
 
-  const deployedModel = generateDbPairingId(
-    extendDatabaseInfo(loadedDbModel ? databaseInfoFromYamlModel(loadedDbModel) : await importDbModel(modelFolder))
-  );
-  const currentModel = generateDbPairingId(extendDatabaseInfo(analysedStructure));
-  const opts = {
-    ...modelCompareDbDiffOptions,
+    const deployedModel = generateDbPairingId(
+      extendDatabaseInfo(loadedDbModel ? databaseInfoFromYamlModel(loadedDbModel) : await importDbModel(modelFolder))
+    );
+    const currentModel = generateDbPairingId(extendDatabaseInfo(analysedStructure));
+    const opts = {
+      ...modelCompareDbDiffOptions,
 
-    noDropTable: true,
-    noDropColumn: true,
-    noDropConstraint: true,
-    noDropSqlObject: true,
-    noRenameTable: true,
-    noRenameColumn: true,
-  };
-  const currentModelPaired = matchPairedObjects(deployedModel, currentModel, opts);
-  const currentModelPairedPreloaded = await enrichWithPreloadedRows(deployedModel, currentModelPaired, pool, driver);
+      noDropTable: true,
+      noDropColumn: true,
+      noDropConstraint: true,
+      noDropSqlObject: true,
+      noRenameTable: true,
+      noRenameColumn: true,
+    };
+    const currentModelPaired = matchPairedObjects(deployedModel, currentModel, opts);
+    const currentModelPairedPreloaded = await enrichWithPreloadedRows(deployedModel, currentModelPaired, dbhan, driver);
 
-  // console.log('currentModelPairedPreloaded', currentModelPairedPreloaded.tables[0]);
-  // console.log('deployedModel', deployedModel.tables[0]);
-  // console.log('currentModel', currentModel.tables[0]);
-  // console.log('currentModelPaired', currentModelPaired.tables[0]);
-  const res = getAlterDatabaseScript(
-    currentModelPairedPreloaded,
-    deployedModel,
-    opts,
-    currentModelPairedPreloaded,
-    deployedModel,
-    driver
-  );
-  return res;
+    // console.log('currentModelPairedPreloaded', currentModelPairedPreloaded.tables[0]);
+    // console.log('deployedModel', deployedModel.tables[0]);
+    // console.log('currentModel', currentModel.tables[0]);
+    // console.log('currentModelPaired', currentModelPaired.tables[0]);
+    const res = getAlterDatabaseScript(
+      currentModelPairedPreloaded,
+      deployedModel,
+      opts,
+      currentModelPairedPreloaded,
+      deployedModel,
+      driver
+    );
+    
+    return res;
+  } finally {
+    if (!systemConnection) {
+      await driver.close(dbhan);
+    }
+  }
 }
 
 module.exports = generateDeploySql;

package/src/shell/importDatabase.js

@@ -59,21 +59,27 @@ async function importDatabase({ connection = undefined, systemConnection = undef
 
   if (!driver) driver = requireEngineDriver(connection);
   const dbhan = systemConnection || (await connectUtility(driver, connection, 'write'));
-  logger.info(`Connected.`);
+  try {
+    logger.info(`Connected.`);
 
-  logger.info(`Input file: ${inputFile}`);
-  const downloadedFile = await download(inputFile);
-  logger.info(`Downloaded file: ${downloadedFile}`);
+    logger.info(`Input file: ${inputFile}`);
+    const downloadedFile = await download(inputFile);
+    logger.info(`Downloaded file: ${downloadedFile}`);
 
-  const fileStream = fs.createReadStream(downloadedFile, 'utf-8');
-  const splittedStream = splitQueryStream(fileStream, {
-    ...driver.getQuerySplitterOptions('import'),
-    returnRichInfo: true,
-  });
-  const importStream = new ImportStream(dbhan, driver);
-  // @ts-ignore
-  splittedStream.pipe(importStream);
-  await awaitStreamEnd(importStream);
+    const fileStream = fs.createReadStream(downloadedFile, 'utf-8');
+    const splittedStream = splitQueryStream(fileStream, {
+      ...driver.getQuerySplitterOptions('import'),
+      returnRichInfo: true,
+    });
+    const importStream = new ImportStream(dbhan, driver);
+    // @ts-ignore
+    splittedStream.pipe(importStream);
+    await awaitStreamEnd(importStream);
+  } finally {
+    if (!systemConnection) {
+      await driver.close(dbhan);
+    }
+  }
 }
 
 module.exports = importDatabase;

package/src/shell/loadDatabase.js

@@ -9,13 +9,19 @@ async function loadDatabase({ connection = undefined, systemConnection = undefin
   logger.info(`Analysing database`);
 
   if (!driver) driver = requireEngineDriver(connection);
-  const pool = systemConnection || (await connectUtility(driver, connection, 'read', { forceRowsAsObjects: true }));
-  logger.info(`Connected.`);
+  const dbhan = systemConnection || (await connectUtility(driver, connection, 'read', { forceRowsAsObjects: true }));
+  try {
+    logger.info(`Connected.`);
 
-  const dbInfo = await driver.analyseFull(pool);
-  logger.info(`Analyse finished`);
+    const dbInfo = await driver.analyseFull(dbhan);
+    logger.info(`Analyse finished`);
 
-  await exportDbModel(dbInfo, outputDir);
+    await exportDbModel(dbInfo, outputDir);
+  } finally {
+    if (!systemConnection) {
+      await driver.close(dbhan);
+    }
+  }
 }
 
 module.exports = loadDatabase;

package/src/shell/tableReader.js

@@ -3,9 +3,9 @@ const requireEngineDriver = require('../utility/requireEngineDriver');
 const connectUtility = require('../utility/connectUtility');
 const logger = getLogger('tableReader');
 
-async function tableReader({ connection, pureName, schemaName }) {
+async function tableReader({ connection, systemConnection, pureName, schemaName }) {
   const driver = requireEngineDriver(connection);
-  const pool = await connectUtility(driver, connection, 'read');
+  const dbhan = systemConnection || (await connectUtility(driver, connection, 'read'));
   logger.info(`Connected.`);
 
   const fullName = { pureName, schemaName };
@@ -14,26 +14,26 @@ async function tableReader({ connection, pureName, schemaName }) {
     // @ts-ignore
     logger.info(`Reading collection ${fullNameToString(fullName)}`);
     // @ts-ignore
-    return await driver.readQuery(pool, JSON.stringify(fullName));
+    return await driver.readQuery(dbhan, JSON.stringify(fullName));
   }
 
-  const table = await driver.analyseSingleObject(pool, fullName, 'tables');
+  const table = await driver.analyseSingleObject(dbhan, fullName, 'tables');
   const query = `select * from ${quoteFullName(driver.dialect, fullName)}`;
   if (table) {
     // @ts-ignore
     logger.info(`Reading table ${fullNameToString(table)}`);
     // @ts-ignore
-    return await driver.readQuery(pool, query, table);
+    return await driver.readQuery(dbhan, query, table);
   }
-  const view = await driver.analyseSingleObject(pool, fullName, 'views');
+  const view = await driver.analyseSingleObject(dbhan, fullName, 'views');
   if (view) {
     // @ts-ignore
     logger.info(`Reading view ${fullNameToString(view)}`);
     // @ts-ignore
-    return await driver.readQuery(pool, query, view);
+    return await driver.readQuery(dbhan, query, view);
   }
 
-  return await driver.readQuery(pool, query);
+  return await driver.readQuery(dbhan, query);
 }
 
 module.exports = tableReader;

package/src/shell/tableWriter.js

@@ -9,10 +9,16 @@ async function tableWriter({ connection, schemaName, pureName, driver, systemCon
   if (!driver) {
     driver = requireEngineDriver(connection);
   }
-  const pool = systemConnection || (await connectUtility(driver, connection, 'write'));
+  const dbhan = systemConnection || (await connectUtility(driver, connection, 'write'));
 
-  logger.info(`Connected.`);
-  return await driver.writeTable(pool, { schemaName, pureName }, options);
+  try {
+    logger.info(`Connected.`);
+    return await driver.writeTable(dbhan, { schemaName, pureName }, options);
+  } finally {
+    if (!systemConnection) {
+      await driver.close(dbhan);
+    }
+  }
 }
 
 module.exports = tableWriter;

package/src/utility/connectUtility.js

@@ -3,9 +3,10 @@ const { decryptConnection } = require('./crypting');
 const { getSshTunnelProxy } = require('./sshTunnelProxy');
 const platformInfo = require('../utility/platformInfo');
 const connections = require('../controllers/connections');
+const _ = require('lodash');
 
 async function loadConnection(driver, storedConnection, connectionMode) {
-  const { allowShellConnection } = platformInfo;
+  const { allowShellConnection, allowConnectionFromEnvVariables } = platformInfo;
 
   if (connectionMode == 'app') {
     return storedConnection;
@@ -33,6 +34,16 @@ async function loadConnection(driver, storedConnection, connectionMode) {
     }
     return loadedWithDb;
   }
+
+  if (allowConnectionFromEnvVariables) {
+    return _.mapValues(storedConnection, (value, key) => {
+      if (_.isString(value) && value.startsWith('$')) {
+        return process.env[value.substring(1)];
+      }
+      return value;
+    });
+  }
+
   return storedConnection;
 }
 

package/src/utility/platformInfo.js

@@ -11,6 +11,7 @@ const isLinux = platform === 'linux';
 const isDocker = fs.existsSync('/home/dbgate-docker/public');
 const isDevMode = process.env.DEVMODE == '1';
 const isNpmDist = !!global['IS_NPM_DIST'];
+const isDbModel = !!global['IS_DB_MODEL'];
 const isForkedApi = processArgs.isForkedApi;
 
 // function moduleAvailable(name) {
@@ -39,8 +40,11 @@ const platformInfo = {
   environment: process.env.NODE_ENV,
   platform,
   runningInWebpack: !!process.env.WEBPACK_DEV_SERVER_URL,
-  allowShellConnection: (!processArgs.listenApiChild && !isNpmDist) || !!process.env.SHELL_CONNECTION || !!isElectron(),
-  allowShellScripting: (!processArgs.listenApiChild && !isNpmDist) || !!process.env.SHELL_SCRIPTING || !!isElectron(),
+  allowShellConnection:
+    (!processArgs.listenApiChild && !isNpmDist) || !!process.env.SHELL_CONNECTION || !!isElectron() || !!isDbModel,
+  allowShellScripting:
+    (!processArgs.listenApiChild && !isNpmDist) || !!process.env.SHELL_SCRIPTING || !!isElectron() || !!isDbModel,
+  allowConnectionFromEnvVariables: !!isDbModel,
   defaultKeyfile: path.join(os.homedir(), '.ssh/id_rsa'),
 };