Author: buildbot
Date: Fri Mar 22 22:26:52 2013
New Revision: 855622
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/book-component-appendix.html
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 Mar 22
22:26:52 2013
@@ -16622,7 +16622,7 @@ sql:select * from table where id=:#myId
<h3><a shape="rect" name="BookComponentAppendix-Options"></a>Options</h3>
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Option </th><th colspan="1" rowspan="1"
class="confluenceTh"> Type </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>batch</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.7.5, 2.8.4 and 2.9:</b> Execute SQL batch
update statements. See notes below on how the treatment of the inbound message
body changes if this is set to <tt>true</tt>. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>dataSourceRef</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>String</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1
" rowspan="1" class="confluenceTd"> Reference to a <tt>DataSource</tt> to look
up in the registry. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>placeholder</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>String</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>#</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.4:</b> Specifies a character that will be
replaced to <tt>?</tt> in SQL query. Notice, that it is simple
<tt>String.replaceAll()</tt> operation and no SQL parsing is involved (quoted
strings will also change). This replacement is <b>only</b> happening if the
endpoint is created using the <tt>SqlComponent</tt>. If you manually create the
endpoint, then use the expected <tt>?</tt> sign instead. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>template.<xxx></tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd
"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Sets
additional options on the Spring <tt>JdbcTemplate</tt> that is used behind the
scenes to execute the queries. For instance, <tt>template.maxRows=10</tt>. 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. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>allowNamedParameters</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>boolean</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> Whether to
allow using named parameters in the queries. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>processingStrategy</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <
/td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL
consumer only:</b> Allows to plugin to use a custom
<tt>org.apache.camel.component.sql.SqlProcessingStrategy</tt> to execute
queries when the consumer has processed the rows/batch. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>prepareStatementStrategy</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> Allows to plugin to use a
custom <tt>org.apache.camel.component.sql.SqlPrepareStatementStrategy</tt> to
control preparation of the query and prepared statement. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.delay</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>long</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt
>500</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel
>2.11:</b> <b>SQL consumer only:</b> Delay in milliseconds between each poll.
></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
><tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1"
>class="confluenceTd"> <tt>long</tt> </td><td colspan="1" rowspan="1"
>class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1"
>class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b>
>Milliseconds before polling starts. </td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"> <tt>consumer.useFixedDelay</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer
>only:</b> Set to <tt>true</tt> 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.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>int</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> An integer
value to define the maximum number of messages to gather per poll. By default,
no maximum is set. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.useIterator</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b>
If <tt>true</tt> each row returned when polling will be proce
ssed individually. If <tt>false</tt> the entire <tt>java.util.List</tt> of
data is set as the IN body. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.routeEmptyResultSet</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL
consumer only:</b> Whether to route a single empty <a shape="rect"
href="exchange.html" title="Exchange">Exchange</a> if there was no data to
poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.onConsume</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>String</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> After
processing each row then this query can be executed, if the <a shape="rect
" href="exchange.html" title="Exchange">Exchange</a> was processed
successfully, for example to mark the row as processed. The query can have
parameter. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.onConsumeFailed</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>String</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> After
processing each row then this query can be executed, if the <a shape="rect"
href="exchange.html" title="Exchange">Exchange</a> failed, for example to mark
the row as failed. The query can have parameter. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.onConsumeBatchComplete</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>String</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="c
onfluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> After processing
the entire batch, this query can be executed to bulk update rows etc. The query
cannot have parameters. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.expectedUpdateCount</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>int</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> If using
<tt>consumer.onConsume</tt> then this option can be used to set an expected
number of rows being updated. Typically you may set this to <tt>1</tt> to
expect one row to be updated. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.breakBatchOnConsumeFail</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td
colspan="1" rowspan="1" c
lass="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> If using
<tt>consumer.onConsume</tt> and it fails, then this option controls whether to
break out of the batch or continue processing the next row from the batch.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>alwaysPopulateStatement</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL producer only:</b> If enabled
then the <tt>populateStatement</tt> method from
<tt>org.apache.camel.component.sql.SqlPrepareStatementStrategy</tt> is always
invoked, also if there is no expected parameters to be prepared. When this is
<tt>false</tt> then the <tt>populateStatement</tt> 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 para
meters. </td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Option </th><th colspan="1" rowspan="1"
class="confluenceTh"> Type </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>batch</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.7.5, 2.8.4 and 2.9:</b> Execute SQL batch
update statements. See notes below on how the treatment of the inbound message
body changes if this is set to <tt>true</tt>. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>dataSourceRef</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>String</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1
" rowspan="1" class="confluenceTd"> <b>Deprecated and will be removed in Camel
3.0:</b> Reference to a <tt>DataSource</tt> to look up in the registry.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>dataSource</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>String</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel
2.11:</b> Reference to a <tt>DataSource</tt> to look up in the registry.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>placeholder</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>String</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>#</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel
2.4:</b> Specifies a character that will be replaced to <tt>?</tt> in SQL
query. Notice, that it is simple <tt>String.replaceAll()</tt> operation and no
SQL parsing is involved (quoted string
s will also change). This replacement is <b>only</b> happening if the endpoint
is created using the <tt>SqlComponent</tt>. If you manually create the
endpoint, then use the expected <tt>?</tt> sign instead. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>template.<xxx></tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> Sets additional options on the
Spring <tt>JdbcTemplate</tt> that is used behind the scenes to execute the
queries. For instance, <tt>template.maxRows=10</tt>. 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. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>allowNamedParameters</tt>
</td><td co
lspan="1" rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> Whether to
allow using named parameters in the queries. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>processingStrategy</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> Allows to
plugin to use a custom
<tt>org.apache.camel.component.sql.SqlProcessingStrategy</tt> to execute
queries when the consumer has processed the rows/batch. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>prepareStatementStrategy</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" clas
s="confluenceTd"> <b>Camel 2.11:</b> Allows to plugin to use a custom
<tt>org.apache.camel.component.sql.SqlPrepareStatementStrategy</tt> to control
preparation of the query and prepared statement. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>long</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>500</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> Delay in
milliseconds between each poll. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.initialDelay</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>long</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b>
Milliseconds before polling starts. </td></tr><tr><td colspan="1" rowspan="1"
class="conflue
nceTd"> <tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> Set to
<tt>true</tt> 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.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>int</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> An integer
value to define the maximum number of messages to gather per poll. By default,
no
maximum is set. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.useIterator</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b>
If <tt>true</tt> each row returned when polling will be processed individually.
If <tt>false</tt> the entire <tt>java.util.List</tt> of data is set as the IN
body. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.routeEmptyResultSet</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> Whether to
route a single empty <a shape="rect" href="exchange.html"
title="Exchange">Exchange</a> if there was no data to poll.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.onConsume</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>String</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> After
processing each row then this query can be executed, if the <a shape="rect"
href="exchange.html" title="Exchange">Exchange</a> was processed successfully,
for example to mark the row as processed. The query can have parameter.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.onConsumeFailed</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>String</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> After
processing each row then this query can be executed, if the <a shape="rect" hr
ef="exchange.html" title="Exchange">Exchange</a> failed, for example to mark
the row as failed. The query can have parameter. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.onConsumeBatchComplete</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>String</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL
consumer only:</b> After processing the entire batch, this query can be
executed to bulk update rows etc. The query cannot have parameters.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.expectedUpdateCount</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>int</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> If using
<tt>consumer.onConsume</tt> then this option can
be used to set an expected number of rows being updated. Typically you may set
this to <tt>1</tt> to expect one row to be updated. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.breakBatchOnConsumeFail</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> If using
<tt>consumer.onConsume</tt> and it fails, then this option controls whether to
break out of the batch or continue processing the next row from the batch.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>alwaysPopulateStatement</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL producer only:</b> If enab
led then the <tt>populateStatement</tt> method from
<tt>org.apache.camel.component.sql.SqlPrepareStatementStrategy</tt> is always
invoked, also if there is no expected parameters to be prepared. When this is
<tt>false</tt> then the <tt>populateStatement</tt> 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.
</td></tr></tbody></table>
</div>
</div>
Modified: websites/production/camel/content/sql-component.html
==============================================================================
--- websites/production/camel/content/sql-component.html (original)
+++ websites/production/camel/content/sql-component.html Fri Mar 22 22:26:52
2013
@@ -132,7 +132,7 @@ sql:select * from table where id=:#myId
<h3><a shape="rect" name="SQLComponent-Options"></a>Options</h3>
<div class="confluenceTableSmall"><div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Option </th><th colspan="1" rowspan="1"
class="confluenceTh"> Type </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>batch</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.7.5, 2.8.4 and 2.9:</b> Execute SQL batch
update statements. See notes below on how the treatment of the inbound message
body changes if this is set to <tt>true</tt>. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>dataSourceRef</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>String</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1
" rowspan="1" class="confluenceTd"> Reference to a <tt>DataSource</tt> to look
up in the registry. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>placeholder</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>String</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>#</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.4:</b> Specifies a character that will be
replaced to <tt>?</tt> in SQL query. Notice, that it is simple
<tt>String.replaceAll()</tt> operation and no SQL parsing is involved (quoted
strings will also change). This replacement is <b>only</b> happening if the
endpoint is created using the <tt>SqlComponent</tt>. If you manually create the
endpoint, then use the expected <tt>?</tt> sign instead. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>template.<xxx></tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd
"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Sets
additional options on the Spring <tt>JdbcTemplate</tt> that is used behind the
scenes to execute the queries. For instance, <tt>template.maxRows=10</tt>. 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. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>allowNamedParameters</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>boolean</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> Whether to
allow using named parameters in the queries. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>processingStrategy</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <
/td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL
consumer only:</b> Allows to plugin to use a custom
<tt>org.apache.camel.component.sql.SqlProcessingStrategy</tt> to execute
queries when the consumer has processed the rows/batch. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>prepareStatementStrategy</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> Allows to plugin to use a
custom <tt>org.apache.camel.component.sql.SqlPrepareStatementStrategy</tt> to
control preparation of the query and prepared statement. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.delay</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>long</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt
>500</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel
>2.11:</b> <b>SQL consumer only:</b> Delay in milliseconds between each poll.
></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
><tt>consumer.initialDelay</tt> </td><td colspan="1" rowspan="1"
>class="confluenceTd"> <tt>long</tt> </td><td colspan="1" rowspan="1"
>class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1"
>class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b>
>Milliseconds before polling starts. </td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"> <tt>consumer.useFixedDelay</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1"
>rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer
>only:</b> Set to <tt>true</tt> 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.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>int</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> An integer
value to define the maximum number of messages to gather per poll. By default,
no maximum is set. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.useIterator</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b>
If <tt>true</tt> each row returned when polling will be proce
ssed individually. If <tt>false</tt> the entire <tt>java.util.List</tt> of
data is set as the IN body. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.routeEmptyResultSet</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL
consumer only:</b> Whether to route a single empty <a shape="rect"
href="exchange.html" title="Exchange">Exchange</a> if there was no data to
poll. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.onConsume</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>String</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> After
processing each row then this query can be executed, if the <a shape="rect
" href="exchange.html" title="Exchange">Exchange</a> was processed
successfully, for example to mark the row as processed. The query can have
parameter. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.onConsumeFailed</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>String</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> After
processing each row then this query can be executed, if the <a shape="rect"
href="exchange.html" title="Exchange">Exchange</a> failed, for example to mark
the row as failed. The query can have parameter. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.onConsumeBatchComplete</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>String</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="c
onfluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> After processing
the entire batch, this query can be executed to bulk update rows etc. The query
cannot have parameters. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.expectedUpdateCount</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>int</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> If using
<tt>consumer.onConsume</tt> then this option can be used to set an expected
number of rows being updated. Typically you may set this to <tt>1</tt> to
expect one row to be updated. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.breakBatchOnConsumeFail</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td
colspan="1" rowspan="1" c
lass="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> If using
<tt>consumer.onConsume</tt> and it fails, then this option controls whether to
break out of the batch or continue processing the next row from the batch.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>alwaysPopulateStatement</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL producer only:</b> If enabled
then the <tt>populateStatement</tt> method from
<tt>org.apache.camel.component.sql.SqlPrepareStatementStrategy</tt> is always
invoked, also if there is no expected parameters to be prepared. When this is
<tt>false</tt> then the <tt>populateStatement</tt> 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 para
meters. </td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Option </th><th colspan="1" rowspan="1"
class="confluenceTh"> Type </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>batch</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.7.5, 2.8.4 and 2.9:</b> Execute SQL batch
update statements. See notes below on how the treatment of the inbound message
body changes if this is set to <tt>true</tt>. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>dataSourceRef</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>String</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1
" rowspan="1" class="confluenceTd"> <b>Deprecated and will be removed in Camel
3.0:</b> Reference to a <tt>DataSource</tt> to look up in the registry.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>dataSource</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>String</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel
2.11:</b> Reference to a <tt>DataSource</tt> to look up in the registry.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>placeholder</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>String</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>#</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel
2.4:</b> Specifies a character that will be replaced to <tt>?</tt> in SQL
query. Notice, that it is simple <tt>String.replaceAll()</tt> operation and no
SQL parsing is involved (quoted string
s will also change). This replacement is <b>only</b> happening if the endpoint
is created using the <tt>SqlComponent</tt>. If you manually create the
endpoint, then use the expected <tt>?</tt> sign instead. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>template.<xxx></tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> Sets additional options on the
Spring <tt>JdbcTemplate</tt> that is used behind the scenes to execute the
queries. For instance, <tt>template.maxRows=10</tt>. 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. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>allowNamedParameters</tt>
</td><td co
lspan="1" rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> Whether to
allow using named parameters in the queries. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>processingStrategy</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> Allows to
plugin to use a custom
<tt>org.apache.camel.component.sql.SqlProcessingStrategy</tt> to execute
queries when the consumer has processed the rows/batch. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>prepareStatementStrategy</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" clas
s="confluenceTd"> <b>Camel 2.11:</b> Allows to plugin to use a custom
<tt>org.apache.camel.component.sql.SqlPrepareStatementStrategy</tt> to control
preparation of the query and prepared statement. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.delay</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>long</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>500</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> Delay in
milliseconds between each poll. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.initialDelay</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>long</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b>
Milliseconds before polling starts. </td></tr><tr><td colspan="1" rowspan="1"
class="conflue
nceTd"> <tt>consumer.useFixedDelay</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> Set to
<tt>true</tt> 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.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>int</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> An integer
value to define the maximum number of messages to gather per poll. By default,
no
maximum is set. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>consumer.useIterator</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b>
If <tt>true</tt> each row returned when polling will be processed individually.
If <tt>false</tt> the entire <tt>java.util.List</tt> of data is set as the IN
body. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.routeEmptyResultSet</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> Whether to
route a single empty <a shape="rect" href="exchange.html"
title="Exchange">Exchange</a> if there was no data to poll.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.onConsume</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>String</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> After
processing each row then this query can be executed, if the <a shape="rect"
href="exchange.html" title="Exchange">Exchange</a> was processed successfully,
for example to mark the row as processed. The query can have parameter.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.onConsumeFailed</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>String</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> After
processing each row then this query can be executed, if the <a shape="rect" hr
ef="exchange.html" title="Exchange">Exchange</a> failed, for example to mark
the row as failed. The query can have parameter. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>consumer.onConsumeBatchComplete</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>String</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL
consumer only:</b> After processing the entire batch, this query can be
executed to bulk update rows etc. The query cannot have parameters.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.expectedUpdateCount</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>int</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> If using
<tt>consumer.onConsume</tt> then this option can
be used to set an expected number of rows being updated. Typically you may set
this to <tt>1</tt> to expect one row to be updated. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">
<tt>consumer.breakBatchOnConsumeFail</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL consumer only:</b> If using
<tt>consumer.onConsume</tt> and it fails, then this option controls whether to
break out of the batch or continue processing the next row from the batch.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">
<tt>alwaysPopulateStatement</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>boolean</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.11:</b> <b>SQL producer only:</b> If enab
led then the <tt>populateStatement</tt> method from
<tt>org.apache.camel.component.sql.SqlPrepareStatementStrategy</tt> is always
invoked, also if there is no expected parameters to be prepared. When this is
<tt>false</tt> then the <tt>populateStatement</tt> 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.
</td></tr></tbody></table>
</div>
</div>
