@rmwxxwmr/mcp-database-service 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 rmwxxwmr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,236 @@
+English | [简体中文](./README.zh-CN.md)
+
+# MCP Database Service
+
+A multi-database MCP server for Model Context Protocol (MCP), written in TypeScript.
+
+It supports MySQL, PostgreSQL, Oracle, openGauss, and Redis, with lazy short-lived connections, read-oriented database tools, SQL plan analysis, config reload, and guarded write execution.
+
+This project is intended for AI agents and MCP clients that need safe database discovery, querying, performance analysis, and controlled write operations.
+
+## Quick Start
+
+Install from npm:
+
+```powershell
+npm install -g @rmwxxwmr/mcp-database-service
+mcp-database-service --config ./config/databases.example.json
+```
+
+Run from source:
+
+```bash
+npm install
+npm run build
+node dist/index.js --config ./config/databases.example.json
+```
+
+## Support Matrix
+
+| Database | Query Tools | Metadata Tools | `explain_query` | `analyze_query` | Write Support |
+| --- | --- | --- | --- | --- | --- |
+| MySQL | Yes | Yes | Yes | Yes | Yes |
+| PostgreSQL | Yes | Yes | Yes | Yes | Yes |
+| openGauss | Yes | Yes | Yes | Yes | Yes |
+| Oracle | Yes | Yes | Yes | No | Yes |
+| Redis | Yes | Limited to Redis tools | No | No | No |
+
+Notes:
+- show_create_table currently supports MySQL and Oracle. PostgreSQL and openGauss currently return NOT_SUPPORTED.
+- Operational tools such as `show_variables`, `find_long_running_queries`, `find_blocking_sessions`, and `show_locks` depend on the visibility and privileges of the configured database account.
+
+## Supported Databases
+- MySQL
+- Oracle
+- PostgreSQL
+- openGauss (via PostgreSQL protocol compatibility)
+- Redis
+
+## Features
+- Multiple named database targets in a single config file
+- Optional file logging with configurable output directory
+- Manual config reload without restarting the MCP server
+- Automatic config reload when the JSON file changes on disk
+- Strict read-only enforcement for query tools
+- Optional write execution with explicit MCP confirmation for writable targets
+- Lazy connections with guaranteed cleanup after each request
+- Metadata discovery tools for SQL databases
+- Dedicated read tools for Redis
+
+## Configuration
+Provide the config path by one of these methods:
+
+1. `node dist/index.js --config ./config/databases.json`
+2. Set `MCP_DATABASE_CONFIG=/absolute/path/to/databases.json`
+
+The configuration file must be a JSON object with a required top-level `databases` array. Optional top-level sections such as `logging` and `query` may also be provided. Example:
+
+```json
+{
+  "logging": {
+    "enabled": true,
+    "directory": "./logs"
+  },
+  "query": {
+    "timeoutMs": 5000
+  },
+  "databases": [
+    {
+      "key": "main-mysql",
+      "type": "mysql",
+      "readonly": true,
+      "connection": {
+        "host": "127.0.0.1",
+        "port": 3306,
+        "databaseName": "app_db",
+        "user": "root",
+        "password": "secret",
+        "connectTimeoutMs": 5000
+      }
+    }
+  ]
+}
+```
+
+`logging.enabled` defaults to `false`. When enabled, logs are written to the system temporary directory by default. You can override that with `logging.directory`, and relative paths are resolved relative to the config file location. In the example above, logs are written under `./logs`.
+
+`query.timeoutMs` is optional. When set, the server applies a query timeout to database operations. In the example above, queries time out after `5000` milliseconds.
+
+Oracle supports both Thin and Thick mode. Thick mode uses the same `oracledb` package, but requires Oracle Instant Client on the host machine. Example:
+
+```json
+{
+  "key": "oracle-thick-example",
+  "type": "oracle",
+  "readonly": true,
+  "connection": {
+    "host": "127.0.0.1",
+    "port": 1521,
+    "serviceName": "XEPDB1",
+    "user": "system",
+    "password": "secret",
+    "clientMode": "thick",
+    "clientLibDir": "C:\\oracle\\instantclient_19_25"
+  }
+}
+```
+
+## Available MCP Tools
+- `show_loaded_config`: show the current in-memory config path, load time, and all configured database targets
+- `reload_config`: reload the JSON config file currently in use and atomically replace the in-memory configuration on success
+- `list_databases`: list all configured target keys and logical database names without opening database connections
+- `ping_database`: test connectivity for one configured target
+- `list_schemas`: list schemas for one SQL target
+- `list_tables`: list tables/views under one SQL schema or the default schema
+- `list_views`: list views under one SQL schema or the default schema
+- `describe_table`: inspect columns before writing joins, reports, or optimization SQL
+- `show_create_table`: inspect exact database-side DDL when the current database supports it
+- `search_tables`: search tables or views by partial name
+- `search_columns`: search columns by partial name across a schema
+- `list_indexes`: inspect table indexes for performance analysis
+- `get_table_statistics`: inspect approximate row counts, storage metrics, and database-specific table statistics
+- `show_variables`: inspect database runtime configuration variables
+- `find_long_running_queries`: inspect currently running sessions above a duration threshold
+- `find_blocking_sessions`: inspect current blocking relationships between sessions
+- `show_locks`: inspect current lock rows exposed by the database
+- `execute_query`: run one read-only SQL query; pass the original query SQL, not write SQL
+- `explain_query`: get the static execution plan for one read-only SQL query; pass the original query SQL, not `EXPLAIN ...`
+- `analyze_query`: get runtime analysis for one read-only SQL query; pass the original query SQL, not `EXPLAIN ANALYZE ...`
+- `execute_statement`: run one non-query SQL statement on a writable target after explicit manual confirmation
+- `redis_get`: read one Redis string key
+- `redis_hgetall`: read one Redis hash key
+- `redis_scan`: cursor-scan Redis keys safely with an optional pattern
+
+## Development
+
+```bash
+npm install
+npm run build
+node dist/index.js --config ./config/databases.example.json
+```
+
+## Global Installation
+
+This project exposes a CLI command named `mcp-database-service` through the package `bin` field.
+
+Recommended options:
+
+1. Install from npm:
+
+```powershell
+npm install -g @rmwxxwmr/mcp-database-service
+```
+
+2. Or install from the local source tree with the helper script:
+
+```powershell
+pwsh -File .\scripts\install-global.ps1
+```
+
+Or on Linux/macOS:
+
+```bash
+sh ./scripts/install-global.sh
+```
+
+The helper scripts install dependencies, build the project, create a tarball with `npm pack`, install that tarball globally with `npm install -g <tarball>`, and then delete the temporary tarball. They do not use `npm link`.
+
+3. Or install the packed tarball manually:
+
+```powershell
+npm pack
+npm install -g .\mcp-database-service-0.1.0.tgz
+```
+
+The package only publishes runtime files through the `files` field, so packaged installation includes `dist` and the runtime README/config example, not the whole source tree.
+
+After installation, the command can be used like this:
+
+```powershell
+mcp-database-service --config .\config\databases.example.json
+```
+
+Example MCP server configuration:
+
+```json
+{
+  "mcpServers": {
+    "database": {
+      "command": "mcp-database-service",
+      "args": [
+        "--config",
+        "C:\\path\\to\\databases.json"
+      ]
+    }
+  }
+}
+```
+
+## Config Reload
+
+- The server loads the JSON config file at startup and keeps a validated in-memory snapshot.
+- The server also watches the same JSON file and automatically reloads it after on-disk changes are detected.
+- Automatic reload is debounced to avoid reloading half-written files too aggressively.
+- You can still use `reload_config` to force a manual reload without restarting the process.
+- Reload is atomic: if the new file is invalid, the old in-memory configuration remains active.
+- `show_loaded_config` can be used to inspect the current config path, load time, and configured database targets.
+- `show_loaded_config` also includes the current logging status, resolved log directory, and configured query timeout.
+- `show_loaded_config` also includes a sanitized connection summary for each target, such as host, port, databaseName or serviceName, user name, and Oracle client mode, but it never exposes passwords.
+
+## Oracle Notes
+- Thin mode is the default when `clientMode` is omitted.
+- Thick mode requires `clientMode: "thick"` and a valid `clientLibDir`.
+- All Oracle targets in one process must use the same client mode. Thick mode targets must also share the same `clientLibDir`.
+- `analyze_query` is currently not supported for Oracle and will return `NOT_SUPPORTED`.
+
+## Write Statements
+- `execute_query` remains read-only and blocks non-query SQL.
+- `execute_statement` is intended for writable SQL targets only.
+- `execute_statement` requires `readonly: false` on the target database config.
+- Before executing a non-query SQL statement, the server asks the MCP client for explicit user confirmation through MCP elicitation when the client supports it.
+- If the MCP client does not support elicitation, `execute_statement` automatically falls back to a two-step confirmation flow: the first call returns confirmation details and a `confirmationId`, and the second call must resend the same SQL with `confirmationId` and `confirmExecution: true` after the user confirms.
+- `execute_statement` confirmation includes SQL type, target object, SQL preview, parameter preview, and risk hints for dangerous statements.
+
+
+
+

