This is an automated email from the ASF dual-hosted git repository. jamesnetherton pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
commit 426e19ea19a11abfe56d024bd38e203e718ed306 Author: James Netherton <[email protected]> AuthorDate: Wed Jun 23 08:52:10 2021 +0100 Deprecate quarkus.camel.sql.script-files configuration property --- docs/modules/ROOT/pages/migration-guide/2.0.0.adoc | 6 ++++++ docs/modules/ROOT/pages/reference/extensions/sql.adoc | 18 +----------------- .../quarkus/component/sql/deployment/SqlProcessor.java | 4 ++++ extensions/sql/runtime/src/main/doc/configuration.adoc | 2 +- .../camel/quarkus/component/sql/CamelSqlConfig.java | 4 ++++ .../sql/src/main/resources/application.properties | 2 +- 6 files changed, 17 insertions(+), 19 deletions(-) diff --git a/docs/modules/ROOT/pages/migration-guide/2.0.0.adoc b/docs/modules/ROOT/pages/migration-guide/2.0.0.adoc index 0eb5734..c7b333f 100644 --- a/docs/modules/ROOT/pages/migration-guide/2.0.0.adoc +++ b/docs/modules/ROOT/pages/migration-guide/2.0.0.adoc @@ -34,3 +34,9 @@ Since that version `camel-quarkus-xml-io` was deprecated and was kept only for b The `quarkus.camel.native.resources.include-patterns` and `quarkus.camel.native.resources.exclude-patterns` configuration properties were removed in Camel Quarkus 2.0.0. Please use `quarkus.native.resources.includes` and `quarkus.native.resources.excludes` instead respectively. + +== SQL extension `quarkus.camel.sql.script-files` configuration property is deprecated + +The `quarkus.camel.sql.script-files` configuration property provided by the SQL extension is deprecated and will be removed in Camel Quarkus 2.1.0. + +If you need to have SQL script files accessible via the classpath for `sql` or `sql-stored` endpoints, please use configuration property `quarkus.native.resources.includes`. diff --git a/docs/modules/ROOT/pages/reference/extensions/sql.adoc b/docs/modules/ROOT/pages/reference/extensions/sql.adoc index 534c204..e7e5397 100644 --- a/docs/modules/ROOT/pages/reference/extensions/sql.adoc +++ b/docs/modules/ROOT/pages/reference/extensions/sql.adoc @@ -99,22 +99,6 @@ Note that URI schemes such as `file` or `http` do not need to be listed. [source,properties] ---- -quarkus.camel.sql.script-files = queries.sql, classpath:sql/insert.sql +quarkus.native.resources.includes = queries.sql, sql/*.sql ---- - -[width="100%",cols="80,5,15",options="header"] -|=== -| Configuration property | Type | Default - - -|icon:lock[title=Fixed at build time] [[quarkus.camel.sql.script-files]]`link:#quarkus.camel.sql.script-files[quarkus.camel.sql.script-files]` - -A comma separated list of paths to script files referenced by SQL endpoints. Script files that only need to be accessible from the classpath should be specified on this property. Paths can either be schemeless (E.g sql/my-script.sql) or be prefixed with the classpath: URI scheme (E.g classpath:sql/my-script.sql). Other URI schemes are not supported. -| `string` -| -|=== - -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time. All other configuration properties are overridable at runtime. - diff --git a/extensions/sql/deployment/src/main/java/org/apache/camel/quarkus/component/sql/deployment/SqlProcessor.java b/extensions/sql/deployment/src/main/java/org/apache/camel/quarkus/component/sql/deployment/SqlProcessor.java index fbdcec7..4dfbd97 100644 --- a/extensions/sql/deployment/src/main/java/org/apache/camel/quarkus/component/sql/deployment/SqlProcessor.java +++ b/extensions/sql/deployment/src/main/java/org/apache/camel/quarkus/component/sql/deployment/SqlProcessor.java @@ -25,9 +25,11 @@ import io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBuildItem; import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem; import org.apache.camel.quarkus.component.sql.CamelSqlConfig; import org.apache.camel.support.DefaultExchangeHolder; +import org.jboss.logging.Logger; class SqlProcessor { + private static final Logger LOG = Logger.getLogger(SqlProcessor.class); private static final String FEATURE = "camel-sql"; @BuildStep @@ -46,6 +48,8 @@ class SqlProcessor { return; } + LOG.warn( + "Configuration property quarkus.camel.sql.script-files is deprecated. Please use quarkus.native.resources.includes"); config.scriptFiles.get() .stream() .map(scriptFile -> new NativeImageResourceBuildItem(scriptFile.replace("classpath:", ""))) diff --git a/extensions/sql/runtime/src/main/doc/configuration.adoc b/extensions/sql/runtime/src/main/doc/configuration.adoc index 6b4075b..6a55bf0 100644 --- a/extensions/sql/runtime/src/main/doc/configuration.adoc +++ b/extensions/sql/runtime/src/main/doc/configuration.adoc @@ -20,5 +20,5 @@ Note that URI schemes such as `file` or `http` do not need to be listed. [source,properties] ---- -quarkus.camel.sql.script-files = queries.sql, classpath:sql/insert.sql +quarkus.native.resources.includes = queries.sql, sql/*.sql ---- diff --git a/extensions/sql/runtime/src/main/java/org/apache/camel/quarkus/component/sql/CamelSqlConfig.java b/extensions/sql/runtime/src/main/java/org/apache/camel/quarkus/component/sql/CamelSqlConfig.java index bb83a24..4b0f7b2 100644 --- a/extensions/sql/runtime/src/main/java/org/apache/camel/quarkus/component/sql/CamelSqlConfig.java +++ b/extensions/sql/runtime/src/main/java/org/apache/camel/quarkus/component/sql/CamelSqlConfig.java @@ -33,7 +33,11 @@ public class CamelSqlConfig { * * Paths can either be schemeless (E.g sql/my-script.sql) or be prefixed with the classpath: URI scheme (E.g * classpath:sql/my-script.sql). Other URI schemes are not supported. + * + * @deprecated use configuration property `quarkus.native.resources.includes` to include your SQL scripts in the native + * image. */ @ConfigItem + @Deprecated public Optional<List<String>> scriptFiles; } diff --git a/integration-tests/sql/src/main/resources/application.properties b/integration-tests/sql/src/main/resources/application.properties index 0b6ec0d..d0da756 100644 --- a/integration-tests/sql/src/main/resources/application.properties +++ b/integration-tests/sql/src/main/resources/application.properties @@ -17,7 +17,7 @@ # Camel Quarkus SQL # -quarkus.camel.sql.script-files=sql/get-camels.sql,sql/initDb.sql,sql/selectProjects.sql +quarkus.native.resources.includes=sql/*.sql #Serialization-config.json is a workaround until serilazation support makes it into Quarkus (see https://github.com/quarkusio/quarkus/pull/15380) quarkus.native.additional-build-args=-H:SerializationConfigurationResources=serialization-config.json
