Author: buildbot
Date: Fri Feb 19 11:21:30 2016
New Revision: 980773
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/book-component-appendix.html
websites/production/camel/content/book-in-one-page.html
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/sql-component.html
Modified: websites/production/camel/content/book-component-appendix.html
==============================================================================
--- websites/production/camel/content/book-component-appendix.html (original)
+++ websites/production/camel/content/book-component-appendix.html Fri Feb 19
11:21:30 2016
@@ -1016,11 +1016,11 @@ template.send("direct:alias-verify&
]]></script>
</div></div><p></p><h3 id="BookComponentAppendix-SeeAlso.8">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul><li><a
shape="rect" href="crypto.html">Crypto</a> Crypto is also available as a <a
shape="rect" href="data-format.html">Data Format</a></li></ul> <h2
id="BookComponentAppendix-CXFComponent">CXF Component</h2><div
class="confluence-information-macro confluence-information-macro-note"><span
class="aui-icon aui-icon-small aui-iconfont-warning
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>When using CXF as a consumer, the
<a shape="rect" href="cxf-bean-component.html">CXF Bean Component</a> allows
you to factor out how message payloads are received from their processing as a
RESTful or SOAP web service. This has the potential of using a multitude of
transports to cons
ume web services. The bean component's configuration is also simpler and
provides the fastest method to implement web services using Camel and
CXF.</p></div></div><div class="confluence-information-macro
confluence-information-macro-tip"><span class="aui-icon aui-icon-small
aui-iconfont-approve confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>When using CXF in streaming modes
(see DataFormat option), then also read about <a shape="rect"
href="stream-caching.html">Stream caching</a>.</p></div></div><p>The
<strong>cxf:</strong> component provides integration with <a shape="rect"
href="http://cxf.apache.org";>Apache CXF</a> for connecting to JAX-WS services
hosted in CXF.</p><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1455823106434 {padding: 0px;}
-div.rbtoc1455823106434 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1455823106434 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1455880681246 {padding: 0px;}
+div.rbtoc1455880681246 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1455880681246 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1455823106434">
+/*]]>*/</style></p><div class="toc-macro rbtoc1455880681246">
<ul class="toc-indentation"><li><a shape="rect"
href="#BookComponentAppendix-CXFComponent">CXF Component</a>
<ul class="toc-indentation"><li><a shape="rect"
href="#BookComponentAppendix-URIformat">URI format</a></li><li><a shape="rect"
href="#BookComponentAppendix-Options">Options</a>
<ul class="toc-indentation"><li><a shape="rect"
href="#BookComponentAppendix-Thedescriptionsofthedataformats">The descriptions
of the dataformats</a>
@@ -10209,9 +10209,19 @@ protected RouteBuilder createRouteBuilde
</div></div><p>From Camel 2.11 onwards you can use named parameters by using
:<code>#name_of_the_parameter</code> style as shown:</p><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[sql:select * from table where id=:#myId order
by name[?options]
]]></script>
-</div></div><p>When using named parameters, Camel will lookup the names from,
in the given precedence:<br clear="none"> 1. from message body if its a
<code>java.util.Map</code><br clear="none"> 2. from message headers</p><p>If a
named parameter cannot be resolved, then an exception is thrown.</p><p>From
Camel 2.14 onward you can use Simple expressions as parameters as
shown:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+</div></div><p>When using named parameters, Camel will lookup the names from,
in the given precedence:<br clear="none"> 1. from message body if its a
<code>java.util.Map</code><br clear="none"> 2. from message headers</p><p>If a
named parameter cannot be resolved, then an exception is thrown.</p><p>From
<strong>Camel 2.14</strong> onward you can use Simple expressions as parameters
as shown:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[sql:select * from table where
id=:#${property.myId} order by name[?options]]]></script>
-</div></div><p>Notice that the standard <code>?</code> symbol that denotes the
parameters to an SQL query is substituted with the <code>#</code> symbol,
because the <code>?</code> symbol is used to specify options for the endpoint.
The <code>?</code> symbol replacement can be configured on endpoint
basis.</p><p>You can append query options to the URI in the following format,
<code>?option=value&option=value&...</code></p><h3
id="BookComponentAppendix-Options.54">Options</h3><div
class="confluenceTableSmall"><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>batch</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><
p><code>boolean</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.7.5, 2.8.4 and 2.9:</strong> Execute
SQL batch update statements. See notes below on how the treatment of the
inbound message body changes if this is set to
<code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>dataSourceRef</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in
Camel 3.0:</strong> Reference to a <code>DataSource</code> to look up in the
registry. Use <code>dataSource=#theName</code> instead.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>dataSource</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><
code>String</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> Reference to a
<code>DataSource</code> to look up in the registry.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>placeholder</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>#</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.4:</strong> Specifies a
character that will be replaced to <code>?</code> in SQL query. Notice, that it
is simple <code>String.replaceAll()</code> operation and no SQL parsing is
involved (quoted strings will also change). This replacement is
<strong>only</strong> happening if the endpoint is created using the
<code>SqlComponent</code>. If you manually create the endpoint, then use the
expected <code>?</code> sign i
nstead.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>template.<xxx></code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Sets additional options on the Spring
<code>JdbcTemplate</code> that is used behind the scenes to execute the
queries. For instance, <code>template.maxRows=10</code>. For detailed
documentation, see the <a shape="rect" class="external-link"
href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html";
rel="nofollow">JdbcTemplate javadoc</a> documentation.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>allowNamedParameters</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
Whether to allow using named parameters in the queries.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>processingStrategy</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
only:</strong> Allows to plugin to use a custom
<code>org.apache.camel.component.sql.SqlProcessingStrategy</code> to execute
queries when the consumer has processed the rows/batch.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>prepareStatementStrategy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> Allows t
o plugin to use a custom
<code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> to
control preparation of the query and prepared statement.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.delay</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>long</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>500</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> Delay in milliseconds between each
poll.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.initialDelay</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>long</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
<strong>SQL consumer only:</strong> Milliseconds before polling starts.</
p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.useFixedDelay</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> Set to <code>true</code> to use fixed delay between
polls, otherwise fixed rate is used. See <a shape="rect" class="external-link"
href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html";
rel="nofollow">ScheduledExecutorService</a> in JDK for
details.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>maxMessagesPerPoll</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><s
trong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> An integer
value to define the maximum number of messages to gather per poll. By default,
no maximum is set.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>useIterator</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
<strong>SQL consumer only:</strong> If <code>true</code> each row returned when
polling will be processed individually. If <code>false</code> the entire
<code>java.util.List</code> of data is set as the IN body.<span> Notice in
Camel 2.15.x or older you need to prefix this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>routeEmptyResultSet</code></p></td><td
colspan="1" rowspan="1" class="conf
luenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
only:</strong> Whether to route a single empty <a shape="rect"
href="exchange.html">Exchange</a> if there was no data to poll.<span> Notice in
Camel 2.15.x or older you need to prefix this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>onConsume</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> After processing each row then this query can be
executed, if the <a shape="rect" href="exchange.html">Exchange</a> was
processed successfully, for ex
ample to mark the row as processed. The query can have parameter.<span> Notice
in Camel 2.15.x or older you need to prefix this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>onConsumeFailed</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> After processing each row then this query can be
executed, if the <a shape="rect" href="exchange.html">Exchange</a> failed, for
example to mark the row as failed. The query can have parameter.<span> Notice
in Camel 2.15.x or older you need to prefix this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>onConsumeBatchComplete</code></p></td>
<td colspan="1" rowspan="1"
class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
only:</strong> After processing the entire batch, this query can be executed to
bulk update rows etc. The query cannot have parameters.<span> Notice in Camel
2.15.x or older you need to prefix this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>expectedUpdateCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
<strong>SQL consumer only:</strong> If using <code>consumer.onConsume</code>
then this option can be used to set an expected number of
rows being updated. Typically you may set this to <code>1</code> to expect one
row to be updated.<span> Notice in Camel 2.15.x or older you need to prefix
this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>breakBatchOnConsumeFail</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> If using <code>consumer.onConsume</code> and it fails,
then this option controls whether to break out of the batch or continue
processing the next row from the batch. Notice in Camel 2.15.x or older you
need to prefix this option with consumer., eg
consumer.useIterator=true.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>alwaysPopulateStatement</code></p><
/td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
producer only:</strong> If enabled then the <code>populateStatement</code>
method from
<code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> is
always invoked, also if there is no expected parameters to be prepared. When
this is <code>false</code> then the <code>populateStatement</code> 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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>separator</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>char</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>,</code></p></td><td colspan="1" row
span="1" class="confluenceTd"><p><strong>Camel 2.11.1:</strong> The separator
to use when parameter values is taken from message body (if the body is a
String type), to be inserted at # placeholders. Notice if you use named
parameters, then a <code>Map</code> type is used instead.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>outputType</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>SelectList</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong>
Make the output of consumer or producer to <code>SelectList</code> as List of
Map, or <code>SelectOne</code> as single Java object in the following way:<br
clear="none"> a) If the query has only single column, then that JDBC Column
object is returned. (such as <code>SELECT COUNT( * ) FROM PROJECT</code> will
return a Long object.<br clear="none"> b) If the query ha
s more than one column, then it will return a Map of that result.<br
clear="none"> c) If the <code>outputClass</code> is set, then it will convert
the query result into an Java bean object by calling all the setters that match
the column names. It will assume your class has a default constructor to create
instance with.<br clear="none"> d) If the query resulted in more than one rows,
it throws an non-unique result exception.</p><p>From <strong>Camel
2.14.1</strong> onwards the SelectList also supports mapping each row to a Java
object as the SelectOne does <span>(only step c)</span>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>outputClass</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong> Specify the
full package and class name to use as conversion wh
en <code>outputType=SelectOne</code>.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>outputHeader</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>String</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.15:</strong> To
store the result as a header instead of the message body. This allows to
preserve the existing message body as-is.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>parametersCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel
2.11.2/2.12.0</strong> 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 c
ould not return correct parameters count, then user may override
instead.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>noop</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0</strong> 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</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><code>useMessageBodyForSql</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>boolean</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>false</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong>
Whether to use the message body as the SQL and then headers for parameters. If
this option is enabled then the SQL in the u
ri is not used. The SQL parameters must then be provided in a header with the
key <code>CamelSqlParameters</code>. This option is only for the
producer.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>transacted</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>boolean</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>false</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.16.2:</strong> <strong>SQL consumer
only:</strong>Enables or disables transaction. If enabled then if processing an
exchange failed then the consumer break out processing any further exchanges to
cause a rollback eager</td></tr></tbody></table></div></div><h3
id="BookComponentAppendix-Treatmentofthemessagebody">Treatment of the message
body</h3><p>The SQL component tries to convert the message body to an object of
<code>java.util.Iterator</code> type and then uses this iterator to fill the
query parameters (where each query parameter is
represented by a <code>#</code> symbol (or configured placeholder) in the
endpoint URI). If the message body is not an array or collection, the
conversion results in an iterator that iterates over only one object, which is
the body itself.</p><p>For example, if the message body is an instance of
<code>java.util.List</code>, the first item in the list is substituted into the
first occurrence of <code>#</code> in the SQL query, the second item in the
list is substituted into the second occurrence of <code>#</code>, and so
on.</p><p>If <code>batch</code> is set to <code>true</code>, then the
interpretation of the inbound 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.</p><p>From Camel 2.16 onwards you can use the
option <span>useMessageBodyForSql that allows to use the message body as
the SQL statement, and then the SQL para
meters 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.</span></p><h3
id="BookComponentAppendix-Resultofthequery">Result of the query</h3><p>For
<code>select</code> operations, the result is an instance of
<code>List<Map<String, Object>></code> type, as returned by the <a
shape="rect" class="external-link"
href="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)"
rel="nofollow">JdbcTemplate.queryForList()</a> method. For <code>update</code>
operations, the result is the number of updated rows, returned as an
<code>Integer</code>.</p><p>By default, the result is placed in the message
body.  If the outputHeader parameter is set, the result is placed in the
header.  This is an alternative to using a full message enrichment pattern
to add
headers, it provides a concise syntax for querying a sequence or some other
small value into a header.  It is convenient to use outputHeader and
outputType together:</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+</div></div><p>Notice that the standard <code>?</code> symbol that denotes the
parameters to an SQL query is substituted with the <code>#</code> symbol,
because the <code>?</code> symbol is used to specify options for the endpoint.
The <code>?</code> symbol replacement can be configured on endpoint
basis.</p><p>From <strong>Camel 2.17</strong> onwards you can externalize your
SQL queries to files in the classpath or file system as shown:</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[sql:classpath:sql/myquery.sql[?options]]]></script>
+</div></div><p>And the myquery.sql file is in the classpath and is just a
plain text</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[-- this is a comment
+select *
+from table
+where
+ id = :#${property.myId}
+order by
+ name]]></script>
+</div></div><p>In the file you can use multilines and format the SQL as you
wish. And also use comments such as the – dash line.</p><p>You can
append query options to the URI in the following format,
<code>?option=value&option=value&...</code></p><h3
id="BookComponentAppendix-Options.54">Options</h3><div
class="confluenceTableSmall"><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>batch</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><stro
ng>Camel 2.7.5, 2.8.4 and 2.9:</strong> Execute SQL batch update statements.
See notes below on how the treatment of the inbound message body changes if
this is set to <code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>dataSourceRef</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in
Camel 3.0:</strong> Reference to a <code>DataSource</code> to look up in the
registry. Use <code>dataSource=#theName</code> instead.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>dataSource</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Ca
mel 2.11:</strong> Reference to a <code>DataSource</code> to look up in the
registry.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>placeholder</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>#</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.4:</strong> Specifies a
character that will be replaced to <code>?</code> in SQL query. Notice, that it
is simple <code>String.replaceAll()</code> operation and no SQL parsing is
involved (quoted strings will also change). This replacement is
<strong>only</strong> happening if the endpoint is created using the
<code>SqlComponent</code>. If you manually create the endpoint, then use the
expected <code>?</code> sign instead.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><code>usePlaceholder</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>boolea
n</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>true</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.17:</strong> Sets whether to use
placeholder and replace all placeholder characters with ? sign in the SQL
queries.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>template.<xxx></code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Sets additional options on the Spring
<code>JdbcTemplate</code> that is used behind the scenes to execute the
queries. For instance, <code>template.maxRows=10</code>. For detailed
documentation, see the <a shape="rect" class="external-link"
href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html";
rel="nofollow">JdbcTemplate javadoc</a> documentation.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>allowNamedParameters</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Whether to
allow using named parameters in the queries.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>processingStrategy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
only:</strong> Allows to plugin to use a custom
<code>org.apache.camel.component.sql.SqlProcessingStrategy</code> to execute
queries when the consumer has processed the rows/batch.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>prepareSta
tementStrategy</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> Allows to plugin to use a
custom <code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code>
to control preparation of the query and prepared
statement.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.delay</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>long</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>500</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> Delay in milliseconds between each
poll.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.initialDelay</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code
>long</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>1000</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
>only:</strong> Milliseconds before polling starts.</p></td></tr><tr><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>consumer.useFixedDelay</code></p></td><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
><strong>SQL consumer only:</strong> Set to <code>true</code> to use fixed
>delay between polls, otherwise fixed rate is used. See <a shape="rect"
>class="external-link"
>href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html";
> rel="nofollow">ScheduledExecutorService</a> in JDK for
>details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluence
Td"><p><code>maxMessagesPerPoll</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>int</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
only:</strong> An integer value to define the maximum number of messages to
gather per poll. By default, no maximum is set.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>useIterator</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
<strong>SQL consumer only:</strong> If <code>true</code> each row returned when
polling will be processed individually. If <code>false</code> the entire
<code>java.util.List</code> of data is set as the IN body.<span> Notice in Ca
mel 2.15.x or older you need to prefix this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>routeEmptyResultSet</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> Whether to route a single empty <a shape="rect"
href="exchange.html">Exchange</a> if there was no data to poll.<span> Notice in
Camel 2.15.x or older you need to prefix this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>onConsume</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1
" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> After processing each row then this query can be
executed, if the <a shape="rect" href="exchange.html">Exchange</a> was
processed successfully, for example to mark the row as processed. The query can
have parameter.<span> Notice in Camel 2.15.x or older you need to prefix this
option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>onConsumeFailed</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> After processing each row then this query can be
executed, if the <a shape="rect" href="exchange.html">Exchange</a> failed, for
example to mark the row as failed. The query ca
n have parameter.<span> Notice in Camel 2.15.x or older you need to prefix
this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>onConsumeBatchComplete</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
<strong>SQL consumer only:</strong> After processing the entire batch, this
query can be executed to bulk update rows etc. The query cannot have
parameters.<span> Notice in Camel 2.15.x or older you need to prefix this
option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>expectedUpdateCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td
colspan="1" rowspan="1" class="conf
luenceTd"><p><code>-1</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
only:</strong> If using <code>consumer.onConsume</code> then this option can be
used to set an expected number of rows being updated. Typically you may set
this to <code>1</code> to expect one row to be updated.<span> Notice in Camel
2.15.x or older you need to prefix this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>breakBatchOnConsumeFail</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> If using <code>consumer.onConsume</code> and it fails,
then this option controls whether to break out of the batch or continue proces
sing the next row from the batch. Notice in Camel 2.15.x or older you need to
prefix this option with consumer., eg
consumer.useIterator=true.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>alwaysPopulateStatement</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
producer only:</strong> If enabled then the <code>populateStatement</code>
method from
<code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> is
always invoked, also if there is no expected parameters to be prepared. When
this is <code>false</code> then the <code>populateStatement</code> 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.</p></td></tr><tr><t
d colspan="1" rowspan="1"
class="confluenceTd"><p><code>separator</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>char</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>,</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.1:</strong> The
separator to use when parameter values is taken from message body (if the body
is a String type), to be inserted at # placeholders. Notice if you use named
parameters, then a <code>Map</code> type is used instead.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>outputType</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>SelectList</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong>
Make the output of consumer or producer to <code>SelectList</code> as List of
Map, or <code>SelectOne</code> as si
ngle Java object in the following way:<br clear="none"> a) If the query has
only single column, then that JDBC Column object is returned. (such as
<code>SELECT COUNT( * ) FROM PROJECT</code> will return a Long object.<br
clear="none"> b) If the query has more than one column, then it will return a
Map of that result.<br clear="none"> c) If the <code>outputClass</code> is set,
then it will convert the query result into an Java bean object by calling all
the setters that match the column names. It will assume your class has a
default constructor to create instance with.<br clear="none"> d) If the query
resulted in more than one rows, it throws an non-unique result
exception.</p><p>From <strong>Camel 2.14.1</strong> onwards the SelectList also
supports mapping each row to a Java object as the SelectOne does <span>(only
step c)</span>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>outputClass</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p
><code>String</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><strong>Camel 2.12.0:</strong> Specify the full
>package and class name to use as conversion when
><code>outputType=SelectOne</code>.</p></td></tr><tr><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>outputHeader</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><code>String</code></td><td
>colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.15:</strong>
>To store the result as a header instead of the message body. This allows to
>preserve the existing message body as-is.</p></td></tr><tr><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>parametersCount</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><t
d colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel
2.11.2/2.12.0</strong> 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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>noop</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0</strong> 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</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><code>useMessageBodyForSql</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>boolean</code></td><td
colspan="1" rows
pan="1" class="confluenceTd"><code>false</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong> 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. The SQL parameters must then be
provided in a header with the key <code>CamelSqlParameters</code>. This option
is only for the producer.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>transacted</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>boolean</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>false</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.16.2:</strong> <strong>SQL consumer
only:</strong>Enables or disables transaction. If enabled then if processing an
exchange failed then the consumer break out processing any further exchanges to
cause a rollback eager</td></tr></tbody></table></div></div><h3
id="BookComponentAppendix-Trea
tmentofthemessagebody">Treatment of the message body</h3><p>The SQL component
tries to convert the message body to an object of
<code>java.util.Iterator</code> type and then uses this iterator to fill the
query parameters (where each query parameter is represented by a <code>#</code>
symbol (or configured placeholder) in the endpoint URI). If the message body is
not an array or collection, the conversion results in an iterator that iterates
over only one object, which is the body itself.</p><p>For example, if the
message body is an instance of <code>java.util.List</code>, the first item in
the list is substituted into the first occurrence of <code>#</code> in the SQL
query, the second item in the list is substituted into the second occurrence of
<code>#</code>, and so on.</p><p>If <code>batch</code> is set to
<code>true</code>, then the interpretation of the inbound message body changes
slightly – instead of an iterator of parameters, the component expects an
iterator that con
tains the parameter iterators; the size of the outer iterator determines the
batch size.</p><p>From Camel 2.16 onwards you can use the
option <span>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.</span></p><h3
id="BookComponentAppendix-Resultofthequery">Result of the query</h3><p>For
<code>select</code> operations, the result is an instance of
<code>List<Map<String, Object>></code> type, as returned by the <a
shape="rect" class="external-link"
href="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)"
rel="nofollow">JdbcTemplate.queryForList()</a> method. For <code>update</code>
operations, the result is the number of updated rows, re
turned as an <code>Integer</code>.</p><p>By default, the result is placed in
the message body.  If the outputHeader parameter is set, the result is
placed in the header.  This is an alternative to using a full message
enrichment pattern to add headers, it provides a concise syntax for querying a
sequence or some other small value into a header.  It is convenient to use
outputHeader and outputType together:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[from("jms:order.inbox")
.to("sql:select order_seq.nextval from
dual?outputHeader=OrderId&outputType=SelectOne")
.to("jms:order.booking");]]></script>
