[camel] branch main updated: Polished doc
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 696aaf1ee8d Polished doc
696aaf1ee8d is described below
commit 696aaf1ee8dcea24084a949a6b53b934e8197074
Author: Claus Ibsen
AuthorDate: Mon Apr 24 20:45:22 2023 +0200
Polished doc
---
.../camel-sql/src/main/docs/sql-component.adoc | 107 +
1 file changed, 45 insertions(+), 62 deletions(-)
diff --git a/components/camel-sql/src/main/docs/sql-component.adoc
b/components/camel-sql/src/main/docs/sql-component.adoc
index 301e477a739..74388dabc70 100644
--- a/components/camel-sql/src/main/docs/sql-component.adoc
+++ b/components/camel-sql/src/main/docs/sql-component.adoc
@@ -36,11 +36,8 @@ for this component:
The SQL component also supports:
-* a JDBC based repository for the
-Idempotent Consumer EIP pattern. See
-further below.
-* a JDBC based repository for the Aggregator EIP
-pattern. See further below.
+* a JDBC based repository for the Idempotent Consumer EIP pattern. See further
below.
+* a JDBC based repository for the Aggregator EIP pattern. See further below.
== URI format
@@ -56,8 +53,7 @@ The SQL component uses the following endpoint URI notation:
sql:select * from table where id=# order by name[?options]
-You can use named parameters by using
-:`#name_of_the_parameter` style as shown:
+You can use named parameters by using `:#name_of_the_parameter` style as shown:
sql:select * from table where id=:#myId order by name[?options]
@@ -66,13 +62,13 @@ sql:select * from table where id=:#myId order by
name[?options]
When using named parameters, Camel will lookup the names from, in the
given precedence:
-1. from message body if its a `java.util.Map`
-2. from message headers
+1. from a xref:languages:simple-language.adoc[Simple] expressions
+2. from message body if its a `java.util.Map`
+3. from message headers
If a named parameter cannot be resolved, then an exception is thrown.
-You can use Simple expressions as parameters as
-shown:
+You can use xref:languages:simple-language.adoc[Simple] expressions as
parameters as shown:
sql:select * from table where id=:#${exchangeProperty.myId} order by
name[?options]
@@ -83,14 +79,13 @@ SQL query is substituted with the `pass:[#]` symbol,
because the `?` symbol is
used to specify options for the endpoint. The `?` symbol replacement can
be configured on endpoint basis.
-You can externalize your SQL queries to files
-in the classpath or file system as shown:
+You can externalize your SQL queries to files in the classpath or file system
as shown:
sql:classpath:sql/myquery.sql[?options]
-And the myquery.sql file is in the classpath and is just a plain text
+And the `myquery.sql` file is in the classpath and is just a plain text
[source,sql]
@@ -107,7 +102,6 @@ In the file you can use multilines and format the SQL as
you wish. And
also use comments such as the – dash line.
-
// component-configure options: START
// component-configure options: END
@@ -156,7 +150,7 @@ depending on the presence of query parameters.
For `select` operations, the result is an instance of
`List>` type, as returned by the
-http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html#queryForList(java.lang.String,%20java.lang.Object%91%93)[JdbcTemplate.queryForList()]
+http://static.springframework.org/spring/docs/6.0.x/api/org/springframework/jdbc/core/JdbcTemplate.html#queryForList(java.lang.String,%20java.lang.Object%91%93)[JdbcTemplate.queryForList()]
method. For `update` operations, a `NULL` body is returned as the `update`
operation is only set as a header and never as a body.
By default, the result is placed in the message body. If the
@@ -175,7 +169,7 @@ from("jms:order.inbox")
== Using StreamList
-The producer supports outputType=StreamList
+The producer supports `outputType=StreamList`
that uses an iterator to stream the output of the query. This allows to
process the data in a streaming fashion which for example can be used by
the Splitter EIP to process each row one at a time,
@@ -184,32 +178,28 @@ and load data from the database as needed.
[source,java]
from("direct:withSplitModel")
-.to("sql:select * from projects order by
id?outputType=StreamList=org.apache.camel.component.sql.ProjectModel")
-.to("log:stream")
-.split(body()).streaming()
-.to("log:row")
-.to("mock:result")
-.end();
+.to("sql:select * from projects order by
id?outputType=StreamList=org.apache.camel.component.sql.ProjectModel")
+.to("log:stream")
+.split(body()).streaming()
+.to("log:row")
+.to("mock:result")
+.end();
== Generated keys
-*Since Camel 2.12.4, 2.13.1 and 2.14*
-
If
[camel] branch main updated: Polished doc
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 400acbb Polished doc
400acbb is described below
commit 400acbbabcc1e88f1c1e048700adb39f120f1c86
Author: Claus Ibsen
AuthorDate: Thu Jan 13 22:24:50 2022 +0100
Polished doc
---
docs/user-manual/modules/ROOT/pages/tracer.adoc | 9 +++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/docs/user-manual/modules/ROOT/pages/tracer.adoc
b/docs/user-manual/modules/ROOT/pages/tracer.adoc
index 41403ba..a2845c7 100644
--- a/docs/user-manual/modules/ROOT/pages/tracer.adoc
+++ b/docs/user-manual/modules/ROOT/pages/tracer.adoc
@@ -89,7 +89,7 @@ The default format can be customized using, for exameple to
use wider columns:
[source,java]
-context.setTracingLoggingFormat("%-4.4s [%-30.30s] [%-50.50s]);
+context.setTracingLoggingFormat("%-4.4s [%-30.30s] [%-50.50s]");
And in XML DSL:
@@ -103,9 +103,14 @@ And in XML DSL:
And in Spring Boot
-[source,text]
+[source,properties]
camel.springboot.tracing-logging-format = %-4.4s [%-30.30s] [%-50.50s]
+And in Camel Main / Quarkus
+[source,properties]
+
+camel.main.tracing-logging-format = %-4.4s [%-30.30s] [%-50.50s]
+
[camel] branch main updated: Polished doc
This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git The following commit(s) were added to refs/heads/main by this push: new 12006fd Polished doc 12006fd is described below commit 12006fdf7e79b3d428d2a86f2511e33676f1d12b Author: Claus Ibsen AuthorDate: Tue Jan 4 16:45:42 2022 +0100 Polished doc --- components/camel-jfr/src/main/docs/jfr.adoc | 6 ++ 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/components/camel-jfr/src/main/docs/jfr.adoc b/components/camel-jfr/src/main/docs/jfr.adoc index 4d07c6f..7f716df 100644 --- a/components/camel-jfr/src/main/docs/jfr.adoc +++ b/components/camel-jfr/src/main/docs/jfr.adoc @@ -17,19 +17,17 @@ This allows to monitor and troubleshoot your Camel applications with JFR. The camel-jfr component emits lifecycle events for startup to JFR. This can for example be used to pin-point which Camel routes may be slow to startup. -[[jfr-Options]] - See the __startupRecorder__ options from xref:components:others:main.adoc[Camel Main] -[[jfr-Example]] == Example To enable you just need to add `camel-jfr` to the classpath, and enable JFR recording. JFR recordings can be started either at: + - When running the JVM using JVM arguments - When starting Camel by setting `camel.main.startup-recorder-recording=true`. -See the `camel-example-flight-recorder` from the Camel Examples. +See the `flight-recorder` from the Camel Examples. include::spring-boot:partial$starter.adoc[]
[camel] branch main updated: Polished doc
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new f6c197f Polished doc
f6c197f is described below
commit f6c197f1cc670e495e06ca2819f8ad934fe58cea
Author: Claus Ibsen
AuthorDate: Thu Sep 2 15:50:54 2021 +0200
Polished doc
---
.../generated/resources/org/apache/camel/catalog/models/choice.json | 2 +-
.../resources/org/apache/camel/catalog/models/convertBodyTo.json | 1 +
.../resources/org/apache/camel/catalog/models/dynamicRouter.json | 4 ++--
.../resources/org/apache/camel/catalog/models/recipientList.json | 2 +-
.../src/main/docs/modules/eips/pages/choice-eip.adoc | 3 +--
.../src/main/docs/modules/eips/pages/convertBodyTo-eip.adoc | 3 ++-
.../src/main/docs/modules/eips/pages/dynamicRouter-eip.adoc | 4 ++--
.../src/main/docs/modules/eips/pages/recipientList-eip.adoc | 2 +-
.../src/generated/resources/org/apache/camel/model/choice.json| 2 +-
.../src/generated/resources/org/apache/camel/model/dynamicRouter.json | 2 +-
.../src/generated/resources/org/apache/camel/model/recipientList.json | 2 +-
.../src/main/java/org/apache/camel/model/ChoiceDefinition.java| 2 +-
.../src/main/java/org/apache/camel/model/DynamicRouterDefinition.java | 2 +-
.../src/main/java/org/apache/camel/model/RecipientListDefinition.java | 2 +-
14 files changed, 17 insertions(+), 16 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/choice.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/choice.json
index 4a1e131..e227b1b 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/choice.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/choice.json
@@ -3,7 +3,7 @@
"kind": "model",
"name": "choice",
"title": "Choice",
-"description": "Routes messages based on a series of predicates",
+"description": "Route messages based on a series of predicates",
"deprecated": false,
"label": "eip,routing",
"javaType": "org.apache.camel.model.ChoiceDefinition",
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/convertBodyTo.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/convertBodyTo.json
index 448e03b..4b84803 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/convertBodyTo.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/convertBodyTo.json
@@ -12,6 +12,7 @@
},
"properties": {
"type": { "kind": "attribute", "displayName": "Type", "required": true,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "The java type to convert
to" },
+"mandatory": { "kind": "attribute", "displayName": "Mandatory",
"required": false, "type": "boolean", "javaType": "java.lang.Boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "When mandatory then the conversion must return a value (cannot
be null), if this is not possible then NoTypeConversionAvailableException is
thrown. Setting this to false could mean conversion is not possible and the
value is null." },
"charset": { "kind": "attribute", "displayName": "Charset", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "To use a specific charset
when converting" },
"id": { "kind": "attribute", "displayName": "Id", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the id of this node"
},
"description": { "kind": "element", "displayName": "Description",
"required": false, "type": "object", "javaType":
"org.apache.camel.model.DescriptionDefinition", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the description of
this node" }
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/dynamicRouter.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/dynamicRouter.json
index 67431d9..3025197 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/dynamicRouter.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/dynamicRouter.json
@@ -3,7 +3,7 @@
"kind": "model",
"name": "dynamicRouter",
"title": "Dynamic Router",
-"description": "Routes messages based on dynamic rules",
+"description": "Route messages based on dynamic rules",
