Skip to content
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.

Sign up for GitHub

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

Tiny tweaks based on QE feedback for Datasource guide #37069

Merged
merged 1 commit into from
Nov 14, 2023
Merged

Tiny tweaks based on QE feedback for Datasource guide #37069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/src/main/asciidoc/datasource.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -561,12 +561,13 @@

Example:: `jdbc:h2:tcp://localhost/~/test`, `jdbc:h2:mem:myDB`

H2 is an embedded database that can run as a server, based on a file, or run completely in memory.
H2 is a database that can run in embedded or server mode.
It can use a file storage or run entirely in memory.
All of these options are available as listed above.

Check warning on line 566 in docs/src/main/asciidoc/datasource.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/datasource.adoc", "range": {"start": {"line": 566, "column": 31}}}, "severity": "INFO"}

For more information, see the link:https://h2database.com/html/features.html?highlight=url&search=url#database_url[official documentation].
For more information, see the link:https://h2database.com/html/features.html#database_url[official documentation].

==== MariaDB

Check warning on line 570 in docs/src/main/asciidoc/datasource.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Headings] Use sentence-style capitalization in 'MariaDB'.

Raw Output:
{"message": "[Quarkus.Headings] Use sentence-style capitalization in 'MariaDB'.", "location": {"path": "docs/src/main/asciidoc/datasource.adoc", "range": {"start": {"line": 570, "column": 1}}}, "severity": "INFO"}

`jdbc:mariadb:[replication:|failover:|sequential:|aurora:]//<hostDescription>[,<hostDescription>...]/[database][?<key1>=<value1>[&<key2>=<value2>]]`
hostDescription:: `<host>[:<portnumber>] or address=(host=<host>)[(port=<portnumber>)][(type=(master|slave))]`
Expand All @@ -592,7 +593,7 @@

Example:: `jdbc:mysql://localhost:3306/test`

For more information, see the link:https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-reference.html[official documentation].
For more information, see the link:https://dev.mysql.com/doc/connector-j/en/[official documentation].

===== MySQL limitations

Expand Down
7 changes: 5 additions & 2 deletions ...s/agroal/runtime/src/main/java/io/quarkus/agroal/runtime/DataSourceJdbcRuntimeConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ public interface DataSourceJdbcRuntimeConfig {
/**
* The interval at which we check for connection leaks.
*/

@ConfigDocDefault("This feature is disabled by default.")
Optional<Duration> leakDetectionInterval();

/**
Expand All @@ -72,6 +74,7 @@ public interface DataSourceJdbcRuntimeConfig {
/**
* The max lifetime of a connection.
*/
@ConfigDocDefault("By default, there is no restriction on the lifespan of a connection.")
Optional<Duration> maxLifetime();

/**
Expand All @@ -92,7 +95,7 @@ public interface DataSourceJdbcRuntimeConfig {
boolean flushOnClose();

/**
* When enabled Agroal will be able to produce a warning when a connection is returned
* When enabled, Agroal will be able to produce a warning when a connection is returned
* to the pool without the application having closed all open statements.
* This is unrelated with tracking of open connections.
* Disable for peak performance, but only when there's high confidence that
Expand All @@ -112,7 +115,7 @@ public interface DataSourceJdbcRuntimeConfig {
Optional<String> validationQuerySql();

/**
* Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle
* Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle
* of Connections.
*/
@WithDefault("true")
Expand Down
4 changes: 2 additions & 2 deletions ...src/main/java/io/quarkus/reactive/datasource/runtime/DataSourceReactiveRuntimeConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ public interface DataSourceReactiveRuntimeConfig {
* The datasource URLs.
* <p>
* If multiple values are set, this datasource will create a pool with a list of servers instead of a single server.
* The pool uses a round-robin load balancing when a connection is created to select different servers.
* Note: some driver may not support multiple values here.
* The pool uses round-robin load balancing for server selection during connection establishment.
* Note that certain drivers might not accommodate multiple values in this context.
*/
Optional<List<String>> url();

Expand Down
Loading