package/README.zh-CN.md

@@ -0,0 +1,236 @@
+[English](./README.md) | 简体中文
+
+# MCP Database Service
+
+一个基于 TypeScript 实现的多数据库 MCP 服务，面向 Model Context Protocol (MCP)。
+
+它支持 MySQL、PostgreSQL、Oracle、openGauss 和 Redis，提供懒连接、读为主的数据库工具、SQL 执行计划分析、配置热刷新，以及带保护机制的写操作执行。
+
+这个项目适合需要安全地做数据库发现、查询、性能分析和受控写操作的 AI agent 与 MCP client。
+
+## 快速开始
+
+从 npm 安装：
+
+```powershell
+npm install -g @rmwxxwmr/mcp-database-service
+mcp-database-service --config ./config/databases.example.json
+```
+
+从源码运行：
+
+```bash
+npm install
+npm run build
+node dist/index.js --config ./config/databases.example.json
+```
+
+## 支持矩阵
+
+| 数据库 | 查询工具 | 元数据工具 | `explain_query` | `analyze_query` | 写操作支持 |
+| --- | --- | --- | --- | --- | --- |
+| MySQL | 是 | 是 | 是 | 是 | 是 |
+| PostgreSQL | 是 | 是 | 是 | 是 | 是 |
+| openGauss | 是 | 是 | 是 | 是 | 是 |
+| Oracle | 是 | 是 | 是 | 否 | 是 |
+| Redis | 是 | 仅 Redis 专用工具 | 否 | 否 | 否 |
+
+补充说明：
+- show_create_table 当前支持 MySQL 和 Oracle；PostgreSQL 与 openGauss 目前会返回 NOT_SUPPORTED。
+- `show_variables`、`find_long_running_queries`、`find_blocking_sessions`、`show_locks` 这类运行态排障工具依赖数据库账号可见性和权限，结果可能为空或受限。
+
+## 支持的数据库
+- MySQL
+- Oracle
+- PostgreSQL
+- openGauss（通过 PostgreSQL 协议兼容）
+- Redis
+
+## 特性
+- 单个配置文件中支持多个数据库目标
+- 支持可选的文件日志，可自定义输出目录
+- 无需重启服务即可手动刷新配置
+- JSON 配置文件变更后自动热刷新
+- 对查询工具进行严格只读限制
+- 可写目标支持显式确认后的写操作
+- 每次请求使用懒连接，并在完成后保证关闭
+- 为 SQL 数据库提供元数据发现工具
+- 为 Redis 提供专用只读工具
+
+## 配置
+可以通过以下任一方式传入配置文件路径：
+
+1. `node dist/index.js --config ./config/databases.json`
+2. 设置 `MCP_DATABASE_CONFIG=/absolute/path/to/databases.json`
+
+配置文件必须是一个 JSON 对象，其中顶层 `databases` 数组是必填项；`logging`、`query` 等顶层配置项是可选的。示例：
+
+```json
+{
+  "logging": {
+    "enabled": true,
+    "directory": "./logs"
+  },
+  "query": {
+    "timeoutMs": 5000
+  },
+  "databases": [
+    {
+      "key": "main-mysql",
+      "type": "mysql",
+      "readonly": true,
+      "connection": {
+        "host": "127.0.0.1",
+        "port": 3306,
+        "databaseName": "app_db",
+        "user": "root",
+        "password": "secret",
+        "connectTimeoutMs": 5000
+      }
+    }
+  ]
+}
+```
+
+`logging.enabled` 默认是 `false`。开启后，日志默认写入系统临时目录；你也可以通过 `logging.directory` 自定义目录，若填相对路径，则相对于配置文件所在目录解析。上面的示例会把日志写到 `./logs`。
+
+`query.timeoutMs` 是可选项。配置后，服务会为数据库操作应用查询超时。上面的示例会在 `5000` 毫秒后超时。
+
+Oracle 同时支持 Thin 和 Thick 模式。Thick 模式仍然使用同一个 `oracledb` 包，但要求宿主机安装 Oracle Instant Client。示例：
+
+```json
+{
+  "key": "oracle-thick-example",
+  "type": "oracle",
+  "readonly": true,
+  "connection": {
+    "host": "127.0.0.1",
+    "port": 1521,
+    "serviceName": "XEPDB1",
+    "user": "system",
+    "password": "secret",
+    "clientMode": "thick",
+    "clientLibDir": "C:\\oracle\\instantclient_19_25"
+  }
+}
+```
+
+## 可用 MCP Tools
+- `show_loaded_config`：查看当前内存中的配置路径、加载时间和所有已配置数据库目标
+- `reload_config`：重新读取当前 JSON 配置文件，并在成功时原子替换内存配置
+- `list_databases`：列出所有已配置目标的 key 和逻辑数据库名，不会打开数据库连接
+- `ping_database`：测试某个已配置目标的连通性
+- `list_schemas`：列出某个 SQL 目标下的 schema
+- `list_tables`：列出某个 SQL schema 或默认 schema 下的表 / 视图
+- `list_views`：列出某个 SQL schema 或默认 schema 下的视图
+- `describe_table`：查看列信息，适合写 join、报表或优化 SQL 前使用
+- `show_create_table`：在当前数据库支持时查看数据库侧的 DDL 定义
+- `search_tables`：按部分名称搜索表或视图
+- `search_columns`：按部分名称搜索 schema 下的列
+- `list_indexes`：查看表索引，适合做性能分析
+- `get_table_statistics`：查看近似行数、存储信息和数据库特定统计信息
+- `show_variables`：查看数据库运行时参数
+- `find_long_running_queries`：查看超过阈值的当前长时间运行会话
+- `find_blocking_sessions`：查看当前阻塞关系
+- `show_locks`：查看数据库当前可见的锁信息
+- `execute_query`：执行只读 SQL 查询；传原始查询 SQL，不要传写 SQL
+- `explain_query`：查看只读 SQL 的静态执行计划；传原始查询 SQL，不要传 `EXPLAIN ...`
+- `analyze_query`：查看只读 SQL 的运行时分析；传原始查询 SQL，不要传 `EXPLAIN ANALYZE ...`
+- `execute_statement`：在可写目标上执行非查询 SQL，但必须先经过显式确认
+- `redis_get`：读取一个 Redis 字符串 key
+- `redis_hgetall`：读取一个 Redis hash key
+- `redis_scan`：按游标安全扫描 Redis key，可选 pattern
+
+## 开发
+
+```bash
+npm install
+npm run build
+node dist/index.js --config ./config/databases.example.json
+```
+
+## 全局安装
+
+本项目通过 `bin` 字段暴露了一个 CLI 命令：`mcp-database-service`。
+
+推荐方式：
+
+1. 直接从 npm 安装：
+
+```powershell
+npm install -g @rmwxxwmr/mcp-database-service
+```
+
+2. 或从本地源码树通过辅助脚本安装：
+
+```powershell
+pwsh -File .\scripts\install-global.ps1
+```
+
+Linux / macOS 可使用：
+
+```bash
+sh ./scripts/install-global.sh
+```
+
+这些脚本会安装依赖、构建项目、通过 `npm pack` 生成 tarball、再用 `npm install -g <tarball>` 全局安装，最后删除临时 tarball。它们不会使用 `npm link`。
+
+3. 或手动安装打包产物：
+
+```powershell
+npm pack
+npm install -g .\mcp-database-service-0.1.0.tgz
+```
+
+由于 `files` 字段只发布运行时文件，所以打包安装时会包含 `dist`、运行时 README 和配置示例，而不是整个源码目录。
+
+安装后可以这样启动：
+
+```powershell
+mcp-database-service --config .\config\databases.example.json
+```
+
+MCP 服务配置示例：
+
+```json
+{
+  "mcpServers": {
+    "database": {
+      "command": "mcp-database-service",
+      "args": [
+        "--config",
+        "C:\\path\\to\\databases.json"
+      ]
+    }
+  }
+}
+```
+
+## 配置刷新
+
+- 服务启动时会加载 JSON 配置文件，并保留一份校验通过的内存快照
+- 服务也会监听同一个 JSON 文件，在磁盘变更后自动热刷新
+- 自动刷新有防抖，避免在文件半写入状态下频繁重载
+- 你仍然可以使用 `reload_config` 手动刷新，而无需重启进程
+- 刷新是原子的：如果新文件无效，旧的内存配置会继续保持生效
+- 可以用 `show_loaded_config` 查看当前配置路径、加载时间和已配置数据库目标
+- `show_loaded_config` 也会返回当前日志开关状态、解析后的日志目录以及配置的查询超时
+- `show_loaded_config` 还会返回脱敏后的连接摘要，例如 host、port、databaseName 或 serviceName、用户名以及 Oracle client mode，但不会暴露密码
+
+## Oracle 说明
+- 未配置 `clientMode` 时，默认使用 Thin 模式
+- Thick 模式要求 `clientMode: "thick"`，并提供有效的 `clientLibDir`
+- 同一进程中的所有 Oracle 目标必须使用相同的 client mode；如果使用 Thick，还必须共用同一个 `clientLibDir`
+- Oracle 目前不支持 `analyze_query`，会返回 `NOT_SUPPORTED`
+
+## 写操作说明
+- `execute_query` 始终是只读的，会拦截非查询 SQL
+- `execute_statement` 仅用于可写 SQL 目标
+- `execute_statement` 要求目标配置为 `readonly: false`
+- 如果 MCP client 支持交互确认，服务会在执行非查询 SQL 前通过 MCP elicitation 请求用户确认
+- 如果 MCP client 不支持 elicitation，`execute_statement` 会自动退回到二段式确认流程：第一次调用返回确认详情和 `confirmationId`，用户确认后，第二次必须带上 `confirmationId` 和 `confirmExecution: true`，并重复同一条 SQL 才会真正执行
+- `execute_statement` 的确认信息会包含 SQL 类型、目标对象、SQL 预览、参数预览，以及高风险语句的风险提示
+
+
+
+

