SQL

Since Camel 1.0

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.

Looking 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).

<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.

from("queue:foo").setBody().sql("select * from MyType").to("queue:bar")

And the spring DSL:

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

Options

The SQL language supports 1 options, which are listed below.

Name Default Java Type Description

Name	Default	Java Type	Description
trim	`true`	`Boolean`	Whether to trim the value to remove leading and trailing whitespaces and line breaks

trim

true

Boolean

Whether to trim the value to remove leading and trailing whitespaces and line breaks

Spring Boot Auto-Configuration

When using Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

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

The component supports 2 options, which are listed below.

Name	Description	Default	Type
camel.language.sql.enabled	Enable sql language	true	Boolean
camel.language.sql.trim	Whether to trim the value to remove leading and trailing whitespaces and line breaks	true	Boolean

Name

Description

Default

Type

camel.language.sql.enabled

Enable sql language

true

Boolean

camel.language.sql.trim

Whether to trim the value to remove leading and trailing whitespaces and line breaks

true

Boolean

Loading script from external resource

Since 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:

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