Modified: websites/production/camel/content/elsql.html
==============================================================================
--- websites/production/camel/content/elsql.html (original)
+++ websites/production/camel/content/elsql.html Sat Nov 21 11:22:39 2015
@@ -96,7 +96,7 @@
</div></div><div class="confluence-information-macro
confluence-information-macro-information"><span class="aui-icon aui-icon-small
aui-iconfont-info confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>This component can be used as a <a
shape="rect" class="external-link"
href="http://camel.apache.org/transactional-client.html";>Transactional
Client</a>.</p></div></div><p>The SQL component uses the following endpoint URI
notation:</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:elSqlName:resourceUri[?options]
]]></script>
-</div></div><p>You can append query options to the URI in the following
format, <code style="line-height:
1.42857;">?option=value&option=value&...</code></p><p>The parameters to
the SQL queries are named parameters in the elsql mapping files, and maps to
corresponding keys from the Camel message, in the given
precedence:</p><p>1. <strong>Camel 2.16.1:</strong> from message body
if <a shape="rect" href="simple.html">Simple</a> expression.</p><div>2.
from message body if its a <code style="line-height: 1.42857;">java.util.Map<br
clear="none"></code>3. from message headers</div><p>If a named parameter cannot
be resolved, then an exception is thrown.</p><h3
id="ElSql-Options">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="confluenc
eTh"><p>Default</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><code>resourceUri</code></td><td colspan="1"
rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1"
class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Required</strong> The resource file which contains
the elsql SQL statements to use. You can specify multiple resources separated
by comma. The resources are loaded on the classpath by default, you can prefix
with file: to load from file system. Notice you can set this option on the
component and then you do not have to configure this on the
endpoint.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>elSqlConfig</code></td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd">To use a specific configured
ElSqlConfig. It may be better to use the databaseVendor option
instead.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>databaseVendor</code></td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">Default</td><td colspan="1" rowspan="1"
class="confluenceTd">To use a vendor specific ElSqlConfig. The possible values
are: Default, Postgres, HSql, MySql, Oracle, SqlServer2008,
Veritca</td></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>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>dataSour
ce</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>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>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
NamedParameterJdbcTemplate that is used behind the scenes to execute the
queries. For instance, <code>template.maxRows=10</code>. For detailed
documentation, see the NamedParameterJdbcTemplate javadoc
documentation.</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>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>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>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>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>consumer.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>If <code>true</code> each row returned when
polling will be pro
cessed individually. If <code>false</code> the entire
<code>java.util.List</code> of data is set as the IN body.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>Whether to route a single empty <a
shape="rect" href="exchange.html">Exchange</a> if there was no data to
poll.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>After processing each row then this query
can be executed, if the <a shape="rect" href="exchange.html">Exchange</a> was pr
ocessed successfully, for example to mark the row as processed. The query can
have parameter.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>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.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>consumer.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>After processing the entire batch, this query can be
executed to bulk update rows etc. The query cannot have
parameters.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>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.</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>Make the output of consumer or
producer to <code>SelectList</code> as List of Map, or <code>SelectOne</code> a
s 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 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>Tthe 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 colsp
an="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>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>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>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>If set, will ignore the results of the SQL
query an
d use the existing IN message as the OUT message for the continuation of
processing</p></td></tr></tbody></table></div></div><h3
id="ElSql-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 JdbcTemplate.queryForList()
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><h3
id="ElSql-Headervalues">Header values</h3><p>When performing
<code>update</code> operations, the SQL Component stores the up
date count in the following message headers:</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelSqlUpdateCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The number of rows updated for
<code>update</code> operations, returned as an <code>Integer</code>
object.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelSqlRowCount</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The number of rows returned for
<code>select</code> operations, returned as an <code>Integer</code>
object.</p></td></tr></tbody></table></div><h4
id="ElSql-Sample">Sample</h4><p><span style="line-height: 1.42857;">In the
given route below, we want to get all the projects from the projects table.
Notice the SQL query has 2
named parameters, :#lic and :#min.</span></p><p>Camel will then lookup for
these parameters from the message body or message headers. Notice in the
example above we set two headers with constant value<br clear="none"> for the
named parameters:</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+</div></div><p>You can append query options to the URI in the following
format, <code style="line-height:
1.42857;">?option=value&option=value&...</code></p><p>The parameters to
the SQL queries are named parameters in the elsql mapping files, and maps to
corresponding keys from the Camel message, in the given
precedence:</p><p>1. <strong>Camel 2.16.1:</strong> from message body
if <a shape="rect" href="simple.html">Simple</a> expression.</p><div>2.
from message body if its a <code style="line-height: 1.42857;">java.util.Map<br
clear="none"></code>3. from message headers</div><p>If a named parameter cannot
be resolved, then an exception is thrown.</p><h3
id="ElSql-Options">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="confluenc
eTh"><p>Default</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><code>resourceUri</code></td><td colspan="1"
rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1"
class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Required</strong> The resource file which contains
the elsql SQL statements to use. You can specify multiple resources separated
by comma. The resources are loaded on the classpath by default, you can prefix
with file: to load from file system. Notice you can set this option on the
component and then you do not have to configure this on the
endpoint.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>elSqlConfig</code></td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd">To use a specific configured
ElSqlConfig. It may be better to use the databaseVendor option
instead.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>databaseVendor</code></td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">Default</td><td colspan="1" rowspan="1"
class="confluenceTd">To use a vendor specific ElSqlConfig. The possible values
are: Default, Postgres, HSql, MySql, Oracle, SqlServer2008,
Veritca</td></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>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>dataSour
ce</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>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>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
NamedParameterJdbcTemplate that is used behind the scenes to execute the
queries. For instance, <code>template.maxRows=10</code>. For detailed
documentation, see the NamedParameterJdbcTemplate javadoc
documentation.</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>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>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>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>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>consumer.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>If <code>true</code> each row returned when
polling will be pro
cessed individually. If <code>false</code> the entire
<code>java.util.List</code> of data is set as the IN body.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>Whether to route a single empty <a
shape="rect" href="exchange.html">Exchange</a> if there was no data to
poll.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>After processing each row then this query
can be executed, if the <a shape="rect" href="exchange.html">Exchange</a> was pr
ocessed successfully, for example to mark the row as processed. The query can
have parameter.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>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.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>consumer.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>After processing the entire batch, this query can be
executed to bulk update rows etc. The query cannot have
parameters.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>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.</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>Make the output of consumer or
producer to <code>SelectList</code> as List of Map, or <code>SelectOne</code> a
s 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 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>Tthe 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 colsp
an="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>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>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>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>If set, will ignore the results of the SQL
query an
d 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>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="ElSql-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 JdbcTemplate.queryForList()
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><h3 id="ElSql-Headervalues">Header values</h3><p>When performing
<code>update</code> operations, the SQL Component stores the update count in
the following message headers:</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelSqlUpdateCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The number of rows updated for
<code>update</code> operations, returne
d as an <code>Integer</code> object.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>CamelSqlRowCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The number of rows returned for
<code>select</code> operations, returned as an <code>Integer</code>
object.</p></td></tr></tbody></table></div><h4
id="ElSql-Sample">Sample</h4><p><span style="line-height: 1.42857;">In the
given route below, we want to get all the projects from the projects table.
Notice the SQL query has 2 named parameters, :#lic and
:#min.</span></p><p>Camel will then lookup for these parameters from the
message body or message headers. Notice in the example above we set two headers
with constant value<br clear="none"> for the named parameters:</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("direct:projects")
.setHeader("lic", constant("ASF"))
.setHeader("min", constant(123))
Modified: websites/production/camel/content/mybatis.html
==============================================================================
--- websites/production/camel/content/mybatis.html (original)
+++ websites/production/camel/content/mybatis.html Sat Nov 21 11:22:39 2015
@@ -97,7 +97,7 @@
</div></div><h3 id="MyBatis-URIformat">URI format</h3><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[mybatis:statementName[?options]
]]></script>
-</div></div><p>Where <strong>statementName</strong> is the statement name in
the MyBatis XML mapping file which maps to the query, insert, update or delete
operation you wish to evaluate.</p><p>You can append query options to the URI
in the following format,
<code>?option=value&option=value&...</code></p><p>This component will
by default load the MyBatis SqlMapConfig file from the root of the classpath
with the expected name of <code>SqlMapConfig.xml</code>.<br clear="none"> If
the file is located in another location, you will need to configure the
<code>configurationUri</code> option on the <code>MyBatisComponent</code>
component.</p><h3 id="MyBatis-Options">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 colsp
an="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>Statements to run after consuming. Can be
used, for example, to update rows after they have been consumed and processed
in Camel. See sample later. Multiple statements can be separated with
commas.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>If <code>true</code> each row returned when
polling will be processed individually. If <code>false</cod
e> the entire <code>List</code> of data is set as the IN
body.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>Sets whether empty result sets should be
routed.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>statementType</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>StatementType</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Mandatory to specify for the
producer to control which kind of operation to invoke. The enum values are:
<code>SelectOne</code>, <code>SelectList</code>, <code>Insert</code>,
<code>InsertList</code>, <code>Update</code>, <code>Update
List</code>, <code>Delete</code>, and <code>DeleteList</code>.
<strong>Notice:</strong> <code>InsertList</code> is available as of Camel 2.10,
and <code>UpdateList</code>, <code>DeleteList</code> is available as of Camel
2.11.</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>This option is intended to split results
returned by the database pool into the batches and deliver them in multiple
exchanges. This integer defines the maximum messages to deliver in single
exchange. By default, no maximum is set. Can be used to set a limit of e.g.
1000 to avoid when starting up the server that there are thousands of files.
Set a value of 0 or negative to disable it.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>
<code>executorType</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> The executor type to be
used while executing statements. The supported values are: simple, reuse,
batch. By default, the value is not specified and is equal to what MyBatis
uses, i.e. <strong>simple</strong>. <br clear="none"
class="atl-forced-newline"> <strong>simple</strong> executor does nothing
special. <br clear="none" class="atl-forced-newline"> <strong>reuse</strong>
executor reuses prepared statements. <br clear="none"
class="atl-forced-newline"> <strong>batch</strong> executor reuses statements
and batches updates.</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" ro
wspan="1" class="confluenceTd"><code>null</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Camel 2.15:</strong><span
style="color: rgb(0,0,0);"> To store the result as a header instead of the
message body. This allows to preserve the existing message body
as-is.</span></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>inputHeader</code></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"><strong>Camel 2.15:  </strong>"inputHeader" parameter
to use a header value as input to the component instead of the
body.</td></tr></tbody></table></div></div><h3
id="MyBatis-MessageHeaders">Message Headers</h3><p>Camel will populate the
result message, either IN or OUT with a header with the statement used:</p><div
class="confluenceTableSmall"><div class="table-wrap"><table
class="confluenceTable"><tbody><tr>
<th colspan="1" rowspan="1" class="confluenceTh"><p>Header</p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p>Type</p></th><th colspan="1"
rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelMyBatisStatementName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The
<strong>statementName</strong> used (for example:
insertAccount).</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelMyBatisResult</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Object</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The <strong>response</strong> returned from
MtBatis in any of the operations. For instance an <code>INSERT</code> could
return the auto-generated key, or number of rows
etc.</p></td></tr></tbody></table></div></div><h3 id="MyBatis-MessageBody
">Message Body</h3><p>The response from MyBatis will only be set as the body
if it's a <code>SELECT</code> statement. That means, for example, for
<code>INSERT</code> statements Camel will not replace the body. This allows you
to continue routing and keep the original body. The response from MyBatis is
always stored in the header with the key
<code>CamelMyBatisResult</code>.</p><h3 id="MyBatis-Samples">Samples</h3><p>For
example if you wish to consume beans from a JMS queue and insert them into a
database you could do the following:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>Where <strong>statementName</strong> is the statement name in
the MyBatis XML mapping file which maps to the query, insert, update or delete
operation you wish to evaluate.</p><p>You can append query options to the URI
in the following format,
<code>?option=value&option=value&...</code></p><p>This component will
by default load the MyBatis SqlMapConfig file from the root of the classpath
with the expected name of <code>SqlMapConfig.xml</code>.<br clear="none"> If
the file is located in another location, you will need to configure the
<code>configurationUri</code> option on the <code>MyBatisComponent</code>
component.</p><h3 id="MyBatis-Options">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 colsp
an="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>Statements to run after consuming. Can be
used, for example, to update rows after they have been consumed and processed
in Camel. See sample later. Multiple statements can be separated with
commas.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>If <code>true</code> each row returned when
polling will be processed individually. If <code>false</cod
e> the entire <code>List</code> of data is set as the IN
body.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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>Sets whether empty result sets should be
routed.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>statementType</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>StatementType</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Mandatory to specify for the
producer to control which kind of operation to invoke. The enum values are:
<code>SelectOne</code>, <code>SelectList</code>, <code>Insert</code>,
<code>InsertList</code>, <code>Update</code>, <code>Update
List</code>, <code>Delete</code>, and <code>DeleteList</code>.
<strong>Notice:</strong> <code>InsertList</code> is available as of Camel 2.10,
and <code>UpdateList</code>, <code>DeleteList</code> is available as of Camel
2.11.</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>This option is intended to split results
returned by the database pool into the batches and deliver them in multiple
exchanges. This integer defines the maximum messages to deliver in single
exchange. By default, no maximum is set. Can be used to set a limit of e.g.
1000 to avoid when starting up the server that there are thousands of files.
Set a value of 0 or negative to disable it.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>
<code>executorType</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> The executor type to be
used while executing statements. The supported values are: simple, reuse,
batch. By default, the value is not specified and is equal to what MyBatis
uses, i.e. <strong>simple</strong>. <br clear="none"
class="atl-forced-newline"> <strong>simple</strong> executor does nothing
special. <br clear="none" class="atl-forced-newline"> <strong>reuse</strong>
executor reuses prepared statements. <br clear="none"
class="atl-forced-newline"> <strong>batch</strong> executor reuses statements
and batches updates.</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" ro
wspan="1" class="confluenceTd"><code>null</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Camel 2.15:</strong><span
style="color: rgb(0,0,0);"> To store the result as a header instead of the
message body. This allows to preserve the existing message body
as-is.</span></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>inputHeader</code></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"><strong>Camel 2.15:  </strong>"inputHeader" parameter
to use a header value as input to the component instead of the
body.</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"><stron
g>Camel 2.16.2:</strong><span> </span><strong>SQL consumer
only:</strong><span>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</span></td></tr></tbody></table></div></div><h3
id="MyBatis-MessageHeaders">Message Headers</h3><p>Camel will populate the
result message, either IN or OUT with a header with the statement used:</p><div
class="confluenceTableSmall"><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelMyBatisStatementName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Th
e <strong>statementName</strong> used (for example:
insertAccount).</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelMyBatisResult</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Object</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The <strong>response</strong> returned from
MtBatis in any of the operations. For instance an <code>INSERT</code> could
return the auto-generated key, or number of rows
etc.</p></td></tr></tbody></table></div></div><h3
id="MyBatis-MessageBody">Message Body</h3><p>The response from MyBatis will
only be set as the body if it's a <code>SELECT</code> statement. That means,
for example, for <code>INSERT</code> statements Camel will not replace the
body. This allows you to continue routing and keep the original body. The
response from MyBatis is always stored in the header with the key
<code>CamelMyBatisResult</code>.</p><h3 id="MyBatis-Samples">Samples</h3><p>For
example if you wish t
o consume beans from a JMS queue and insert them into a database you could do
the following:</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("activemq:queue:newAccount").
to("mybatis:insertAccount?statementType=Insert");
]]></script>
@@ -121,13 +121,13 @@ from("direct:start")
.to("mybatis:selectAccountById?statementType=SelectOne")
.to("mock:result");
]]></script>
-</div></div><p>In the code above we can invoke the MyBatis statement
<code>selectAccountById</code> and the IN body should contain the account id we
want to retrieve, such as an <code>Integer</code> type.</p><p>We can do the
same for some of the other operations, such as <code>SelectList</code>:</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+</div></div>In the code above we can invoke the MyBatis statement
<code>selectAccountById</code> and the IN body should contain the account id we
want to retrieve, such as an <code>Integer</code> type.<p>We can do the same
for some of the other operations, such as <code>SelectList</code>:</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("direct:start")
.to("mybatis:selectAllAccounts?statementType=SelectList")
.to("mock:result");
]]></script>
-</div></div><p>And the same for <code>UPDATE</code>, where we can send an
<code>Account</code> object as the IN body to MyBatis:</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div>And the same for <code>UPDATE</code>, where we can send an
<code>Account</code> object as the IN body to MyBatis:<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("direct:start")
.to("mybatis:updateAccount?statementType=Update")
@@ -150,7 +150,7 @@ from("direct:start")
)
</insert>
]]></script>
-</div></div><p>Then you can insert multiple rows, by sending a Camel message
to the <code>mybatis</code> endpoint which uses the <code>InsertList</code>
statement type, as shown below:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div>Then you can insert multiple rows, by sending a Camel message to
the <code>mybatis</code> endpoint which uses the <code>InsertList</code>
statement type, as shown below:<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("direct:start")
.to("mybatis:batchInsertAccount?statementType=InsertList")
@@ -202,7 +202,7 @@ from("direct:start")
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
from("mybatis:selectUnprocessedAccounts?consumer.onConsume=consumeAccount").to("mock:results");
]]></script>
-</div></div><p>And the statements in the sqlmap file:</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div>And the statements in the sqlmap file:<div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
<select id="selectUnprocessedAccounts"
resultMap="AccountResult">
select * from ACCOUNT where PROCESSED = false
Modified: websites/production/camel/content/sql-component.html
==============================================================================
--- websites/production/camel/content/sql-component.html (original)
+++ websites/production/camel/content/sql-component.html Sat Nov 21 11:22:39
2015
@@ -103,7 +103,7 @@
]]></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">
<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="SQLComponent-Options">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>bool
ean</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 instead.</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 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="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><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>consumer.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.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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.</p></td></tr><tr><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>consumer.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.</p></td></tr><tr><td colspan="1" rowspan="1" class="conflue
nceTd"><p><code>consumer.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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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 optio
n controls whether to break out of the batch or continue processing the next
row from the batch.</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" 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 single Java object in the following way:<br clea
r="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"
r
owspan="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><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 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"
>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 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></tbody></table></div></div><h3
>id="SQLComponent-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</cod
e>, 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
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="SQLComponent-Resultofthequery">Result of the query</h3><p>For
<code>select</code> operations, the result is an instance of <cod
e>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>You can append query options to the URI in the following format,
<code>?option=value&option=value&...</code></p><h3
id="SQLComponent-Options">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>bool
ean</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 instead.</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 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="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><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>consumer.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.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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.</p></td></tr><tr><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>consumer.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.</p></td></tr><tr><td colspan="1" rowspan="1" class="conflue
nceTd"><p><code>consumer.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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.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 optio
n controls whether to break out of the batch or continue processing the next
row from the batch.</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" 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 single Java object in the following way:<br clea
r="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"
r
owspan="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><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 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"
>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 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="SQLComponent-Treatmentofthemessagebody">Treatment of the message body</h
3><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 it
erator 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="SQLComponent-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">
<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>
