Class ExasolDriver

Implements

IExasolDriver

Index

Constructors

Accessors

Methods

[asyncDispose] cancel close connect execute executeBatch exportToCsvFile fetchData importFromCsvFile prepare query sendCommand sendCommandWithNoResult

Constructors

constructor

new ExasolDriver(
    websocketFactory: WebsocketFactory,
    config: Partial<Config>,
    logger?: ILogger,
): ExasolDriver
Parameters
- websocketFactory: WebsocketFactory
- config: Partial<Config>
- logger: ILogger = ...
Returns ExasolDriver
- Defined in src/lib/sql-client.ts:80

Accessors

broken

get broken(): boolean
Returns boolean
- Defined in src/lib/sql-client.ts:204

Methods

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Returns Promise<void>
Implementation of IExasolDriver.[asyncDispose]
- Defined in src/lib/sql-client.ts:199

cancel

cancel(): Promise<void>
Cancel the last active job

Returns Promise<void>
Implementation of IExasolDriver.cancel
- Defined in src/lib/sql-client.ts:168

close

close(): Promise<void>
Close current connection

Returns Promise<void>
Implementation of IExasolDriver.close
- Defined in src/lib/sql-client.ts:185

connect

connect(): Promise<void>
Connect to database

Returns Promise<void>

Throws
Implementation of IExasolDriver.connect
- Defined in src/lib/sql-client.ts:94

execute

execute(
    sqlStatement: string,
    attributes?: Partial<Attributes>,
    getCancel?: CetCancelFunction,
): Promise<number>
Execute single SQL statement
Parameters
- sqlStatement: string
- Optionalattributes: Partial<Attributes>
- OptionalgetCancel: CetCancelFunction
Returns Promise<number>

Throws
Implementation of IExasolDriver.execute
- Defined in src/lib/sql-client.ts:310
execute(
    sqlStatement: string,
    attributes?: Partial<Attributes>,
    getCancel?: CetCancelFunction,
    responseType?: "default",
): Promise<number>
Parameters
- sqlStatement: string
- Optionalattributes: Partial<Attributes>
- OptionalgetCancel: CetCancelFunction
- OptionalresponseType: "default"
Returns Promise<number>

Inherit Doc
Implementation of IExasolDriver.execute
- Defined in src/lib/sql-client.ts:315
execute(
    sqlStatement: string,
    attributes?: Partial<Attributes>,
    getCancel?: CetCancelFunction,
    responseType?: "raw",
): Promise<SQLResponse<SQLQueriesResponse>>
Execute single SQL statement and get raw result back
Parameters
- sqlStatement: string
- Optionalattributes: Partial<Attributes>
- OptionalgetCancel: CetCancelFunction
- OptionalresponseType: "raw"
Returns Promise<SQLResponse<SQLQueriesResponse>>

Throws
Implementation of IExasolDriver.execute
- Defined in src/lib/sql-client.ts:321

executeBatch

executeBatch(
    sqlStatements: string[],
    attributes?: Partial<Attributes>,
    getCancel?: CetCancelFunction,
): Promise<SQLResponse<SQLQueriesResponse>>
Executes multiple SQL statements sequentially as a batch.
Parameters
- sqlStatements: string[]
  Array of sql statements
- Optionalattributes: Partial<Attributes>
- OptionalgetCancel: CetCancelFunction
Returns Promise<SQLResponse<SQLQueriesResponse>>

Throws
Implementation of IExasolDriver.executeBatch
- Defined in src/lib/sql-client.ts:385

exportToCsvFile

exportToCsvFile(
    source: string,
    filePath: string,
    csvOptions?: CsvExportFormatOptions,
    options?: CsvExportOptions,
): Promise<number>
Export an Exasol table or parenthesized query result to a new local CSV file.

Node.js only.
Parameters
- source: string
  Source table name (optionally schema-qualified) or parenthesized query
- filePath: string
  Path to the new local CSV file
- OptionalcsvOptions: CsvExportFormatOptions
  Optional CSV format options
- Optionaloptions: CsvExportOptions
  Optional export control options
Returns Promise<number>
Number of rows exported
Implementation of IExasolDriver.exportToCsvFile
- Defined in src/lib/sql-client.ts:477

fetchData

fetchData(
data: SQLResponse<SQLQueriesResponse>,
connection: Connection,
): Promise<SQLResponse<SQLQueriesResponse>>
Parameters
- data: SQLResponse<SQLQueriesResponse>
- connection: Connection
Returns Promise<SQLResponse<SQLQueriesResponse>>
- Defined in src/lib/sql-client.ts:302

importFromCsvFile

importFromCsvFile(
    tableName: string,
    filePath: string,
    csvOptions?: CsvFormatOptions,
    options?: CsvImportOptions,
): Promise<number>
Import data from a local CSV file into an Exasol table.

Node.js only.
Parameters
- tableName: string
  Target table name (optionally schema-qualified)
- filePath: string
  Path to the local CSV file
