io.reactiverse.reactivex.pgclient

Class PgClient

java.lang.Object

io.reactiverse.reactivex.pgclient.PgClient

Direct Known Subclasses:

PgConnection, PgPool, PgTransaction

public class PgClient
extends Object

Defines the client operations with a Postgres Database.

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<PgClient>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
PgClient(PgClient delegate)

Method Summary

Modifier and Type	Method and Description
static void	connect(io.vertx.reactivex.core.Vertx vertx, io.vertx.core.Handler<io.vertx.core.AsyncResult<PgConnection>> handler) Like connect(io.vertx.reactivex.core.Vertx, io.reactiverse.pgclient.PgConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.reactiverse.reactivex.pgclient.PgConnection>>) with options build from the environment variables.
static void	connect(io.vertx.reactivex.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 void	connect(io.vertx.reactivex.core.Vertx vertx, String connectionUri, io.vertx.core.Handler<io.vertx.core.AsyncResult<PgConnection>> handler) Like connect(io.vertx.reactivex.core.Vertx, io.reactiverse.pgclient.PgConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.reactiverse.reactivex.pgclient.PgConnection>>) with options build from connectionUri.
boolean	equals(Object o)
PgClient	getDelegate()
int	hashCode()
static PgClient	newInstance(PgClient arg)
static PgPool	pool() Like pool() with options build from the environment variables.
static PgPool	pool(PgPoolOptions options) Create a connection pool to the database configured with the given options.
static PgPool	pool(String connectionUri) Like pool() with options build from connectionUri.
static PgPool	pool(io.vertx.reactivex.core.Vertx vertx) Like pool() with options build from the environment variables.
static PgPool	pool(io.vertx.reactivex.core.Vertx vertx, PgPoolOptions options) Like pool() with a specific instance.
static PgPool	pool(io.vertx.reactivex.core.Vertx vertx, String connectionUri) Like pool() with options build from connectionUri.
PgClient	preparedBatch(String sql, List<Tuple> batch, io.vertx.core.Handler<io.vertx.core.AsyncResult<PgRowSet>> handler) Prepare and execute a createBatch.
PgClient	preparedQuery(String sql, io.vertx.core.Handler<io.vertx.core.AsyncResult<PgRowSet>> handler) Prepare and execute a query.
PgClient	preparedQuery(String sql, Tuple arguments, io.vertx.core.Handler<io.vertx.core.AsyncResult<PgRowSet>> handler) Prepare and execute a query.
PgClient	query(String sql, io.vertx.core.Handler<io.vertx.core.AsyncResult<PgRowSet>> handler) Execute a simple query.
static Single<PgConnection>	rxConnect(io.vertx.reactivex.core.Vertx vertx) Like connect(io.vertx.reactivex.core.Vertx, io.reactiverse.pgclient.PgConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.reactiverse.reactivex.pgclient.PgConnection>>) with options build from the environment variables.
static Single<PgConnection>	rxConnect(io.vertx.reactivex.core.Vertx vertx, PgConnectOptions options) Connects to the database and returns the connection if that succeeds.
static Single<PgConnection>	rxConnect(io.vertx.reactivex.core.Vertx vertx, String connectionUri) Like connect(io.vertx.reactivex.core.Vertx, io.reactiverse.pgclient.PgConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.reactiverse.reactivex.pgclient.PgConnection>>) with options build from connectionUri.
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.
String	toString()

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<PgClient> __TYPE_ARG

Constructor Detail

PgClient

public PgClient(PgClient delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public PgClient getDelegate()

pool

public static PgPool pool()

Like pool() with options build from the environment variables.

Returns:

pool

public static PgPool pool(String connectionUri)

Like pool() with options build from connectionUri.

Parameters:

connectionUri -

Returns:

pool

public static PgPool pool(io.vertx.reactivex.core.Vertx vertx)

Like pool() with options build from the environment variables.

Parameters:

vertx -

Returns:

pool

public static PgPool pool(io.vertx.reactivex.core.Vertx vertx,
                          String connectionUri)

Like pool() with options build from connectionUri.

Parameters:

vertx -

connectionUri -

Returns:

pool

public static PgPool pool(PgPoolOptions options)

Create a connection pool to the database configured with the given options.

Parameters:

options - the options for creating the pool

Returns:

the connection pool

pool

public static PgPool pool(io.vertx.reactivex.core.Vertx vertx,
                          PgPoolOptions options)

Like pool() with a specific instance.

Parameters:

vertx -

options -

Returns:

connect

public static void connect(io.vertx.reactivex.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.

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

rxConnect

public static Single<PgConnection> rxConnect(io.vertx.reactivex.core.Vertx vertx,
                                             PgConnectOptions options)

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

Returns:

connect

public static void connect(io.vertx.reactivex.core.Vertx vertx,
                           io.vertx.core.Handler<io.vertx.core.AsyncResult<PgConnection>> handler)

Like connect(io.vertx.reactivex.core.Vertx, io.reactiverse.pgclient.PgConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.reactiverse.reactivex.pgclient.PgConnection>>) with options build from the environment variables.

Parameters:

vertx -

handler -

rxConnect

public static Single<PgConnection> rxConnect(io.vertx.reactivex.core.Vertx vertx)

Like connect(io.vertx.reactivex.core.Vertx, io.reactiverse.pgclient.PgConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.reactiverse.reactivex.pgclient.PgConnection>>) with options build from the environment variables.

Parameters:

vertx -

Returns:

connect

public static void connect(io.vertx.reactivex.core.Vertx vertx,
                           String connectionUri,
                           io.vertx.core.Handler<io.vertx.core.AsyncResult<PgConnection>> handler)

Like connect(io.vertx.reactivex.core.Vertx, io.reactiverse.pgclient.PgConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.reactiverse.reactivex.pgclient.PgConnection>>) with options build from connectionUri.

Parameters:

vertx -

connectionUri -

handler -

rxConnect

public static Single<PgConnection> rxConnect(io.vertx.reactivex.core.Vertx vertx,
                                             String connectionUri)

Like connect(io.vertx.reactivex.core.Vertx, io.reactiverse.pgclient.PgConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.reactiverse.reactivex.pgclient.PgConnection>>) with options build from connectionUri.

Parameters:

vertx -

connectionUri -

Returns:

query

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

Execute a simple query.

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)

Execute a simple query.

Parameters:

sql - the query SQL

Returns:

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

preparedQuery

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

Prepare and execute a query.

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)

Prepare and execute a query.

Parameters:

sql - the prepared query SQL

Returns:

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

preparedQuery

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

Prepare and execute a query.

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)

Prepare and execute a query.

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 PgClient preparedBatch(String sql,
                              List<Tuple> batch,
                              io.vertx.core.Handler<io.vertx.core.AsyncResult<PgRowSet>> handler)

Prepare and execute a createBatch.

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)

Prepare and execute a createBatch.

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 PgClient newInstance(PgClient arg)