@frank-x/dsh-dm

Service Definition for DM (达梦) database capability seam.

Overview

This package defines the abstract interface for DM database operations. It provides the DmExecutor abstract class that must be implemented by a provider (like @frank-x/dsh-dm-jdbc).

Installation

npm install @frank-x/dsh-dm

Usage

import { DmExecutor } from '@frank-x/dsh-dm'

// Implement the abstract class
class MyDmExecutor extends DmExecutor {
  async connect(name: string, config: DmConnectionConfig): Promise<void> {
    // Implementation
  }

  async disconnect(name: string): Promise<void> {
    // Implementation
  }

  async execute(name: string, sql: string, options?: { timeoutMs?: number; maxRows?: number }): Promise<DmQueryResult> {
    // Implementation
  }

  async testConnection(name: string): Promise<DmConnectionTestResult> {
    // Implementation
  }

  async getSchema(name: string, filter?: DmSchemaFilter): Promise<DmSchemaInfo> {
    // Implementation
  }

  async getConnections(): Promise<string[]> {
    // Implementation
  }
}

API

DmExecutor

Abstract class extending Service from Cordis. Registers as ctx.dm.

Methods

• connect(name: string, config: DmConnectionConfig): Promise<void>
• disconnect(name: string): Promise<void>
• execute(name: string, sql: string, options?: { timeoutMs?: number; maxRows?: number }): Promise<DmQueryResult>
• testConnection(name: string): Promise<DmConnectionTestResult>
• getSchema(name: string, filter?: DmSchemaFilter): Promise<DmSchemaInfo>
• getConnections(): Promise<string[]>

Types

• DmConnectionConfig - Connection parameters
• DmQueryResult - Query result with columns/rows or affected count
• DmSchemaInfo - Schema metadata
• DmTableInfo - Table information
• DmColumnInfo - Column metadata
• DmConnectionTestResult - Connection test outcome
• DmSchemaFilter - Schema filter options

License

MIT