Skip to content

docs: EXPOSED-534 Add documentation for R2DBC support #2503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Jul 2, 2025

Conversation

vnikolova
Copy link
Collaborator

@vnikolova vnikolova commented Jun 4, 2025

Description

Document R2DBC support introduced in 1.0.0-beta-1.

Detailed description:

  • list the exposed-r2dbc module in Modules

  • introduce labels for JDBC-only or R2DBC-only topics

  • mention driver support in the About page

  • Working with Databases:

    • document how to connect to a db using r2dbc
    • add a section "choosing between JDBC and R2DBC"
  • update Working with Transaction:

    • document suspend transaction
    • use tabs for JDBC/R2DBC examples
    • remove "Working with Coroutines" section
  • Data types:

    • specify JDBC/R2DBC support for different data types
    • update Custom data types examples for ranges of data and case insensitive data.

New topics:

  • Working with ConnectionFactory
  • Custom type mapping

This PR also fixes broken API links across all topics. (EXPOSED-795)


Type of Change

  • Documentation update

Checklist

  • Unit tests are in place
  • The build is green (including the Detekt check)
  • All public methods affected by my PR has up to date API docs
  • Documentation for my change is up to date

Related Issues

EXPOSED-534

@vnikolova vnikolova force-pushed the vnikolova/docs-r2dbc branch from 02863a2 to ad03647 Compare June 4, 2025 15:51
vnikolova and others added 5 commits June 4, 2025 21:00
- Fix issues with H2 r2dbc version & Sql Server dependency
- Fix issue with option for H2 database (DRIVER must always be "h2"); removed
- Update section on connection factory to have all potential connection options
@vnikolova vnikolova force-pushed the vnikolova/docs-r2dbc branch from 5801c7e to 98f0c68 Compare June 25, 2025 09:53
@vnikolova vnikolova marked this pull request as ready for review June 26, 2025 12:54
Copy link
Member

@bog-walk bog-walk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for putting all these updates together 🎉

@vnikolova vnikolova merged commit f7feaa5 into main Jul 2, 2025
5 of 6 checks passed
@vnikolova vnikolova deleted the vnikolova/docs-r2dbc branch July 2, 2025 06:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants