Modified: websites/production/camel/content/jdbc.html
==============================================================================
--- websites/production/camel/content/jdbc.html (original)
+++ websites/production/camel/content/jdbc.html Fri Jul 29 17:19:58 2016
@@ -97,7 +97,7 @@
</div></div><div class="confluence-information-macro
confluence-information-macro-warning"><span class="aui-icon aui-icon-small
aui-iconfont-error confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>This component can only be used to
define producer endpoints, which means that you cannot use the JDBC component
in a <code>from()</code> statement.</p></div></div><h3 id="JDBC-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[jdbc:dataSourceName[?options]
]]></script>
-</div></div><p>This component only supports producer endpoints.</p><p>You can
append query options to the URI in the following format,
<code>?option=value&option=value&...</code></p><h3
id="JDBC-Options">Options</h3><div class="confluenceTableSmall"><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>readSize</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The default maximum number of
rows that can be read by a polling query. The default value is
0.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>statement.<xxx></code></p></td><td
colspan="1" rowspan="1" class="c
onfluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.1:</strong> Sets additional options on
the <code>java.sql.Statement</code> that is used behind the scenes to execute
the queries. For instance, <code>statement.maxRows=10</code>. For detailed
documentation, see the <a shape="rect" class="external-link"
href="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/Statement.html";
rel="nofollow"><code>java.sql.Statement</code> javadoc</a>
documentation.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>useJDBC4ColumnNameAndLabelSemantics</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.2:</strong>
Sets whether to use JDBC 4/3 column label/name semantics. You can use this
option to turn it <code>false</code> in case you have issues with your JDBC
driver to select data. This only applies when using <c
ode>SQL SELECT</code> using aliases (e.g. <code>SQL SELECT id as identifier,
name as given_name from persons</code>).</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>resetAutoCommit</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.9:</strong> If
true, Camel will set the autoCommit on the JDBC connection to be false, commit
the change after executing the statement and reset the autoCommit flag of the
connection at the end. If the JDBC connection does not support resetting the
autoCommit flag, set this to false. <br clear="none">When used with XA
transactions you most likely need to set it to false so that the transaction
manager is in charge of committing this tx.</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>true</code></p></
td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel
2.12:</strong> Whether to allow using named parameters in the
queries.</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><strong>Camel 2.12:</strong> Allows to
plugin to use a custom
<code>org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy</code> to
control preparation of the query and prepared statement.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>useHeadersAsParameters</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:</strong>
Set this option to <code>true</code> to use the
<code>prepareStatementStrategy</code> with named parameters. This allows to
define queries with named plac
eholders, and use headers with the dynamic values for the query
placeholders.</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>SelectList</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.1:</strong>
<span>Make the output of consumer or producer.
</span><code>SelectList</code><span> will output a List of Map.
</span><code>SelectOne</code><span> will output single Java object in the
following way</span>:<br clear="none"> a) If the query has only single column,
then that JDBC Column object is returned. (such as SELECT COUNT( * ) FROM
PROJECT 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 outputClass 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 ass
ume your class has a default constructor to create instance with. From
<strong>Camel 2.14</strong> onwards then SelectList is also supported. <br
clear="none"> d) If the query resulted in more than one rows, it throws an
non-unique result exception.<br clear="none"> <strong>Camel 2.14.0:</strong>
New <code>StreamList</code> output type value that streams the result of the
query using an <code>Iterator<Map<String, Object>></code>, it can
be used along with the <a shape="rect" href="splitter.html">Splitter</a>
EIP.</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>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.1:</strong> Specify the
full package and class name to use as conversion when outputType=SelectOne.
From <strong>Camel 2.14</strong> onwards then SelectList is also
supported.</p></td></tr><tr><td colspan="1" rowspa
n="1" class="confluenceTd"><p><code>beanRowMapper</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.1:</strong> To use a
custom <code>org.apache.camel.component.jdbc.BeanRowMapper</code> when using
<code>outputClass</code>. The default implementation will lower case the row
names and skip underscores, and dashes. For example <code>"CUST_ID"</code> is
mapped as <code>"custId"</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>useGetBytesForBlob</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> To read BLOB
columns as bytes instead of string data. This may be needed for certain
databases such as Oracle where you must read BLOB columns as
bytes.</td></tr></tbody></table></div></div><h3
id="JDBC-Result">Result</h3><p>By default the result is return
ed in the OUT body as an <code>ArrayList<HashMap<String,
Object>></code>. The <code>List</code> object contains the list of rows
and the <code>Map</code> objects contain each row with the <code>String</code>
key as the column name. You can use the option <code>outputType</code> to
control the result.</p><p><strong>Note:</strong> This component fetches
<code>ResultSetMetaData</code> to be able to return the column name as the key
in the <code>Map</code>.</p><h4 id="JDBC-MessageHeaders">Message
Headers</h4><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>CamelJdbcRowCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>If the query is a
<code>SELECT</code>, query the row count is returned in this OUT
header.</p></td></tr><tr><td colspa
n="1" rowspan="1"
class="confluenceTd"><p><code>CamelJdbcUpdateCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>If the query is an
<code>UPDATE</code>, query the update count is returned in this OUT
header.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelGeneratedKeysRows</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.10:</strong>
Rows that contains the generated kets.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelGeneratedKeysRowCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.10:</strong>
The number of rows in the header that contains generated
keys.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelJdbcColumnNames</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.1:</strong>
The column names from the ResultSet as a <code>java.util.Set</code> type.</p><
/td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelJdbcParametes</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong> A
<code>java.util.Map</code> which has the headers to be used if
<code>useHeadersAsParameters</code> has been
enabled.</p></td></tr></tbody></table></div><h3
id="JDBC-Generatedkeys">Generated keys</h3><p><strong>Available as of Camel
2.10</strong></p><p>If you insert data using SQL INSERT, then the RDBMS may
support auto generated keys. You can instruct the <a shape="rect"
href="jdbc.html">JDBC</a> producer to return the generated keys in headers.<br
clear="none"> To do that set the header
<code>CamelRetrieveGeneratedKeys=true</code>. Then the generated keys will be
provided as headers with the keys listed in the table above.</p><p>You can see
more details in this <a shape="rect" class="external-link"
href="https://svn.apache.org/repos/asf/camel/trunk/components/camel-jdbc/src/test/java/org/apache/ca
mel/component/jdbc/JdbcGeneratedKeysTest.java">unit test</a>.</p><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>Using generated keys does not work
with together with named parameters.</p></div></div><h3
id="JDBC-Usingnamedparameters">Using named parameters</h3><p><strong>Available
as of Camel 2.12</strong></p><p>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.<br clear="none"> Camel will then lookup these
parameters from the 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>This component only supports producer endpoints.</p><p>You can
append query options to the URI in the following format,
<code>?option=value&option=value&...</code></p><h3
id="JDBC-Options">Options</h3><div class="confluenceTableSmall"><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>readSize</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The default maximum number of
rows that can be read by a polling query. The default value is
0.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>statement.<xxx></code></p></td><td
colspan="1" rowspan="1" class="c
onfluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.1:</strong> Sets additional options on
the <code>java.sql.Statement</code> that is used behind the scenes to execute
the queries. For instance, <code>statement.maxRows=10</code>. For detailed
documentation, see the <a shape="rect" class="external-link"
href="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/Statement.html";
rel="nofollow"><code>java.sql.Statement</code> javadoc</a>
documentation.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>useJDBC4ColumnNameAndLabelSemantics</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.2:</strong>
Sets whether to use JDBC 4/3 column label/name semantics. You can use this
option to turn it <code>false</code> in case you have issues with your JDBC
driver to select data. This only applies when using <c
ode>SQL SELECT</code> using aliases (e.g. <code>SQL SELECT id as identifier,
name as given_name from persons</code>).</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>resetAutoCommit</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.9:</strong> If
true, Camel will set the autoCommit on the JDBC connection to be false, commit
the change after executing the statement and reset the autoCommit flag of the
connection at the end. If the JDBC connection does not support resetting the
autoCommit flag, set this to false. <br clear="none">When used with XA
transactions you most likely need to set it to false so that the transaction
manager is in charge of committing this tx.</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>true</code></p></
td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel
2.12:</strong> Whether to allow using named parameters in the
queries.</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><strong>Camel 2.12:</strong> Allows to
plugin to use a custom
<code>org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy</code> to
control preparation of the query and prepared statement.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>useHeadersAsParameters</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:</strong>
Set this option to <code>true</code> to use the
<code>prepareStatementStrategy</code> with named parameters. This allows to
define queries with named plac
eholders, and use headers with the dynamic values for the query
placeholders.</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>SelectList</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.1:</strong>
<span>outputType='SelectList', for consumer or producer, w</span><span>ill
output a List of Map. </span><code>SelectOne</code><span> will output single
Java object in the following way</span>:<br clear="none"> a) If the query has
only single column, then that JDBC Column object is returned. (such as SELECT
COUNT( * ) FROM PROJECT 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 outputClass 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. From <strong>Camel
2.14</strong> onwards then SelectList is also supported. <br clear="none"> d)
If the query resulted in more than one rows, it throws an non-unique result
exception.<br clear="none"> <strong>Camel 2.14.0:</strong> New
<code>StreamList</code> output type value that streams the result of the query
using an <code>Iterator<Map<String, Object>></code>, it can be used
along with the <a shape="rect" href="splitter.html">Splitter</a>
EIP.</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>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.1:</strong> Specify the
full package and class name to use as conversion when outputType=SelectOne.
From <strong>Camel 2.14</strong> onwards then SelectList is also
supported.</p></td></tr><tr><td colspan="1" rowspan="1" class="c
onfluenceTd"><p><code>beanRowMapper</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.12.1:</strong> To use a custom
<code>org.apache.camel.component.jdbc.BeanRowMapper</code> when using
<code>outputClass</code>. The default implementation will lower case the row
names and skip underscores, and dashes. For example <code>"CUST_ID"</code> is
mapped as <code>"custId"</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>useGetBytesForBlob</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> To read BLOB
columns as bytes instead of string data. This may be needed for certain
databases such as Oracle where you must read BLOB columns as
bytes.</td></tr></tbody></table></div></div><h3
id="JDBC-Result">Result</h3><p>By default the result is returned in the OUT
body as an <code>ArrayList<HashMap<String, Object>></code>. The
<code>List</code> object contains the list of rows and the <code>Map</code>
objects contain each row with the <code>String</code> key as the column name.
You can use the option <code>outputType</code> to control the
result.</p><p><strong>Note:</strong> This component fetches
<code>ResultSetMetaData</code> to be able to return the column name as the key
in the <code>Map</code>.</p><h4 id="JDBC-MessageHeaders">Message
Headers</h4><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>CamelJdbcRowCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>If the query is a
<code>SELECT</code>, query the row count is returned in this OUT
header.</p></td></tr><tr><td colspan="1" rowspan=
"1" class="confluenceTd"><p><code>CamelJdbcUpdateCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>If the query is an
<code>UPDATE</code>, query the update count is returned in this OUT
header.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelGeneratedKeysRows</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.10:</strong>
Rows that contains the generated kets.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelGeneratedKeysRowCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.10:</strong>
The number of rows in the header that contains generated
keys.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelJdbcColumnNames</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.1:</strong>
The column names from the ResultSet as a <code>java.util.Set</code>
type.</p></td></tr><tr><
td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelJdbcParametes</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong> A
<code>java.util.Map</code> which has the headers to be used if
<code>useHeadersAsParameters</code> has been
enabled.</p></td></tr></tbody></table></div><h3
id="JDBC-Generatedkeys">Generated keys</h3><p><strong>Available as of Camel
2.10</strong></p><p>If you insert data using SQL INSERT, then the RDBMS may
support auto generated keys. You can instruct the <a shape="rect"
href="jdbc.html">JDBC</a> producer to return the generated keys in headers.<br
clear="none"> To do that set the header
<code>CamelRetrieveGeneratedKeys=true</code>. Then the generated keys will be
provided as headers with the keys listed in the table above.</p><p>You can see
more details in this <a shape="rect" class="external-link"
href="https://svn.apache.org/repos/asf/camel/trunk/components/camel-jdbc/src/test/java/org/apache/camel/component/
jdbc/JdbcGeneratedKeysTest.java">unit test</a>.</p><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>Using generated keys does not work
with together with named parameters.</p></div></div><h3
id="JDBC-Usingnamedparameters">Using named parameters</h3><p><strong>Available
as of Camel 2.12</strong></p><p>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.<br clear="none"> Camel will then lookup these
parameters from the 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/sql-component.html
==============================================================================
--- websites/production/camel/content/sql-component.html (original)
+++ websites/production/camel/content/sql-component.html Fri Jul 29 17:19:58
2016
@@ -113,7 +113,7 @@ where
id = :#${property.myId}
order by
name]]></script>
-</div></div><p>In the file you can use multilines and format the SQL as you
wish. And also use comments such as the – dash line.</p><p>You can
append query options to the URI in the following format,
<code>?option=value&option=value&...</code></p><h3
id="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>boolean</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.7
.5, 2.8.4 and 2.9:</strong> Execute SQL batch update statements. See notes
below on how the treatment of the inbound message body changes if this is set
to <code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>dataSourceRef</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in
Camel 3.0:</strong> Reference to a <code>DataSource</code> to look up in the
registry. Use <code>dataSource=#theName</code> instead.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>dataSource</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</s
trong> Reference to a <code>DataSource</code> to look up in the
registry.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>placeholder</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>#</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.4:</strong> Specifies a
character that will be replaced to <code>?</code> in SQL query. Notice, that it
is simple <code>String.replaceAll()</code> operation and no SQL parsing is
involved (quoted strings will also change). This replacement is
<strong>only</strong> happening if the endpoint is created using the
<code>SqlComponent</code>. If you manually create the endpoint, then use the
expected <code>?</code> sign instead.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><code>usePlaceholder</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>boolean</code></td
><td colspan="1" rowspan="1" class="confluenceTd"><code>true</code></td><td
>colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong>
>Sets whether to use placeholder and replace all placeholder characters with ?
>sign in the SQL queries.</td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>template.<xxx></code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p>Sets additional options on
>the Spring <code>JdbcTemplate</code> that is used behind the scenes to
>execute the queries. For instance, <code>template.maxRows=10</code>. For
>detailed documentation, see the <a shape="rect" class="external-link"
>href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html";
> rel="nofollow">JdbcTemplate javadoc</a> documentation.</p></td></tr><tr><td
>colspan="1"
rowspan="1"
class="confluenceTd"><p><code>allowNamedParameters</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Whether to
allow using named parameters in the queries.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>processingStrategy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
only:</strong> Allows to plugin to use a custom
<code>org.apache.camel.component.sql.SqlProcessingStrategy</code> to execute
queries when the consumer has processed the rows/batch.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>prepareStatementStrate
gy</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>useIterator</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
><strong>SQL consumer only:</strong> If <code>true</code> each row returned
>when polling will be processed individually. If <code>false</code> the entire
><code>java.util.List</code> of data is set as the IN body.<span> Notice in
>Camel 2.15.x o
r older you need to prefix this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>routeEmptyResultSet</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> Whether to route a single empty <a shape="rect"
href="exchange.html">Exchange</a> if there was no data to poll.<span> Notice in
Camel 2.15.x or older you need to prefix this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>onConsume</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1
" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
only:</strong> After processing each row then this query can be executed, if
the <a shape="rect" href="exchange.html">Exchange</a> was processed
successfully, for example to mark the row as processed. The query can have
parameter.<span> Notice in Camel 2.15.x or older you need to prefix this option
with consumer., eg consumer.useIterator=true.</span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>onConsumeFailed</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> After processing each row then this query can be
executed, if the <a shape="rect" href="exchange.html">Exchange</a> failed, for
example to mark the row as failed. The query can have param
eter.<span> Notice in Camel 2.15.x or older you need to prefix this option
with consumer., eg consumer.useIterator=true.</span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>onConsumeBatchComplete</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
<strong>SQL consumer only:</strong> After processing the entire batch, this
query can be executed to bulk update rows etc. The query cannot have
parameters.<span> Notice in Camel 2.15.x or older you need to prefix this
option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>expectedUpdateCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p
><code>-1</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
>only:</strong> If using <code>consumer.onConsume</code> then this option can
>be used to set an expected number of rows being updated. Typically you may
>set this to <code>1</code> to expect one row to be updated.<span> Notice in
>Camel 2.15.x or older you need to prefix this option with consumer., eg
>consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1"
>rowspan="1"
>class="confluenceTd"><p><code>breakBatchOnConsumeFail</code></p></td><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
><strong>SQL consumer only:</strong> If using <code>consumer.onConsume</code>
>and it fails, then this option controls whether to break out of the batch or
>continue processing the nex
t row from the batch. Notice in Camel 2.15.x or older you need to prefix this
option with consumer., eg consumer.useIterator=true.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>alwaysPopulateStatement</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
producer only:</strong> If enabled then the <code>populateStatement</code>
method from
<code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> is
always invoked, also if there is no expected parameters to be prepared. When
this is <code>false</code> then the <code>populateStatement</code> is only
invoked if there is 1 or more expected parameters to be set; for example this
avoids reading the message body/headers for SQL queries with no
parameters.</p></td></tr><tr><td colspan="1
" rowspan="1" class="confluenceTd"><p><code>separator</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>char</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>,</code></p></td><td
colspan="1" 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. <code>SelectList</code> will output a
List of Map. <code>SelectOne</code> will output
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>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><p>From <strong>Camel 2.18</strong> onwards there is a new
StreamList outputType that streams the result of the query using an Iterator.
It can be
used with the <a shape="rect" href="splitter.html">Splitter</a> EIP in
streaming mode to process the ResultSet in streaming fashion. This StreamList
do not support batch mode, but you can use outputClass to map each row to a
class.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>outputClass</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong> Specify the
full package and class name to use as conversion when
<code>outputType=SelectOne</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>outputHeader</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>String</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.15:</s
trong> 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" cl
ass="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="conflue
nceTd"><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</h3><p>The SQL component tries to convert the message body to an object of
<code>java.util.Iterator</code> type and then uses this iterator to fill the
query parameters (where each query parameter is represented by a <code>#</code>
symbol (or configured placeholder) in the endpoint URI). If the message body is
not an array or collection, the conversion results in an iterator that iterates
over only one object, which is the body itself.</p><p>For example, if the
message body is an instance of <code>java.util.List</code>, the first item in
the list is substituted
into the first occurrence of <code>#</code> in the SQL query, the second item
in the list is substituted into the second occurrence of <code>#</code>, and so
on.</p><p>If <code>batch</code> is set to <code>true</code>, then the
interpretation of the inbound message body changes slightly – instead of
an iterator of parameters, the component expects an iterator that contains the
parameter iterators; the size of the outer iterator determines the batch
size.</p><p>From Camel 2.16 onwards you can use the
option <span>useMessageBodyForSql that allows to use the message body as
the SQL statement, and then the SQL 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">
+</div></div><p>In the file you can use multilines and format the SQL as you
wish. And also use comments such as the – dash line.</p><p>You can
append query options to the URI in the following format,
<code>?option=value&option=value&...</code></p><h3
id="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>boolean</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.7
.5, 2.8.4 and 2.9:</strong> Execute SQL batch update statements. See notes
below on how the treatment of the inbound message body changes if this is set
to <code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>dataSourceRef</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in
Camel 3.0:</strong> Reference to a <code>DataSource</code> to look up in the
registry. Use <code>dataSource=#theName</code> instead.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>dataSource</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</s
trong> Reference to a <code>DataSource</code> to look up in the
registry.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>placeholder</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>#</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.4:</strong> Specifies a
character that will be replaced to <code>?</code> in SQL query. Notice, that it
is simple <code>String.replaceAll()</code> operation and no SQL parsing is
involved (quoted strings will also change). This replacement is
<strong>only</strong> happening if the endpoint is created using the
<code>SqlComponent</code>. If you manually create the endpoint, then use the
expected <code>?</code> sign instead.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><code>usePlaceholder</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>boolean</code></td
><td colspan="1" rowspan="1" class="confluenceTd"><code>true</code></td><td
>colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong>
>Sets whether to use placeholder and replace all placeholder characters with ?
>sign in the SQL queries.</td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>template.<xxx></code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p>Sets additional options on
>the Spring <code>JdbcTemplate</code> that is used behind the scenes to
>execute the queries. For instance, <code>template.maxRows=10</code>. For
>detailed documentation, see the <a shape="rect" class="external-link"
>href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html";
> rel="nofollow">JdbcTemplate javadoc</a> documentation.</p></td></tr><tr><td
>colspan="1"
rowspan="1"
class="confluenceTd"><p><code>allowNamedParameters</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Whether to
allow using named parameters in the queries.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>processingStrategy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
only:</strong> Allows to plugin to use a custom
<code>org.apache.camel.component.sql.SqlProcessingStrategy</code> to execute
queries when the consumer has processed the rows/batch.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>prepareStatementStrate
gy</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>useIterator</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
><strong>SQL consumer only:</strong> If <code>true</code> each row returned
>when polling will be processed individually. If <code>false</code> the entire
><code>java.util.List</code> of data is set as the IN body.<span> Notice in
>Camel 2.15.x o
r older you need to prefix this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>routeEmptyResultSet</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> Whether to route a single empty <a shape="rect"
href="exchange.html">Exchange</a> if there was no data to poll.<span> Notice in
Camel 2.15.x or older you need to prefix this option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>onConsume</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1
" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
only:</strong> After processing each row then this query can be executed, if
the <a shape="rect" href="exchange.html">Exchange</a> was processed
successfully, for example to mark the row as processed. The query can have
parameter.<span> Notice in Camel 2.15.x or older you need to prefix this option
with consumer., eg consumer.useIterator=true.</span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>onConsumeFailed</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> After processing each row then this query can be
executed, if the <a shape="rect" href="exchange.html">Exchange</a> failed, for
example to mark the row as failed. The query can have param
eter.<span> Notice in Camel 2.15.x or older you need to prefix this option
with consumer., eg consumer.useIterator=true.</span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>onConsumeBatchComplete</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
<strong>SQL consumer only:</strong> After processing the entire batch, this
query can be executed to bulk update rows etc. The query cannot have
parameters.<span> Notice in Camel 2.15.x or older you need to prefix this
option with consumer., eg
consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>expectedUpdateCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p
><code>-1</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
>only:</strong> If using <code>consumer.onConsume</code> then this option can
>be used to set an expected number of rows being updated. Typically you may
>set this to <code>1</code> to expect one row to be updated.<span> Notice in
>Camel 2.15.x or older you need to prefix this option with consumer., eg
>consumer.useIterator=true.</span></p></td></tr><tr><td colspan="1"
>rowspan="1"
>class="confluenceTd"><p><code>breakBatchOnConsumeFail</code></p></td><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
><strong>SQL consumer only:</strong> If using <code>consumer.onConsume</code>
>and it fails, then this option controls whether to break out of the batch or
>continue processing the nex
t row from the batch. Notice in Camel 2.15.x or older you need to prefix this
option with consumer., eg consumer.useIterator=true.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>alwaysPopulateStatement</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
producer only:</strong> If enabled then the <code>populateStatement</code>
method from
<code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> is
always invoked, also if there is no expected parameters to be prepared. When
this is <code>false</code> then the <code>populateStatement</code> is only
invoked if there is 1 or more expected parameters to be set; for example this
avoids reading the message body/headers for SQL queries with no
parameters.</p></td></tr><tr><td colspan="1
" rowspan="1" class="confluenceTd"><p><code>separator</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>char</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>,</code></p></td><td
colspan="1" 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>
<span>outputType='SelectList', for consumer or producer, w</span><span>ill
output a List of Map</span>. <code>SelectOne</code>
will output 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>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><p>From <strong>Camel 2.18</strong> onwards
there is a new StreamList outputType that streams the result of the query using
an Iterator
. It can be used with the <a shape="rect" href="splitter.html">Splitter</a>
EIP in streaming mode to process the ResultSet in streaming fashion. This
StreamList do not support batch mode, but you can use outputClass to map each
row to a class.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>outputClass</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong> Specify the
full package and class name to use as conversion when
<code>outputType=SelectOne</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>outputHeader</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>String</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Ca
mel 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"
ro
wspan="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" cl
ass="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</h3><p>The SQL component tries to convert the message body to an object of
<code>java.util.Iterator</code> type and then uses this iterator to fill the
query parameters (where each query parameter is represented by a <code>#</code>
symbol (or configured placeholder) in the endpoint URI). If the message body is
not an array or collection, the conversion results in an iterator that iterates
over only one object, which is the body itself.</p><p>For example, if the
message body is an instance of <code>java.util.List</code>, the first item in
the list is
substituted into the first occurrence of <code>#</code> in the SQL query, the
second item in the list is substituted into the second occurrence of
<code>#</code>, and so on.</p><p>If <code>batch</code> is set to
<code>true</code>, then the interpretation of the inbound message body changes
slightly – instead of an iterator of parameters, the component expects an
iterator that contains the parameter iterators; the size of the outer iterator
determines the batch size.</p><p>From Camel 2.16 onwards you can use the
option <span>useMessageBodyForSql that allows to use the message body as
the SQL statement, and then the SQL 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>
