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.

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

Add notes on Quarkus Dev Services to JDBC & SQL extension docs #3127

Merged
merged 1 commit into from
Sep 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/modules/ROOT/pages/reference/extensions/jdbc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,9 @@ quarkus.datasource.camel.jdbc.url=jdbc:postgresql://localhost:5432/your-database
quarkus.datasource.camel.jdbc.max-size=16
----

If you choose to not name the datasource, you can resolve the default `DataSource` by defining your endpoint like `to("jdbc:default")`.

==== Zero configuration with Quarkus Dev Services

In dev and test mode you can take advantage of https://quarkus.io/guides/datasource#dev-services-configuration-free-databases[Configuration Free Databases]. All you need to do is reference the default database in your routes. E.g `to("jdbc:default")`.

6 changes: 5 additions & 1 deletion docs/modules/ROOT/pages/reference/extensions/sql.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ quarkus.datasource.jdbc.max-size=16
The Camel SQL component will automatically resolve the `DataSource` bean from the registry. When configuring multiple datasources, you can specify which one is to be used on an SQL endpoint via
the URI options `datasource` or `dataSourceRef`. Refer to the SQL component documentation for more details.

==== Zero configuration with Quarkus Dev Services

In dev and test mode you can take advantage of https://quarkus.io/guides/datasource#dev-services-configuration-free-databases[Configuration Free Databases]. The Camel SQL component will be automatically configured to use a `DataSource` that points to a local containerized instance of the database matching the JDBC driver type that you have selected.

=== SQL scripts

When configuring `sql` or `sql-stored` endpoints to reference script files from the classpath, set the following configuration property to ensure that they are available in native mode.
Expand All @@ -67,7 +71,7 @@ When configuring `sql` or `sql-stored` endpoints to reference script files from
quarkus.native.resources.includes = queries.sql, sql/*.sql
----

=== SQL Aggregator ===
=== SQL Aggregator

If your exchanges in native mode contain objects, which are not automatically registered for serialization (see xref:extensions/core.adoc#quarkus.camel.native.reflection.serialization-enabled[documentation]),
you have to register them manually (see xref:extensions/core.adoc#quarkus.camel.native.reflection.serialization-enabled[documentation])
Expand Down
6 changes: 6 additions & 0 deletions extensions/jdbc/runtime/src/main/doc/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,9 @@ quarkus.datasource.camel.password=your-password
quarkus.datasource.camel.jdbc.url=jdbc:postgresql://localhost:5432/your-database
quarkus.datasource.camel.jdbc.max-size=16
----

If you choose to not name the datasource, you can resolve the default `DataSource` by defining your endpoint like `to("jdbc:default")`.

==== Zero configuration with Quarkus Dev Services

In dev and test mode you can take advantage of https://quarkus.io/guides/datasource#dev-services-configuration-free-databases[Configuration Free Databases]. All you need to do is reference the default database in your routes. E.g `to("jdbc:default")`.
6 changes: 5 additions & 1 deletion extensions/sql/runtime/src/main/doc/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ quarkus.datasource.jdbc.max-size=16
The Camel SQL component will automatically resolve the `DataSource` bean from the registry. When configuring multiple datasources, you can specify which one is to be used on an SQL endpoint via
the URI options `datasource` or `dataSourceRef`. Refer to the SQL component documentation for more details.

==== Zero configuration with Quarkus Dev Services

In dev and test mode you can take advantage of https://quarkus.io/guides/datasource#dev-services-configuration-free-databases[Configuration Free Databases]. The Camel SQL component will be automatically configured to use a `DataSource` that points to a local containerized instance of the database matching the JDBC driver type that you have selected.

=== SQL scripts

When configuring `sql` or `sql-stored` endpoints to reference script files from the classpath, set the following configuration property to ensure that they are available in native mode.
Expand All @@ -23,7 +27,7 @@ When configuring `sql` or `sql-stored` endpoints to reference script files from
quarkus.native.resources.includes = queries.sql, sql/*.sql
----

=== SQL Aggregator ===
=== SQL Aggregator

If your exchanges in native mode contain objects, which are not automatically registered for serialization (see xref:extensions/core.adoc#quarkus.camel.native.reflection.serialization-enabled[documentation]),
you have to register them manually (see xref:extensions/core.adoc#quarkus.camel.native.reflection.serialization-enabled[documentation])
Expand Down