package/config/databases.example.json

@@ -0,0 +1,48 @@
+{
+  "logging": {
+    "enabled": true,
+    "directory": "./logs"
+  },
+  "query": {
+    "timeoutMs": 5000
+  },
+  "databases": [
+    {
+      "key": "main-mysql",
+      "type": "mysql",
+      "readonly": true,
+      "connection": {
+        "host": "127.0.0.1",
+        "port": 3306,
+        "databaseName": "app_db",
+        "user": "root",
+        "password": "secret",
+        "connectTimeoutMs": 5000
+      }
+    },
+    {
+      "key": "cache-redis",
+      "type": "redis",
+      "readonly": true,
+      "connection": {
+        "url": "redis://127.0.0.1:6379/0",
+        "connectTimeoutMs": 5000
+      }
+    },
+    {
+      "key": "oracle-thick-example",
+      "type": "oracle",
+      "readonly": true,
+      "connection": {
+        "host": "127.0.0.1",
+        "port": 1521,
+        "serviceName": "XEPDB1",
+        "user": "system",
+        "password": "secret",
+        "connectTimeoutMs": 5000,
+        "clientMode": "thick",
+        "clientLibDir": "D:\\Work\\Navicat\\instantclient_19_25"
+      }
+    }
+  ]
+}

package/dist/config/configSummary.d.ts

