SQLConnection | @vertx/jdbc-client

Represents a connection to a SQL database

Hierarchy

SQLConnection

Implements

SQLOperations

Methods

batch

batch(sqlStatements: string): PromiseLike<number>
batch(sqlStatements: string, handler: ((res: AsyncResult<number>) => void) | Handler<AsyncResult<number>>): SQLConnection

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:514
Batch simple SQL strings and execute the batch where the async result contains a array of Integers.

Parameters
- sqlStatements: string
Returns PromiseLike<number>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:519
Batch simple SQL strings and execute the batch where the async result contains a array of Integers.

Parameters
- sqlStatements: string
- handler: ((res: AsyncResult<number>) => void) | Handler<AsyncResult<number>>
Returns SQLConnection

batchCallableWithParams

batchCallableWithParams(sqlStatement: string, inArgs: any[], outArgs: any[]): PromiseLike<number>
batchCallableWithParams(sqlStatement: string, inArgs: any[], outArgs: any[], handler: ((res: AsyncResult<number>) => void) | Handler<AsyncResult<number>>): SQLConnection

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:538
Batch a callable statement with all entries from the args list. Each entry is a batch. The size of the lists inArgs and outArgs MUST be the equal. The operation completes with the execution of the batch where the async result contains a array of Integers.

Parameters
- sqlStatement: string
- inArgs: any[]
- outArgs: any[]
Returns PromiseLike<number>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:545
Batch a callable statement with all entries from the args list. Each entry is a batch. The size of the lists inArgs and outArgs MUST be the equal. The operation completes with the execution of the batch where the async result contains a array of Integers.

Parameters
- sqlStatement: string
- inArgs: any[]
- outArgs: any[]
- handler: ((res: AsyncResult<number>) => void) | Handler<AsyncResult<number>>
Returns SQLConnection

batchWithParams

batchWithParams(sqlStatement: string, args: any[]): PromiseLike<number>
batchWithParams(sqlStatement: string, args: any[], handler: ((res: AsyncResult<number>) => void) | Handler<AsyncResult<number>>): SQLConnection

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:525
Batch a prepared statement with all entries from the args list. Each entry is a batch. The operation completes with the execution of the batch where the async result contains a array of Integers.

Parameters
- sqlStatement: string
- args: any[]
Returns PromiseLike<number>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:531
Batch a prepared statement with all entries from the args list. Each entry is a batch. The operation completes with the execution of the batch where the async result contains a array of Integers.

Parameters
- sqlStatement: string
- args: any[]
- handler: ((res: AsyncResult<number>) => void) | Handler<AsyncResult<number>>
Returns SQLConnection

call

call(sql: string): PromiseLike<ResultSet>
call(sql: string, resultHandler: ((res: AsyncResult<ResultSet>) => void) | Handler<AsyncResult<ResultSet>>): SQLConnection

Implementation of SQLOperations.call
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:436
Calls the given SQL PROCEDURE which returns the result from the procedure.

Parameters
- sql: string
Returns PromiseLike<ResultSet>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:441
Calls the given SQL PROCEDURE which returns the result from the procedure.

Parameters
- sql: string
- resultHandler: ((res: AsyncResult<ResultSet>) => void) | Handler<AsyncResult<ResultSet>>
Returns SQLConnection

callWithParams

callWithParams(sql: string, params: any[], outputs: any[]): PromiseLike<ResultSet>
callWithParams(sql: string, params: any[], outputs: any[], resultHandler: ((res: AsyncResult<ResultSet>) => void) | Handler<AsyncResult<ResultSet>>): SQLConnection

Implementation of SQLOperations.callWithParams
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:454
Calls the given SQL PROCEDURE which returns the result from the procedure.

The index of params and outputs are important for both arrays, for example when dealing with a prodecure that takes the first 2 arguments as input values and the 3 arg as an output then the arrays should be like:
```
  params = [VALUE1, VALUE2, null]
  outputs = [null, null, "VARCHAR"]
```
Parameters
- sql: string
- params: any[]
- outputs: any[]
Returns PromiseLike<ResultSet>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:467
Calls the given SQL PROCEDURE which returns the result from the procedure.

