@bytebase/dbhub 0.4.0 → 0.4.1

package/README.md

@@ -98,6 +98,17 @@ docker run --rm --init \
    --dsn "oracle://username:password@localhost:1521/service_name"
 ```
 
+```bash
+# Oracle example with thick mode for connecting to 11g or older 
+docker run --rm --init \
+   --name dbhub \
+   --publish 8080:8080 \
+   bytebase/dbhub-oracle-thick \
+   --transport sse \
+   --port 8080 \
+   --dsn "oracle://username:password@localhost:1521/service_name"
+```
+
 ### NPM
 
 ```bash
@@ -221,6 +232,27 @@ DBHub supports the following database connection string formats:
 | SQLite     | `sqlite:///[path/to/file]` or `sqlite::memory:`           | `sqlite:///path/to/database.db`, `sqlite:C:/Users/YourName/data/database.db (windows)` or `sqlite::memory:` |
 | Oracle     | `oracle://[user]:[password]@[host]:[port]/[service_name]` | `oracle://username:password@localhost:1521/service_name`                                                    |
 
+#### Oracle
+
+If you see the error "NJS-138: connections to this database server version are not supported by node-oracledb in Thin mode", you need to use Thick mode as described below.
+
+##### Docker
+
+Use `bytebase/dbhub-oracle-thick` instead of `bytebase/dbhub` docker image.
+
+##### npx
+
+1. Download and install [Oracle Instant Client](https://www.oracle.com/database/technologies/instant-client/downloads.html) for your platform
+1. Set the `ORACLE_LIB_DIR` environment variable to the path of your Oracle Instant Client:
+
+```bash
+# Set environment variable to Oracle Instant Client directory
+export ORACLE_LIB_DIR=/path/to/instantclient_19_8
+
+# Then run DBHub
+npx @bytebase/dbhub --dsn "oracle://username:password@localhost:1521/service_name"
+```
+
 #### SQL Server
 
 Extra query parameters:

package/dist/index.js

@@ -1680,6 +1680,16 @@ var OracleConnector = class {
         }
       }
     };
+    try {
+      if (process.env.ORACLE_LIB_DIR) {
+        oracledb.initOracleClient({ libDir: process.env.ORACLE_LIB_DIR });
+        console.error("Oracle client initialized in Thick mode");
+      } else {
+        console.error("ORACLE_LIB_DIR not specified, will use Thin mode by default");
+      }
+    } catch (err) {
+      console.error("Failed to initialize Oracle client:", err);
+    }
     oracledb.autoCommit = true;
   }
   async connect(dsn, initializationScript) {
@@ -1704,6 +1714,19 @@ var OracleConnector = class {
       }
     } catch (error) {
       console.error("Failed to connect to Oracle database:", error);
+      if (error instanceof Error && error.message.includes("NJS-138")) {
+        const enhancedError = new Error(
+          `${error.message}
+
+This error occurs when your Oracle database version is not supported by node-oracledb in Thin mode.
+To resolve this, you need to use Thick mode:
+1. Download Oracle Instant Client from https://www.oracle.com/database/technologies/instant-client/downloads.html
+2. Set ORACLE_LIB_DIR environment variable to the path of your Oracle Instant Client
+   Example: export ORACLE_LIB_DIR=/path/to/instantclient_19_8
+3. Restart DBHub`
+        );
+        throw enhancedError;
+      }
       throw error;
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytebase/dbhub",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Universal Database MCP Server",
   "main": "dist/index.js",
   "type": "module",