R2DBC Proxying Framework
This project contains the proxy framework of the R2DBC SPI. R2DBC is a Reactive Foundation project.
This project is governed by the R2DBC Code of Conduct. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to [email protected].
Artifacts can be found on Maven Central:
<dependency>
<groupId>io.r2dbc</groupId>
<artifactId>r2dbc-proxy</artifactId>
<version>${version}</version>
</dependency>
If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version.
<dependency>
<groupId>io.r2dbc</groupId>
<artifactId>r2dbc-proxy</artifactId>
<version>${version}.BUILD-SNAPSHOT</version>
</dependency>
<repository>
<id>sonatype-nexus-snapshots</id>
<name>Sonatype OSS Snapshot Repository</name>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</repository>
R2DBC Proxy | R2DBC SPI |
---|---|
1.0.x , 1.1.x |
1.0.x |
0.9.x |
0.9.x |
0.8.x |
0.8.x |
Here shows how to create a proxy ConnectionFactory
.
ConnectionFactory connectionFactory = ConnectionFactories.get("r2dbc:proxy:<driver>//<host>:<port>>/<database>[?proxyListener=<fqdn>]");
Sample URLs:
# with driver
r2dbc:proxy:postgresql://localhost:5432/myDB?proxyListener=com.example.MyListener
# with pooling
r2dbc:proxy:pool:postgresql://localhost:5432/myDB?proxyListener=com.example.MyListener&maxIdleTime=PT60S
ConnectionFactory connectionFactory = ConnectionFactories.get(ConnectionFactoryOptions.builder()
.option(DRIVER, "proxy")
.option(PROTOCOL, "postgresql")
.build());
Mono<Connection> connection = connectionFactory.create();
Supported Connection Factory Discovery options:
Option | Description |
---|---|
driver |
Must be proxy |
protocol |
Delegating connection factory driver |
proxyListener |
Comma separated list of fully qualified proxy listener class names (Optional) |
When programmatically ConnectionFactoryOptions
are constructed, proxyListener
option allows following values:
ProxyConnectionFactory
ConnectionFactory original = ...
ConnectionFactory connectionFactory = ProxyConnectionFactory.builder(original)
.onAfterQuery(queryInfo ->
... // after query callback logic
)
.onBeforeMethod(methodInfo ->
... // before method callback logic
)
.listener(...) // add listener
.build();
Publisher<? extends Connection> connectionPublisher = connectionFactory.create();
// Alternative: Creating a Mono using Project Reactor
Mono<Connection> connectionMono = Mono.from(connectionFactory.create());
r2dbc-proxy-samples repository contains sample listener implementations.
Having trouble with R2DBC? We'd love to help!
r2dbc
.
You can also chat with the community on Gitter.R2DBC uses GitHub as issue tracking system to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:
You don't need to build from source to use R2DBC Proxy (binaries in Maven Central), but if you want to try out the latest and greatest, R2DBC Proxy can be easily built with the maven wrapper. You also need JDK 1.8 and Docker to run integration tests.
$ ./mvnw clean install
If you want to build with the regular mvn
command, you will need Maven v3.5.0 or above.
Also see CONTRIBUTING.adoc if you wish to submit pull requests. Commits require Signed-off-by
(git commit -s
) to ensure Developer Certificate of Origin.
Building the documentation uses maven asciidoctor plugin.
$ ./mvnw clean exec:java@generate-micrometer-docs asciidoctor:process-asciidoc
To stage a release to Maven Central, you need to create a release tag (release version) that contains the desired state and version numbers (mvn versions:set versions:commit -q -o -DgenerateBackupPoms=false -DnewVersion=x.y.z.(RELEASE|Mnnn|RCnnn
) and force-push it to the release-0.x
branch. This push will trigger a Maven staging build (see build-and-deploy-to-maven-central.sh
).
This project is released under version 2.0 of the Apache License.