README.adoc

The Reactive PostgreSQL Client

Documentation:

• Website documentation

Features

• Event driven

• Lightweight

• Built-in connection pooling

• Prepared queries caching

• Publish / subscribe using Postgres LISTEN/NOTIFY

• Batch and cursor support

• Row streaming

• java.util.stream.Collector row set transformation

• Command pipeling

• RxJava API

• Direct memory to object without unnecessary copies

• Java 8 Date and Time

• SSL/TLS

• Unix domain socket

• HTTP/1.x CONNECT, SOCKS4a or SOCKS5 proxy

• Request cancellation

Supported Data Types

The Reactive Postgres Client currently supports the following data types

_	Value		Array
Postgres	Java	Supported	JAVA	Supported
BOOLEAN	j.l.Boolean	✔	j.l.Boolean[]	✔
INT2	j.l.Short	✔	j.l.Short[]	✔
INT4	j.l.Integer	✔	j.l.Integer[]	✔
INT8	j.l.Long	✔	j.l.Long[]	✔
FLOAT4	j.l.Float	✔	j.l.Float[]	✔
FLOAT8	j.l.Double	✔	j.l.Double[]	✔
CHAR	j.l.Character	✔	j.l.Character[]	✔
VARCHAR	j.l.String	✔	j.l.String[]	✔
TEXT	j.l.String	✔	j.l.String[]	✔
ENUM	j.l.String	✔	j.l.String[]	✔
NAME	j.l.String	✔	j.l.String[]	✔
SERIAL2	j.l.Short	✔	invalid type	✕
SERIAL4	j.l.Integer	✔	invalid type	✕
SERIAL8	j.l.Long	✔	invalid type	✕
NUMERIC	i.r.p.data.Numeric	✔	i.r.p.data.Numeric[]	✔
UUID	j.u.UUID	✔	j.u.UUID[]	✔
DATE	j.t.LocalDate	✔	j.t.LocalDate[]	✔
TIME	j.t.LocalTime	✔	j.t.LocalTime[]	✔
TIMETZ	j.t.OffsetTime	✔	j.t.OffsetTime[]	✔
TIMESTAMP	j.t.LocalDateTime	✔	j.t.LocalDateTime[]	✔
TIMESTAMPTZ	j.t.OffsetDateTime	✔	j.t.OffsetDateTime[]	✔
INTERVAL	i.r.p.data.Interval	✔	i.r.p.data.Interval[]	✔
BYTEA	i.v.c.b.Buffer	✔	i.v.c.b.Buffer[]	✔
JSON	Object	✔	Object[]	✔
JSONB	Object	✔	Object[]	✔
POINT	i.r.p.data.Point	✔	i.r.p.data.Point[]	✔
LINE	i.r.p.data.Line	✔	i.r.p.data.Line[]	✔
LSEG	i.r.p.data.LineSegment	✔	i.r.p.data.LineSegment[]	✔
BOX	i.r.p.data.Box	✔	i.r.p.data.Box[]	✔
INET	io.vertx.pgclient.data.Inet	✔	io.vertx.pgclient.data.Inet[]	✔
MONEY	io.vertx.pgclient.data.Money	✔	io.vertx.pgclient.data.Money[]	✔
CIDR	io.vertx.pgclient.data.Cidr	✔	PATH	i.r.p.data.Path
✔	i.r.p.data.Path[]	✔	POLYGON	i.r.p.data.Polygon
✔	i.r.p.data.Polygon[]	✔	CIRCLE	i.r.p.data.Circle
✔	i.r.p.data.Circle[]	✔	TSVECTOR	j.l.String
✔	j.l.String[]	✔	TSQUERY	j.l.String
✔	j.l.String[]	✔	UNKNOWN	j.l.String

Note: PostgreSQL JSON and JSONB types are represented by the following Java types:

• java.lang.String

• java.lang.Number

• java.lang.Boolean

• io.vertx.core.json.JsonObject

• io.vertx.core.json.JsonArray

• io.vertx.sqlclient.Tuple#JSON_NULL for representing the JSON null literal

The following types

MONEY, BIT, VARBIT, MACADDR, MACADDR8, XML, HSTORE, OID, VOID

are not implemented yet (PR are welcome).

Developers

Testing

Out of the box, the test suite runs an embedded Postgres by default.

You can change the version of the embedded Postgres by passing a property embedded.postgres.version like this:

> mvn test -Dembedded.postgres.version=9.6

The following versions of embedded Postgres are supported:

• 9.6

• 10.6 (default)

• 11.x (Unix Domain Socket Test are ignored)

The embedded Postgres database binds to an arbitrary port by default to avoid conflicts. Nevertheless, you can force the usage of the standard PostgreSQL port (5432) with a flag:

mvn test -DcontainerFixedPort

Testing with an external database

You can run tests with an external database:

• the script src/test/resources/create-postgres.sql creates the test data

• the TLSTest expects the database to be configured with SSL with src/test/resources/tls/server.key / src/test/resources/tls/server.cert src/test/resources/tls/pg_hba.conf as an example how to force SSL

You need to add some properties for testing:

> mvn test -Dconnection.uri=postgres://$username:$password@$host:$port/$database -Dtls.connection.uri=postgres://$username:$password@$host:$port/$database -Dunix.socket.directory=$path

• connection.uri(mandatory): configure the client to connect the specified database

• tls.connection.uri(mandatory): configure the client to run TLSTest with the specified Postgres with SSL enabled

• tls.force.connection.uri(mandatory): configure the client to run TLSTest with the specified Postgres with SSL forced (only option)

• unix.socket.directory(optional): the single unix socket directory(multiple socket directories are not supported) to test Unix domain socket with a specified database, domain socket tests will be skipped if this property is not specified (Note: Make sure you can access the unix domain socket with this directory under your host machine)

• unix.socket.port(optional): unix socket file is named .s.PGSQL.nnnn and nnnn is the server’s port number, this property is mostly used when you test with Docker, when you publish your Postgres container port other than 5432 in your host but Postgres may actually listen on a different port in the container, you will then need this property to help you connect the Postgres with Unix domain socket

Testing with Docker

Run the Postgres containers with docker compose:

> cd docker/postgres
> docker compose up --build -V

Run tests:

> mvn test -Dconnection.uri=postgres://$username:$password@$host:$port/$database -Dtls.connection.uri=postgres://$username:$password@$host:$port/$database -Dtls.force.connection.uri=postgres://$username:$password@$host:$port/$database -Dunix.socket.directory=$path -Dunix.socket.port=$port