This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push: new 3378a57 Regen 3378a57 is described below commit 3378a57244252f51fef965637a1ff60400c4d91f Author: Claus Ibsen <claus.ib...@gmail.com> AuthorDate: Fri Mar 13 09:36:44 2020 +0100 Regen --- .../resources/org/apache/camel/component/elsql/elsql.json | 2 +- components/camel-elsql/src/main/docs/elsql-component.adoc | 2 +- .../builder/endpoint/dsl/ElsqlEndpointBuilderFactory.java | 6 ++++-- docs/components/modules/ROOT/pages/elsql-component.adoc | 2 +- docs/components/modules/ROOT/pages/pulsar-component.adoc | 10 ++++++---- docs/components/modules/ROOT/pages/sql-component.adoc | 11 +++++++---- 6 files changed, 20 insertions(+), 13 deletions(-) diff --git a/components/camel-elsql/src/generated/resources/org/apache/camel/component/elsql/elsql.json b/components/camel-elsql/src/generated/resources/org/apache/camel/component/elsql/elsql.json index 1ba3da7..9ad5397 100644 --- a/components/camel-elsql/src/generated/resources/org/apache/camel/component/elsql/elsql.json +++ b/components/camel-elsql/src/generated/resources/org/apache/camel/component/elsql/elsql.json @@ -56,7 +56,7 @@ "batch": { "kind": "parameter", "displayName": "Batch", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Enables or disables batch mode" }, "lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the [...] "noop": { "kind": "parameter", "displayName": "Noop", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "If set, will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing" }, - "useMessageBodyForSql": { "kind": "parameter", "displayName": "Use Message Body For Sql", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used." }, + "useMessageBodyForSql": { "kind": "parameter", "displayName": "Use Message Body For Sql", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. Note that query parameters in the message body are represented by a question ma [...] "alwaysPopulateStatement": { "kind": "parameter", "displayName": "Always Populate Statement", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked, also if there is no expected parameters to be prepared. When this is false then the po [...] "basicPropertyBinding": { "kind": "parameter", "displayName": "Basic Property Binding", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities" }, "elSqlConfig": { "kind": "parameter", "displayName": "El Sql Config", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "com.opengamma.elsql.ElSqlConfig", "deprecated": false, "secret": false, "description": "To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead." }, diff --git a/components/camel-elsql/src/main/docs/elsql-component.adoc b/components/camel-elsql/src/main/docs/elsql-component.adoc index 550057d..7c123f1 100644 --- a/components/camel-elsql/src/main/docs/elsql-component.adoc +++ b/components/camel-elsql/src/main/docs/elsql-component.adoc @@ -125,7 +125,7 @@ with the following path and query parameters: | *batch* (producer) | Enables or disables batch mode | false | boolean | *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] | *noop* (producer) | If set, will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing | false | boolean -| *useMessageBodyForSql* (producer) | Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. | false | boolean +| *useMessageBodyForSql* (producer) | Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. Note that query parameters in the message body are represented by a question mark instead of a # symbol. | false | boolean | *alwaysPopulateStatement* (advanced) | If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked, also if there is no expected parameters to be prepared. When this is false then the populateStatement is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters. | false | boolean | *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean | *elSqlConfig* (advanced) | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. | | ElSqlConfig diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/ElsqlEndpointBuilderFactory.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/ElsqlEndpointBuilderFactory.java index b6d8ec6..6f195a5 100644 --- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/ElsqlEndpointBuilderFactory.java +++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/ElsqlEndpointBuilderFactory.java @@ -1566,7 +1566,8 @@ public interface ElsqlEndpointBuilderFactory { /** * Whether to use the message body as the SQL and then headers for * parameters. If this option is enabled then the SQL in the uri is not - * used. + * used. Note that query parameters in the message body are represented + * by a question mark instead of a # symbol. * * The option is a: <code>boolean</code> type. * @@ -1581,7 +1582,8 @@ public interface ElsqlEndpointBuilderFactory { /** * Whether to use the message body as the SQL and then headers for * parameters. If this option is enabled then the SQL in the uri is not - * used. + * used. Note that query parameters in the message body are represented + * by a question mark instead of a # symbol. * * The option will be converted to a <code>boolean</code> type. * diff --git a/docs/components/modules/ROOT/pages/elsql-component.adoc b/docs/components/modules/ROOT/pages/elsql-component.adoc index 9248949..652bf2f 100644 --- a/docs/components/modules/ROOT/pages/elsql-component.adoc +++ b/docs/components/modules/ROOT/pages/elsql-component.adoc @@ -126,7 +126,7 @@ with the following path and query parameters: | *batch* (producer) | Enables or disables batch mode | false | boolean | *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] | *noop* (producer) | If set, will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing | false | boolean -| *useMessageBodyForSql* (producer) | Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. | false | boolean +| *useMessageBodyForSql* (producer) | Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. Note that query parameters in the message body are represented by a question mark instead of a # symbol. | false | boolean | *alwaysPopulateStatement* (advanced) | If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked, also if there is no expected parameters to be prepared. When this is false then the populateStatement is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters. | false | boolean | *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean | *elSqlConfig* (advanced) | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. | | ElSqlConfig diff --git a/docs/components/modules/ROOT/pages/pulsar-component.adoc b/docs/components/modules/ROOT/pages/pulsar-component.adoc index 0ddc816..5cbe1e3 100644 --- a/docs/components/modules/ROOT/pages/pulsar-component.adoc +++ b/docs/components/modules/ROOT/pages/pulsar-component.adoc @@ -32,7 +32,7 @@ pulsar:[persistent|non-persistent]://tenant/namespace/topic // component options: START -The Pulsar component supports 32 options, which are listed below. +The Pulsar component supports 33 options, which are listed below. @@ -53,8 +53,9 @@ The Pulsar component supports 32 options, which are listed below. | *numberOfConsumers* (consumer) | Number of consumers - defaults to 1 | 1 | int | *subscriptionInitialPosition* (consumer) | Control the initial position in the topic of a newly created subscription. Default is latest message. The value can be one of: EARLIEST, LATEST | LATEST | SubscriptionInitialPosition | *subscriptionName* (consumer) | Name of the subscription to use | subs | String -| *subscriptionType* (consumer) | Type of the subscription EXCLUSIVESHAREDFAILOVER, defaults to EXCLUSIVE. The value can be one of: EXCLUSIVE, SHARED, FAILOVER | EXCLUSIVE | SubscriptionType +| *subscriptionType* (consumer) | Type of the subscription EXCLUSIVESHAREDFAILOVERKEY_SHARED, defaults to EXCLUSIVE. The value can be one of: EXCLUSIVE, SHARED, FAILOVER, KEY_SHARED | EXCLUSIVE | SubscriptionType | *pulsarMessageReceiptFactory* (consumer) | Provide a factory to create an alternate implementation of PulsarMessageReceipt. | | PulsarMessageReceiptFactory +| *batcherBuilder* (producer) | Control batching method used by the producer. | DEFAULT | BatcherBuilder | *batchingEnabled* (producer) | Control whether automatic batching of messages is enabled for the producer. | true | boolean | *batchingMaxMessages* (producer) | The maximum size to batch messages. | 1000 | int | *batchingMaxPublishDelayMicros* (producer) | The maximum time period within which the messages sent will be batched if batchingEnabled is true. | 1000 | long @@ -100,7 +101,7 @@ with the following path and query parameters: |=== -=== Query Parameters (31 parameters): +=== Query Parameters (32 parameters): [width="100%",cols="2,5,^1,2",options="header"] @@ -119,9 +120,10 @@ with the following path and query parameters: | *numberOfConsumers* (consumer) | Number of consumers - defaults to 1 | 1 | int | *subscriptionInitialPosition* (consumer) | Control the initial position in the topic of a newly created subscription. Default is latest message. The value can be one of: EARLIEST, LATEST | LATEST | SubscriptionInitialPosition | *subscriptionName* (consumer) | Name of the subscription to use | subs | String -| *subscriptionType* (consumer) | Type of the subscription EXCLUSIVESHAREDFAILOVER, defaults to EXCLUSIVE. The value can be one of: EXCLUSIVE, SHARED, FAILOVER | EXCLUSIVE | SubscriptionType +| *subscriptionType* (consumer) | Type of the subscription EXCLUSIVESHAREDFAILOVERKEY_SHARED, defaults to EXCLUSIVE. The value can be one of: EXCLUSIVE, SHARED, FAILOVER, KEY_SHARED | EXCLUSIVE | SubscriptionType | *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler | *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | | ExchangePattern +| *batcherBuilder* (producer) | Control batching method used by the producer. | DEFAULT | BatcherBuilder | *batchingEnabled* (producer) | Control whether automatic batching of messages is enabled for the producer. | true | boolean | *batchingMaxMessages* (producer) | The maximum size to batch messages. | 1000 | int | *batchingMaxPublishDelayMicros* (producer) | The maximum time period within which the messages sent will be batched if batchingEnabled is true. | 1000 | long diff --git a/docs/components/modules/ROOT/pages/sql-component.adoc b/docs/components/modules/ROOT/pages/sql-component.adoc index d7a6a7f..24c6fc7 100644 --- a/docs/components/modules/ROOT/pages/sql-component.adoc +++ b/docs/components/modules/ROOT/pages/sql-component.adoc @@ -181,7 +181,7 @@ with the following path and query parameters: | *batch* (producer) | Enables or disables batch mode | false | boolean | *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] | *noop* (producer) | If set, will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing | false | boolean -| *useMessageBodyForSql* (producer) | Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. | false | boolean +| *useMessageBodyForSql* (producer) | Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. Note that query parameters in the message body are represented by a question mark instead of a # symbol. | false | boolean | *alwaysPopulateStatement* (advanced) | If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked, also if there is no expected parameters to be prepared. When this is false then the populateStatement is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters. | false | boolean | *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean | *parametersCount* (advanced) | If set greater than zero, then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API. This is useful if the JDBC vendor could not return correct parameters count, then user may override instead. | | int @@ -228,11 +228,14 @@ message body changes slightly – instead of an iterator of parameters, the component expects an iterator that contains the parameter iterators; the size of the outer iterator determines the batch size. -You can use the option useMessageBodyForSql that +You can use the option `useMessageBodyForSql` that allows to use the message body as the SQL statement, and then the SQL parameters must be provided in a header with the -key SqlConstants.SQL_PARAMETERS. This allows the SQL component to work -more dynamic as the SQL query is from the message body. +key `SqlConstants.SQL_PARAMETERS`. This allows the SQL component to work +more dynamically as the SQL query is from the message body. Use +https://camel.apache.org/manual/latest/templating.html[Camel templating] +for conditional processing, e.g. to include or exclude `where` clauses +depending on the presence of query parameters. == Result of the query