@zz1996/dbhub-dameng 0.1.0

package/docs/dameng-connector-plan.md

@@ -0,0 +1,143 @@
+# Dameng/DM8 Connector Plan
+
+This fork tracks the work needed to add Dameng/DM8 support to DBHub without
+changing DBHub's MCP surface area. The desired result is that agents can keep
+using `search_objects` and `execute_sql`, while Dameng behaves like the existing
+PostgreSQL/MySQL/SQL Server/SQLite connectors.
+
+## Current Baseline
+
+- Upstream repository: `https://github.com/bytebase/dbhub.git`
+- Local branch: `dameng-connector`
+- Upstream connector types currently include PostgreSQL, MySQL, MariaDB,
+  SQL Server, and SQLite.
+- DBHub is MIT licensed, so this fork can be modified and used locally while
+  preserving the upstream license notice.
+
+## Implementation Checklist
+
+1. Add `dameng` to connector type definitions.
+   - `src/connectors/interface.ts`
+   - `src/types/config.ts`
+   - `src/api/openapi.yaml`
+   - regenerate `src/api/openapi.d.ts`
+
+2. Add DSN support.
+   - Accept `dameng://user:password@host:5236/schema`.
+   - Map default port `5236`.
+   - Update `src/utils/dsn-obfuscate.ts`.
+
+3. Add driver loading.
+   - Add optional dependency `dmdb`.
+   - Add a lazy loader entry in `src/index.ts`.
+   - Keep startup behavior consistent with other optional database drivers.
+
+4. Implement `src/connectors/dameng/index.ts`.
+   - `clone`
+   - `connect`
+   - `disconnect`
+   - `getSchemas`
+   - `getDefaultSchema`
+   - `getTables`
+   - `getViews`
+   - `getTableSchema`
+   - `tableExists`
+   - `getTableIndexes`
+   - `getStoredProcedures`
+   - `getStoredProcedureDetail`
+   - `getTableRowCount`
+   - `getTableComment`
+   - `executeSQL`
+
+5. Add read-only handling.
+   - Add Dameng allowed keywords in `src/utils/allowed-keywords.ts`.
+   - Add Dameng scanner fallback in `src/utils/sql-parser.ts` if needed.
+   - Prefer database account permissions as the primary safety boundary.
+
+6. Add identifier quoting and parameter mapping.
+   - `src/utils/identifier-quoter.ts`
+   - `src/utils/parameter-mapper.ts`
+   - Dameng generally accepts Oracle-style uppercase identifiers and bind
+     variables; verify actual `dmdb` binding shape before finalizing.
+
+7. Add docs and examples.
+   - `dbhub.dameng.toml.example`
+   - README support list
+   - docs installation/configuration references if this fork is published.
+
+8. Add tests.
+   - Unit tests for DSN parsing and readonly SQL classification.
+   - Connector tests against a reachable DM8 instance when available.
+   - Build smoke test before using the MCP server in an agent.
+
+## Useful Catalog Queries
+
+List schemas:
+
+```sql
+SELECT USERNAME AS SCHEMA_NAME
+FROM ALL_USERS
+WHERE USERNAME NOT IN ('SYS', 'SYSTEM', 'SYSAUDITOR', 'SYSSSO', 'CTISYS')
+ORDER BY USERNAME;
+```
+
+List tables:
+
+```sql
+SELECT TABLE_NAME
+FROM ALL_TABLES
+WHERE OWNER = :owner
+ORDER BY TABLE_NAME;
+```
+
+List columns:
+
+```sql
+SELECT COLUMN_NAME, DATA_TYPE, DATA_LENGTH, DATA_PRECISION, DATA_SCALE,
+       NULLABLE, DATA_DEFAULT, COLUMN_ID
+FROM ALL_TAB_COLUMNS
+WHERE OWNER = :owner AND TABLE_NAME = :table
+ORDER BY COLUMN_ID;
+```
+
+List indexes:
+
+```sql
+SELECT i.INDEX_NAME, i.UNIQUENESS, ic.COLUMN_NAME, ic.COLUMN_POSITION
+FROM ALL_INDEXES i
+JOIN ALL_IND_COLUMNS ic
+  ON i.OWNER = ic.INDEX_OWNER AND i.INDEX_NAME = ic.INDEX_NAME
+WHERE i.TABLE_OWNER = :owner AND i.TABLE_NAME = :table
+ORDER BY i.INDEX_NAME, ic.COLUMN_POSITION;
+```
+
+Table comments:
+
+```sql
+SELECT COMMENTS
+FROM ALL_TAB_COMMENTS
+WHERE OWNER = :owner AND TABLE_NAME = :table;
+```
+
+Column comments:
+
+```sql
+SELECT COLUMN_NAME, COMMENTS
+FROM ALL_COL_COMMENTS
+WHERE OWNER = :owner AND TABLE_NAME = :table;
+```
+
+## Suggested First Milestone
+
+Build the minimum useful connector first:
+
+- DSN parser
+- `connect` / `disconnect`
+- `executeSQL`
+- `getSchemas`
+- `getTables`
+- `getTableSchema`
+- readonly keyword support
+
+After that, wire the connector into `search_objects` and test agent behavior
+with `detail_level: "names"` before adding richer metadata.

