How niuhuoshan/dsh-connect works
dsh-connect is a DSH connector plugin for read-only database discovery/querying and administrator-configured HTTP API tools. Users configure connections and APIs in the settings UI; Host RPC validates and handles operations, while registered Agent tools expose metadata, SQL, and enabled APIs to conversations. Database scanning discovers physical structure, enriches semantic profiles, and persists profiles, metrics, jobs, and change records. The README documents additional metadata editing, YAML export, metrics, and scan modes. Some RPC internals and UI call details are unsampled, so only documented or indexed relationships are shown.
Main entry points: rpc.ts Host RPC · src/index.ts Plugin runtime · datasource/index.ts Provider registry · store.ts Connect store
Components 23
Settings UI
- Connector settings
src/client/ConnectSettings.tsx - RPC client
src/client/rpc.ts
Host runtime
- Plugin runtime
src/index.ts - Host RPC
src/host/rpc.ts - Provider registry
src/host/datasource/index.ts - Provider contract
src/host/datasource/provider.ts - MySQL provider
src/host/datasource/mysql.ts - PostgreSQL provider
src/host/datasource/postgresql.ts - ClickHouse provider
src/host/datasource/clickhouse.ts
Metadata
- Metadata profiler
src/host/metadata/profiler.ts - Semantic enricher
src/host/metadata/enricher.ts - Metadata tools
src/host/metadata/tools.ts - Metadata governance
src/host/metadata/governance.ts
HTTP APIs
- API tool registry
src/host/http/tools.ts - HTTP executor
src/host/http/executor.ts - Outbound security
src/host/http/security.ts - API creation tool
src/host/http/conversation-api.ts
Persistence
- Connect store
src/host/store.ts - Domain tables
src/domain.ts
Other components
- Administrator
- DSH Agent
- Database
- Configured API
Connections 39
- Administrator → Connector settings: configures
README.md - Connector settings → RPC client: sends RPC
src/client/ConnectSettings.tsx - Plugin runtime → Connect store: creates
src/index.ts - Plugin runtime → Metadata profiler: creates
src/index.ts - Plugin runtime → API tool registry: registers tools
src/index.ts - Plugin runtime → Metadata tools: registers tools
src/index.ts - Plugin runtime → API creation tool: registers tool
src/index.ts - Plugin runtime → Host RPC: routes RPC
src/index.ts - RPC client → Host RPC: calls
README.md - Host RPC → Connect store: reads and writes
src/host/rpc.ts - Connect store → Domain tables: persists records
src/host/store.ts - Host RPC → Provider registry: selects provider
src/host/rpc.ts - Provider registry → MySQL provider: dispatches
src/host/datasource/index.ts - Provider registry → PostgreSQL provider: dispatches
src/host/datasource/index.ts - Provider registry → ClickHouse provider: dispatches
src/host/datasource/index.ts - MySQL provider → Database: discovers and queries
- PostgreSQL provider → Database: discovers and queries
src/host/datasource/postgresql.ts - ClickHouse provider → Database: discovers and queries
- MySQL provider → Provider contract: implements
src/host/datasource/mysql.ts - PostgreSQL provider → Provider contract: implements
src/host/datasource/postgresql.ts - ClickHouse provider → Provider contract: implements
src/host/datasource/clickhouse.ts - Host RPC → Metadata profiler: starts scans
src/host/rpc.ts - Metadata profiler → Provider registry: discovers objects
src/host/metadata/profiler.ts - Metadata profiler → Semantic enricher: enriches profiles
src/host/metadata/profiler.ts - Metadata profiler → Connect store: persists profiles
src/host/metadata/profiler.ts - Metadata tools → Connect store: reads metadata
src/host/metadata/tools.ts - Metadata tools → Provider registry: queries data
src/host/metadata/tools.ts - Metadata tools → Metadata governance: uses governance
src/host/metadata/tools.ts - DSH Agent → Metadata tools: invokes tools
- DSH Agent → API tool registry: invokes enabled tools
- Host RPC → API tool registry: refreshes registrations
src/host/rpc.ts - API tool registry → Connect store: loads definitions
src/host/http/tools.ts - API tool registry → HTTP executor: executes tools
src/host/http/tools.ts - HTTP executor → Outbound security: checks targets
src/host/http/executor.ts - HTTP executor → Configured API: sends request
- Host RPC → HTTP executor: tests API requests
src/host/rpc.ts - Host RPC → API creation tool: validates and saves
src/host/rpc.ts - DSH Agent → API creation tool: proposes API config
src/host/http/conversation-api.ts - API creation tool → Host RPC: requests approval save
src/host/http/conversation-api.ts