public interface PgConnection extends SqlConnection
The connection object supports all the operations defined in the SqlConnection
interface,
it also provides additional support:
Modifier and Type | Method and Description |
---|---|
PgConnection |
cancelRequest(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)
Send a request cancellation message to tell the server to cancel processing request in this connection.
|
static PgConnection |
cast(SqlConnection sqlConnection)
Cast a
SqlConnection to PgConnection . |
PgConnection |
closeHandler(io.vertx.core.Handler<Void> handler) |
static io.vertx.core.Future<PgConnection> |
connect(io.vertx.core.Vertx vertx)
Like
connect(Vertx, Handler) but returns a Future of the asynchronous result |
static void |
connect(io.vertx.core.Vertx vertx,
io.vertx.core.Handler<io.vertx.core.AsyncResult<PgConnection>> handler)
Like
connect(Vertx, PgConnectOptions, Handler) with options build from the environment variables. |
static io.vertx.core.Future<PgConnection> |
connect(io.vertx.core.Vertx vertx,
PgConnectOptions options)
Like
connect(Vertx, PgConnectOptions, Handler) but returns a Future of the asynchronous result |
static void |
connect(io.vertx.core.Vertx vertx,
PgConnectOptions options,
io.vertx.core.Handler<io.vertx.core.AsyncResult<PgConnection>> handler)
Connects to the database and returns the connection if that succeeds.
|
static io.vertx.core.Future<PgConnection> |
connect(io.vertx.core.Vertx vertx,
String connectionUri)
Like
connect(Vertx, String, Handler) but returns a Future of the asynchronous result |
static void |
connect(io.vertx.core.Vertx vertx,
String connectionUri,
io.vertx.core.Handler<io.vertx.core.AsyncResult<PgConnection>> handler)
Like
connect(Vertx, PgConnectOptions, Handler) with options build from connectionUri . |
PgConnection |
exceptionHandler(io.vertx.core.Handler<Throwable> handler) |
PgConnection |
notificationHandler(io.vertx.core.Handler<PgNotification> handler)
Set an handler called when the connection receives notification on a channel.
|
PgConnection |
prepare(String sql,
io.vertx.core.Handler<io.vertx.core.AsyncResult<PreparedStatement>> handler) |
int |
processId() |
int |
secretKey() |
begin, begin, close, databaseMetadata, isSSL, prepare
close, preparedQuery, query
static void connect(io.vertx.core.Vertx vertx, PgConnectOptions options, io.vertx.core.Handler<io.vertx.core.AsyncResult<PgConnection>> handler)
vertx
- the vertx instanceoptions
- the connect optionshandler
- the handler called with the connection or the failurestatic io.vertx.core.Future<PgConnection> connect(io.vertx.core.Vertx vertx, PgConnectOptions options)
connect(Vertx, PgConnectOptions, Handler)
but returns a Future
of the asynchronous resultstatic void connect(io.vertx.core.Vertx vertx, io.vertx.core.Handler<io.vertx.core.AsyncResult<PgConnection>> handler)
connect(Vertx, PgConnectOptions, Handler)
with options build from the environment variables.static io.vertx.core.Future<PgConnection> connect(io.vertx.core.Vertx vertx)
connect(Vertx, Handler)
but returns a Future
of the asynchronous resultstatic void connect(io.vertx.core.Vertx vertx, String connectionUri, io.vertx.core.Handler<io.vertx.core.AsyncResult<PgConnection>> handler)
connect(Vertx, PgConnectOptions, Handler)
with options build from connectionUri
.static io.vertx.core.Future<PgConnection> connect(io.vertx.core.Vertx vertx, String connectionUri)
connect(Vertx, String, Handler)
but returns a Future
of the asynchronous resultPgConnection notificationHandler(io.vertx.core.Handler<PgNotification> handler)
PgNotification
and has access to the channel name
and the notification payload.handler
- the handlerPgConnection cancelRequest(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)
handler
- the handler notified if cancelling request is sentint processId()
int secretKey()
PgConnection prepare(String sql, io.vertx.core.Handler<io.vertx.core.AsyncResult<PreparedStatement>> handler)
prepare
in interface SqlConnection
PgConnection exceptionHandler(io.vertx.core.Handler<Throwable> handler)
exceptionHandler
in interface SqlConnection
PgConnection closeHandler(io.vertx.core.Handler<Void> handler)
closeHandler
in interface SqlConnection
static PgConnection cast(SqlConnection sqlConnection)
SqlConnection
to PgConnection
.
This is mostly useful for Vert.x generated APIs like RxJava/Mutiny.sqlConnection
- the connection to castinstance
Copyright © 2021 Eclipse. All rights reserved.