SQLClient | @vertx/jdbc-client

A common asynchronous client interface for interacting with SQL compliant database

Hierarchy

SQLClient
- JDBCClient

Implements

SQLOperations

Index

Methods

call

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

Implementation of SQLOperations.call
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:269
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:274
Calls the given SQL PROCEDURE which returns the result from the procedure.

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

callWithParams

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

Implementation of SQLOperations.callWithParams
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:287
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:300
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[]
- handler: ((res: AsyncResult<ResultSet>) => void) | Handler<AsyncResult<ResultSet>>
Returns SQLClient

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:185
Close the client and release all resources. Call the handler when close is complete.

Returns PromiseLike<void>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:191
Close the client and release all resources. Call the handler when close is complete.

Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:196
Close the client

Returns void

getConnection

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

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:173
Returns a connection that can be used to perform SQL operations on. It's important to remember to close the connection when you are done, so it is returned to the pool.

Returns PromiseLike<SQLConnection>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:179
Returns a connection that can be used to perform SQL operations on. It's important to remember to close the connection when you are done, so it is returned to the pool.

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

query

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

Implementation of SQLOperations.query
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:202
Execute a single SQL statement, this method acquires a connection from the the pool and executes the SQL statement and returns it back after the execution.

Parameters
- sql: string
Returns PromiseLike<ResultSet>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:208
Execute a single SQL statement, this method acquires a connection from the the pool and executes the SQL statement and returns it back after the execution.

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

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:146
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:153
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:160
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:167
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>>): SQLClient

Implementation of SQLOperations.queryStream
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:213
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:218
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 SQLClient

queryStreamWithParams

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

Implementation of SQLOperations.queryStreamWithParams
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:223
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:228
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 SQLClient

queryWithParams

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

Implementation of SQLOperations.queryWithParams
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:234
Execute a single SQL prepared statement, this method acquires a connection from the the pool and executes the SQL prepared statement and returns it back after the execution.

Parameters
- sql: string
- arguments: any[]
Returns PromiseLike<ResultSet>
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:240
Execute a single SQL prepared statement, this method acquires a connection from the the pool and executes the SQL prepared statement and returns it back after the execution.

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

update

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

Implementation of SQLOperations.update
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:246
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:252
Executes the given SQL statement which may be an INSERT, UPDATE, or DELETE statement.

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

updateWithParams

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

Implementation of SQLOperations.updateWithParams
- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:258
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:264
Executes the given prepared statement which may be an INSERT, UPDATE, or DELETE statement with the given parameters

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

Hierarchy

Implements

Index

Methods

Methods

call

Parameters

sql: string

Returns PromiseLike<ResultSet>

Parameters

sql: string

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

Returns SQLClient

callWithParams

Parameters

sql: string

params: any[]

outputs: any[]

Returns PromiseLike<ResultSet>

Parameters

sql: string

params: any[]

outputs: any[]

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

Returns SQLClient

close

Returns PromiseLike<void>

Parameters

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

Returns void

Returns void

getConnection

Returns PromiseLike<SQLConnection>

Parameters

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

Returns SQLClient

query

Parameters

sql: string

Returns PromiseLike<ResultSet>

Parameters

sql: string

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

Returns SQLClient

querySingle

Parameters

sql: string

Returns PromiseLike<any[]>

Parameters

sql: string

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

Returns SQLOperations

querySingleWithParams

Parameters

sql: string

arguments: any[]

Returns PromiseLike<any[]>

Parameters

sql: string

arguments: any[]

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

Returns SQLOperations

queryStream

Parameters

sql: string

Returns PromiseLike<SQLRowStream>

Parameters

sql: string

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

Returns SQLClient

queryStreamWithParams

Parameters

sql: string

params: any[]

Returns PromiseLike<SQLRowStream>

Parameters

sql: string

params: any[]

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

Returns SQLClient