Skip to content

Commit 43c473c

Browse files
committed
#375 - Improve documentation for supported databases.
Add explicit note about dialects.
1 parent e71c2b9 commit 43c473c

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

src/main/asciidoc/reference/r2dbc-core.adoc

+8-6
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ There is a https://github.com/spring-projects/spring-data-examples[GitHub reposi
215215
[[r2dbc.connecting]]
216216
== Connecting to a Relational Database with Spring
217217

218-
One of the first tasks when using relational databases and Spring is to create a `io.r2dbc.spi.ConnectionFactory` object by using the IoC container.
218+
One of the first tasks when using relational databases and Spring is to create a `io.r2dbc.spi.ConnectionFactory` object by using the IoC container. Make sure to use a <<r2dbc.drivers,supported database and driver>>.
219219

220220
[[r2dbc.connectionfactory]]
221221
=== Registering a `ConnectionFactory` Instance using Java-based Metadata
@@ -245,18 +245,20 @@ This approach lets you use the standard `io.r2dbc.spi.ConnectionFactory` instanc
245245
[[r2dbc.drivers]]
246246
=== R2DBC Drivers
247247

248-
Spring Data R2DBC supports drivers through R2DBC's pluggable SPI mechanism. You can use any driver that implements the R2DBC spec with Spring Data R2DBC.
249-
R2DBC is a relatively young initiative that gains significance by maturing through adoption.
250-
As of this writing, the following drivers are available:
248+
Spring Data R2DBC supports drivers through R2DBC's pluggable SPI mechanism.
249+
You can use any driver that implements the R2DBC spec with Spring Data R2DBC.
250+
Since Spring Data R2DBC reacts to specific features of each database, it requires a `Dialect` implementation otherwise your application won't start up.
251+
Spring Data R2DBC ships with dialect impelemtations for the following drivers:
251252

252-
* https://github.com/r2dbc/r2dbc-postgresql[Postgres] (`io.r2dbc:r2dbc-postgresql`)
253253
* https://github.com/r2dbc/r2dbc-h2[H2] (`io.r2dbc:r2dbc-h2`)
254+
* https://github.com/mariadb-corporation/mariadb-connector-r2dbc[MariaDB] (`org.mariadb:r2dbc-mariadb`)
254255
* https://github.com/r2dbc/r2dbc-mssql[Microsoft SQL Server] (`io.r2dbc:r2dbc-mssql`)
255256
* https://github.com/mirromutth/r2dbc-mysql[MySQL] (`dev.miku:r2dbc-mysql`)
256257
* https://github.com/jasync-sql/jasync-sql[jasync-sql MySQL] (`com.github.jasync-sql:jasync-r2dbc-mysql`)
258+
* https://github.com/r2dbc/r2dbc-postgresql[Postgres] (`io.r2dbc:r2dbc-postgresql`)
257259

258260
Spring Data R2DBC reacts to database specifics by inspecting the `ConnectionFactory` and selects the appropriate database dialect accordingly.
259-
You can configure your own {spring-data-r2dbc-javadoc}/api/org/springframework/data/r2dbc/dialect/R2dbcDialect.html[`R2dbcDialect`] if the driver you use is not yet known to Spring Data R2DBC.
261+
You need to configure your own {spring-data-r2dbc-javadoc}/api/org/springframework/data/r2dbc/dialect/R2dbcDialect.html[`R2dbcDialect`] if the driver you use is not yet known to Spring Data R2DBC.
260262

261263
TIP: Dialects are resolved by {spring-data-r2dbc-javadoc}/org/springframework/data/r2dbc/dialect/DialectResolver.html[`DialectResolver`] from a `ConnectionFactory`, typically by inspecting `ConnectionFactoryMetadata`.
262264
+

0 commit comments

Comments
 (0)