# Package io.vertx.sqlclient

- Interface Summary
  Interface | Description
  --- | ---
  ClientBuilder<C> | Builder for `SqlClient` instances.
  Cursor | A cursor that reads progressively rows from the database, it is useful for reading very large result sets.
  Pool | A connection pool which reuses a number of SQL connections.
  PreparedQuery<T> | A query for a prepared statement allowing parameterized execution of the query, this query will use a prepared statement.
  PreparedStatement | A prepared statement, the statement is pre-compiled and it's more efficient to execute the statement for multiple times.
  PropertyKind<T> | The kind of the property, this can be used to fetch some specific property of the `execution result`.
  Query<T> | A query.
  Row | A single row of the `execution result rowset`.
  RowIterator<R> | An iterator for processing rows.
  RowSet<R> | The execution result of the row set of a query provided as `<R>`, commonly used as a `RowSet<Row>`.
  RowStream<T> | A row oriented stream.
  SqlClient | Defines common SQL client operations with a database server.
  SqlConnection | A connection to the database server.
  SqlResult<T> | An interface that represents the execution result of an operation on the database server.
  Transaction | A transaction.
  Tuple | A general purpose tuple.

- Class Summary
  Class | Description
  --- | ---
  PoolOptions | The options for configuring a connection pool.
  PoolOptionsConverter | Converter and mapper for `PoolOptions`.
  PrepareOptions | Options for preparing a statement.
  SqlConnectOptions | Connect options for configuring `SqlConnection` or `Pool`.
  SqlConnectOptionsConverter | Converter and mapper for `SqlConnectOptions`.

- Enum Summary
  Enum | Description
  --- | ---
  TransactionPropagation | Defines how the acquired connection will be managed during the execution of the function provided in `Pool.withTransaction(TransactionPropagation, Function)`.

- Exception Summary
  Exception | Description
  --- | ---
  ClosedConnectionException | When a client operation fails with this exception, the underlying connection may have been lost unexpectedly.
  DatabaseException | Base class for database failures.
  TransactionRollbackException | Failure reported to the `Transaction.completion()` future when the database server reports the current transaction is failed.

Copyright © 2024 Eclipse. All rights reserved.