io.reactiverse.reactivex.pgclient

Class PgConnection

java.lang.Object

io.reactiverse.reactivex.pgclient.PgClient

io.reactiverse.reactivex.pgclient.PgConnection

public class PgConnection
extends PgClient

A connection to Postgres.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field and Description
static io.vertx.lang.rx.TypeArg<PgConnection>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
PgConnection(PgConnection delegate)

Method Summary

Modifier and Type	Method and Description
PgTransaction	begin() Begin a transaction and returns a PgTransaction for controlling and tracking this transaction.
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.
void	close() Close the current connection after all the pending commands have been processed.
PgConnection	closeHandler(io.vertx.core.Handler<Void> handler) Set an handler called when the connection is closed.
boolean	equals(Object o)
PgConnection	exceptionHandler(io.vertx.core.Handler<Throwable> handler) Set an handler called with connection errors.
PgConnection	getDelegate()
int	hashCode()
boolean	isSSL()
static PgConnection	newInstance(PgConnection arg)
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<PgPreparedQuery>> handler) Create a prepared query.
PgConnection	preparedBatch(String sql, List<Tuple> batch, io.vertx.core.Handler<io.vertx.core.AsyncResult<PgRowSet>> handler) Prepare and execute a createBatch.
PgConnection	preparedQuery(String sql, io.vertx.core.Handler<io.vertx.core.AsyncResult<PgRowSet>> handler) Prepare and execute a query.
PgConnection	preparedQuery(String sql, Tuple arguments, io.vertx.core.Handler<io.vertx.core.AsyncResult<PgRowSet>> handler) Prepare and execute a query.
int	processId()
PgConnection	query(String sql, io.vertx.core.Handler<io.vertx.core.AsyncResult<PgRowSet>> handler) Execute a simple query.
Single<PgPreparedQuery>	rxPrepare(String sql) Create a prepared query.
Single<PgRowSet>	rxPreparedBatch(String sql, List<Tuple> batch) Prepare and execute a createBatch.
Single<PgRowSet>	rxPreparedQuery(String sql) Prepare and execute a query.
Single<PgRowSet>	rxPreparedQuery(String sql, Tuple arguments) Prepare and execute a query.
Single<PgRowSet>	rxQuery(String sql) Execute a simple query.
int	secretKey()
String	toString()

Methods inherited from class io.reactiverse.reactivex.pgclient.PgClient

connect, connect, connect, newInstance, pool, pool, pool, pool, pool, pool, rxConnect, rxConnect, rxConnect

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final io.vertx.lang.rx.TypeArg<PgConnection> __TYPE_ARG

Constructor Detail

PgConnection

public PgConnection(PgConnection delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class PgClient

equals

public boolean equals(Object o)

Overrides:

equals in class PgClient

hashCode

public int hashCode()

Overrides:

hashCode in class PgClient

getDelegate

public PgConnection getDelegate()

Overrides:

getDelegate in class PgClient

prepare

public PgConnection prepare(String sql,
                            io.vertx.core.Handler<io.vertx.core.AsyncResult<PgPreparedQuery>> handler)

Create a prepared query.

Parameters:

sql - the sql

handler - the handler notified with the prepared query asynchronously

Returns:

rxPrepare

public Single<PgPreparedQuery> rxPrepare(String sql)

Create a prepared query.

Parameters:

sql - the sql

Returns:

exceptionHandler

public PgConnection exceptionHandler(io.vertx.core.Handler<Throwable> handler)

Set an handler called with connection errors.

Parameters:

handler - the handler

Returns:

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

closeHandler

public PgConnection closeHandler(io.vertx.core.Handler<Void> handler)

Set an handler called when the connection is closed.

Parameters:

handler - the handler

Returns:

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

begin

public PgTransaction begin()

Begin a transaction and returns a PgTransaction for controlling and tracking this transaction.

When the connection is explicitely closed, any inflight transaction is rollbacked.

Returns:

the transaction instance

notificationHandler

public PgConnection notificationHandler(io.vertx.core.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

processId

public int processId()

Returns:

The process ID of the target backend

secretKey

public int secretKey()

Returns:

The secret key for the target backend

cancelRequest

public 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.
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

isSSL

public boolean isSSL()

Returns:

whether the connection uses SSL

close

public void close()

Close the current connection after all the pending commands have been processed.

preparedQuery

public PgConnection preparedQuery(String sql,
                                  io.vertx.core.Handler<io.vertx.core.AsyncResult<PgRowSet>> handler)

Description copied from class: PgClient

Prepare and execute a query.

Overrides:

preparedQuery in class PgClient

Parameters:

sql - the prepared query SQL

handler - the handler notified with the execution result

Returns:

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

rxPreparedQuery

public Single<PgRowSet> rxPreparedQuery(String sql)

Description copied from class: PgClient

Prepare and execute a query.

Overrides:

rxPreparedQuery in class PgClient

Parameters:

sql - the prepared query SQL

Returns:

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

query

public PgConnection query(String sql,
                          io.vertx.core.Handler<io.vertx.core.AsyncResult<PgRowSet>> handler)

Description copied from class: PgClient

Execute a simple query.

Overrides:

query in class PgClient

Parameters:

sql - the query SQL

handler - the handler notified with the execution result

Returns:

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

rxQuery

public Single<PgRowSet> rxQuery(String sql)

Description copied from class: PgClient

Execute a simple query.

Overrides:

rxQuery in class PgClient

Parameters:

sql - the query SQL

Returns:

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

preparedQuery

public PgConnection preparedQuery(String sql,
                                  Tuple arguments,
                                  io.vertx.core.Handler<io.vertx.core.AsyncResult<PgRowSet>> handler)

Description copied from class: PgClient

Prepare and execute a query.

Overrides:

preparedQuery in class PgClient

Parameters:

sql - the prepared query SQL

arguments - the list of arguments

handler - the handler notified with the execution result

Returns:

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

rxPreparedQuery

public Single<PgRowSet> rxPreparedQuery(String sql,
                                        Tuple arguments)

Description copied from class: PgClient

Prepare and execute a query.

Overrides:

rxPreparedQuery in class PgClient

Parameters:

sql - the prepared query SQL

arguments - the list of arguments

Returns:

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

preparedBatch

public PgConnection preparedBatch(String sql,
                                  List<Tuple> batch,
                                  io.vertx.core.Handler<io.vertx.core.AsyncResult<PgRowSet>> handler)

Description copied from class: PgClient

Prepare and execute a createBatch.

Overrides:

preparedBatch in class PgClient

Parameters:

sql - the prepared query SQL

batch - the batch of tuples

handler - the handler notified with the execution result

Returns:

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

rxPreparedBatch

public Single<PgRowSet> rxPreparedBatch(String sql,
                                        List<Tuple> batch)

Description copied from class: PgClient

Prepare and execute a createBatch.

Overrides:

rxPreparedBatch in class PgClient

Parameters:

sql - the prepared query SQL

batch - the batch of tuples

Returns:

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

newInstance

public static PgConnection newInstance(PgConnection arg)