{"id":21994356,"url":"https://github.com/codelibs/elasticsearch-dataformat","last_synced_at":"2025-06-29T21:04:29.530Z","repository":{"id":11485744,"uuid":"13957781","full_name":"codelibs/elasticsearch-dataformat","owner":"codelibs","description":"Excel/CSV/BulkJSON downloads on Elasticsearch.","archived":false,"fork":false,"pushed_at":"2022-10-05T18:20:07.000Z","size":319,"stargazers_count":145,"open_issues_count":30,"forks_count":36,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-05-20T09:06:36.335Z","etag":null,"topics":["csv","elasticsearch","elasticsearch-plugin","excel","json"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codelibs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-10-29T14:16:34.000Z","updated_at":"2024-10-17T10:22:28.000Z","dependencies_parsed_at":"2023-01-11T20:16:58.449Z","dependency_job_id":null,"html_url":"https://github.com/codelibs/elasticsearch-dataformat","commit_stats":null,"previous_names":[],"tags_count":58,"template":false,"template_full_name":null,"purl":"pkg:github/codelibs/elasticsearch-dataformat","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Felasticsearch-dataformat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Felasticsearch-dataformat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Felasticsearch-dataformat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Felasticsearch-dataformat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codelibs","download_url":"https://codeload.github.com/codelibs/elasticsearch-dataformat/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codelibs%2Felasticsearch-dataformat/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262667290,"owners_count":23345529,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csv","elasticsearch","elasticsearch-plugin","excel","json"],"created_at":"2024-11-29T21:08:34.926Z","updated_at":"2025-06-29T21:04:28.740Z","avatar_url":"https://github.com/codelibs.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"Elasticsearch Data Format Plugin\n========================\n\n## Overview\n\nElasticsearch Data Format Plugin provides a feature to allow you to download a response of a search result as several formats other than JSON.\nThe supported formats are CSV, Excel, JSON(Bulk) and JSON(Object List).\n\n## Version\n\n[Versions in Maven Repository](https://repo1.maven.org/maven2/org/codelibs/elasticsearch-dataformat/)\n\n### Issues/Questions\n\nPlease file an [issue](https://github.com/codelibs/elasticsearch-dataformat/issues \"issue\").\n\n## Installation\n\n    $ $ES_HOME/bin/elasticsearch-plugin install org.codelibs:elasticsearch-dataformat:7.6.0\n\n## Supported Output Formats\n\nThis plugin allows you to download data as a format you want.\nBy default, the 100 first hits are returned.\nYou can customize hits returned with `from` and `size` query parameters.\nIf you want to download all data, use `scroll=1m` query parameter.\n\n### CSV\n\n    $ curl -o /tmp/data.csv -XGET \"localhost:9200/{index}/{type}/_data?format=csv\u0026source=...\"\n\n| Request Parameter | Type    | Description |\n|:------------------|:-------:|:------------|\n| append.header     | boolean | Append column headers if true |\n| fields_name       | string  | choose the fields to dump |\n| source            | string  | [Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html) |\n| csv.separator     | string  | Separate character in CSV |\n| csv.quote         | string  | Quote character in CSV|\n| csv.escape        | string  | Escape character in CSV |\n| csv.nullString    | string  | String if a value is null |\n| csv.encoding      | string  | Encoding for CSV |\n\n### Excel\n\n    $ curl -o /tmp/data.xls -XGET \"localhost:9200/{index}/{type}/_data?format=xls\u0026source=...\"\n\n| Request Parameter | Type    | Description |\n|:------------------|:-------:|:------------|\n| append.header     | boolean | Append column headers if true |\n| fields_name       | string  | choose the fields to dump |\n| source            | string  | [Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html) |\n\n### Excel 2007\n\n    $ curl -o /tmp/data.xlsx -XGET \"localhost:9200/{index}/{type}/_data?format=xlsx\u0026source=...\"\n\n| Request Parameter | Type    | Description |\n|:------------------|:-------:|:------------|\n| source            | string  | [Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html) |\n\n### JSON (Elasticsearch Bulk format)\n\n    $ curl -o /tmp/data.json -XGET \"localhost:9200/{index}/{type}/_data?format=json\u0026source=...\"\n\n| Request Parameter | Type    | Description |\n|:------------------|:-------:|:------------|\n| source            | string  | [Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html) |\n| bulk.index        | string  | Index name in Bulk file |\n| bulk.type         | string  | Type name in Bulk file |\n\n### JSON (Object List format)\n\n    $ curl -o /tmp/data.json -XGET \"localhost:9200/{index}/{type}/_data?format=jsonlist\u0026source=...\"\n\n| Request Parameter |  Type  | Description                                                  |\n| :---------------- | :----: | :----------------------------------------------------------- |\n| source            | string | [Query DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html) |\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodelibs%2Felasticsearch-dataformat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodelibs%2Felasticsearch-dataformat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodelibs%2Felasticsearch-dataformat/lists"}