x-pg-client.4.3.7.source-code.connections.adoc Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-pg-client Show documentation

The Reactive PostgreSQL Client

There is a newer version: 5.0.0.CR1

== Using connections

=== Getting a connection

When you need to execute sequential queries (without a transaction), you can create a new connection
or borrow one from the pool. Remember that between acquiring the connection from the pool and returning it to the pool, you should take care of the connection because it might be closed by the server for some reason such as an idle time out.

[source,$lang]
----
{@link examples.SqlClientExamples#usingConnections01(io.vertx.core.Vertx, io.vertx.sqlclient.Pool)}
----

Prepared queries can be created:

[source,$lang]
----
{@link examples.SqlClientExamples#usingConnections02(io.vertx.sqlclient.SqlConnection)}
----

=== Simplified connection API

When you use a pool, you can call {@link io.vertx.sqlclient.Pool#withConnection} to pass it a function executed
within a connection.

It borrows a connection from the pool and calls the function with this connection.

The function must return a future of an arbitrary result.

After the future completes, the connection is returned to the pool and the overall result is provided.

[source,$lang]
----
{@link examples.SqlClientExamples#usingConnections03(io.vertx.sqlclient.Pool)}
----