Modified: websites/production/camel/content/sql-component.html
==============================================================================
--- websites/production/camel/content/sql-component.html (original)
+++ websites/production/camel/content/sql-component.html Sun Jul 12 09:19:43
2015
@@ -88,48 +88,48 @@
<tr>
<td valign="top" width="100%">
<div class="wiki-content maincontent"><h2 id="SQLComponent-SQLComponent">SQL
Component</h2><p>The <strong>sql:</strong> component allows you to work with
databases using JDBC queries. The difference between this component and <a
shape="rect" href="jdbc.html">JDBC</a> component is that in case of SQL the
query is a property of the endpoint and it uses message payload as parameters
passed to the query.</p><p>This component uses
<code><strong>spring-jdbc</strong></code> behind the scenes for the actual SQL
handling.</p><p>Maven users will need to add the following dependency to their
<code>pom.xml</code> for this component:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"><dependency>
+<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-sql</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
-</pre>
+]]></script>
</div></div><p>The SQL component also supports:</p><ul class="alternate"><li>a
JDBC based repository for the <a shape="rect"
href="idempotent-consumer.html">Idempotent Consumer</a> EIP pattern. See
further below.</li><li>a JDBC based repository for the <a shape="rect"
href="aggregator2.html">Aggregator</a> EIP pattern. See further
below.</li></ul><h3 id="SQLComponent-URIformat">URI format</h3><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>From Camel 2.11 onwards this
component can create both consumer (e.g. <code>from()</code>) and producer
endpoints (e.g. <code>to()</code>).</p><p>In previous versions, it could only
act as a producer.</p></div></div><div class="confluence-information-macro
confluence-information-macro-information"><span class="aui-icon aui-icon-small
aui-iconfont-info confluence-informati
on-macro-icon"></span><div class="confluence-information-macro-body"><p>This
component can be used as a <a shape="rect" class="external-link"
href="http://camel.apache.org/transactional-client.html";>Transactional
Client</a>.</p></div></div><p>The SQL component uses the following endpoint URI
notation:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">sql:select * from table where id=# order by
name[?options]
-</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[sql:select * from table where id=# order by
name[?options]
+]]></script>
</div></div><p>From Camel 2.11 onwards you can use named parameters by using
:<code>#name_of_the_parameter</code> style as shown:</p><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">sql:select * from table where id=:#myId order by
name[?options]
-</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[sql:select * from table where id=:#myId order
by name[?options]
+]]></script>
</div></div><p>When using named parameters, Camel will lookup the names from,
in the given precedence:<br clear="none"> 1. from message body if its a
<code>java.util.Map</code><br clear="none"> 2. from message headers</p><p>If a
named parameter cannot be resolved, then an exception is thrown.</p><p>From
Camel 2.14 onward you can use Simple expressions as parameters as
shown:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">sql:select * from table where id=:#${property.myId}
order by name[?options]</pre>
-</div></div><p>Notice that the standard <code>?</code> symbol that denotes the
parameters to an SQL query is substituted with the <code>#</code> symbol,
because the <code>?</code> symbol is used to specify options for the endpoint.
The <code>?</code> symbol replacement can be configured on endpoint
basis.</p><p>You can append query options to the URI in the following format,
<code>?option=value&option=value&...</code></p><h3
id="SQLComponent-Options">Options</h3><div class="confluenceTableSmall"><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>batch</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>bool
ean</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.7.5, 2.8.4 and 2.9:</strong> Execute
SQL batch update statements. See notes below on how the treatment of the
inbound message body changes if this is set to
<code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>dataSourceRef</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in
Camel 3.0:</strong> Reference to a <code>DataSource</code> to look up in the
registry. Use <code>dataSource=#theName</code> instead.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>dataSource</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String<
/code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> Reference to a
<code>DataSource</code> to look up in the registry.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>placeholder</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>#</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.4:</strong> Specifies a
character that will be replaced to <code>?</code> in SQL query. Notice, that it
is simple <code>String.replaceAll()</code> operation and no SQL parsing is
involved (quoted strings will also change). This replacement is
<strong>only</strong> happening if the endpoint is created using the
<code>SqlComponent</code>. If you manually create the endpoint, then use the
expected <code>?</code> sign instead.</p><
/td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>template.<xxx></code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Sets additional options on the Spring
<code>JdbcTemplate</code> that is used behind the scenes to execute the
queries. For instance, <code>template.maxRows=10</code>. For detailed
documentation, see the <a shape="rect" class="external-link"
href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html";
rel="nofollow">JdbcTemplate javadoc</a> documentation.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>allowNamedParameters</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Whether to
allow using named parameters in the queries.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>processingStrategy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
only:</strong> Allows to plugin to use a custom
<code>org.apache.camel.component.sql.SqlProcessingStrategy</code> to execute
queries when the consumer has processed the rows/batch.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>prepareStatementStrategy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> Allows to plugin to
use a custom
<code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> to
control preparation of the query and prepared statement.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.delay</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>long</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>500</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> Delay in milliseconds between each
poll.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.initialDelay</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>long</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
<strong>SQL consumer only:</strong> Milliseconds before polling
starts.</p></td></tr>
<tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.useFixedDelay</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> Set to <code>true</code> to use fixed delay between
polls, otherwise fixed rate is used. See <a shape="rect" class="external-link"
href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html";
rel="nofollow">ScheduledExecutorService</a> in JDK for
details.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>maxMessagesPerPoll</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel
2.11:</strong> <strong>SQL consumer only:</strong> An integer value to define
the maximum number of messages to gather per poll. By default, no maximum is
set.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.useIterator</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> If <code>true</code> each row returned when polling
will be processed individually. If <code>false</code> the entire
<code>java.util.List</code> of data is set as the IN body.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.routeEmptyResultSet</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p>
</td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel
2.11:</strong> <strong>SQL consumer only:</strong> Whether to route a single
empty <a shape="rect" href="exchange.html">Exchange</a> if there was no data to
poll.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.onConsume</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> After processing each row then this query can be
executed, if the <a shape="rect" href="exchange.html">Exchange</a> was
processed successfully, for example to mark the row as processed. The query can
have parameter.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.onConsumeFailed</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"
><p><code>String</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
>only:</strong> After processing each row then this query can be executed, if
>the <a shape="rect" href="exchange.html">Exchange</a> failed, for example to
>mark the row as failed. The query can have parameter.</p></td></tr><tr><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>consumer.onConsumeBatchComplete</code></p></td><td
> colspan="1" rowspan="1"
>class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
>consumer only:</strong> After processing the entire batch, this query can be
>executed to bulk update rows etc. The query cannot have
>parameters.</p></td></tr><tr><td colspan="1" rowspan="1" class="conflue
nceTd"><p><code>consumer.expectedUpdateCount</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> If using <code>consumer.onConsume</code> then this
option can be used to set an expected number of rows being updated. Typically
you may set this to <code>1</code> to expect one row to be
updated.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.breakBatchOnConsumeFail</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> If using <code>consumer.onConsume</code> and it fails,
then this optio
n controls whether to break out of the batch or continue processing the next
row from the batch.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>alwaysPopulateStatement</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
producer only:</strong> If enabled then the <code>populateStatement</code>
method from
<code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> is
always invoked, also if there is no expected parameters to be prepared. When
this is <code>false</code> then the <code>populateStatement</code> is only
invoked if there is 1 or more expected parameters to be set; for example this
avoids reading the message body/headers for SQL queries with no
parameters.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"
><p><code>separator</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>char</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>,</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><strong>Camel 2.11.1:</strong> The separator to use
>when parameter values is taken from message body (if the body is a String
>type), to be inserted at # placeholders. Notice if you use named parameters,
>then a <code>Map</code> type is used instead.</p></td></tr><tr><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>outputType</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>SelectList</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong> Make the
>output of consumer or producer to <code>SelectList</code> as List of Map, or
><code>SelectOne</code> as single Java object in the following way:<br clea
r="none"> a) If the query has only single column, then that JDBC Column object
is returned. (such as <code>SELECT COUNT( * ) FROM PROJECT</code> will return a
Long object.<br clear="none"> b) If the query has more than one column, then it
will return a Map of that result.<br clear="none"> c) If the
<code>outputClass</code> is set, then it will convert the query result into an
Java bean object by calling all the setters that match the column names. It
will assume your class has a default constructor to create instance with.<br
clear="none"> d) If the query resulted in more than one rows, it throws an
non-unique result exception.</p><p>From <strong>Camel 2.14.1</strong> onwards
the SelectList also supports mapping each row to a Java object as the SelectOne
does <span>(only step c)</span>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>outputClass</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
r
owspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong> Specify the
full package and class name to use as conversion when
<code>outputType=SelectOne</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>outputHeader</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>String</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.15:</strong> To store the
result as a header instead of the message body. This allows to preserve the
existing message body as-is.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>parametersCount</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"
><p><strong>Camel 2.11.2/2.12.0</strong> If set greater than zero, then Camel
>will use this count value of parameters to replace instead of querying via
>JDBC metadata API. This is useful if the JDBC vendor could not return correct
>parameters count, then user may override instead.</p></td></tr><tr><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>noop</code></p></td><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0</strong>
>If set, will ignore the results of the SQL query and use the existing IN
>message as the OUT message for the continuation of
>processing</p></td></tr></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><h3 id="SQLComponent-Resultofthequery">Result of the query</h3><p>For
<code>select</co
de> 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">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">from("jms:order.inbox")
- .to("sql:select order_seq.nextval from
dual?outputHeader=OrderId&outputType=SelectOne")
- .to("jms:order.booking");</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[sql:select * from table where
id=:#${property.myId} order by name[?options]]]></script>
+</div></div><p>Notice that the standard <code>?</code> symbol that denotes the
parameters to an SQL query is substituted with the <code>#</code> symbol,
because the <code>?</code> symbol is used to specify options for the endpoint.
The <code>?</code> symbol replacement can be configured on endpoint
basis.</p><p>You can append query options to the URI in the following format,
<code>?option=value&option=value&...</code></p><h3
id="SQLComponent-Options">Options</h3><div class="confluenceTableSmall"><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>batch</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>bool
ean</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.7.5, 2.8.4 and 2.9:</strong> Execute
SQL batch update statements. See notes below on how the treatment of the
inbound message body changes if this is set to
<code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>dataSourceRef</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in
Camel 3.0:</strong> Reference to a <code>DataSource</code> to look up in the
registry. Use <code>dataSource=#theName</code> instead.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>dataSource</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String<
/code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> Reference to a
<code>DataSource</code> to look up in the registry.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>placeholder</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>#</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.4:</strong> Specifies a
character that will be replaced to <code>?</code> in SQL query. Notice, that it
is simple <code>String.replaceAll()</code> operation and no SQL parsing is
involved (quoted strings will also change). This replacement is
<strong>only</strong> happening if the endpoint is created using the
<code>SqlComponent</code>. If you manually create the endpoint, then use the
expected <code>?</code> sign instead.</p><
/td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>template.<xxx></code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Sets additional options on the Spring
<code>JdbcTemplate</code> that is used behind the scenes to execute the
queries. For instance, <code>template.maxRows=10</code>. For detailed
documentation, see the <a shape="rect" class="external-link"
href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html";
rel="nofollow">JdbcTemplate javadoc</a> documentation.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>allowNamedParameters</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Whether to
allow using named parameters in the queries.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>processingStrategy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
only:</strong> Allows to plugin to use a custom
<code>org.apache.camel.component.sql.SqlProcessingStrategy</code> to execute
queries when the consumer has processed the rows/batch.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>prepareStatementStrategy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> Allows to plugin to
use a custom
<code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> to
control preparation of the query and prepared statement.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.delay</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>long</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>500</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> Delay in milliseconds between each
poll.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.initialDelay</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>long</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
<strong>SQL consumer only:</strong> Milliseconds before polling
starts.</p></td></tr>
<tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.useFixedDelay</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> Set to <code>true</code> to use fixed delay between
polls, otherwise fixed rate is used. See <a shape="rect" class="external-link"
href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html";
rel="nofollow">ScheduledExecutorService</a> in JDK for
details.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>maxMessagesPerPoll</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel
2.11:</strong> <strong>SQL consumer only:</strong> An integer value to define
the maximum number of messages to gather per poll. By default, no maximum is
set.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.useIterator</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> If <code>true</code> each row returned when polling
will be processed individually. If <code>false</code> the entire
<code>java.util.List</code> of data is set as the IN body.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.routeEmptyResultSet</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p>
</td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel
2.11:</strong> <strong>SQL consumer only:</strong> Whether to route a single
empty <a shape="rect" href="exchange.html">Exchange</a> if there was no data to
poll.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.onConsume</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> After processing each row then this query can be
executed, if the <a shape="rect" href="exchange.html">Exchange</a> was
processed successfully, for example to mark the row as processed. The query can
have parameter.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.onConsumeFailed</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"
><p><code>String</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer
>only:</strong> After processing each row then this query can be executed, if
>the <a shape="rect" href="exchange.html">Exchange</a> failed, for example to
>mark the row as failed. The query can have parameter.</p></td></tr><tr><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>consumer.onConsumeBatchComplete</code></p></td><td
> colspan="1" rowspan="1"
>class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
>consumer only:</strong> After processing the entire batch, this query can be
>executed to bulk update rows etc. The query cannot have
>parameters.</p></td></tr><tr><td colspan="1" rowspan="1" class="conflue
nceTd"><p><code>consumer.expectedUpdateCount</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> If using <code>consumer.onConsume</code> then this
option can be used to set an expected number of rows being updated. Typically
you may set this to <code>1</code> to expect one row to be
updated.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.breakBatchOnConsumeFail</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
consumer only:</strong> If using <code>consumer.onConsume</code> and it fails,
then this optio
n controls whether to break out of the batch or continue processing the next
row from the batch.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>alwaysPopulateStatement</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL
producer only:</strong> If enabled then the <code>populateStatement</code>
method from
<code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> is
always invoked, also if there is no expected parameters to be prepared. When
this is <code>false</code> then the <code>populateStatement</code> is only
invoked if there is 1 or more expected parameters to be set; for example this
avoids reading the message body/headers for SQL queries with no
parameters.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"
><p><code>separator</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>char</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>,</code></p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p><strong>Camel 2.11.1:</strong> The separator to use
>when parameter values is taken from message body (if the body is a String
>type), to be inserted at # placeholders. Notice if you use named parameters,
>then a <code>Map</code> type is used instead.</p></td></tr><tr><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>outputType</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>SelectList</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong> Make the
>output of consumer or producer to <code>SelectList</code> as List of Map, or
><code>SelectOne</code> as single Java object in the following way:<br clea
r="none"> a) If the query has only single column, then that JDBC Column object
is returned. (such as <code>SELECT COUNT( * ) FROM PROJECT</code> will return a
Long object.<br clear="none"> b) If the query has more than one column, then it
will return a Map of that result.<br clear="none"> c) If the
<code>outputClass</code> is set, then it will convert the query result into an
Java bean object by calling all the setters that match the column names. It
will assume your class has a default constructor to create instance with.<br
clear="none"> d) If the query resulted in more than one rows, it throws an
non-unique result exception.</p><p>From <strong>Camel 2.14.1</strong> onwards
the SelectList also supports mapping each row to a Java object as the SelectOne
does <span>(only step c)</span>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>outputClass</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
r
owspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong> Specify the
full package and class name to use as conversion when
<code>outputType=SelectOne</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>outputHeader</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>String</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.15:</strong> To store the
result as a header instead of the message body. This allows to preserve the
existing message body as-is.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>parametersCount</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"
><p><strong>Camel 2.11.2/2.12.0</strong> If set greater than zero, then Camel
>will use this count value of parameters to replace instead of querying via
>JDBC metadata API. This is useful if the JDBC vendor could not return correct
>parameters count, then user may override instead.</p></td></tr><tr><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>noop</code></p></td><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0</strong>
>If set, will ignore the results of the SQL query and use the existing IN
>message as the OUT message for the continuation of
>processing</p></td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><code>useMessageBodyForSql</code></td><td colspan="1"
>rowspan="1" class="confluenceTd"><code>boolean</code></td><td colspan="1"
>rowspan="1" class="confluenceTd"><code>false</code
></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel
>2.16:</strong> Whether to use the message body as the SQL and then headers
>for parameters. If this option is enabled then the SQL in the uri is not
>used. The SQL parameters must then be provided in a header with the key
><code>CamelSqlParameters</code>. This option is only for the
>producer.</td></tr></tbody></table></div></div><h3
>id="SQLComponent-Treatmentofthemessagebody">Treatment of the message
>body</h3><p>The SQL component tries to convert the message body to an object
>of <code>java.util.Iterator</code> type and then uses this iterator to fill
>the query parameters (where each query parameter is represented by a
><code>#</code> symbol (or configured placeholder) in the endpoint URI). If
>the message body is not an array or collection, the conversion results in an
>iterator that iterates over only one object, which is the body
>itself.</p><p>For example, if the message body is an instance of
><code>java.util.List</cod
e>, the first item in the list is substituted into the first occurrence of
<code>#</code> in the SQL query, the second item in the list is substituted
into the second occurrence of <code>#</code>, and so on.</p><p>If
<code>batch</code> is set to <code>true</code>, then the interpretation of the
inbound message body changes slightly – instead of an iterator of
parameters, the component expects an iterator that contains the parameter
iterators; the size of the outer iterator determines the batch size.</p><p>From
Camel 2.16 onwards you can use the option <span>useMessageBodyForSql that
allows to use the message body as the SQL statement, and then the SQL
parameters must be provided in a header with the
key SqlConstants.SQL_PARAMETERS. This allows the SQL component to work
more dynamic as the SQL query is from the message body.</span></p><h3
id="SQLComponent-Resultofthequery">Result of the query</h3><p>For
<code>select</code> operations, the result is an instance of <cod
e>List<Map<String, Object>></code> type, as returned by the <a
shape="rect" class="external-link"
href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html#queryForList(java.lang.String,%20java.lang.Object%91%93)"
rel="nofollow">JdbcTemplate.queryForList()</a> method. For <code>update</code>
operations, the result is the number of updated rows, returned as an
<code>Integer</code>.</p><p>By default, the result is placed in the message
body.  If the outputHeader parameter is set, the result is placed in the
header.  This is an alternative to using a full message enrichment pattern
to add headers, it provides a concise syntax for querying a sequence or some
other small value into a header.  It is convenient to use outputHeader and
outputType together:</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+<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>
</div></div><p> </p><h3 id="SQLComponent-Headervalues">Header
values</h3><p>When performing <code>update</code> operations, the SQL Component
stores the update count in the following message headers:</p><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>CamelSqlUpdateCount</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The number of rows updated for
<code>update</code> operations, returned as an <code>Integer</code>
object.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>CamelSqlRowCount</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The number of rows returned for
<code>select</code> operations, returned as an <code>Integer</code>
object.</p></td></tr><tr><td colspan="1" rowspan="1" class="conf
luenceTd"><p><code>CamelSqlQuery</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.8:</strong> Query to execute. This
query takes precedence over the query specified in the endpoint URI. Note that
query parameters in the header <em>are</em> represented by a <code>?</code>
instead of a <code>#</code> symbol</p></td></tr></tbody></table></div><p>When
performing <code>insert</code> operations, the SQL Component stores the
rows with the generated keys and number of these rown in the following message
headers (<strong>Available as of Camel 2.12.4, 2.13.1</strong>):</p><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><pre>CamelSqlGeneratedKeysRowCount</pre></td><td
colspan="1" rowspan="1" class="confluenceTd">The number of rows in the header
that contains generated keys.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><pre>CamelSqlGeneratedKeyRows</pre></td><td colspan="1"
rowspan="1" class="confluenceTd"> Rows that contains the generated keys (a
list of maps of keys).</td></tr></tbody></table></div><h3
id="SQLComponent-Generatedkeys">Generated keys</h3><p><strong>Available as of
Camel 2.12.4, 2.13.1 and 2.14<br clear="none"></strong></p><p>If you insert
data using SQL INSERT, then the RDBMS may support auto generated keys. You can
instruct the SQL producer to return the generated keys in headers.<br
clear="none"> To do that set the header
<code>CamelSqlRetrieveGeneratedKeys=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://git-wip-us.apache.org/repos/asf?p=camel.git;a=blob_plain;f=components/camel-sql/src/test/java/org/apache/camel/component/sql/SqlGenera
tedKeysTest.java;hb=3962b23f94bb4bc23011b931add08c3f6833c82e">unit
test</a>.</p><h3 id="SQLComponent-Configuration">Configuration</h3><p>You can
now set a reference to a <code>DataSource</code> in the URI directly:</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">sql:select * from table where id=# order by
name?dataSource=myDS
-</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[sql:select * from table where id=# order by
name?dataSource=myDS
+]]></script>
</div></div><h3 id="SQLComponent-Sample">Sample</h3><p>In the sample below we
execute a query and retrieve the result as a <code>List</code> of rows, where
each row is a <code>Map<String, Object</code> and the key is the column
name.</p><p>First, we set up a table to use for our sample. As this is based on
an unit test, we do it in java:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
// this is the database we create with some initial data for our unit test
db = new EmbeddedDatabaseBuilder()
.setType(EmbeddedDatabaseType.DERBY).addScript("sql/createAndPopulateDatabase.sql").build();
]]></script>
-</div></div><p>The SQL script <code>createAndPopulateDatabase.sql</code> we
execute looks like as described below:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div>The SQL script <code>createAndPopulateDatabase.sql</code> we
execute looks like as described below:<div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: sql; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
create table projects (id integer primary key, project varchar(10), license
varchar(5));
insert into projects values (1, 'Camel', 'ASF');
insert into projects values (2, 'AMQ', 'ASF');
insert into projects values (3, 'Linux', 'XXX');
]]></script>
-</div></div><p>Then we configure our route and our <code>sql</code> component.
Notice that we use a <code>direct</code> endpoint in front of the
<code>sql</code> endpoint. This allows us to send an exchange to the
<code>direct</code> endpoint with the URI, <code>direct:simple</code>, which is
much easier for the client to use than the long <code>sql:</code> URI. Note
that the <code>DataSource</code> is looked up up in the registry, so we can use
standard Spring XML to configure our <code>DataSource</code>.</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+</div></div>Then we configure our route and our <code>sql</code> component.
Notice that we use a <code>direct</code> endpoint in front of the
<code>sql</code> endpoint. This allows us to send an exchange to the
<code>direct</code> endpoint with the URI, <code>direct:simple</code>, which is
much easier for the client to use than the long <code>sql:</code> URI. Note
that the <code>DataSource</code> is looked up up in the registry, so we can use
standard Spring XML to configure our <code>DataSource</code>.<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:simple")
.to("sql:select * from projects where license = # order by
id?dataSourceRef=jdbc/myDataSource")
.to("mock:result");
]]></script>
-</div></div><p>And then we fire the message into the <code>direct</code>
endpoint that will route it to our <code>sql</code> component that queries the
database.</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+</div></div>And then we fire the message into the <code>direct</code> endpoint
that will route it to our <code>sql</code> component that queries the
database.<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[
MockEndpoint mock = getMockEndpoint("mock:result");
mock.expectedMessageCount(1);
@@ -151,42 +151,42 @@ Map<?, ?> row = assertIsInstanceOf
// and we should be able the get the project from the map that should be Linux
assertEquals("Linux", row.get("PROJECT"));
]]></script>
-</div></div><p>We could configure the <code>DataSource</code> in Spring XML as
follows:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"> <jee:jndi-lookup id="myDS"
jndi-name="jdbc/myDataSource"/>
-</pre>
+</div></div>We could configure the <code>DataSource</code> in Spring XML as
follows:<div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ <jee:jndi-lookup id="myDS"
jndi-name="jdbc/myDataSource"/>
+]]></script>
</div></div><h4 id="SQLComponent-Usingnamedparameters">Using named
parameters</h4><p><strong>Available as of Camel 2.11</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 for these parameters from the message body or message
headers. Notice in the example above we set two headers with constant value<br
clear="none"> for the named parameters:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;"> from("direct:projects")
- .setHeader("lic", constant("ASF"))
- .setHeader("min", constant(123))
- .to("sql:select * from projects where license = :#lic and id > :#min
order by id")
-</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ from("direct:projects")
+ .setHeader("lic", constant("ASF"))
+ .setHeader("min", constant(123))
+ .to("sql:select * from projects where license = :#lic and id >
:#min order by id")
+]]></script>
</div></div><p>Though if the message body is a <code>java.util.Map</code> then
the named parameters will be taken from the body.</p><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;"> from("direct:projects")
- .to("sql:select * from projects where license = :#lic and id > :#min
order by id")
-</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ from("direct:projects")
+ .to("sql:select * from projects where license = :#lic and id >
:#min order by id")
+]]></script>
</div></div><h4 id="SQLComponent-Usingexpressionparameters">Using expression
parameters</h4><p><strong>Available as of Camel 2.14</strong></p><p>In the
given route below, we want to get all the project from the database. It uses
the body of the exchange for defining the license and uses the value of a
property as the second parameter.</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">from("direct:projects")
- .setBody(constant("ASF"))
- .setProperty("min", constant(123))
- .to("sql:select * from projects where license = :#${body} and id >
:#${property.min} order by id")</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[from("direct:projects")
+ .setBody(constant("ASF"))
+ .setProperty("min", constant(123))
+ .to("sql:select * from projects where license = :#${body} and id >
:#${property.min} order by id")]]></script>
</div></div><h3 id="SQLComponent-UsingtheJDBCbasedidempotentrepository">Using
the JDBC based idempotent repository</h3><p><strong>Available as of Camel
2.7</strong>: In this section we will use the JDBC based idempotent
repository.</p><div class="confluence-information-macro
confluence-information-macro-tip"><p class="title">Abstract class</p><span
class="aui-icon aui-icon-small aui-iconfont-approve
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>From Camel 2.9 onwards there is an
abstract class
<code>org.apache.camel.processor.idempotent.jdbc.AbstractJdbcMessageIdRepository</code>
you can extend to build custom JDBC idempotent
repository.</p></div></div><p>First we have to create the database table which
will be used by the idempotent repository. For <strong>Camel 2.7</strong>, we
use the following schema:</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: sql; gutter: false; theme: Default"
style="font-size:12px;">CREATE TABLE CAMEL_MESSAGEPROCESSED (
+<script class="brush: sql; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[CREATE TABLE CAMEL_MESSAGEPROCESSED (
processorName VARCHAR(255),
messageId VARCHAR(100)
)
-</pre>
+]]></script>
</div></div><p>In <strong>Camel 2.8</strong>, we added the createdAt
column:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: sql; gutter: false; theme: Default"
style="font-size:12px;">CREATE TABLE CAMEL_MESSAGEPROCESSED (
+<script class="brush: sql; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[CREATE TABLE CAMEL_MESSAGEPROCESSED (
processorName VARCHAR(255),
messageId VARCHAR(100),
createdAt TIMESTAMP
)
-</pre>
+]]></script>
</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">The SQL
Server <strong>TIMESTAMP</strong> type is a fixed-length binary-string
type. It does not map to any of the JDBC time types: <strong>DATE</strong>,
<strong>TIME</strong>, or
<strong>TIMESTAMP</strong>.</div></div><p> </p><p>We recommend to have a
unique constraint on the columns processorName and messageId. Because the
syntax for this constraint differs for database to database, we do not show it
here.</p><p>Second we need to setup a <code>javax.sql.DataSource</code> in the
spring XML file:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
<jdbc:embedded-database id="dataSource" type="DERBY"
/>
]]></script>
-</div></div><p>And finally we can create our JDBC idempotent repository in the
spring XML file as well:</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+</div></div>And finally we can create our JDBC idempotent repository in the
spring XML file as well:<div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
<bean id="messageIdRepository"
class="org.apache.camel.processor.idempotent.jdbc.JdbcMessageIdRepository">
<constructor-arg ref="dataSource" />
@@ -220,7 +220,7 @@ assertEquals("Linux", row.get(
</bean>
]]></script>
</div></div><h3 id="SQLComponent-UsingtheJDBCbasedaggregationrepository">Using
the JDBC based aggregation repository</h3><p><strong>Available as of Camel
2.6</strong></p><div class="confluence-information-macro
confluence-information-macro-information"><p class="title">Using
JdbcAggregationRepository in Camel 2.6</p><span class="aui-icon aui-icon-small
aui-iconfont-info confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>In Camel 2.6, the
JdbcAggregationRepository is provided in the <code>camel-jdbc-aggregator</code>
component. From Camel 2.7 onwards, the <code>JdbcAggregationRepository</code>
is provided in the <code>camel-sql</code>
component.</p></div></div><p><code>JdbcAggregationRepository</code> is an
<code>AggregationRepository</code> which on the fly persists the aggregated
messages. This ensures that you will not loose messages, as the default
aggregator will use an in memory only <code>AggregationRepository</code>.<br
clear="none"> T
he <code>JdbcAggregationRepository</code> allows together with Camel to
provide persistent support for the <a shape="rect"
href="aggregator2.html">Aggregator</a>.</p><p>It has the following
options:</p><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>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>dataSource</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>DataSource</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Mandatory:</strong> The
<code>javax.sql.DataSource</code> to use for accessing the
database.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>repositoryName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspa
n="1" rowspan="1" class="confluenceTd"><p><strong>Mandatory:</strong> The name
of the repository.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>transactionManager</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>TransactionManager</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Mandatory:</strong> The
<code>org.springframework.transaction.PlatformTransactionManager</code> to
mange transactions for the database. The TransactionManager must be able to
support databases.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>lobHandler</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>LobHandler</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>A
<code>org.springframework.jdbc.support.lob.LobHandler</code> to handle Lob
types in the database. Use this option to use a vendor specific LobHandler, for
example when using Oracle.</p></td></tr><tr><td co
lspan="1" rowspan="1"
class="confluenceTd"><p><code>returnOldExchange</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>boolean</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Whether the get operation should return the old
existing Exchange if any existed. By default this option is <code>false</code>
to optimize as we do not need the old exchange when
aggregating.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>useRecovery</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>boolean</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Whether or not recovery is enabled. This option is by
default <code>true</code>. When enabled the Camel <a shape="rect"
href="aggregator2.html">Aggregator</a> automatic recover failed aggregated
exchange and have them resubmitted.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>recoveryInterval</code></p></td><td
colspan="1" rowspan="1" class="confl
uenceTd"><p>long</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>If recovery is enabled then a background task is run
every x'th time to scan for failed exchanges to recover and resubmit. By
default this interval is 5000 millis.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>maximumRedeliveries</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>int</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Allows you to limit the maximum number of
redelivery attempts for a recovered exchange. If enabled then the Exchange will
be moved to the dead letter channel if all redelivery attempts failed. By
default this option is disabled. If this option is used then the
<code>deadLetterUri</code> option must also be provided.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>deadLetterUri</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>String</p></td><td colspan="1" rowspan="1"
class="conflu
enceTd"><p>An endpoint uri for a <a shape="rect"
href="dead-letter-channel.html">Dead Letter Channel</a> where exhausted
recovered Exchanges will be moved. If this option is used then the
<code>maximumRedeliveries</code> option must also be
provided.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>storeBodyAsText</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>boolean</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.11:</strong> Whether to store the
message body as String which is human readable. By default this option is
<code>false</code> storing the body in binary format.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>headersToStoreAsText</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>List<String></code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Allows to
store headers as String which is human readable.
By default this option is disabled, storing the headers in binary
format.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>optimisticLocking</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> To turn on
optimistic locking, which often would be needed in clustered environments where
multiple Camel applications shared the same JDBC based aggregation
repository.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>jdbcOptimisticLockingExceptionMapper</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 a custom
<code>org.apache.camel.processor.aggregate.jdbc.JdbcOptimisticLockingExceptionMapper</code>
to map vendor specific error codes to an optimistick locking error, for Camel
to perform a
retry. This requires <code>optimisticLocking</code> to be
enabled.</p></td></tr></tbody></table></div><h4
id="SQLComponent-Whatispreservedwhenpersisting">What is preserved when
persisting</h4><p><code>JdbcAggregationRepository</code> will only preserve any
<code>Serializable</code> compatible data types. If a data type is not such a
type its dropped and a <code>WARN</code> is logged. And it only persists the
<code>Message</code> body and the <code>Message</code> headers. The
<code>Exchange</code> properties are <strong>not</strong> persisted.</p><p>From
Camel 2.11 onwards you can store the message body and select(ed) headers as
String in separate columns.</p><h4
id="SQLComponent-Recovery">Recovery</h4><p>The
<code>JdbcAggregationRepository</code> will by default recover any failed <a
shape="rect" href="exchange.html">Exchange</a>. It does this by having a
background tasks that scans for failed <a shape="rect"
href="exchange.html">Exchange</a>s in the persistent store. You can use th
e <code>checkInterval</code> option to set how often this task runs. The
recovery works as transactional which ensures that Camel will try to recover
and redeliver the failed <a shape="rect" href="exchange.html">Exchange</a>. Any
<a shape="rect" href="exchange.html">Exchange</a> which was found to be
recovered will be restored from the persistent store and resubmitted and send
out again.</p><p>The following headers is set when an <a shape="rect"
href="exchange.html">Exchange</a> is being recovered/redelivered:</p><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>Exchange.REDELIVERED</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Boolean</p></td><td colspan="1"
rowspan="1" class="co
nfluenceTd"><p>Is set to true to indicate the <a shape="rect"
href="exchange.html">Exchange</a> is being redelivered.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>Exchange.REDELIVERY_COUNTER</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Integer</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The redelivery attempt, starting from
1.</p></td></tr></tbody></table></div><p>Only when an <a shape="rect"
href="exchange.html">Exchange</a> has been successfully processed it will be
marked as complete which happens when the <code>confirm</code> method is
invoked on the <code>AggregationRepository</code>. This means if the same <a
shape="rect" href="exchange.html">Exchange</a> fails again it will be kept
retried until it success.</p><p>You can use option
<code>maximumRedeliveries</code> to limit the maximum number of redelivery
attempts for a given recovered <a shape="rect"
href="exchange.html">Exchange</a>. You must also set the <
code>deadLetterUri</code> option so Camel knows where to send the <a
shape="rect" href="exchange.html">Exchange</a> when the
<code>maximumRedeliveries</code> was hit.</p><p>You can see some examples in
the unit tests of camel-sql, for example <a shape="rect" class="external-link"
href="https://svn.apache.org/repos/asf/camel/trunk/components/camel-sql/src/test/java/org/apache/camel/processor/aggregate/jdbc/JdbcAggregateRecoverDeadLetterChannelTest.java";>this
test</a>.</p><h4 id="SQLComponent-Database">Database</h4><p>To be operational,
each aggregator uses two table: the aggregation and completed one. By
convention the completed has the same name as the aggregation one suffixed with
<code>"_COMPLETED"</code>. The name must be configured in the Spring bean with
the <code>RepositoryName</code> property. In the following example aggregation
will be used.</p><p>The table structure definition of both table are identical:
in both case a String value is used as key (<strong>id</strong>) whe
reas a Blob contains the exchange serialized in byte array.<br clear="none">
However one difference should be remembered: the <strong>id</strong> field does
not have the same content depending on the table.<br clear="none"> In the
aggregation table <strong>id</strong> holds the correlation Id used by the
component to aggregate the messages. In the completed table,
<strong>id</strong> holds the id of the exchange stored in corresponding the
blob field.</p><p>Here is the SQL query used to create the tables, just replace
<code>"aggregation"</code> with your aggregator repository name.</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<pre class="brush: sql; gutter: false; theme: Default"
style="font-size:12px;">CREATE TABLE aggregation (
+<script class="brush: sql; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[CREATE TABLE aggregation (
id varchar(255) NOT NULL,
exchange blob NOT NULL,
constraint aggregation_pk PRIMARY KEY (id)
@@ -230,9 +230,9 @@ CREATE TABLE aggregation_completed (
exchange blob NOT NULL,
constraint aggregation_completed_pk PRIMARY KEY (id)
);
-</pre>
+]]></script>
</div></div><h4 id="SQLComponent-Storingbodyandheadersastext">Storing body and
headers as text</h4><p><strong>Available as of Camel 2.11</strong></p><p>You
can configure the <code>JdbcAggregationRepository</code> to store message body
and select(ed) headers as String in separate columns. For example to store the
body, and the following two headers <code>companyName</code> and
<code>accountName</code> use the following SQL:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: sql; gutter: false; theme: Default"
style="font-size:12px;">CREATE TABLE aggregationRepo3 (
+<script class="brush: sql; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[CREATE TABLE aggregationRepo3 (
id varchar(255) NOT NULL,
exchange blob NOT NULL,
body varchar(1000),
@@ -248,55 +248,55 @@ CREATE TABLE aggregationRepo3_completed
accountName varchar(1000),
constraint aggregationRepo3_completed_pk PRIMARY KEY (id)
);
-</pre>
+]]></script>
</div></div><p>And then configure the repository to enable this behavior as
shown below:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"> <bean id="repo3"
class="org.apache.camel.processor.aggregate.jdbc.JdbcAggregationRepository">
- <property name="repositoryName" value="aggregationRepo3"/>
- <property name="transactionManager" ref="txManager3"/>
- <property name="dataSource" ref="dataSource3"/>
+<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ <bean id="repo3"
class="org.apache.camel.processor.aggregate.jdbc.JdbcAggregationRepository">
+ <property name="repositoryName"
value="aggregationRepo3"/>
+ <property name="transactionManager"
ref="txManager3"/>
+ <property name="dataSource"
ref="dataSource3"/>
<!-- configure to store the message body and following headers as
text in the repo -->
- <property name="storeBodyAsText" value="true"/>
- <property name="headersToStoreAsText">
+ <property name="storeBodyAsText"
value="true"/>
+ <property name="headersToStoreAsText">
<list>
<value>companyName</value>
<value>accountName</value>
</list>
</property>
</bean>
-</pre>
+]]></script>
</div></div><h4 id="SQLComponent-Codec(Serialization)">Codec
(Serialization)</h4><p>Since they can contain any type of payload, Exchanges
are not serializable by design. It is converted into a byte array to be stored
in a database BLOB field. All those conversions are handled by the
<code>JdbcCodec</code> class. One detail of the code requires your attention:
the <code>ClassLoadingAwareObjectInputStream</code>.</p><p>The
<code>ClassLoadingAwareObjectInputStream</code> has been reused from the <a
shape="rect" class="external-link" href="http://activemq.apache.org/";>Apache
ActiveMQ</a> project. It wraps an <code>ObjectInputStream</code> and use it
with the <code>ContextClassLoader</code> rather than the
<code>currentThread</code> one. The benefit is to be able to load classes
exposed by other bundles. This allows the exchange body and headers to have
custom types object references.</p><h4
id="SQLComponent-Transaction">Transaction</h4><p>A Spring
<code>PlatformTransactionManager</code>
is required to orchestrate transaction.</p><h4
id="SQLComponent-Service(Start/Stop)">Service (Start/Stop)</h4><p>The
<code>start</code> method verify the connection of the database and the
presence of the required tables. If anything is wrong it will fail during
starting.</p><h4 id="SQLComponent-Aggregatorconfiguration">Aggregator
configuration</h4><p>Depending on the targeted environment, the aggregator
might need some configuration. As you already know, each aggregator should have
its own repository (with the corresponding pair of table created in the
database) and a data source. If the default lobHandler is not adapted to your
database system, it can be injected with the <code>lobHandler</code>
property.</p><p>Here is the declaration for Oracle:</p><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"> <bean id="lobHandler"
class="org.springframework.jdbc.support.lob.OracleLobHandler">
- <property name="nativeJdbcExtractor" ref="nativeJdbcExtractor"/>
+<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ <bean id="lobHandler"
class="org.springframework.jdbc.support.lob.OracleLobHandler">
+ <property name="nativeJdbcExtractor"
ref="nativeJdbcExtractor"/>
</bean>
- <bean id="nativeJdbcExtractor"
class="org.springframework.jdbc.support.nativejdbc.CommonsDbcpNativeJdbcExtractor"/>
+ <bean id="nativeJdbcExtractor"
class="org.springframework.jdbc.support.nativejdbc.CommonsDbcpNativeJdbcExtractor"/>
- <bean id="repo"
class="org.apache.camel.processor.aggregate.jdbc.JdbcAggregationRepository">
- <property name="transactionManager" ref="transactionManager"/>
- <property name="repositoryName" value="aggregation"/>
- <property name="dataSource" ref="dataSource"/>
+ <bean id="repo"
class="org.apache.camel.processor.aggregate.jdbc.JdbcAggregationRepository">
+ <property name="transactionManager"
ref="transactionManager"/>
+ <property name="repositoryName"
value="aggregation"/>
+ <property name="dataSource"
ref="dataSource"/>
<!-- Only with Oracle, else use default -->
- <property name="lobHandler" ref="lobHandler"/>
+ <property name="lobHandler"
ref="lobHandler"/>
</bean>
-</pre>
+]]></script>
</div></div><h3 id="SQLComponent-Optimisticlocking">Optimistic
locking</h3><p>From <strong>Camel 2.12</strong> onwards you can turn on
<code>optimisticLocking</code> and use this JDBC based aggregation repository
in a clustered environment where multiple Camel applications shared the same
database for the aggregation repository. If there is a race condition there
JDBC driver will throw a vendor specific exception which the
<code>JdbcAggregationRepository</code> can react upon. To know which caused
exceptions from the JDBC driver is regarded as an optimistick locking error we
need a mapper to do this. Therefore there is a
<code>org.apache.camel.processor.aggregate.jdbc.JdbcOptimisticLockingExceptionMapper</code>
allows you to implement your custom logic if needed. There is a default
implementation
<code>org.apache.camel.processor.aggregate.jdbc.DefaultJdbcOptimisticLockingExceptionMapper</code>
which works as follows:</p><p>The following check is done:</p><ul
class="alternate"><li>If
the caused exception is an <code>SQLException</code> then the SQLState is
checked if starts with 23.</li><li>If the caused exception is a
<code>DataIntegrityViolationException</code></li><li>If the caused exception
class name has "ConstraintViolation" in its name.</li><li>optional checking for
FQN class name matches if any class names has been configured</li></ul><p>You
can in addition add FQN classnames, and if any of the caused exception (or any
nested) equals any of the FQN class names, then its an optimistick locking
error.</p><p>Here is an example, where we define 2 extra FQN class names from
the JDBC vendor.</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"> <bean id="repo"
class="org.apache.camel.processor.aggregate.jdbc.JdbcAggregationRepository">
- <property name="transactionManager" ref="transactionManager"/>
- <property name="repositoryName" value="aggregation"/>
- <property name="dataSource" ref="dataSource"/>
- <property name"jdbcOptimisticLockingExceptionMapper"
ref="myExceptionMapper"/>
+<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ <bean id="repo"
class="org.apache.camel.processor.aggregate.jdbc.JdbcAggregationRepository">
+ <property name="transactionManager"
ref="transactionManager"/>
+ <property name="repositoryName"
value="aggregation"/>
+ <property name="dataSource"
ref="dataSource"/>
+ <property name"jdbcOptimisticLockingExceptionMapper"
ref="myExceptionMapper"/>
</bean>
<!-- use the default mapper with extra FQN class names from our JDBC
driver -->
- <bean id="myExceptionMapper"
class="org.apache.camel.processor.aggregate.jdbc.DefaultJdbcOptimisticLockingExceptionMapper">
- <property name="classNames">
+ <bean id="myExceptionMapper"
class="org.apache.camel.processor.aggregate.jdbc.DefaultJdbcOptimisticLockingExceptionMapper">
+ <property name="classNames">
<util:set>
<value>com.foo.sql.MyViolationExceptoion</value>
<value>com.foo.sql.MyOtherViolationExceptoion</value>
</util:set>
</property>
</bean>
-</pre>
+]]></script>
</div></div><p></p><h3 id="SQLComponent-SeeAlso">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul
class="alternate"><li><a shape="rect" href="jdbc.html">JDBC</a></li></ul></div>
</td>
@@ -304,7 +304,7 @@ CREATE TABLE aggregationRepo3_completed
<div class="navigation">
<div class="navigation_top">
<!-- NavigationBar -->
-<div class="navigation_bottom" id="navigation_bottom"><h3
id="Navigation-Overviewhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49132";><a
shape="rect" href="overview.html">Overview</a></h3><ul
class="alternate"><li><a shape="rect" href="index.html">Home</a></li><li><a
shape="rect" href="download.html">Download</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li><li><a shape="rect"
href="faq.html">FAQ</a></li></ul><h3
id="Navigation-Documentationhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49534";><a
shape="rect" href="documentation.html">Documentation</a></h3><ul
class="alternate"><li><a shape="rect" href="user-guide.html">User
Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a
shape="rect" href="books.html">Books</a></li><li><a shape="rect"
href="tutorials.html">Tutorials</a></li><li><a shape="rect"
href="examples.html">Examples</a></li><li><a shape="rect"
href="cookbook.html">Cookbook</a></li>
<li><a shape="rect" href="architecture.html">Architecture</a></li><li><a
shape="rect" href="enterprise-integration-patterns.html">Enterprise Integration
Patterns</a></li><li><a shape="rect" href="dsl.html">DSL</a></li><li><a
shape="rect" href="components.html">Components</a></li><li><a shape="rect"
href="data-format.html">Data Format</a></li><li><a shape="rect"
href="languages.html">Languages</a></li><li><a shape="rect"
href="security.html">Security</a></li><li><a shape="rect"
href="security-advisories.html">Security Advisories</a></li></ul><h3
id="Navigation-Search">Search</h3><form
enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box"
action="http://www.google.com/cse";>
+<div class="navigation_bottom" id="navigation_bottom"><h3
id="Navigation-Overview"><a shape="rect"
href="overview.html">Overview</a></h3><ul class="alternate"><li><a shape="rect"
href="index.html">Home</a></li><li><a shape="rect"
href="download.html">Download</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li><li><a shape="rect"
href="faq.html">FAQ</a></li></ul><h3 id="Navigation-Documentation"><a
shape="rect" href="documentation.html">Documentation</a></h3><ul
class="alternate"><li><a shape="rect" href="user-guide.html">User
Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a
shape="rect" href="books.html">Books</a></li><li><a shape="rect"
href="tutorials.html">Tutorials</a></li><li><a shape="rect"
href="examples.html">Examples</a></li><li><a shape="rect"
href="cookbook.html">Cookbook</a></li><li><a shape="rect"
href="architecture.html">Architecture</a></li><li><a shape="rect"
href="enterprise-integration-patterns.html">Enterprise
Integration Patterns</a></li><li><a shape="rect"
href="dsl.html">DSL</a></li><li><a shape="rect"
href="components.html">Components</a></li><li><a shape="rect"
href="data-format.html">Data Format</a></li><li><a shape="rect"
href="languages.html">Languages</a></li><li><a shape="rect"
href="security.html">Security</a></li><li><a shape="rect"
href="security-advisories.html">Security Advisories</a></li></ul><h3
id="Navigation-Search">Search</h3><form
enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box"
action="http://www.google.com/cse";>
<div>
<input type="hidden" name="cx" value="007878419884033443453:m5nhvy4hmyq">
<input type="hidden" name="ie" value="UTF-8">
@@ -312,7 +312,7 @@ CREATE TABLE aggregationRepo3_completed
<input type="submit" name="sa" value="Search">
</div>
</form>
-<script type="text/javascript"
src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en";></script><h3
id="Navigation-Communityhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49115";><a
shape="rect" href="community.html">Community</a></h3><ul
class="alternate"><li><a shape="rect"
href="support.html">Support</a></li><li><a shape="rect"
href="contributing.html">Contributing</a></li><li><a shape="rect"
href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect"
href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect"
href="user-stories.html">User Stories</a></li><li><a shape="rect"
href="news.html">News</a></li><li><a shape="rect"
href="articles.html">Articles</a></li><li><a shape="rect"
href="site.html">Site</a></li><li><a shape="rect"
href="team.html">Team</a></li><li><a shape="rect" class="external-link"
href="http://camel-extra.googlecode.com/"; rel="nofollow">Camel
Extra</a></li></ul><h3 id="Navigation-Developershttps://cwi
ki.apache.org/confluence/pages/viewpage.action?pageId=49124"><a shape="rect"
href="developers.html">Developers</a></h3><ul class="alternate"><li><a
shape="rect" href="developers.html">Developer Guide</a></li><li><a shape="rect"
href="source.html">Source</a></li><li><a shape="rect"
href="building.html">Building</a></li><li><a shape="rect"
href="javadoc.html">JavaDoc</a></li><li><a shape="rect"
href="irc-room.html">IRC Room</a></li></ul><h3
id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul
class="alternate"><li><a shape="rect" class="external-link"
href="http://www.apache.org/licenses/";>License</a></li><li><a shape="rect"
class="external-link"
href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a
shape="rect" class="external-link"
href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li><li><a
shape="rect" class="external-link"
href="http://www.apache.org/security/";>Security</a></li></ul></div>
+<script type="text/javascript"
src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en";></script><h3
id="Navigation-Community"><a shape="rect"
href="community.html">Community</a></h3><ul class="alternate"><li><a
shape="rect" href="support.html">Support</a></li><li><a shape="rect"
href="contributing.html">Contributing</a></li><li><a shape="rect"
href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect"
href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect"
href="user-stories.html">User Stories</a></li><li><a shape="rect"
href="news.html">News</a></li><li><a shape="rect"
href="articles.html">Articles</a></li><li><a shape="rect"
href="site.html">Site</a></li><li><a shape="rect"
href="team.html">Team</a></li><li><a shape="rect" class="external-link"
href="http://camel-extra.googlecode.com/"; rel="nofollow">Camel
Extra</a></li></ul><h3 id="Navigation-Developers"><a shape="rect"
href="developers.html">Developers</a></h3><ul class="alternate"
><li><a shape="rect" href="developers.html">Developer Guide</a></li><li><a
>shape="rect" href="source.html">Source</a></li><li><a shape="rect"
>href="building.html">Building</a></li><li><a shape="rect"
>href="javadoc.html">JavaDoc</a></li><li><a shape="rect"
>href="irc-room.html">IRC Room</a></li></ul><h3
>id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul
>class="alternate"><li><a shape="rect" class="external-link"
>href="http://www.apache.org/licenses/";>License</a></li><li><a shape="rect"
>class="external-link"
>href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a
> shape="rect" class="external-link"
>href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li><li><a
>shape="rect" class="external-link"
>href="http://www.apache.org/security/";>Security</a></li></ul></div>
<!-- NavigationBar -->
</div>
</div>