- OptionalcsvOptions: CsvFormatOptions
  Optional CSV format options
- Optionaloptions: CsvImportOptions
  Optional import control options
Returns Promise<number>
Number of rows imported
Implementation of IExasolDriver.importFromCsvFile
- Defined in src/lib/sql-client.ts:455

prepare

prepare(
sqlStatement: string,
getCancel?: CetCancelFunction,
): Promise<IStatement>
Prepare statement
Parameters
- sqlStatement: string
- OptionalgetCancel: CetCancelFunction
Returns Promise<IStatement>

Throws
Implementation of IExasolDriver.prepare
- Defined in src/lib/sql-client.ts:414

query

query(
    sqlStatement: string,
    attributes?: Partial<Attributes>,
    getCancel?: CetCancelFunction,
): Promise<QueryResult>
Query single SQL statement
Parameters
- sqlStatement: string
- Optionalattributes: Partial<Attributes>
- OptionalgetCancel: CetCancelFunction
Returns Promise<QueryResult>

Throws
Implementation of IExasolDriver.query
- Defined in src/lib/sql-client.ts:234
query(
    sqlStatement: string,
    attributes?: Partial<Attributes>,
    getCancel?: CetCancelFunction,
    responseType?: "default",
): Promise<QueryResult>
Parameters
- sqlStatement: string
- Optionalattributes: Partial<Attributes>
- OptionalgetCancel: CetCancelFunction
- OptionalresponseType: "default"
Returns Promise<QueryResult>

Inherit Doc
Implementation of IExasolDriver.query
- Defined in src/lib/sql-client.ts:239
query(
    sqlStatement: string,
    attributes?: Partial<Attributes>,
    getCancel?: CetCancelFunction,
    responseType?: "raw",
): Promise<SQLResponse<SQLQueriesResponse>>
Query single SQL statement and get raw result
Parameters
- sqlStatement: string
- Optionalattributes: Partial<Attributes>
- OptionalgetCancel: CetCancelFunction
- OptionalresponseType: "raw"
Returns Promise<SQLResponse<SQLQueriesResponse>>

Throws
Implementation of IExasolDriver.query
- Defined in src/lib/sql-client.ts:245
query(
    sqlStatement: string,
    attributes?: Partial<Attributes>,
    getCancel?: CetCancelFunction,
    responseType?: "raw" | "default",
): Promise<QueryResult | SQLResponse<SQLQueriesResponse>>
Parameters
- sqlStatement: string
- Optionalattributes: Partial<Attributes>
- OptionalgetCancel: CetCancelFunction
- OptionalresponseType: "raw" | "default"
Returns Promise<QueryResult | SQLResponse<SQLQueriesResponse>>

Inherit Doc
Implementation of IExasolDriver.query
- Defined in src/lib/sql-client.ts:251

sendCommand

sendCommand<T>(
cmd: Commands,
getCancel?: CetCancelFunction,
): Promise<SQLResponse<T>>
Send commands and wait for result, while a command is executed all other commands will be rejected till the current command finished.
Type Parameters
- T
Parameters
- cmd: Commands
- OptionalgetCancel: CetCancelFunction
Returns Promise<SQLResponse<T>>

Throws
Implementation of IExasolDriver.sendCommand
- Defined in src/lib/sql-client.ts:433

sendCommandWithNoResult

sendCommandWithNoResult(cmd: AbortQueryCommand): Promise<void>
Send commands which have no results
Parameters
- cmd: AbortQueryCommand
Returns Promise<void>
Implementation of IExasolDriver.sendCommandWithNoResult
- Defined in src/lib/sql-client.ts:211

Class ExasolDriver

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ExasolDriver

Accessors

broken

Returns boolean

Methods

[asyncDispose]

Returns Promise<void>

cancel

Returns Promise<void>

close

Returns Promise<void>

connect

Returns Promise<void>

Throws

execute

Parameters

Returns Promise<number>

Throws

Parameters

Returns Promise<number>

Inherit Doc

Parameters

Returns Promise<SQLResponse<SQLQueriesResponse>>

Throws

executeBatch

Parameters

Returns Promise<SQLResponse<SQLQueriesResponse>>

Throws

exportToCsvFile

Parameters

Returns Promise<number>

fetchData

Parameters

Returns Promise<SQLResponse<SQLQueriesResponse>>

importFromCsvFile

Parameters

Returns Promise<number>

prepare

Parameters

Returns Promise<IStatement>

Throws

query

Parameters

Returns Promise<QueryResult>

Throws

Parameters

Returns Promise<QueryResult>

Inherit Doc

Parameters

Returns Promise<SQLResponse<SQLQueriesResponse>>

Throws

Parameters

Returns Promise<QueryResult | SQLResponse<SQLQueriesResponse>>

Inherit Doc

sendCommand

Type Parameters

Parameters

Returns Promise<SQLResponse<T>>

Throws

sendCommandWithNoResult

Parameters

Returns Promise<void>

Settings

On This Page