@@ -0,0 +1,4 @@
+import type { DatabaseConfig, LoadedConfig } from "./configTypes.js";
+export declare function summarizeLoadedConfig(config: LoadedConfig): Record<string, unknown>;
+export declare function summarizeDatabaseConfig(database: DatabaseConfig): Record<string, unknown>;
+export declare function summarizeDatabaseListItem(database: DatabaseConfig): Record<string, unknown>;

package/dist/config/configSummary.js

@@ -0,0 +1,117 @@
+import { URL } from "node:url";
+export function summarizeLoadedConfig(config) {
+    return {
+        configPath: config.configPath,
+        loadedAt: config.loadedAt,
+        databaseCount: config.databases.length,
+        logging: {
+            enabled: config.logging.enabled,
+            directory: config.logging.directory
+        },
+        query: {
+            timeoutMs: config.query.timeoutMs
+        },
+        items: config.databases.map((database) => summarizeDatabaseConfig(database))
+    };
+}
+export function summarizeDatabaseConfig(database) {
+    return {
+        key: database.key,
+        databaseName: summarizeLogicalDatabaseName(database),
+        type: database.type,
+        readonly: database.readonly,
+        connection: summarizeConnection(database)
+    };
+}
+export function summarizeDatabaseListItem(database) {
+    return {
+        key: database.key,
+        databaseName: summarizeLogicalDatabaseName(database),
+        type: database.type,
+        readonly: database.readonly
+    };
+}
+function summarizeConnection(database) {
+    switch (database.type) {
+        case "mysql":
+            return summarizeMysqlConnection(database);
+        case "postgresql":
+        case "opengauss":
+            return summarizePostgresConnection(database);
+        case "oracle":
+            return summarizeOracleConnection(database);
+        case "redis":
+            return summarizeRedisConnection(database);
+    }
+}
+function summarizeMysqlConnection(database) {
+    return {
+        host: database.connection.host,
+        port: database.connection.port ?? 3306,
+        databaseName: database.connection.databaseName,
+        user: database.connection.user,
+        connectTimeoutMs: database.connection.connectTimeoutMs ?? null,
+        sslEnabled: database.connection.ssl === true || typeof database.connection.ssl === "object"
+    };
+}
+function summarizePostgresConnection(database) {
+    return {
+        host: database.connection.host,
+        port: database.connection.port ?? 5432,
+        databaseName: database.connection.databaseName,
+        user: database.connection.user,
+        connectTimeoutMs: database.connection.connectTimeoutMs ?? null,
+        sslEnabled: database.connection.ssl === true || typeof database.connection.ssl === "object"
+    };
+}
+function summarizeOracleConnection(database) {
+    return {
+        host: database.connection.host,
+        port: database.connection.port ?? 1521,
+        serviceName: database.connection.serviceName ?? null,
+        sid: database.connection.sid ?? null,
+        user: database.connection.user,
+        connectTimeoutMs: database.connection.connectTimeoutMs ?? null,
+        clientMode: database.connection.clientMode ?? (database.connection.clientLibDir ? "thick" : "thin"),
+        clientLibDir: database.connection.clientLibDir ?? null
+    };
+}
+function summarizeRedisConnection(database) {
+    return {
+        url: database.connection.url ? sanitizeRedisUrl(database.connection.url) : null,
+        host: database.connection.host ?? null,
+        port: database.connection.port ?? null,
+        databaseName: database.connection.databaseName ?? null,
+        username: database.connection.username ?? null,
+        connectTimeoutMs: database.connection.connectTimeoutMs ?? null
+    };
+}
+function summarizeLogicalDatabaseName(database) {
+    switch (database.type) {
+        case "mysql":
+            return database.connection.databaseName;
+        case "postgresql":
+        case "opengauss":
+            return database.connection.databaseName;
+        case "oracle":
+            return database.connection.serviceName ?? database.connection.sid ?? null;
+        case "redis":
+            return database.connection.databaseName ?? null;
+    }
+}
+function sanitizeRedisUrl(rawUrl) {
+    try {
+        const parsed = new URL(rawUrl);
+        if (parsed.password) {
+            parsed.password = "***";
+        }
+        if (parsed.username) {
+            parsed.username = parsed.username;
+        }
+        return parsed.toString();
+    }
+    catch {
+        return rawUrl.replace(/\/\/([^:@/]+):([^@/]+)@/, "//$1:***@");
+    }
+}
+//# sourceMappingURL=configSummary.js.map

