Page History

h2. MyBatis
*Available as of Camel 2.7*

The *mybatis:* component allows you to query, poll, insert, update and delete data in a relational database using [MyBatis|http://mybatis.org/].

Maven users will need to add the following dependency to their {{pom.xml}} for this component:
{code:xml}
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-mybatis</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>
{code}

h3. URI format

{code}
mybatis:statementName[?options]
{code}

Where *statementName* is the statement name in the MyBatis XML mapping file which maps to the query, insert, update or delete operation you wish to evaluate.

You can append query options to the URI in the following format, {{?option=value&option=value&...}}

This component will by default load the MyBatis SqlMapConfig file from the root of the classpath and expected named as {{SqlMapConfig.xml}}.
If the file is located in another location, you would have to configure the {{configurationUri}} option on the {{MyBatisComponent}} component.

h3. Options
{div:class=confluenceTableSmall}
|| Option || Type || Default || Description ||
| {{consumer.onConsume}} | {{String}} | {{null}} | Statements to run after consuming. Can be used, for example, to update rows after they have been consumed and processed in Camel. See sample later. Multiple statements can be separated with comma. |
| {{consumer.useIterator}} | {{boolean}} | {{true}} | If {{true}} each row returned when polling will be processed individually. If {{false}} the entire {{List}} of data is set as the IN body. |
| {{consumer.routeEmptyResultSet}} | {{boolean}} | {{false}} | Sets whether empty result set should be routed or not. By default, empty result sets are not routed. |
| {{statementType}} | {{StatementType}} | {{null}} | Mandatory to specify for producer to control which kind of operation to invoke. The enum values are: {{SelectOne}}, {{SelectList}}, {{Insert}}, {{InsertList}}, {{Update}}, {{Delete}}. *Notice:* {{InsertList}} is available as of Camel 2.10. |
| {{maxMessagesPerPoll}} | {{int}} | {{0}} | An integer to define a maximum messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. |
{div}

h3. Message Headers
Camel will populate the result message, either IN or OUT with a header with the statement used:
{div:class=confluenceTableSmall}
|| Header || Type || Description ||
| {{CamelMyBatisStatementName}} | {{String}} | The *statementName* used (for example: insertAccount). |
| {{CamelMyBatisResult}} | {{Object}} | The *response* returned from MtBatis in any of the operations. For instance an {{INSERT}} could return the auto-generated key, or number of rows etc. |
{div}

h3. Message Body
The response from MyBatis will only be set as body if it's a {{SELECT}} statement. That means, for example, for {{INSERT}} statements Camel will not replace the body. This allows you to continue routing and keep the original body. The response from MyBatis is always stored in the header with the key {{CamelMyBatisResult}}.

h3. Samples

For example if you wish to consume beans from a JMS queue and insert them into a database you could do the following:

{code}
from("activemq:queue:newAccount").
  to("mybatis:insertAccount?statementType=Insert");
{code}

Notice we have to specify the {{statementType}}, as we need to instruct Camel which kind of operation to invoke.

Where *insertAccount* is the MyBatis ID in the SQL mapping file:
{code:xml}
  <!-- Insert example, using the Account parameter class -->
  <insert id="insertAccount" parameterType="Account">
    insert into ACCOUNT (
      ACC_ID,
      ACC_FIRST_NAME,
      ACC_LAST_NAME,
      ACC_EMAIL
    )
    values (
      #{id}, #{firstName}, #{lastName}, #{emailAddress}
    )
  </insert>
{code}

h3. Using StatementType for better control of MyBatis
When routing to an MyBatis endpoint you want more fine grained control so you can control whether the SQL statement to be executed is a {{SELEECT}}, {{UPDATE}}, {{DELETE}} or {{INSERT}} etc. So for instance if we want to route to an MyBatis endpoint in which the IN body contains parameters to a {{SELECT}} statement we can do:
{snippet:id=e1|lang=java|url=camel/trunk/components/camel-mybatis/src/test/java/org/apache/camel/component/mybatis/MyBatisSelectOneTest.java}

In the code above we can invoke the MyBatis statement {{selectAccountById}} and the IN body should contain the account id we want to retrieve, such as an {{Integer}} type.

We can do the same for some of the other operations, such as {{SelectList}}:
{snippet:id=e1|lang=java|url=camel/trunk/components/camel-mybatis/src/test/java/org/apache/camel/component/mybatis/MyBatisSelectListTest.java}

And the same for {{UPDATE}}, where we can send an {{Account}} object as IN body to MyBatis:
{snippet:id=e1|lang=java|url=camel/trunk/components/camel-mybatis/src/test/java/org/apache/camel/component/mybatis/MyBatisUpdateTest.java}

h4. Using InsertList StatementType
*Available as of Camel 2.10*

MyBatis allows you to insert multiple rows using its for-each batch driver. To use this, you need to use the <for-each><foreach> in the mapper XML file. For example as shown below:
{snippet:id=insertList|lang=xml|url=camel/trunk/components/camel-mybatis/src/test/resources/org/apache/camel/component/mybatis/Account.xml}

Then you can insert multiple rows, by sending a Camel message to the {{mybatis}} endpoint which uses the {{InsertList}} statement type, as shown below:
{snippet:id=e1|lang=java|url=camel/trunk/components/camel-mybatis/src/test/java/org/apache/camel/component/mybatis/MyBatisInsertListTest.java}


h4. Scheduled polling example
Since this component does not support scheduled polling, you need to use another mechanism for triggering the scheduled polls, such as the [Timer] or [Quartz] components.

In the sample below we poll the database, every 30 seconds using the [Timer] component and send the data to the JMS queue:
{code:java}
from("timer://pollTheDatabase?delay=30000").to("mbatis:selectAllAccounts").to("activemq:queue:allAccounts");
{code}

And the MyBatis SQL mapping file used:
{code:xml}
  <!-- Select with no parameters using the result map for Account class. -->
  <select id="selectAllAccounts" resultMap="AccountResult">
    select * from ACCOUNT
  </select>
{code}

h4. Using onConsume
This component supports executing statements *after* data have been consumed and processed by Camel. This allows you to do post updates in the database. Notice all statements must be {{UPDATE}} statements. Camel supports executing multiple statements whose name should be separated by comma.

The route below illustrates we execute the *consumeAccount* statement data is processed. This allows us to change the status of the row in the database to processed, so we avoid consuming it twice or more.
{snippet:id=e1|lang=java|url=camel/trunk/components/camel-mybatis/src/test/java/org/apache/camel/component/mybatis/MyBatisQueueTest.java}

And the statements in the sqlmap file:
{snippet:id=e1|lang=xml|url=camel/trunk/components/camel-mybatis/src/test/resources/org/apache/camel/component/mybatis/Account.xml}
{snippet:id=e2|lang=xml|url=camel/trunk/components/camel-mybatis/src/test/resources/org/apache/camel/component/mybatis/Account.xml}

{include:Endpoint See Also}