Skip to content

codelibs/elasticsearch-dataformat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Repository files navigation

Elasticsearch Data Format Plugin

Overview

Elasticsearch Data Format Plugin provides a feature to allow you to download a response of a search result as several formats other than JSON. The supported formats are CSV, Excel and JSON(Bulk).

Version

Versions in Maven Repository

Issues/Questions

Please file an issue. (Japanese forum is here.)

Installation

For 5.x

$ $ES_HOME/bin/elasticsearch-plugin install org.codelibs:elasticsearch-dataformat:5.3.0 

For 2.x

$ $ES_HOME/bin/plugin install org.codelibs/elasticsearch-dataformat/2.4.0 

Supported Output Formats

This plugin allows you to download data as a format you want. If the query dsl contains "from" parameter, the query is processed as search query. If not, it's as scan query(all data are stored.).

CSV

$ curl -o /tmp/data.csv -XGET "localhost:9200/{index}/{type}/_data?format=csv&source=..." 
Request ParameterTypeDescription
append.headerbooleanAppend column headers if true
fields_namestringchoose the fields to dump
sourcestringQuery DSL
csv.separatorstringSeparate character in CSV
csv.quotestringQuote character in CSV
csv.escapestringEscape character in CSV
csv.nullStringstringString if a value is null
csv.encodingstringEncoding for CSV

Excel

$ curl -o /tmp/data.xls -XGET "localhost:9200/{index}/{type}/_data?format=xls&source=..." 
Request ParameterTypeDescription
append.headerbooleanAppend column headers if true
fields_namestringchoose the fields to dump
sourcestringQuery DSL

Excel 2007

$ curl -o /tmp/data.xlsx -XGET "localhost:9200/{index}/{type}/_data?format=xlsx&source=..." 
Request ParameterTypeDescription
sourcestringQuery DSL

JSON (Elasticsearch Bulk format)

$ curl -o /tmp/data.json -XGET "localhost:9200/{index}/{type}/_data?format=json&source=..." 
Request ParameterTypeDescription
sourcestringQuery DSL
bulk.indexstringIndex name in Bulk file
bulk.typestringType name in Bulk file

About

Excel/CSV/BulkJSON downloads on Elasticsearch.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 11

Languages