Interface Connector

interface Connector {
    capabilities: CapabilityFlags;
    database?: string;
    dialect: DialectInfo;
    engine: EngineKind;
    id: string;
    name: string;
    close(): Promise<void>;
    connect(): Promise<void>;
    execute(sql: string, opts?: ExecuteOptions): Promise<ResultSet>;
    explain?(sql: string, opts?: ExecuteOptions): Promise<ResultSet>;
    introspect(): Promise<SchemaCatalog>;
}

Implemented by

Index

Properties

capabilities database? dialect engine id name

Methods

close connect execute explain? introspect

Properties

`Readonly`capabilities

capabilities: CapabilityFlags

`Optional` `Readonly`database

database?: string

The connected database / file name, for display (disambiguates same-engine connections).

`Readonly`dialect

dialect: DialectInfo

`Readonly`engine

engine: EngineKind

`Readonly`id

id: string

`Readonly`name

name: string

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/types.ts:200

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/types.ts:199

execute

execute(sql: string, opts?: ExecuteOptions): Promise<ResultSet>
Parameters
- sql: string
- Optionalopts: ExecuteOptions
Returns Promise<ResultSet>
- Defined in packages/core/src/types.ts:202

`Optional`explain

explain?(sql: string, opts?: ExecuteOptions): Promise<ResultSet>
Parameters
- sql: string
- Optionalopts: ExecuteOptions
Returns Promise<ResultSet>
- Defined in packages/core/src/types.ts:203

introspect

introspect(): Promise<SchemaCatalog>
Returns Promise<SchemaCatalog>
- Defined in packages/core/src/types.ts:201