[ https://issues.apache.org/jira/browse/STORM-845?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14639776#comment-14639776 ]
ASF GitHub Bot commented on STORM-845: -------------------------------------- Github user HeartSaVioR commented on a diff in the pull request: https://github.com/apache/storm/pull/573#discussion_r35388752 --- Diff: external/storm-elasticsearch/README.md --- @@ -0,0 +1,66 @@ +# Storm Elasticsearch Bolt & Trident State + + EsIndexBolt, EsPercolateBolt and EsState allows users to stream data from storm into Elasticsearch directly. + For detailed description, please refer to the following. + +## EsIndexBolt (org.apache.storm.elasticsearch.bolt.EsIndexBolt) + +EsIndexBolt streams tuples directly into Elasticsearch. Tuples are indexed in specified index & type combination. +User should make sure that there are "source", "index","type", and "id" fields declared in preceding bolts or spout. +"index" and "type" fields are used for identifying target index and type. +"source" is a document in JSON format string that will be indexed in elastic search. + +```java +EsConfig esConfig = new EsConfig(); +esConfig.setClusterName(clusterName); +esConfig.setNodes(new String[]{"localhost:9300"}); +EsIndexBolt indexBolt = new IndexBolt(esConfig); +``` + +## EsPercolateBolt (org.apache.storm.elasticsearch.bolt.EsPercolateBolt) + +EsPercolateBolt streams tuples directly into Elasticsearch. Tuples are used to send percolate request to specified index & type combination. +User should make sure that there are "source", "index", and "type" fields declared in preceding bolts or spout. +"index" and "type" fields are used for identifying target index and type. +"source" is a document in JSON format string that will be sent in percolate request to elastic search. + +```java +EsConfig esConfig = new EsConfig(); +esConfig.setClusterName(clusterName); +esConfig.setNodes(new String[]{"localhost:9300"}); +EsPercolateBolt percolateBolt = new EsPercolateBolt(esConfig); +``` + +### EsConfig (org.apache.storm.elasticsearch.common.EsConfig) + +Two bolts above takes in EsConfig as a constructor arg. + + ```java + EsConfig esConfig = new EsConfig(); + esConfig.setClusterName(clusterName); + esConfig.setNodes(new String[]{"localhost:9300"}); + ``` + +EsConfig params --- End diff -- ```EsConfig params => ### EsConfig params``` It would be better to emphasize this section. > Storm ElasticSearch connector > ----------------------------- > > Key: STORM-845 > URL: https://issues.apache.org/jira/browse/STORM-845 > Project: Apache Storm > Issue Type: New Feature > Reporter: Adrian Seungjin Lee > Assignee: Adrian Seungjin Lee > > It would be nice to provide storm driver for elasticsearch, just like it does > for hive, redis and so on. -- This message was sent by Atlassian JIRA (v6.3.4#6332)