SQLOperations | @vertx/jdbc-client

Represents a SQL query interface to a database

Hierarchy

SQLOperations

Implemented by

Index

Methods

call

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

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

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

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>>): SQLOperations

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:690
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:703
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 SQLOperations

query

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

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:580
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:585
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 SQLOperations

querySingle

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

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:622
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:629
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

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:636
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:643
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>>): SQLOperations

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:600
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:605
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 SQLOperations

queryStreamWithParams

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

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:610
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:615
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 SQLOperations

queryWithParams

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

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:590
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:595
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 SQLOperations

update

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

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:649
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:655
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 SQLOperations

updateWithParams

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

- Defined in io.vertx/vertx-jdbc-client/target/npm/index.d.ts:661
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:667
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 SQLOperations

Hierarchy

Implemented by

Index

Methods

Methods

call

Parameters

sql: string

Returns PromiseLike<ResultSet>

Parameters

sql: string

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

Returns SQLOperations

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 SQLOperations

query

Parameters

sql: string

Returns PromiseLike<ResultSet>

Parameters

sql: string

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

Returns SQLOperations

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 SQLOperations

queryStreamWithParams

Parameters

sql: string

params: any[]

Returns PromiseLike<SQLRowStream>

Parameters

sql: string

params: any[]

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

Returns SQLOperations

queryWithParams

Parameters

sql: string

params: any[]

Returns PromiseLike<ResultSet>

Parameters

sql: string

params: any[]

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

Returns SQLOperations

update