package/dist/config/configSummary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configSummary.js","sourceRoot":"","sources":["../../src/config/configSummary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAW/B,MAAM,UAAU,qBAAqB,CAAC,MAAoB;IACxD,OAAO;QACL,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM;QACtC,OAAO,EAAE;YACP,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO;YAC/B,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS;SACpC;QACD,KAAK,EAAE;YACL,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;SAClC;QACD,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;KAC7E,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,QAAwB;IAC9D,OAAO;QACL,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,YAAY,EAAE,4BAA4B,CAAC,QAAQ,CAAC;QACpD,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,UAAU,EAAE,mBAAmB,CAAC,QAAQ,CAAC;KAC1C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,QAAwB;IAChE,OAAO;QACL,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,YAAY,EAAE,4BAA4B,CAAC,QAAQ,CAAC;QACpD,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;KAC5B,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,QAAwB;IACnD,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtB,KAAK,OAAO;YACV,OAAO,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QAC5C,KAAK,YAAY,CAAC;QAClB,KAAK,WAAW;YACd,OAAO,2BAA2B,CAAC,QAAQ,CAAC,CAAC;QAC/C,KAAK,QAAQ;YACX,OAAO,yBAAyB,CAAC,QAAQ,CAAC,CAAC;QAC7C,KAAK,OAAO;YACV,OAAO,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC;AAED,SAAS,wBAAwB,CAAC,QAA6B;IAC7D,OAAO;QACL,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,IAAI;QAC9B,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,IAAI;QACtC,YAAY,EAAE,QAAQ,CAAC,UAAU,CAAC,YAAY;QAC9C,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,IAAI;QAC9B,gBAAgB,EAAE,QAAQ,CAAC,UAAU,CAAC,gBAAgB,IAAI,IAAI;QAC9D,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,KAAK,IAAI,IAAI,OAAO,QAAQ,CAAC,UAAU,CAAC,GAAG,KAAK,QAAQ;KAC5F,CAAC;AACJ,CAAC;AAED,SAAS,2BAA2B,CAAC,QAAgC;IACnE,OAAO;QACL,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,IAAI;QAC9B,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,IAAI;QACtC,YAAY,EAAE,QAAQ,CAAC,UAAU,CAAC,YAAY;QAC9C,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,IAAI;QAC9B,gBAAgB,EAAE,QAAQ,CAAC,UAAU,CAAC,gBAAgB,IAAI,IAAI;QAC9D,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,KAAK,IAAI,IAAI,OAAO,QAAQ,CAAC,UAAU,CAAC,GAAG,KAAK,QAAQ;KAC5F,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAAC,QAA8B;IAC/D,OAAO;QACL,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,IAAI;QAC9B,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,IAAI;QACtC,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,WAAW,IAAI,IAAI;QACpD,GAAG,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,IAAI;QACpC,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,IAAI;QAC9B,gBAAgB,EAAE,QAAQ,CAAC,UAAU,CAAC,gBAAgB,IAAI,IAAI;QAC9D,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,UAAU,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QACnG,YAAY,EAAE,QAAQ,CAAC,UAAU,CAAC,YAAY,IAAI,IAAI;KACvD,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB,CAAC,QAA6B;IAC7D,OAAO;QACL,GAAG,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI;QAC/E,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,IAAI;QACtC,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,IAAI;QACtC,YAAY,EAAE,QAAQ,CAAC,UAAU,CAAC,YAAY,IAAI,IAAI;QACtD,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC,QAAQ,IAAI,IAAI;QAC9C,gBAAgB,EAAE,QAAQ,CAAC,UAAU,CAAC,gBAAgB,IAAI,IAAI;KAC/D,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,CAAC,QAAwB;IAC5D,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;QACtB,KAAK,OAAO;YACV,OAAO,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC;QAC1C,KAAK,YAAY,CAAC;QAClB,KAAK,WAAW;YACd,OAAO,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC;QAC1C,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC,UAAU,CAAC,WAAW,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,IAAI,CAAC;QAC5E,KAAK,OAAO;YACV,OAAO,QAAQ,CAAC,UAAU,CAAC,YAAY,IAAI,IAAI,CAAC;IACpD,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAc;IACtC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC;QAC1B,CAAC;QAED,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QACpC,CAAC;QAED,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,MAAM,CAAC,OAAO,CAAC,yBAAyB,EAAE,WAAW,CAAC,CAAC;IAChE,CAAC;AACH,CAAC"}