Repository: calcite Updated Branches: refs/heads/site 860128004 -> eea0f9df7
Site: Improve documentation for ElasticSearch Adapter 1. Clarify documentation on Scroll API usage in ElasticSearch adapter. 2. Remove stale mention of missing support for aggregations (it is now fully supported). 3. Remove links to old ES adapters: `calcite-elasticsearch2` and `calcite-elasticsearch5`. We now have a single maven module: `calcite-elasticsearch`. Project: http://git-wip-us.apache.org/repos/asf/calcite/repo Commit: http://git-wip-us.apache.org/repos/asf/calcite/commit/eea0f9df Tree: http://git-wip-us.apache.org/repos/asf/calcite/tree/eea0f9df Diff: http://git-wip-us.apache.org/repos/asf/calcite/diff/eea0f9df Branch: refs/heads/site Commit: eea0f9df73888616100595b38c373d597edd10a2 Parents: 8601280 Author: Andrei Sereda <[email protected]> Authored: Mon Dec 24 14:38:53 2018 -0500 Committer: Andrei Sereda <[email protected]> Committed: Mon Dec 24 15:19:33 2018 -0500 ---------------------------------------------------------------------- site/_docs/adapter.md | 4 +--- site/_docs/elasticsearch_adapter.md | 19 +++++++++++-------- 2 files changed, 12 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/calcite/blob/eea0f9df/site/_docs/adapter.md ---------------------------------------------------------------------- diff --git a/site/_docs/adapter.md b/site/_docs/adapter.md index 01c8c87..00a0957 100644 --- a/site/_docs/adapter.md +++ b/site/_docs/adapter.md @@ -31,9 +31,7 @@ presenting the data as tables within a schema. * CSV adapter (<a href="{{ site.apiRoot }}/org/apache/calcite/adapter/csv/package-summary.html">example/csv</a>) * [Druid adapter](druid_adapter.html) (<a href="{{ site.apiRoot }}/org/apache/calcite/adapter/druid/package-summary.html">calcite-druid</a>) * [Elasticsearch adapter](elasticsearch_adapter.html) - (<a href="{{ site.apiRoot }}/org/apache/calcite/adapter/elasticsearch2/package-summary.html">calcite-elasticsearch2</a> - and - <a href="{{ site.apiRoot }}/org/apache/calcite/adapter/elasticsearch5/package-summary.html">calcite-elasticsearch5</a>) + (<a href="{{ site.apiRoot }}/org/apache/calcite/adapter/elasticsearch/package-summary.html">calcite-elasticsearch</a>) * [File adapter](file_adapter.html) (<a href="{{ site.apiRoot }}/org/apache/calcite/adapter/file/package-summary.html">calcite-file</a>) * [Geode adapter](geode_adapter.html) (<a href="{{ site.apiRoot }}/org/apache/calcite/adapter/geode/package-summary.html">calcite-geode</a>) * JDBC adapter (part of <a href="{{ site.apiRoot }}/org/apache/calcite/adapter/jdbc/package-summary.html">calcite-core</a>) http://git-wip-us.apache.org/repos/asf/calcite/blob/eea0f9df/site/_docs/elasticsearch_adapter.md ---------------------------------------------------------------------- diff --git a/site/_docs/elasticsearch_adapter.md b/site/_docs/elasticsearch_adapter.md index 21f2459..3eff935 100644 --- a/site/_docs/elasticsearch_adapter.md +++ b/site/_docs/elasticsearch_adapter.md @@ -47,10 +47,9 @@ A basic example of a model file is given below: { "type": "custom", "name": "elasticsearch", - "factory": "org.apache.calcite.adapter.elasticsearch2.Elasticsearch2SchemaFactory", + "factory": "org.apache.calcite.adapter.elasticsearch.ElasticsearchSchemaFactory", "operand": { "coordinates": "{'127.0.0.1': 9300}", - "userConfig": "{'bulk.flush.max.actions': 10, 'bulk.flush.max.size.mb': 1}", "index": "usa" } } @@ -58,9 +57,6 @@ A basic example of a model file is given below: } {% endhighlight %} -This adapter is targeted for Elasticsearch 2.x. To use Calcite with Elasticsearch 5.x+ you can use the factory -of the adapter targeted for Elasticsearch 5.x: `org.apache.calcite.adapter.elasticsearch5.Elasticsearch5SchemaFactory` - Assuming this file is stored as `model.json`, you can connect to Elasticsearch via [`sqlline`](https://github.com/julianhyde/sqlline) as follows: @@ -134,6 +130,13 @@ The final source json given to Elasticsearch is below: } {% endhighlight %} -This is the initial version of the Calcite Elasticsearch adapter. -Work is in progress to introduce new features like aggregations into -it. +### Use of Scrolling API +For queries without aggregate functions (like `COUNT`, `MAX` etc.) elastic adapter +uses [scroll API](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html), by default. +This ensures that consistent and full data-set is returned to end user (lazily and in batches). Please note that +scroll is automatically cleared (removed) when all query resuts are consumed. + +### Supported versions +Currently this adapter supports ElasticSearch versions 2.x (or newer). Generally +we try to follow official [support schedule](https://www.elastic.co/support/eol). +
