/*
 * Copyright (C) 2017 Julien Viet
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package io.vertx.pgclient;

import io.vertx.pgclient.impl.PgConnectionImpl;
import io.vertx.sqlclient.PreparedQuery;
import io.vertx.sqlclient.SqlResult;
import io.vertx.sqlclient.RowSet;
import io.vertx.sqlclient.Row;
import io.vertx.sqlclient.SqlConnection;
import io.vertx.sqlclient.Tuple;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.*;

import java.util.List;
import java.util.stream.Collector;

A connection to Postgres.
Author:Julien Viet, Emad Alblueshi
/** * A connection to Postgres. * * @author <a href="mailto:julien@julienviet.com">Julien Viet</a> * @author <a href="mailto:emad.albloushi@gmail.com">Emad Alblueshi</a> */
@VertxGen public interface PgConnection extends SqlConnection {
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.
Params:
  • vertx – the vertx instance
  • options – the connect options
  • handler – the handler called with the connection or the failure
/** * Connects to the database and returns the connection if that succeeds. * <p/> * The connection interracts directly with the database is not a proxy, so closing the * connection will close the underlying connection to the database. * * @param vertx the vertx instance * @param options the connect options * @param handler the handler called with the connection or the failure */
static void connect(Vertx vertx, PgConnectOptions options, Handler<AsyncResult<PgConnection>> handler) { PgConnectionImpl.connect(vertx, options, handler); }
Like connect(Vertx, PgConnectOptions, Handler<AsyncResult<PgConnection>>) with options build from the environment variables.
/** * Like {@link #connect(Vertx, PgConnectOptions, Handler)} with options build from the environment variables. */
static void connect(Vertx vertx, Handler<AsyncResult<PgConnection>> handler) { connect(vertx, PgConnectOptions.fromEnv(), handler); } /** * Like {@link #connect(Vertx, PgConnectOptions, Handler)} with options build from {@code connectionUri}. */ static void connect(Vertx vertx, String connectionUri, Handler<AsyncResult<PgConnection>> handler) { connect(vertx, PgConnectOptions.fromUri(connectionUri), 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.
Params:
  • handler – the handler
Returns:the transaction instance
/** * Set an handler called when the connection receives notification on a channel. * <p/> * The handler is called with the {@link PgNotification} and has access to the channel name * and the notification payload. * * @param handler the handler * @return the transaction instance */
@Fluent PgConnection notificationHandler(Handler<PgNotification> 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.
Params:
  • handler – the handler notified if cancelling request is sent
Returns:a reference to this, so the API can be used fluently
/** * Send a request cancellation message to tell the server to cancel processing request in this connection. * <br>Note: Use this with caution because the cancellation signal may or may not have any effect. * * @param handler the handler notified if cancelling request is sent * @return a reference to this, so the API can be used fluently */
PgConnection cancelRequest(Handler<AsyncResult<Void>> handler);
Returns:The process ID of the target backend
/** * @return The process ID of the target backend */
int processId();
Returns:The secret key for the target backend
/** * @return The secret key for the target backend */
int secretKey(); PgConnection prepare(String sql, Handler<AsyncResult<PreparedQuery>> handler); PgConnection exceptionHandler(Handler<Throwable> handler); PgConnection closeHandler(Handler<Void> handler); PgConnection preparedQuery(String sql, Handler<AsyncResult<RowSet>> handler); @GenIgnore <R> PgConnection preparedQuery(String sql, Collector<Row, ?, R> collector, Handler<AsyncResult<SqlResult<R>>> handler); PgConnection query(String sql, Handler<AsyncResult<RowSet>> handler); @GenIgnore <R> PgConnection query(String sql, Collector<Row, ?, R> collector, Handler<AsyncResult<SqlResult<R>>> handler); PgConnection preparedQuery(String sql, Tuple arguments, Handler<AsyncResult<RowSet>> handler); @GenIgnore <R> PgConnection preparedQuery(String sql, Tuple arguments, Collector<Row, ?, R> collector, Handler<AsyncResult<SqlResult<R>>> handler); PgConnection preparedBatch(String sql, List<Tuple> batch, Handler<AsyncResult<RowSet>> handler); @GenIgnore <R> PgConnection preparedBatch(String sql, List<Tuple> batch, Collector<Row, ?, R> collector, Handler<AsyncResult<SqlResult<R>>> handler); }