ElasticSearch Component

Available as of Camel 2.11

The ElasticSearch component allows you to interface with an ElasticSearch server.

Maven users will need to add the following dependency to their pom.xml for this component:

URI format

if you want to run against a local (in JVM/classloader) ElasticSearch server, just set the clusterName value in the URI to "local". See the client guide for more details.

Endpoint Options

The following options may be configured on the ElasticSearch endpoint. All are required to be set as either an endpoint URI parameter or as a header (headers override endpoint properties)




required, indicates the operation to perform


the name of the index to act against


the type of the index to act against


the TransportClient remote host ip to use Camel 2.12


the TransportClient remote port to use (defaults to 9300) Camel 2.12


comma separated list with ip:port formatted remote transport addresses to use Camel 2.16

Options ip and port must be left blank for transportAddresses to be considered instead.


the write consistency level to use with INDEX and BULK operations (can be any of ONE, QUORUM, ALL or DEFAULT) Camel 2.16


the replication type to use with INDEX and BULK operations (can be any of SYNC, ASYNC or DEFAULT) Camel 2.16

Message Operations

The following ElasticSearch operations are currently supported. Simply set an endpoint URI option or exchange header with a key of "operation" and a value set to one of the following. Some operations also require other parameters or the message body to be set.


message body



Map, String, byte[] or XContentBuilder content to index

adds content to an index and returns the content's indexId in the body.

Camel 2.15, you can set the indexId by setting the message header with the key "indexId".


index id of content to retrieve

retrieves the specified index and returns a GetResult object in the body


index id of content to delete

deletes the specified indexId and returns a DeleteResult object in the body


List or Collection of any type that is already accepted (XContentBuilder, Map, byte[], String)

Camel 2.14, adds content to an index and return a List of the id of the successfully indexed documents in the body


List or Collection of any type that is already accepted (XContentBuilder, Map, byte[], String)

Camel 2.15: Adds content to an index and returns the BulkResponse object in the body

SEARCHMap or SearchRequest ObjectCamel 2.15: search the content with the map of query string

Index Example

Below is a simple INDEX example

A client would simply need to pass a body message containing a Map to the route. The result body contains the indexId created.

For more information, see these resources

ElasticSearch Main Site

ElasticSearch Java API

See Also

© 2004-2015 The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Graphic Design By Hiram