package/package.json

@@ -0,0 +1,110 @@
+{
+  "name": "@zz1996/dbhub-dameng",
+  "version": "0.1.0",
+  "mcpName": "io.github.zuozh11/dbhub-dameng",
+  "description": "Local fork of DBHub with Dameng/DM8 database connector support",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zuozh11/dbhub-dameng.git"
+  },
+  "homepage": "https://github.com/zuozh11/dbhub-dameng#readme",
+  "bugs": {
+    "url": "https://github.com/zuozh11/dbhub-dameng/issues"
+  },
+  "main": "dist/index.js",
+  "type": "module",
+  "bin": {
+    "dbhub-dameng": "dist/index.js"
+  },
+  "files": [
+    "dist",
+    "dbhub.dameng.toml.example",
+    "docs/dameng-connector-plan.md",
+    "LICENSE",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "pnpm run generate:api-types && tsup && cd frontend && pnpm run build",
+    "build:backend": "npm run generate:api-types && tsup",
+    "build:frontend": "cd frontend && pnpm run build",
+    "start": "node dist/index.js",
+    "dev": "concurrently --kill-others \"pnpm run dev:backend\" \"pnpm run dev:frontend\"",
+    "dev:backend": "NODE_ENV=development tsx src/index.ts --transport=http",
+    "dev:frontend": "cd frontend && pnpm run dev",
+    "crossdev": "cross-env NODE_ENV=development tsx src/index.ts",
+    "generate:api-types": "openapi-typescript src/api/openapi.yaml -o src/api/openapi.d.ts",
+    "test": "vitest run",
+    "test:unit": "vitest run --project unit",
+    "test:watch": "vitest",
+    "test:integration": "vitest run --project integration",
+    "test:build": "node scripts/smoke-test-build.mjs",
+    "prepublishOnly": "npm run build:backend"
+  },
+  "engines": {
+    "node": ">=22.5.0"
+  },
+  "packageManager": "pnpm@10.17.1",
+  "keywords": [
+    "mcp",
+    "database",
+    "dbhub",
+    "dameng",
+    "dm8"
+  ],
+  "author": "zuozh11",
+  "license": "MIT",
+  "dependencies": {
+    "@iarna/toml": "^2.2.5",
+    "@modelcontextprotocol/sdk": "^1.25.1",
+    "dotenv": "^16.4.7",
+    "express": "^4.18.2",
+    "ssh-config": "^5.0.3",
+    "ssh2": "^1.16.0",
+    "zod": "^3.24.2"
+  },
+  "optionalDependencies": {
+    "@aws-sdk/rds-signer": "^3.1001.0",
+    "@azure/identity": "^4.8.0",
+    "mariadb": "^3.4.0",
+    "mssql": "^11.0.1",
+    "mysql2": "^3.13.0",
+    "pg": "^8.13.3",
+    "dmdb": "^1.0.49630"
+  },
+  "devDependencies": {
+    "@testcontainers/mariadb": "^11.0.3",
+    "@testcontainers/mssqlserver": "^11.0.3",
+    "@testcontainers/mysql": "^11.0.3",
+    "@testcontainers/postgresql": "^11.0.3",
+    "@types/express": "^4.17.21",
+    "@types/mssql": "^9.1.7",
+    "@types/node": "^22.13.10",
+    "@types/pg": "^8.11.11",
+    "@types/ssh2": "^1.15.5",
+    "concurrently": "^9.2.1",
+    "cross-env": "^7.0.3",
+    "openapi-typescript": "^7.10.1",
+    "prettier": "^3.5.3",
+    "testcontainers": "^11.0.3",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.4.0",
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.2",
+    "vitest": "^4.0.6"
+  },
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "strict": true,
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": [
+    "src/**/*"
+  ]
+}