Class SqlClient

Defines common SQL client operations with a database server.

Hierarchy

SqlClient
- Pool
- SqlConnection

Index

Methods

Methods

close

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

- Defined in io.vertx/vertx-sql-client/target/npm/index.d.ts:699
Close the client and release the associated resources.

Returns PromiseLike<void>
- Defined in io.vertx/vertx-sql-client/target/npm/index.d.ts:704
Close the client and release the associated resources.

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

preparedQuery

preparedQuery(sql: string): PreparedQuery<RowSet<Row>>
preparedQuery(sql: string, options: PrepareOptions): PreparedQuery<RowSet<Row>>

- Defined in io.vertx/vertx-sql-client/target/npm/index.d.ts:688
Create a prepared query, one of the {@link Query#execute} or {@link PreparedQuery#executeBatch} methods must be called to execute the query.

Parameters
- sql: string
Returns PreparedQuery<RowSet<Row>>
- Defined in io.vertx/vertx-sql-client/target/npm/index.d.ts:694
Create a prepared query, one of the {@link Query#execute} or {@link PreparedQuery#executeBatch} methods must be called to execute the query.

Parameters
- sql: string
- options: PrepareOptions
Returns PreparedQuery<RowSet<Row>>

query

query(sql: string): Query<RowSet<Row>>

- Defined in io.vertx/vertx-sql-client/target/npm/index.d.ts:682
Create a query, the {@link Query#execute} method must be called to execute the query.

Parameters
- sql: string
Returns Query<RowSet<Row>>

Generated using TypeDoc