agent-database-cli 0.2.7

package/README_EN.md

@@ -0,0 +1,341 @@
+<div align="center">
+
+# agent-database-cli
+
+A CLI-based multi-database tool that packages common database connection, query, metadata inspection, and connection reuse capabilities as local commands callable by agents.
+
+MySQL · PostgreSQL · Redis · Oracle · MongoDB · Read-only mode · Command blocklist · SQLcl Oracle · Local daemon
+
+<p>
+  <img src="https://img.shields.io/badge/CLI-agent--database--cli-2ea44f" alt="CLI agent-database-cli">
+  <img src="https://img.shields.io/badge/License-MIT-green" alt="License MIT">
+  <img src="https://img.shields.io/badge/Node.js-%3E%3D20-339933?logo=node.js&logoColor=white" alt="Node.js >=20">
+  <img src="https://img.shields.io/badge/npm-%3E%3D10-CB3837?logo=npm&logoColor=white" alt="npm >=10">
+  <img src="https://img.shields.io/badge/Windows-MacOS-0078D6?labelColor=0078D6&color=C0C0C0" alt="Windows/MacOS">
+  <img src="https://img.shields.io/badge/release-v0.2.6-blue" alt="release v0.2.6">
+</p>
+
+[AI One-Click Installation](#ai-one-click-installation) · [Installation](#installation) · [Configuration](#configuration) · [Permission Configuration](#permission-configuration) · [Oracle SQLcl](#oracle-sqlcl) · [License](#license) · [Friendly Links](#friendly-links)
+
+[中文](README.md) | English
+
+</div>
+
+## Introduction
+
+`agent-database-cli` references the database adapter, config loading, safety checking, and connection management layering of [Anarkh-Lee/universal-db-mcp](https://github.com/Anarkh-Lee/universal-db-mcp), then rewrites it into a standalone CLI form without MCP, HTTP, or SSE services.
+
+What it can do:
+
+- List currently supported database types and locally configured connections
+- Execute SQL, Redis commands, or MongoDB JSON commands against a specified database
+- Query database metadata such as tables, columns, collections, and Redis keys
+- Enable read-only mode and command blocklists per database configuration
+- Auto-start the local daemon on demand; the daemon exits after `300` idle seconds by default
+- Keep connections alive through the local daemon; each database connection is released after `180` idle seconds by default
+- Switch Oracle between `oracledb` and SQLcl drivers
+- Never store or print unmasked passwords, tokens, or secrets
+- Use named pipes on Windows and Unix sockets on macOS/Linux for the daemon
+
+Driver configuration table:
+
+| Database | `type` | Default driver | Driver switch configuration | Common configuration |
+| --- | --- | --- | --- | --- |
+| MySQL | `mysql` | npm package `mysql2` | Not switchable yet | `readonly`, `blacklist`, `keepAliveSeconds` |
+| PostgreSQL | `postgres` | npm package `pg` | Not switchable yet | `readonly`, `blacklist`, `keepAliveSeconds` |
+| Redis standalone | `redis` | npm package `redis` | Configure `url` only | `readonly`, `blacklist`, `keepAliveSeconds` |
+| Redis cluster | `redis` | npm package `redis` | Configure both `url` and `redisCluster.nodes` | `readonly`, `blacklist`, `keepAliveSeconds` |
+| Oracle | `oracle` | npm package `oracledb` | `oracleDriver: "oracledb" \| "sqlcl"`; SQLcl mode can configure `sqlclPath` and `javaHome`. SQLcl is recommended for older Oracle versions | `readonly`, `blacklist`, `keepAliveSeconds` |
+| MongoDB | `mongodb` | npm package `mongodb` | Not switchable yet; `database` can be configured as the default database | `readonly`, `blacklist`, `keepAliveSeconds` |
+
+## Installation
+
+### Requirements
+
+- Node.js `>= 20`
+- npm `>= 10`
+- Local network access to the target database
+- Docker and Docker Compose if you run integration tests
+- SQLcl and Java installed locally if Oracle uses SQLcl
+
+### AI One-Click Installation
+
+```text
+Please read https://github.com/sleepinginsummer/agent-database-cli/blob/main/AI_INSTALL.md, install the CLI as instructed, and add `SKILL.md`.
+```
+
+### Manual Global Installation
+
+```bash
+npm install -g agent-database-cli
+agent-database-cli --help
+```
+
+If npm package installation is restricted, use the equivalent source installation flow:
+
+```powershell
+git clone https://github.com/sleepinginsummer/agent-database-cli.git
+cd agent-database-cli
+npm install
+npm run build
+npm link
+agent-database-cli --help
+```
+
+Add `SKILL.md` to the agent that needs to use this tool.
+
+## Configuration
+
+Default configuration file:
+
+```text
+~/.agent-database-cli/config.json
+```
+
+You can override the configuration path with an environment variable:
+
+```bash
+AGENT_DATABASE_CLI_CONFIG=/path/to/config.json agent-database-cli list
+```
+
+The configuration file is an object. Each key under `databases` is a database connection name:
+
+- `type`: Database type, supports `mysql`, `postgres`, `redis`, `oracle`, and `mongodb`
+- `url`: Database connection URL. In Redis standalone mode it is the direct target. In Redis cluster mode it is used as the entry node URL
+- `redisCluster`: Optional Redis cluster configuration. When configured, cluster mode is used
+- `sshTunnel`: Optional SSH tunnel configuration. In standalone mode, the database URL host and port are forwarded through SSH. In Redis cluster mode, a local forwarding port is created for each configured cluster node
+- `database`: Optional default MongoDB database name
+- `readonly`: Whether read-only mode is enabled, default `true`; only explicitly set `false` when write access is really required
+- `blacklist`: Command blocklist array, case-insensitive
+- `keepAliveSeconds`: Idle release timeout in seconds for a single database connection, default `180`
+- `oracleDriver`: Oracle driver, supports `oracledb` or `sqlcl`
+- `sqlclPath`: SQLcl executable path, used only when `oracleDriver` is `sqlcl`
+- `javaHome`: Optional `JAVA_HOME` used by SQLcl
+
+`redisCluster` currently supports:
+
+- `nodes`: Array of Redis cluster node URLs. At least one node is required. `redis://` and `rediss://` are supported
+
+Redis cluster notes:
+
+- In the current implementation, Redis cluster mode requires both `url` and `redisCluster.nodes`
+- `url` is used as the cluster entry node. It is recommended to use any stable reachable cluster node URL
+- `redisCluster.nodes` is used as the cluster node list. With SSH tunneling, it is also used to create per-node local forwarding and address mapping
+- When `redisCluster.nodes` is configured, the client switches to Redis Cluster mode
+- When `sshTunnel` is also configured, the program creates a local forwarded port for each cluster node and uses address mapping for cluster redirects
+- With SSH tunneling, `redisCluster.nodes` should cover the cluster node addresses that the client may be redirected to
+
+`sshTunnel` supports password, private key, password plus private key, and passphrase-protected private key authentication:
+
+- `host`: SSH jump host address
+- `port`: SSH port, default `22`
+- `username`: SSH username
+- `password`: Optional SSH password
+- `privateKeyPath`: Optional private key file path, supports `~`
+- `privateKey`: Optional private key content, mutually exclusive with `privateKeyPath`
+- `passphrase`: Optional private key passphrase, only valid when a private key is configured
+- `readyTimeout`: Optional SSH connection timeout in milliseconds
+
+The blocklist and read-only mode work together with a fixed priority: check the blocklist first, reject immediately on match, and only check read-only mode when no blocklist rule matches.
+
+Read-only mode notes:
+
+- Read-only mode is enabled by default; write operations are still rejected when `readonly` is omitted
+- It is recommended to keep all database connections read-only by default. When data changes are needed, let AI generate the SQL or command first, then execute it after your confirmation
+- Only set `readonly: false` on a specific connection when write access is truly required
+
+Reference configuration:
+
+```json
+{
+  "databases": {
+    "local-mysql": {
+      "type": "mysql",
+      "url": "mysql://user:password@localhost:3306/app",
+      "readonly": true,
+      "blacklist": ["drop", "truncate", "delete"],
+      "keepAliveSeconds": 180
+    },
+    "remote-mysql": {
+      "type": "mysql",
+      "url": "mysql://user:password@db.internal:3306/app",
+      "sshTunnel": {
+        "host": "jump.example.com",
+        "port": 22,
+        "username": "deploy",
+        "privateKeyPath": "~/.ssh/id_rsa",
+        "passphrase": "key-passphrase"
+      },
+      "readonly": true,
+      "keepAliveSeconds": 180
+    },
+    "redis-standalone": {
+      "type": "redis",
+      "url": "redis://localhost:6379",
+      "readonly": false,
+      "blacklist": ["flushall", "flushdb"],
+      "keepAliveSeconds": 180
+    },
+    "redis-cluster": {
+      "type": "redis",
+      "url": "redis://10.0.0.11:7001",
+      "redisCluster": {
+        "nodes": [
+          "redis://10.0.0.11:7001",
+          "redis://10.0.0.12:7001",
+          "redis://10.0.0.13:7001"
+        ]
+      },
+      "readonly": true,
+      "blacklist": ["flushall", "flushdb"],
+      "keepAliveSeconds": 180
+    },
+    "redis-cluster-via-ssh": {
+      "type": "redis",
+      "url": "redis://10.0.0.11:7001",
+      "redisCluster": {
+        "nodes": [
+          "redis://10.0.0.11:7001",
+          "redis://10.0.0.12:7001",
+          "redis://10.0.0.13:7001"
+        ]
+      },
+      "sshTunnel": {
+        "host": "jump.example.com",
+        "port": 22,
+        "username": "deploy",
+        "privateKeyPath": "~/.ssh/id_rsa"
+      },
+      "readonly": true,
+      "blacklist": ["flushall", "flushdb"],
+      "keepAliveSeconds": 180
+    },
+    "oracle-test": {
+      "type": "oracle",
+      "url": "oracle://USER:password@127.0.0.1:1521/qftest201",
+      "oracleDriver": "sqlcl",
+      "sqlclPath": "/opt/homebrew/Caskroom/sqlcl/26.1.0.086.1709/sqlcl/bin/sql",
+      "javaHome": "/Applications/IntelliJ IDEA Ultimate.app/Contents/jbr/Contents/Home",
+      "readonly": true,
+      "blacklist": ["drop", "truncate", "delete", "update", "insert", "merge", "alter", "create"],
+      "keepAliveSeconds": 180
+    }
+  }
+}
+```
+
+## Permission Configuration
+
+It is recommended to use both `readonly` and `blacklist` together for permission control. Do not rely on only one of them.
+
+### Read-only Mode
+
+- The default value is `true`
+- When `readonly` is omitted, the connection is still treated as read-only
+- It is recommended to keep all day-to-day query connections read-only by default
+- When data changes are needed, let AI generate the SQL or command first, then execute it after your confirmation
+- Only dedicated writable connections should explicitly set `readonly: false`
+
+### Command Blocklist
+
+- The blocklist has higher priority than read-only mode
+- A command is rejected immediately once it matches the blocklist
+- It is suitable for blocking high-risk commands such as dropping data, schema changes, mass writes, and cache-clearing operations
+- It is recommended for production databases, shared test databases, and online Redis instances
+
+### Execution Order
+
+1. Check `blacklist` first
+2. Reject immediately on match
+3. Check `readonly` only when not matched
+4. When `readonly` is enabled, only read commands are allowed
+
+### Common High-Risk Commands
+
+Common high-risk SQL for MySQL / PostgreSQL / Oracle:
+
+```json
+["drop", "truncate", "delete", "update", "insert", "merge", "alter", "create", "replace", "grant", "revoke"]
+```
+
+Common high-risk Redis commands:
+
+```json
+["flushall", "flushdb", "del", "unlink", "set", "mset", "expire", "rename", "hset", "lpush", "rpush", "sadd", "zadd"]
+```
+
+Common high-risk MongoDB commands:
+
+```json
+["insertOne", "insertMany", "updateOne", "updateMany", "replaceOne", "deleteOne", "deleteMany", "findAndModify", "findOneAndUpdate", "findOneAndDelete", "drop", "dropDatabase", "createIndex", "dropIndex"]
+```
+
+### Recommended Configuration Examples
+
+Recommended for production databases:
+
+```json
+{
+  "type": "mysql",
+  "url": "mysql://user:password@prod-db:3306/app",
+  "readonly": true,
+  "blacklist": ["drop", "truncate", "delete", "update", "insert", "alter", "create"],
+  "keepAliveSeconds": 180
+}
+```
+
+Recommended for a dedicated writable connection:
+
+```json
+{
+  "type": "postgres",
+  "url": "postgres://user:password@write-db:5432/app",
+  "readonly": false,
+  "blacklist": ["drop", "truncate", "alter"],
+  "keepAliveSeconds": 180
+}
+```
+
+## Oracle SQLcl
+
+Official link: https://www.oracle.com/database/sqldeveloper/technologies/sqlcl/
+
+Oracle uses the npm package `oracledb` by default. If the target Oracle version is older, Thin mode compatibility errors such as `NJS-138` may appear. In that case, switch a single Oracle connection to SQLcl:
+
+```json
+{
+  "type": "oracle",
+  "url": "oracle://USER:password@127.0.0.1:1521/qftest201",
+  "oracleDriver": "sqlcl",
+  "sqlclPath": "/opt/homebrew/Caskroom/sqlcl/26.1.0.086.1709/sqlcl/bin/sql",
+  "javaHome": "/Applications/IntelliJ IDEA Ultimate.app/Contents/jbr/Contents/Home",
+  "readonly": true,
+  "blacklist": ["drop", "truncate", "delete", "update", "insert", "merge", "alter", "create"]
+}
+```
+
+SQLcl mode passes the connection script through stdin to avoid exposing the password in process arguments. Security checks still happen before execution, and both blocklist and read-only mode remain effective.
+
+## Update
+
+```bash
+npm install -g agent-database-cli@latest
+```
+
+## Uninstall and Cleanup
+
+Uninstall and clean local configuration:
+
+```bash
+npm uninstall -g agent-database-cli
+npm cache clean --force
+rm -rf ~/.agent-database-cli
+```
+
+## License
+
+[MIT](LICENSE)
+
+## Friendly Links
+
+- [LINUX DO - A New Ideal Community](https://linux.do/)

package/SKILL.md

@@ -0,0 +1,252 @@
+---
+name: agent-database-cli
+description: 使用本地 agent-database-cli 安全操作已配置的数据库。适用于列出数据库连接、测试连接、执行 SQL/Redis/MongoDB 命令、查询表/列/集合/keys 元信息、管理本地连接 daemon，以及验证只读模式和命令黑名单的场景。
+---
+
+# agent-database-cli 使用说明
+
+`agent-database-cli` 是一个基于本地配置的多数据库命令行工具，用于让 AI 或用户安全地操作数据库。
+
+它能做的事：
+
+- 列出支持的数据库类型和本地已配置数据库连接
+- 测试指定数据库连接
+- 执行 SQL、Redis 命令或 MongoDB JSON 命令
+- 查询表、列、集合、Redis keys 等元信息
+- 按单个数据库配置执行命令黑名单和只读模式
+- 普通命令会按需自动启动本地 daemon，daemon 默认空闲 `300` 秒后自动退出
+- 通过本地 daemon 短时间保持连接，单个数据库连接默认空闲 `180` 秒释放
+- daemon 在 Windows 使用 named pipe，在 macOS/Linux 使用 Unix socket
+- Oracle 支持 `oracledb` 和 SQLcl 两种连接方式
+
+它不做的事：
+
+- 不扫描网络或发现数据库，只使用配置文件中的连接
+- 不绕过配置中的黑名单和只读模式
+- 不输出未脱敏的密码、token、secret
+- 不默认执行写入、删除、DDL 或其它危险命令
+
+## 安全确认
+
+执行任何可能写入、删除、修改结构或影响数据完整性的命令前，必须先确认目标数据库配置是否启用了 `readonly` 和 `blacklist`。
+
+危险操作包括：
+
+- DDL：`drop`、`truncate`、`alter`、`create`
+- DML 写入：`insert`、`update`、`delete`、`merge`
+- Redis 清空或写入：`flushall`、`flushdb`、`set`、`del`
+- MongoDB 写入或删除：`insertOne`、`updateOne`、`deleteMany`、`drop`、`dropDatabase`
+- 任何不可逆、影响生产数据、影响结构或权限的命令
+
+如果用户明确要求执行危险命令，先说明目标数据库名、命令、可能影响，并等待用户明确同意。即使用户同意，也不能绕过本项目配置中的黑名单和只读模式。
+
+黑名单优先级高于只读模式。命令执行前先检查 `blacklist`，命中后直接拒绝；未命中时再检查 `readonly`。
+
+读取配置文件json前需要用户确认，防止密钥泄露。
+
+## 环境校验
+
+调用前优先检查 CLI 是否可用：
+
+```bash
+agent-database-cli --help
+```
+
+
+如果上面的命令失败，检查基础环境：
+
+```bash
+node --version
+npm --version
+```
+
+如果依赖或构建产物缺失，在项目目录中执行：
+
+```bash
+npm install
+npm run build
+```
+
+默认配置文件：
+
+```text
+~/.agent-database-cli/config.json
+```
+
+指定其它配置文件：
+
+```bash
+AGENT_DATABASE_CLI_CONFIG=/path/to/config.json agent-database-cli list
+```
+
+## 配置格式
+
+配置文件是 JSON 对象，根字段为 `databases`：
+
+```json
+{
+  "databases": {
+    "local-mysql": {
+      "type": "mysql",
+      "url": "mysql://user:password@localhost:3306/app",
+      "readonly": true,
+      "blacklist": ["drop", "truncate", "delete"],
+      "keepAliveSeconds": 180
+    }
+  }
+}
+```
+
+字段：
+
+- `type`: `mysql`、`postgres`、`redis`、`oracle`、`mongodb`
+- `url`: 数据库连接 URL
+- `database`: MongoDB 默认数据库名，可选
+- `readonly`: 是否启用只读模式
+- `blacklist`: 命令黑名单数组，大小写不敏感
+- `keepAliveSeconds`: daemon 连接空闲释放秒数，默认 `180`
+- `oracleDriver`: Oracle 驱动，可选 `oracledb` 或 `sqlcl`
+- `sqlclPath`: SQLcl 可执行文件路径
+- `javaHome`: SQLcl 使用的 `JAVA_HOME`
+
+## 全局参数
+
+- `--format <format>`: 输出格式，支持 `json` 或 `table`，默认 `json`
+- `--help`, `-h`: 输出帮助
+- `--version`, `-V`: 输出版本
+
+配置路径通过环境变量传递：
+
+```bash
+AGENT_DATABASE_CLI_CONFIG=/path/to/config.json
+```
+
+## list
+
+列出支持的数据库类型、已配置连接和配置文件路径。
+
+```bash
+agent-database-cli list
+agent-database-cli --format table list
+```
+
+
+返回值：
+
+- 成功时 stdout 输出 JSON 或表格
+- 输出包含 `supported`、`configured`、`configPath`
+- 配置文件不存在时仍会输出支持列表，`configured` 为空
+- 退出码为 `0`
+
+## test
+
+测试指定数据库连接。
+
+```bash
+agent-database-cli test --db "<databaseName>"
+```
+
+返回值：
+
+- 成功时 stdout 输出 `{ "ok": true }`
+- 连接失败、配置缺失或认证失败时 stderr 输出错误，退出码为 `1`
+
+## exec
+
+统一执行 SQL、Redis 命令或 MongoDB JSON 命令。
+
+```bash
+agent-database-cli exec --db "<databaseName>" --command "<command>"
+```
+
+示例：
+
+```bash
+agent-database-cli exec --db local-mysql --command "select 1"
+agent-database-cli exec --db cache --command "GET user:1"
+agent-database-cli exec --db local-mongodb --command '{"find":{"collection":"users","filter":{},"limit":1}}'
+```
+
+返回值：
+
+- 成功时 stdout 输出 `rows`、`fields`、`rowCount`
+- 命中黑名单、违反只读模式、命令执行失败时 stderr 输出错误，退出码为 `1`
+- SQLcl Oracle 模式返回 SQLcl 文本输出，字段名为 `output`
+
+## meta
+
+查询数据库元信息。
+
+```bash
+agent-database-cli meta --db "<databaseName>" --type tables
+agent-database-cli meta --db "<databaseName>" --type columns --table users
+agent-database-cli meta --db "<databaseName>" --type collections
+agent-database-cli meta --db "<databaseName>" --type keys --pattern "user:*"
+```
+
+参数：
+
+- `--db <name>`: 数据库配置名
+- `--type <type>`: `tables`、`columns`、`collections`、`keys`
+- `--table <table>`: `columns` 查询所需表名
+- `--pattern <pattern>`: Redis keys 匹配模式
+
+返回值：
+
+- 成功时 stdout 输出查询结果
+- 当前数据库不支持的元信息类型会失败并返回错误
+
+## daemon
+
+管理本地连接守护进程。普通 `test`、`exec`、`meta`、`reset` 命令会在 daemon 未运行时自动启动 daemon，已运行时直接复用，不会重复启动。daemon 使用 Unix socket，不暴露网络端口，默认空闲 `300` 秒后自动退出。
+
+```bash
+agent-database-cli daemon start
+agent-database-cli daemon status
+agent-database-cli daemon stop
+```
+
+返回值：
+
+- `start` 成功时输出 socket 路径
+- `status` 成功时输出当前连接列表
+- `stop` 成功时输出停止结果
+
+## reset
+
+重置指定数据库连接。
+
+```bash
+agent-database-cli reset --db "<databaseName>"
+```
+
+如果 daemon 正在运行，会断开并清理该数据库连接；下一次命令会重新连接。
+
+## Oracle SQLcl
+
+当 Oracle `oracledb` Thin mode 不支持目标库版本时，可以改用 SQLcl。
+
+```json
+{
+  "type": "oracle",
+  "url": "oracle://USER:password@192.0.2.20:1521/qftest201",
+  "oracleDriver": "sqlcl",
+  "sqlclPath": "/opt/homebrew/Caskroom/sqlcl/26.1.0.086.1709/sqlcl/bin/sql",
+  "javaHome": "/Applications/IntelliJ IDEA Ultimate.app/Contents/jbr/Contents/Home",
+  "readonly": true,
+  "blacklist": ["drop", "truncate", "delete", "update", "insert", "merge", "alter", "create"]
+}
+```
+
+SQLcl 模式通过 stdin 传入连接脚本，避免密码出现在命令行参数列表中。执行前仍会先走本地黑名单和只读检查。
+
+## 错误规则
+
+- 配置文件 JSON 无效时失败
+- `databases` 缺失或数据库配置名不存在时失败
+- 未知 `type`、未知 `oracleDriver` 或非法 `keepAliveSeconds` 会失败
+- `exec` 缺少 `--db` 或 `--command` 会失败
+- `meta columns` 缺少 `--table` 会失败
+- 命中黑名单时失败，错误中包含 `黑名单拒绝执行命令`
+- 违反只读模式时失败，错误中包含 `只读模式拒绝执行命令`
+- 所有失败统一在 stderr 输出错误信息，退出码为 `1`

package/config/docker-test.json

@@ -0,0 +1,40 @@
+{
+  "databases": {
+    "local-mysql": {
+      "type": "mysql",
+      "url": "mysql://test:test@127.0.0.1:3306/app",
+      "readonly": false,
+      "blacklist": ["drop", "truncate"],
+      "keepAliveSeconds": 180
+    },
+    "local-postgres": {
+      "type": "postgres",
+      "url": "postgres://test:test@127.0.0.1:5432/app",
+      "readonly": false,
+      "blacklist": ["drop", "truncate"],
+      "keepAliveSeconds": 180
+    },
+    "local-redis": {
+      "type": "redis",
+      "url": "redis://127.0.0.1:6379",
+      "readonly": false,
+      "blacklist": ["flushall", "flushdb"],
+      "keepAliveSeconds": 180
+    },
+    "local-mongodb": {
+      "type": "mongodb",
+      "url": "mongodb://test:test@127.0.0.1:27017/app?authSource=admin",
+      "database": "app",
+      "readonly": false,
+      "blacklist": ["drop", "dropDatabase", "deleteMany"],
+      "keepAliveSeconds": 180
+    },
+    "local-oracle": {
+      "type": "oracle",
+      "url": "oracle://test:test@127.0.0.1:1521/FREEPDB1",
+      "readonly": false,
+      "blacklist": ["drop", "truncate"],
+      "keepAliveSeconds": 180
+    }
+  }
+}

package/dist/adapters/base-sql.d.ts

@@ -0,0 +1,12 @@
+import type { DatabaseAdapter, MetadataRequest, QueryResult } from "../types.js";
+export declare abstract class BaseSqlAdapter implements DatabaseAdapter {
+    protected connected: boolean;
+    abstract connect(): Promise<void>;
+    abstract disconnect(): Promise<void>;
+    abstract execute(command: string): Promise<QueryResult>;
+    protected abstract listTables(): Promise<QueryResult>;
+    protected abstract listColumns(table: string): Promise<QueryResult>;
+    test(): Promise<void>;
+    metadata(request: MetadataRequest): Promise<QueryResult>;
+    protected testQuery(): string;
+}

package/dist/adapters/base-sql.js

@@ -0,0 +1,22 @@
+export class BaseSqlAdapter {
+    connected = false;
+    async test() {
+        await this.execute(this.testQuery());
+    }
+    async metadata(request) {
+        if (request.type === "tables") {
+            return this.listTables();
+        }
+        if (request.type === "columns") {
+            if (!request.table) {
+                throw new Error("columns 元信息查询必须提供 --table");
+            }
+            return this.listColumns(request.table);
+        }
+        throw new Error(`当前数据库不支持元信息类型: ${request.type}`);
+    }
+    testQuery() {
+        return "select 1";
+    }
+}
+//# sourceMappingURL=base-sql.js.map

package/dist/adapters/base-sql.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-sql.js","sourceRoot":"","sources":["../../src/adapters/base-sql.ts"],"names":[],"mappings":"AAEA,MAAM,OAAgB,cAAc;IACxB,SAAS,GAAG,KAAK,CAAC;IAQ5B,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAwB;QACrC,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;QAC3B,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACnB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAC/C,CAAC;YACD,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzC,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,kBAAkB,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACpD,CAAC;IAES,SAAS;QACjB,OAAO,UAAU,CAAC;IACpB,CAAC;CACF"}

package/dist/adapters/factory.d.ts

@@ -0,0 +1,2 @@
+import type { DatabaseAdapter, DatabaseConfig } from "../types.js";
+export declare function createAdapter(config: DatabaseConfig, url?: string): DatabaseAdapter;