The index of params and outputs are important for both arrays, for example when dealing with a prodecure that takes the first 2 arguments as input values and the 3 arg as an output then the arrays should be like:
```
  params = [VALUE1, VALUE2, null]
  outputs = [null, null, "VARCHAR"]
```
Parameters
- sql: string
- params: any[]
- outputs: any[]
- resultHandler: ((res: AsyncResult<ResultSet>) => void) | Handler<AsyncResult<ResultSet>>
Returns SQLConnection

close

close(): PromiseLike<void>
close(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
close(): void

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:472
Closes the connection. Important to always close the connection when you are done so it's returned to the pool.

Returns PromiseLike<void>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:477
Closes the connection. Important to always close the connection when you are done so it's returned to the pool.

Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:482
Closes the connection. Important to always close the connection when you are done so it's returned to the pool.

Returns void

commit

commit(): PromiseLike<void>
commit(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): SQLConnection

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:487
Commits all changes made since the previous commit/rollback.

Returns PromiseLike<void>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:492
Commits all changes made since the previous commit/rollback.

Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns SQLConnection

execute

execute(sql: string): PromiseLike<void>
execute(sql: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): SQLConnection

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:362
Executes the given SQL statement

Parameters
- sql: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:367
Executes the given SQL statement

Parameters
- sql: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns SQLConnection

getTransactionIsolation

getTransactionIsolation(): PromiseLike<TransactionIsolation>
getTransactionIsolation(handler: ((res: AsyncResult<TransactionIsolation>) => void) | Handler<AsyncResult<TransactionIsolation>>): SQLConnection

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:564
Attempts to return the transaction isolation level for this Connection object to the one given.

Returns PromiseLike<TransactionIsolation>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:569
Attempts to return the transaction isolation level for this Connection object to the one given.

Parameters
- handler: ((res: AsyncResult<TransactionIsolation>) => void) | Handler<AsyncResult<TransactionIsolation>>
Returns SQLConnection

query

query(sql: string): PromiseLike<ResultSet>
query(sql: string, resultHandler: ((res: AsyncResult<ResultSet>) => void) | Handler<AsyncResult<ResultSet>>): SQLConnection

Implementation of SQLOperations.query
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:372
Executes the given SQL SELECT statement which returns the results of the query.

Parameters
- sql: string
Returns PromiseLike<ResultSet>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:377
Executes the given SQL SELECT statement which returns the results of the query.

Parameters
- sql: string
- resultHandler: ((res: AsyncResult<ResultSet>) => void) | Handler<AsyncResult<ResultSet>>
Returns SQLConnection

querySingle

querySingle(sql: string): PromiseLike<any[]>
querySingle(sql: string, handler: ((res: AsyncResult<any[]>) => void) | Handler<AsyncResult<any[]>>): SQLOperations

Implementation of SQLOperations.querySingle
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:315
Execute a one shot SQL statement that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

Parameters
- sql: string
Returns PromiseLike<any[]>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:322
Execute a one shot SQL statement that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

Parameters
- sql: string
- handler: ((res: AsyncResult<any[]>) => void) | Handler<AsyncResult<any[]>>
Returns SQLOperations

querySingleWithParams

querySingleWithParams(sql: string, arguments: any[]): PromiseLike<any[]>
querySingleWithParams(sql: string, arguments: any[], handler: ((res: AsyncResult<any[]>) => void) | Handler<AsyncResult<any[]>>): SQLOperations

Implementation of SQLOperations.querySingleWithParams
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:329
Execute a one shot SQL statement with arguments that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

Parameters
- sql: string
- arguments: any[]
Returns PromiseLike<any[]>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:336
Execute a one shot SQL statement with arguments that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

Parameters
- sql: string
- arguments: any[]
- handler: ((res: AsyncResult<any[]>) => void) | Handler<AsyncResult<any[]>>
Returns SQLOperations

queryStream

queryStream(sql: string): PromiseLike<SQLRowStream>
queryStream(sql: string, handler: ((res: AsyncResult<SQLRowStream>) => void) | Handler<AsyncResult<SQLRowStream>>): SQLConnection

Implementation of SQLOperations.queryStream
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:382
Executes the given SQL SELECT statement which returns the results of the query as a read stream.

Parameters
- sql: string
Returns PromiseLike<SQLRowStream>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:387
Executes the given SQL SELECT statement which returns the results of the query as a read stream.

Parameters
- sql: string
- handler: ((res: AsyncResult<SQLRowStream>) => void) | Handler<AsyncResult<SQLRowStream>>
Returns SQLConnection

queryStreamWithParams

queryStreamWithParams(sql: string, params: any[]): PromiseLike<SQLRowStream>
queryStreamWithParams(sql: string, params: any[], handler: ((res: AsyncResult<SQLRowStream>) => void) | Handler<AsyncResult<SQLRowStream>>): SQLConnection

Implementation of SQLOperations.queryStreamWithParams
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:402
Executes the given SQL SELECT statement which returns the results of the query as a read stream.

Parameters
- sql: string
- params: any[]
Returns PromiseLike<SQLRowStream>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:407
Executes the given SQL SELECT statement which returns the results of the query as a read stream.

Parameters
- sql: string
- params: any[]
- handler: ((res: AsyncResult<SQLRowStream>) => void) | Handler<AsyncResult<SQLRowStream>>
Returns SQLConnection

queryWithParams

queryWithParams(sql: string, params: any[]): PromiseLike<ResultSet>
queryWithParams(sql: string, params: any[], resultHandler: ((res: AsyncResult<ResultSet>) => void) | Handler<AsyncResult<ResultSet>>): SQLConnection

Implementation of SQLOperations.queryWithParams
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:392
Executes the given SQL SELECT prepared statement which returns the results of the query.

Parameters
- sql: string
- params: any[]
Returns PromiseLike<ResultSet>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:397
Executes the given SQL SELECT prepared statement which returns the results of the query.

Parameters
- sql: string
- params: any[]
- resultHandler: ((res: AsyncResult<ResultSet>) => void) | Handler<AsyncResult<ResultSet>>
Returns SQLConnection

rollback

rollback(): PromiseLike<void>
rollback(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): SQLConnection

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:497
Rolls back all changes made since the previous commit/rollback.

Returns PromiseLike<void>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:502
Rolls back all changes made since the previous commit/rollback.

Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns SQLConnection

setAutoCommit

setAutoCommit(autoCommit: boolean): PromiseLike<void>
setAutoCommit(autoCommit: boolean, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): SQLConnection

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:352
Sets the auto commit flag for this connection. True by default.

Parameters
- autoCommit: boolean
Returns PromiseLike<void>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:357
Sets the auto commit flag for this connection. True by default.

Parameters
- autoCommit: boolean
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns SQLConnection

setOptions

setOptions(options: SQLOptions): SQLConnection

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:347
Sets the desired options to be applied to the current connection when statements are executed.

The options are not applied globally but applicable to the current connection. For example changing the transaction isolation level will only affect statements run on this connection and not future or current connections acquired from the connection pool.

This method is not async in nature since the apply will only happen at the moment a query is run.

Parameters
- options: SQLOptions
Returns SQLConnection

setQueryTimeout

setQueryTimeout(timeoutInSeconds: number): SQLConnection

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:509
Sets a connection wide query timeout.

It can be over written at any time and becomes active on the next query call.

Parameters
- timeoutInSeconds: number
Returns SQLConnection

setTransactionIsolation

setTransactionIsolation(isolation: TransactionIsolation): PromiseLike<void>
setTransactionIsolation(isolation: TransactionIsolation, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): SQLConnection

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:552
Attempts to change the transaction isolation level for this Connection object to the one given.

The constants defined in the interface Connection are the possible transaction isolation levels.

Parameters
- isolation: TransactionIsolation
Returns PromiseLike<void>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:559
Attempts to change the transaction isolation level for this Connection object to the one given.

The constants defined in the interface Connection are the possible transaction isolation levels.

Parameters
- isolation: TransactionIsolation
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns SQLConnection

update

update(sql: string): PromiseLike<UpdateResult>
update(sql: string, resultHandler: ((res: AsyncResult<UpdateResult>) => void) | Handler<AsyncResult<UpdateResult>>): SQLConnection

Implementation of SQLOperations.update
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:413
Executes the given SQL statement which may be an INSERT, UPDATE, or DELETE statement.

Parameters
- sql: string
Returns PromiseLike<UpdateResult>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:419
Executes the given SQL statement which may be an INSERT, UPDATE, or DELETE statement.

Parameters
- sql: string
- resultHandler: ((res: AsyncResult<UpdateResult>) => void) | Handler<AsyncResult<UpdateResult>>
Returns SQLConnection

updateWithParams

updateWithParams(sql: string, params: any[]): PromiseLike<UpdateResult>
updateWithParams(sql: string, params: any[], resultHandler: ((res: AsyncResult<UpdateResult>) => void) | Handler<AsyncResult<UpdateResult>>): SQLConnection

Implementation of SQLOperations.updateWithParams
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:425
Executes the given prepared statement which may be an INSERT, UPDATE, or DELETE statement with the given parameters

Parameters
- sql: string
- params: any[]
Returns PromiseLike<UpdateResult>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:431
Executes the given prepared statement which may be an INSERT, UPDATE, or DELETE statement with the given parameters

Parameters
- sql: string
- params: any[]
- resultHandler: ((res: AsyncResult<UpdateResult>) => void) | Handler<AsyncResult<UpdateResult>>
Returns SQLConnection

Hierarchy

Implements

Index

Methods

Methods

batch

Parameters

sqlStatements: string

Returns PromiseLike<number>

Parameters

sqlStatements: string

handler: ((res: AsyncResult<number>) => void) | Handler<AsyncResult<number>>

Returns SQLConnection

batchCallableWithParams

Parameters

sqlStatement: string

inArgs: any[]

outArgs: any[]

Returns PromiseLike<number>

Parameters

sqlStatement: string

inArgs: any[]

outArgs: any[]

handler: ((res: AsyncResult<number>) => void) | Handler<AsyncResult<number>>

Returns SQLConnection

batchWithParams

Parameters

sqlStatement: string

args: any[]

Returns PromiseLike<number>

Parameters

sqlStatement: string

args: any[]

handler: ((res: AsyncResult<number>) => void) | Handler<AsyncResult<number>>

Returns SQLConnection

call

Parameters

sql: string

Returns PromiseLike<ResultSet>

Parameters

sql: string

resultHandler: ((res: AsyncResult<ResultSet>) => void) | Handler<AsyncResult<ResultSet>>

Returns SQLConnection

callWithParams

Parameters

sql: string

params: any[]

outputs: any[]

Returns PromiseLike<ResultSet>

Parameters

sql: string

params: any[]

outputs: any[]

resultHandler: ((res: AsyncResult<ResultSet>) => void) | Handler<AsyncResult<ResultSet>>

Returns SQLConnection

close

Returns PromiseLike<void>

Parameters

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

Returns void

commit

Returns PromiseLike<void>

Parameters

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns SQLConnection

execute

Parameters

sql: string

Returns PromiseLike<void>

Parameters

sql: string

resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns SQLConnection

getTransactionIsolation

Returns PromiseLike<TransactionIsolation>

Parameters

handler: ((res: AsyncResult<TransactionIsolation>) => void) | Handler<AsyncResult<TransactionIsolation>>

Returns SQLConnection

query