Class PostgresConnector

Implements

Connector

Index

Constructors

Properties

capabilities database? dialect engine id name

Methods

close connect execute explain introspect

Constructors

constructor

new PostgresConnector(config: PostgresConnectorConfig): PostgresConnector
Parameters
- config: PostgresConnectorConfig
Returns PostgresConnector
- Defined in index.ts:77

Properties

`Readonly`capabilities

capabilities: CapabilityFlags = CAPABILITIES

`Optional` `Readonly`database

database?: string

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

`Readonly`dialect

dialect: DialectInfo = POSTGRES_DIALECT

`Readonly`engine

engine: "postgres" = ...

`Readonly`id

id: string

`Readonly`name

name: string

Methods

close

close(): Promise<void>
Returns Promise<void>
Implementation of Connector.close
- Defined in index.ts:146

connect

connect(): Promise<void>
Returns Promise<void>
Implementation of Connector.connect
- Defined in index.ts:115

execute

execute(sql: string, opts?: ExecuteOptions): Promise<ResultSet>
Parameters
- sql: string
- Optionalopts: ExecuteOptions
Returns Promise<ResultSet>
Implementation of Connector.execute
- Defined in index.ts:190

explain

explain(sql: string, opts?: ExecuteOptions): Promise<ResultSet>
Parameters
- sql: string
- Optionalopts: ExecuteOptions
Returns Promise<ResultSet>
Implementation of Connector.explain
- Defined in index.ts:296

introspect

introspect(): Promise<SchemaCatalog>
Returns Promise<SchemaCatalog>
Implementation of Connector.introspect
- Defined in index.ts:159