io.vertx.pgclient

Interface PgConnection

All Superinterfaces:

SqlClient, SqlConnection

public interface PgConnection
extends SqlConnection

A connection to Postgres.

Author:

Julien Viet, Emad Alblueshi

Method Summary

Modifier and Type	Method and Description
PgConnection	cancelRequest(Handler<AsyncResult<Void>> handler) Send a request cancellation message to tell the server to cancel processing request in this connection.
PgConnection	closeHandler(Handler<Void> handler)
static void	connect(Vertx vertx, Handler<AsyncResult<PgConnection>> handler) Like connect(Vertx, PgConnectOptions, Handler) with options build from the environment variables.
static void	connect(Vertx vertx, PgConnectOptions options, Handler<AsyncResult<PgConnection>> handler) Connects to the database and returns the connection if that succeeds.
static void	connect(Vertx vertx, String connectionUri, Handler<AsyncResult<PgConnection>> handler) Like connect(Vertx, PgConnectOptions, Handler) with options build from connectionUri.
PgConnection	exceptionHandler(Handler<Throwable> handler)
PgConnection	notificationHandler(Handler<PgNotification> handler) Set an handler called when the connection receives notification on a channel.
PgConnection	prepare(String sql, Handler<AsyncResult<PreparedQuery>> handler)
<R> PgConnection	preparedBatch(String sql, List<Tuple> batch, Collector<Row,?,R> collector, Handler<AsyncResult<SqlResult<R>>> handler)
PgConnection	preparedBatch(String sql, List<Tuple> batch, Handler<AsyncResult<RowSet>> handler)
<R> PgConnection	preparedQuery(String sql, Collector<Row,?,R> collector, Handler<AsyncResult<SqlResult<R>>> handler)
PgConnection	preparedQuery(String sql, Handler<AsyncResult<RowSet>> handler)
<R> PgConnection	preparedQuery(String sql, Tuple arguments, Collector<Row,?,R> collector, Handler<AsyncResult<SqlResult<R>>> handler)
PgConnection	preparedQuery(String sql, Tuple arguments, Handler<AsyncResult<RowSet>> handler)
int	processId()
<R> PgConnection	query(String sql, Collector<Row,?,R> collector, Handler<AsyncResult<SqlResult<R>>> handler)
PgConnection	query(String sql, Handler<AsyncResult<RowSet>> handler)
int	secretKey()

Methods inherited from interface io.vertx.sqlclient.SqlConnection

begin, close, isSSL

Method Detail

connect

static void connect(Vertx vertx,
                    PgConnectOptions options,
                    Handler<AsyncResult<PgConnection>> handler)

Connects to the database and returns the connection if that succeeds.

The connection interracts directly with the database is not a proxy, so closing the connection will close the underlying connection to the database.

Parameters:

vertx - the vertx instance

options - the connect options

handler - the handler called with the connection or the failure

connect

static void connect(Vertx vertx,
                    Handler<AsyncResult<PgConnection>> handler)

Like connect(Vertx, PgConnectOptions, Handler) with options build from the environment variables.

connect

static void connect(Vertx vertx,
                    String connectionUri,
                    Handler<AsyncResult<PgConnection>> handler)

Like connect(Vertx, PgConnectOptions, Handler) with options build from connectionUri.

notificationHandler

PgConnection notificationHandler(Handler<PgNotification> handler)

Set an handler called when the connection receives notification on a channel.

The handler is called with the PgNotification and has access to the channel name and the notification payload.

Parameters:

handler - the handler

Returns:

the transaction instance

cancelRequest

PgConnection cancelRequest(Handler<AsyncResult<Void>> handler)

Send a request cancellation message to tell the server to cancel processing request in this connection.
Note: Use this with caution because the cancellation signal may or may not have any effect.

Parameters:

handler - the handler notified if cancelling request is sent

Returns:

a reference to this, so the API can be used fluently

processId

int processId()

Returns:

The process ID of the target backend

secretKey

int secretKey()

Returns:

The secret key for the target backend

prepare

PgConnection prepare(String sql,
                     Handler<AsyncResult<PreparedQuery>> handler)

Specified by:

prepare in interface SqlConnection

exceptionHandler

PgConnection exceptionHandler(Handler<Throwable> handler)

Specified by:

exceptionHandler in interface SqlConnection

closeHandler

PgConnection closeHandler(Handler<Void> handler)

Specified by:

closeHandler in interface SqlConnection

preparedQuery

PgConnection preparedQuery(String sql,
                           Handler<AsyncResult<RowSet>> handler)

Specified by:

preparedQuery in interface SqlClient

Specified by:

preparedQuery in interface SqlConnection

preparedQuery

<R> PgConnection preparedQuery(String sql,
                               Collector<Row,?,R> collector,
                               Handler<AsyncResult<SqlResult<R>>> handler)

Specified by:

preparedQuery in interface SqlClient

Specified by:

preparedQuery in interface SqlConnection

query

PgConnection query(String sql,
                   Handler<AsyncResult<RowSet>> handler)

Specified by:

query in interface SqlClient

Specified by:

query in interface SqlConnection

query

<R> PgConnection query(String sql,
                       Collector<Row,?,R> collector,
                       Handler<AsyncResult<SqlResult<R>>> handler)

Specified by:

query in interface SqlClient

Specified by:

query in interface SqlConnection

preparedQuery

PgConnection preparedQuery(String sql,
                           Tuple arguments,
                           Handler<AsyncResult<RowSet>> handler)

Specified by:

preparedQuery in interface SqlClient

Specified by:

preparedQuery in interface SqlConnection

preparedQuery

<R> PgConnection preparedQuery(String sql,
                               Tuple arguments,
                               Collector<Row,?,R> collector,
                               Handler<AsyncResult<SqlResult<R>>> handler)

Specified by:

preparedQuery in interface SqlClient

Specified by:

preparedQuery in interface SqlConnection

preparedBatch

PgConnection preparedBatch(String sql,
                           List<Tuple> batch,
                           Handler<AsyncResult<RowSet>> handler)

Specified by:

preparedBatch in interface SqlClient

Specified by:

preparedBatch in interface SqlConnection

preparedBatch

<R> PgConnection preparedBatch(String sql,
                               List<Tuple> batch,
                               Collector<Row,?,R> collector,
                               Handler<AsyncResult<SqlResult<R>>> handler)

Specified by:

preparedBatch in interface SqlClient

Specified by:

preparedBatch in interface SqlConnection