oracle thick mode support #843

plugins/dbgate-plugin-oracle/src/backend/driver.js

@@ -1,13 +1,22 @@
 const _ = require('lodash');
 const stream = require('stream');
 
-const driverBases = require('../frontend/drivers');
+const driverBase = require('../frontend/driver');
 const Analyser = require('./Analyser');
-//--const pg = require('pg');
-const oracledb = require('oracledb');
 const { createBulkInsertStreamBase, makeUniqueColumnNames } = require('dbgate-tools');
 const createOracleBulkInsertStream = require('./createOracleBulkInsertStream');
 
+let requireOracledb;
+
+let oracledbValue;
+function getOracledb() {
+  if (!oracledbValue) {
+    oracledbValue = requireOracledb();
+  }
+  return oracledbValue;
+}
+
+
 /*
 pg.types.setTypeParser(1082, 'text', val => val); // date
 pg.types.setTypeParser(1114, 'text', val => val); // timestamp without timezone
@@ -33,8 +42,10 @@ function zipDataRow(rowArray, columns) {
   return obj;
 }
 
+let oracleClientInitialized = false;
+
 /** @type {import('dbgate-types').EngineDriver} */
-const drivers = driverBases.map(driverBase => ({
+const driver = {
   ...driverBase,
   analyserClass: Analyser,
 
@@ -51,8 +62,14 @@ const drivers = driverBases.map(driverBase => ({
     ssl,
     isReadOnly,
     authType,
+    clientLibraryPath,
     socketPath,
   }) {
+    const oracledb = getOracledb();
+    if (authType == 'thick' && !oracleClientInitialized) {
+      oracledb.initOracleClient({ libDir: clientLibraryPath });
+      oracleClientInitialized = true;
+    }
     client = await oracledb.getConnection({
       user,
       password,
@@ -312,15 +329,21 @@ const drivers = driverBases.map(driverBase => ({
   getAuthTypes() {
     return [
       {
-        title: 'Host and port',
-        name: 'hostPort',
+        title: 'Thin mode (default) - direct connection to Oracle database',
+        name: 'thin',
       },
       {
-        title: 'Socket',
-        name: 'socket',
+        title: 'Thick mode - connection via Oracle instant client',
+        name: 'thick',
       },
     ];
   },
-}));
+};
 
-module.exports = drivers;
+driver.initialize = (dbgateEnv) => {
+  if (dbgateEnv.nativeModules && dbgateEnv.nativeModules['oracledb']) {
+    requireOracledb = dbgateEnv.nativeModules['oracledb'];
+  }
+};
+
+module.exports = driver;

plugins/dbgate-plugin-oracle/src/backend/index.js

@@ -1,6 +1,9 @@
-const drivers = require('./drivers');
+const driver = require('./driver');
 
 module.exports = {
   packageName: 'dbgate-plugin-oracle',
-  drivers,
+  drivers: [driver],
+  initialize(dbgateEnv) {
+    driver.initialize(dbgateEnv);
+  },
 };

plugins/dbgate-plugin-oracle/src/frontend/driver.js

@@ -82,10 +82,15 @@ const dialect = {
   },
 };
 
-const oracleDriverBase = {
-  ...driverBase,
-  dumperClass: Dumper,
+/** @type {import('dbgate-types').EngineDriver} */
+const oracleDriver = {
+  engine: 'oracle@dbgate-plugin-oracle',
+  title: 'OracleDB',
+  defaultPort: 1521,
+  authTypeLabel: 'Driver mode',
+  defaultAuthTypeName: 'thin',
   dialect,
+  dumperClass: Dumper,
   // showConnectionField: (field, values) =>
   //   ['server', 'port', 'user', 'password', 'defaultDatabase', 'singleDatabase'].includes(field),
   getQuerySplitterOptions: () => oracleSplitterOptions,
@@ -93,8 +98,12 @@ const oracleDriverBase = {
 
   databaseUrlPlaceholder: 'e.g. localhost:1521/orcl',
 
+  
   showConnectionField: (field, values) => {
     if (field == 'useDatabaseUrl') return true;
+    if (field == 'authType') return true;
+    if (field == 'clientLibraryPath') return values.authType == 'thick';
+
     if (values.useDatabaseUrl) {
       return ['databaseUrl', 'user', 'password'].includes(field);
     }
@@ -126,18 +135,6 @@ $$ LANGUAGE plpgsql;`,
       },
     ];
   },
-};
-
-/** @type {import('dbgate-types').EngineDriver} */
-const oracleDriver = {
-  ...oracleDriverBase,
-  engine: 'oracle@dbgate-plugin-oracle',
-  title: 'OracleDB',
-  defaultPort: 1521,
-  dialect: {
-    ...dialect,
-    materializedViews: true,
-  },
 
   dialectByVersion(version) {
     if (version) {
@@ -156,4 +153,4 @@ const oracleDriver = {
   showConnectionTab: field => field == 'sshTunnel',
 };
 
-module.exports = [oracleDriver];
+module.exports = oracleDriver;

plugins/dbgate-plugin-oracle/src/frontend/index.js

@@ -1,6 +1,6 @@
-import drivers from './drivers';
+import driver from './driver';
 
 export default {
   packageName: 'dbgate-plugin-oracle',
-  drivers,
+  drivers: [driver],
 };