Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

SQL Language

The SQL support is added by JoSQL and is primarily used for performing SQL queries on in-memory objects. If you prefer to perform actual database queries then check out the JPA component.

Tip
titleLooking for the SQL component

Camel has both a SQL language and a SQL Component. This page is about the SQL language. Click on SQL Component if you are looking for the component instead.

To use SQL in your camel routes you need to add the a dependency on camel-josql which implements the SQL language.

If you use maven you could just add the following to your pom.xml, substituting the version number for the latest & greatest release (see the download page for the latest versions).

Code Block
xml
xml
<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-josql</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

Camel supports SQL to allow an Expression or Predicate to be used in the DSL or Xml Configuration. For example you could use SQL to create an Predicate in a Message Filter or as an Expression for a Recipient List.To add an SQL expression to your routing rules its usually easiest to import the SqlBuilder classes methods then you can use the sql() function inside your rules.

Code Block

import static org.apache.camel.builder.sql.SqlBuilder.*;
...
from("queue:foo").setBody().sql("select * from MyType")).to("queue:bar")

And the spring DSL:

Code Block
xml
xml
   <from uri="queue:foo"/>
   <setBody>
       <sql>select * from MyType</sql>
   </setBody>
   <to uri="queue:bar"/>

Variables

Variable

Type

Description

exchange

Exchange

the Exchange object

in

Message

the exchange.in message

out

Message

the exchange.out message

the property key

Object

the Exchange properties

the header key

Object

the exchange.in headers

the variable key

Object

if any additional variables is added using setVariables method

Loading script from external resource

Available as of Camel 2.11

You can externalize the script and have Camel load it from a resource such as "classpath:", "file:", or "http:".
This is done using the following syntax: "resource:scheme:location", eg to refer to a file on the classpath you can do:

Code Block
.setHeader("myHeader").sql("resource:classpath:mysql.sql")