You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2016/06/03 08:19:09 UTC
svn commit: r989851 - in /websites/production/camel/content:
cache/main.pageCache elasticsearch.html
Author: buildbot
Date: Fri Jun 3 08:19:08 2016
New Revision: 989851
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/elasticsearch.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/elasticsearch.html
==============================================================================
--- websites/production/camel/content/elasticsearch.html (original)
+++ websites/production/camel/content/elasticsearch.html Fri Jun 3 08:19:08 2016
@@ -96,7 +96,7 @@
</div></div><h3 id="ElasticSearch-URIformat">URI format</h3><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[elasticsearch://clusterName[?options]
]]></script>
-</div></div><div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>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 <a shape="rect" class="external-link" href="http://www.elasticsearch.org/guide/reference/java-api/client.html" rel="nofollow">client guide</a> for more details.</p></div></div><h3 id="ElasticSearch-EndpointOptions">Endpoint Options</h3><p>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)</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>descrip
tion</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>operation</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>required, indicates the operation to perform</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>indexName</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the name of the index to act against</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>indexType</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the type of the index to act against</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>ip</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the TransportClient remote host ip to use <strong>Camel 2.12</strong></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>port</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the TransportClient remote port to use (defaults to 9300) <strong>Camel 2.12</strong></p></td></tr><tr><td colspan="1" r
owspan="1" class="confluenceTd"><p>transportAddresses</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>comma separated list with <em>ip:port</em> formatted remote transport addresses to use <strong>Camel 2.16</strong></span></p><p><span>Options <em>ip</em> and <em>port</em> must be left blank for <em>transportAddresses</em> to be considered instead</span>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>consistencyLevel</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the write consistency level to use with INDEX and BULK <span>operations</span> (can be any of <span>ONE, QUORUM, ALL or DEFAULT</span>) <strong>Camel 2.16</strong></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>replicationType</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the replication type to use with INDEX<span> and BULK</span> operations (can be any of SYNC, ASYNC or DEFAULT) <strong>Camel 2.16</strong></p><p><strong>From version
2.17 replicationType option has been removed, since from elasticsearch 2.0.0 the async replication has been removed.</strong></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>parent</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span style="color: rgb(34,34,34);">optionally used with INDEX operations for Elasticsearch <a shape="rect" class="external-link" href="https://www.elastic.co/guide/en/elasticsearch/guide/current/parent-child.html" rel="nofollow">Parent-Child relationships</a> to specify the ID of the parent record <strong>Camel 2.16.1 / 2.17.0</strong></span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><span>clientTransportSniff</span></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span style="color: rgb(34,34,34);"><strong>From Camel 2.17 </strong>Define if the client is allowed to sniff the rest of the cluster</span></p></td></tr></tbody></table></div><h3 id="ElasticSearch-MessageOperations">Message O
perations</h3><p>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.</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>operation</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>message body</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>INDEX</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Map, String, byte[] or XContentBuilder content to index</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>adds content to an index and returns the content's indexId in the body.</p><p><strong>Camel 2.15,</strong> you can set the <span style="line-height: 1.4285715;">indexId by setting the message
header with the key "indexId".</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>GET_BY_ID</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>index id of content to retrieve</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>retrieves the specified index and returns a GetResult object in the body</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>DELETE</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>index id of content to delete</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>deletes the specified indexId and returns a DeleteResult object in the body</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="p1">BULK_INDEX</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>a <strong>List</strong> or <strong>Collection</strong> of any type that is already accepted (XContentBuilder, Map, byte[], String)</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><
strong>Camel 2.14, </strong>adds content to an index and return a List of the id of the successfully indexed documents in the body</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>BULK</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>a </span><strong>List</strong><span> or </span><strong>Collection</strong><span> of any type that is already accepted (XContentBuilder, Map, byte[], String)</span></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.15:</strong> Adds content to an index and returns the BulkResponse object in the body</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>SEARCH</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Map or SearchRequest Object</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.15:</strong><span> search the content with the map of query string</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p
>MULTIGET</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>List of MultigetRequest.Item object</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong><span> <span>retrieves the specified indexes, types etc. in MultigetRequest and returns a MultigetResponse object in the body</span></span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>MULTISEARCH</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>List of SearchRequest object</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong><span> <span>search for parameters specified in MultiSearchRequest and returns a MultiSearchResponse object in the body</span></span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>EXISTS</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Index name as header</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong><span> <span>Returns a Boolean object
in the body</span></span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">UPDATE</td><td colspan="1" rowspan="1" class="confluenceTd"><span>Map, String, byte[] or XContentBuilder content to update</span></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong> Updates content to an index <span>and returns the content's indexId in the body.</span></td></tr></tbody></table></div><h3 id="ElasticSearch-IndexExample">Index Example</h3><p>Below is a simple INDEX example</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>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 <a shape="rect" class="external-link" href="http://www.elasticsearch.org/guide/reference/java-api/client.html" rel="nofollow">client guide</a> for more details.</p></div></div><h3 id="ElasticSearch-EndpointOptions">Endpoint Options</h3><p>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)</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>descrip
tion</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>operation</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>required, indicates the operation to perform</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>indexName</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the name of the index to act against</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>indexType</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the type of the index to act against</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>ip</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the TransportClient remote host ip to use <strong>Camel 2.12</strong></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>port</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the TransportClient remote port to use (defaults to 9300) <strong>Camel 2.12</strong></p></td></tr><tr><td colspan="1" r
owspan="1" class="confluenceTd"><p>transportAddresses</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>comma separated list with <em>ip:port</em> formatted remote transport addresses to use <strong>Camel 2.16</strong></span></p><p><span>Options <em>ip</em> and <em>port</em> must be left blank for <em>transportAddresses</em> to be considered instead</span>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>consistencyLevel</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the write consistency level to use with INDEX and BULK <span>operations</span> (can be any of <span>ONE, QUORUM, ALL or DEFAULT</span>) <strong>Camel 2.16</strong></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>replicationType</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the replication type to use with INDEX<span> and BULK</span> operations (can be any of SYNC, ASYNC or DEFAULT) <strong>Camel 2.16</strong></p><p><strong>From version
2.17 replicationType option has been removed, since from elasticsearch 2.0.0 the async replication has been removed.</strong></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>parent</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span style="color: rgb(34,34,34);">optionally used with INDEX operations for Elasticsearch <a shape="rect" class="external-link" href="https://www.elastic.co/guide/en/elasticsearch/guide/current/parent-child.html" rel="nofollow">Parent-Child relationships</a> to specify the ID of the parent record <strong>Camel 2.16.1 / 2.17.0</strong></span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><span>clientTransportSniff</span></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span style="color: rgb(34,34,34);"><strong>From Camel 2.17 </strong>Define if the client is allowed to sniff the rest of the cluster</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><span>pathHome</
span></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span style="color: rgb(34,34,34);"><strong>From Camel 2.17.2  </strong>Define the path.home property inside settings of ElasticSearch node. Default value is <em>/usr/share/elasticsearch</em><br clear="none"></span></p></td></tr></tbody></table></div><h3 id="ElasticSearch-MessageOperations">Message Operations</h3><p>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.</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>operation</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>message body</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>IN
DEX</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Map, String, byte[] or XContentBuilder content to index</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>adds content to an index and returns the content's indexId in the body.</p><p><strong>Camel 2.15,</strong> you can set the <span style="line-height: 1.4285715;">indexId by setting the message header with the key "indexId".</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>GET_BY_ID</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>index id of content to retrieve</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>retrieves the specified index and returns a GetResult object in the body</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>DELETE</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>index id of content to delete</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>deletes the specified indexId and returns a DeleteResult
object in the body</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="p1">BULK_INDEX</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>a <strong>List</strong> or <strong>Collection</strong> of any type that is already accepted (XContentBuilder, Map, byte[], String)</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.14, </strong>adds content to an index and return a List of the id of the successfully indexed documents in the body</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>BULK</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>a </span><strong>List</strong><span> or </span><strong>Collection</strong><span> of any type that is already accepted (XContentBuilder, Map, byte[], String)</span></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.15:</strong> Adds content to an index and returns the BulkResponse object in the body</p></td>
</tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>SEARCH</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Map or SearchRequest Object</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.15:</strong><span> search the content with the map of query string</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>MULTIGET</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>List of MultigetRequest.Item object</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong><span> <span>retrieves the specified indexes, types etc. in MultigetRequest and returns a MultigetResponse object in the body</span></span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>MULTISEARCH</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>List of SearchRequest object</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong><span> <span>search for parameters spe
cified in MultiSearchRequest and returns a MultiSearchResponse object in the body</span></span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>EXISTS</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Index name as header</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong><span> <span>Returns a Boolean object in the body</span></span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">UPDATE</td><td colspan="1" rowspan="1" class="confluenceTd"><span>Map, String, byte[] or XContentBuilder content to update</span></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong> Updates content to an index <span>and returns the content's indexId in the body.</span></td></tr></tbody></table></div><h3 id="ElasticSearch-IndexExample">Index Example</h3><p>Below is a simple INDEX example</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("direct:index")
.to("elasticsearch://local?operation=INDEX&indexName=twitter&indexType=tweet");
]]></script>