Reactive Relational Database Connectivity Service Provider Interface (R2DBC SPI)

The Reactive Relational Database Connectivity (R2DBC) project brings reactive programming APIs to relational databases. R2DBC is a Reactive Foundation project.

In a Nutshell

Based on the Reactive Streams specification. R2DBC is founded on the Reactive Streams specification, which provides a fully-reactive non-blocking API.

Works with relational databases. In contrast to the blocking nature of JDBC, R2DBC allows you to work with SQL databases using a reactive API.

Supports scalable solutions. With Reactive Streams, R2DBC enables you to move from the classic “one thread per connection” model to a more powerful and scalable approach.

Provides an open specification. R2DBC is an open specification and establishes a Service Provider Interface (SPI) for driver vendors to implement and clients to consume.

Code of Conduct

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

Maven configuration

Artifacts can be found on Maven Central.

<dependency>
  <groupId>io.r2dbc</groupId>
  <artifactId>r2dbc-spi</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-spi</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>

Getting Help

Having trouble with R2DBC? We'd love to help!

• The R2DBC website https://r2dbc.io/ gives you an overview over the entire R2DBC eco-system.
• Check the spec documentation, and Javadoc.
• If you are upgrading, check out the changelog for "new and noteworthy" features.
• Ask a question - we monitor stackoverflow.com for questions tagged with r2dbc. You can also chat with the community on Gitter.
• Report bugs with R2DBC SPI at github.com/r2dbc/r2dbc-spi/issues.

Reporting Issues

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:

• Before you log a bug, please search the issue tracker to see if someone has already reported the problem.
• If the issue doesn't already exist, create a new issue.
• Please provide as much information as possible with the issue report, we like to know the version of R2DBC SPI that you are using and JVM version.
• If you need to paste code, or include a stack trace use Markdown ``` escapes before and after your text.
• If possible try to create a test-case or project that replicates the issue. Attach a link to your code or a compressed file containing your code.

Building from Source

You don't need to build from source to use R2DBC SPI (binaries in Maven Central), but if you want to try out the latest and greatest, R2DBC SPI 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.

Staging to Maven Central

To stage a release to Maven Central, you need to create a release tag (release version) that contains the desired state and version numbers.

To do that, run:

$ ci/create-release.sh <github issue> <new-release-version> <next-snapshot-version>

For example, to release 0.9.0.RELEASE against github issue #200, and then continue onto 0.9.1.BUILD-SNAPSHOT, you'd run this:

$ ci/create-release.sh 200 0.9.0.RELEASE 0.9.1.BUILD-SNAPSHOT

This script will bump all the POM files to 0.9.0.RELEASE, apply a tag (v0.9.0.RELEASE), and then bump the version again to 0.9.1.BUILD-SNAPHOT.

From here, you can switch over to the release branch and use that tag.

$ git checkout release-0.x
$ git reset --hard v0.9.0.RELEASE
$ <do any local testing you want>
$ git push --force

This will trigger GitHub to start a Maven staging build (see build-and-deploy-to-maven-central.sh).

NOTE: Everything is staged. Nothing is released. You still have the ability to verify and rollback if something is wrong.

Once you have verified everything on Maven Central, closed, and released, switch back and push the main branch.

$ git checkout main
$ git push
$ git push --tags

License

This project is released under version 2.0 of the Apache License.