From fdab38744bb2f958517c2272b6e72ca9c1758ada Mon Sep 17 00:00:00 2001 From: Thomas Segismont Date: Mon, 4 Jul 2022 17:24:30 +0200 Subject: [PATCH] Document Reactive DS URL --- docs/src/main/asciidoc/datasource.adoc | 90 ++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) diff --git a/docs/src/main/asciidoc/datasource.adoc b/docs/src/main/asciidoc/datasource.adoc index 74d8eaadb9ad1..711db50cfd6e4 100644 --- a/docs/src/main/asciidoc/datasource.adoc +++ b/docs/src/main/asciidoc/datasource.adoc @@ -649,3 +649,93 @@ include::{generated-dir}/config/quarkus-reactive-oracle-client.adoc[opts=optiona === Reactive PostgreSQL Specific Configuration include::{generated-dir}/config/quarkus-reactive-pg-client.adoc[opts=optional, leveloffset=+1] + + +[[reactive-url]] +== Reactive Datasource URL Reference + +=== DB2 + +`db2://[user[:[password]]@]host[:port][/database][?=[&=]]` + +Example:: `db2://dbuser:secretpassword@database.server.com:50000/mydb` + +Currently, the client supports the following parameter keys: + +* `host` +* `port` +* `user` +* `password` +* `database` + +NOTE: Configuring parameters in connection URL will override the default properties. + +=== Microsoft SQL Server + +`sqlserver://[user[:[password]]@]host[:port][/database][?=[&=]]` + +Example:: `sqlserver://dbuser:secretpassword@database.server.com:1433/mydb` + +Currently, the client supports the following parameter keys: + +* `host` +* `port` +* `user` +* `password` +* `database` + +NOTE: Configuring parameters in connection URL will override the default properties. + +=== MySQL / MariaDB + +`mysql://[user[:[password]]@]host[:port][/database][?=[&=]]` + +Example:: `mysql://dbuser:secretpassword@database.server.com:3211/mydb` + +Currently, the client supports the following parameter keys (case-insensitive): + +* `host` +* `port` +* `user` +* `password` +* `schema` +* `socket` +* `useAffectedRows` + +NOTE: Configuring parameters in connection URL will override the default properties. + +=== Oracle + +==== EZConnect Format + +`oracle:thin:@[[protocol:]//]host[:port][/service_name][:server_mode][/instance_name][?connection properties]` + +Example:: `oracle:thin:@mydbhost1:5521/mydbservice?connect_timeout=10sec` + +==== TNS Alias Format + +`oracle:thin:@[?connection properties]` + +Example:: `oracle:thin:@prod_db?TNS_ADMIN=/work/tns/` + +=== PostgreSQL + +`postgresql://[user[:[password]]@]host[:port][/database][?=[&=]]` + +Example:: `postgresql://dbuser:secretpassword@database.server.com:5432/mydb` + +Currently, the client supports the following parameter keys: + +* `host` +* `port` +* `user` +* `password` +* `dbname` +* `sslmode` +* additional properties, including: +** `application_name` +** `fallback_application_name` +** `search_path` +** `options` + +NOTE: Configuring parameters in connection URL will override the default properties.