= Reactive Oracle Client
:PREPARED_PARAMS: `?`

The Reactive Oracle Client is a client for Oracle with a straightforward API focusing on
scalability and low overhead.

*Features*

* Event driven
* Built-in connection pooling
* Java 8 Date and Time
* SSL/TLS
* RxJava API
* Cursor
* Row streaming

*Not supported yet*

* Prepared queries caching
* Stored Procedures

WARNING: this module is in tech preview

== Usage

To use the Reactive Oracle Client add the following dependency to the _dependencies_ section of your build descriptor:

* Maven (in your `pom.xml`):

[source,xml]
----
<dependency>
  <groupId>${maven.groupId}</groupId>
  <artifactId>${maven.artifactId}</artifactId>
  <version>${maven.version}</version>
</dependency>
----
* Gradle (in your `build.gradle` file):

[source,groovy]
----
dependencies {
  compile '${maven.groupId}:${maven.artifactId}:${maven.version}'
}
----

== Getting started

Here is the simplest way to connect, query and disconnect

[source,$lang]
----
{@link examples.OracleClientExamples#gettingStarted()}
----

== Connecting to Oracle

Most of the time you will use a pool to connect to Oracle:

[source,$lang]
----
{@link examples.OracleClientExamples#connecting01}
----

The pooled client uses a connection pool and any operation will borrow a connection from the pool
to execute the operation and release it to the pool.

If you are running with Vert.x you can pass it your Vertx instance:

[source,$lang]
----
{@link examples.OracleClientExamples#connecting02}
----

You need to release the pool when you don't need it anymore:

[source,$lang]
----
{@link examples.OracleClientExamples#connecting03}
----

When you need to execute several operations on the same connection, you need to use a client
{@link io.vertx.sqlclient.SqlConnection connection}.

You can easily get one from the pool:

[source,$lang]
----
{@link examples.OracleClientExamples#connecting04}
----

Once you are done with the connection you must close it to release it to the pool, so it can be reused.

== Pool sharing

include::pool_sharing.adoc[]

== Configuration

There are several alternatives for you to configure the client.

=== Data Object

A simple way to configure the client is to specify a {@link io.vertx.oracleclient.OracleConnectOptions} data object.

[source,$lang]
----
{@link examples.OracleClientExamples#configureFromDataObject(io.vertx.core.Vertx)}
----

=== Connection URI

Apart from configuring with a {@link io.vertx.oracleclient.OracleConnectOptions} data object, we also provide you with an alternative way to connect when you want to configure with a connection URI.

Using the EZConnect format:

[source,$lang]
----
{@link examples.OracleClientExamples#configureFromUri(io.vertx.core.Vertx)}
----

Or, using the TNS Alias format:

[source,$lang]
----
{@link examples.OracleClientExamples#configureFromTnsAliasUri(io.vertx.core.Vertx)}
----

== Connect retries

You can configure the client to retry when a connection fails to be established.

[source,$lang]
----
{@link examples.OracleClientExamples#reconnectAttempts}
----

include::queries.adoc[leveloffset=1]

== Retrieving generated key values

When executing `INSERT` queries, you can retrieve the generated key values.

The values are returned as a {@link io.vertx.sqlclient.Row} instance.
This instance is accessible by invoking {@link io.vertx.sqlclient.SqlResult#property SqlResult.property(kind)} using the {@link io.vertx.oracleclient.OracleClient#GENERATED_KEYS} property kind.

The key values can be retrieved by column name:

[source,$lang]
----
{@link examples.OracleClientExamples#retrieveGeneratedKeyByName}
----

Or, they can be retrieved by column index:

[source,$lang]
----
{@link examples.OracleClientExamples#retrieveGeneratedKeyByIndex}
----

include::connections.adoc[]

include::transactions.adoc[]

include::cursor.adoc[]

== Data types supported

Currently, the client supports the following Oracle data types:

* CHAR/VARCHAR2(`java.lang.String`)
* NCHAR/NVARCHAR2(`java.lang.String`)
* NUMBER(`{@link java.math.BigDecimal}`)
* FLOAT(`java.lang.Double`)
* DATE(`java.time.LocalDate`)
* TIMESTAMP(`java.time.LocalDateTime`)
* RAW(`io.vertx.core.buffer.Buffer`)

Tuple decoding uses the above types when storing values.

`BLOB` data type is also supported with one caveat: it must be represented by an instance of {@link io.vertx.oracleclient.data.Blob} when writing or filtering.
However, when reading `BLOB` data, the client returns a {@link io.vertx.core.buffer.Buffer}.

[source,$lang]
----
{@link examples.OracleClientExamples#blobUsage}
----

== Tracing queries

include::tracing.adoc[]

== Collector queries

You can use Java collectors with the query API:

[source,$lang]
----
{@link examples.OracleClientExamples#collector01Example(io.vertx.sqlclient.SqlClient)}
----

The collector processing must not keep a reference on the {@link io.vertx.sqlclient.Row} as there is a single row used for processing the entire set.

The Java `Collectors` provides many interesting predefined collectors, for example you can create easily create a string directly from the row set:

[source,$lang]
----
{@link examples.OracleClientExamples#collector02Example(io.vertx.sqlclient.SqlClient)}
----

== Using SSL/TLS

To enable encryption in client options, use the {@link io.vertx.oracleclient.OracleConnectOptions#setSsl} method.
By default, `ssl` is set to `false`.

[source,$lang]
----
{@link examples.OracleClientExamples#setSsl}
----

Encryption can be customized using properties.
For example, to set a trust store:

[source,$lang]
----
{@link examples.OracleClientExamples#setTrustStore}
----
