Skip to content

Commit

Permalink
Improve Elasticsearch connector documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fornaix authored and zhenxiao committed Sep 22, 2020
1 parent 00fbb9b commit 79c3a3f
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions presto-docs/src/main/sphinx/connector/elasticsearch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ replacing the properties as appropriate:
connector.name=elasticsearch
elasticsearch.host=localhost
elasticsearch.port=9200
elasticsearch.default-schema=default
elasticsearch.default-schema-name=default
Configuration Properties
------------------------
Expand All @@ -41,7 +41,7 @@ Property Name Description
============================================= ==============================================================================
``elasticsearch.host`` Host name of the Elasticsearch server.
``elasticsearch.port`` Port of the Elasticsearch server.
``elasticsearch.default-schema`` Default schema name for tables.
``elasticsearch.default-schema-name`` Default schema name for tables.
``elasticsearch.scroll-size`` Maximum number of hits to be returned with each Elasticsearch scroll request.
``elasticsearch.scroll-timeout`` Amount of time Elasticsearch will keep the search context alive for scroll requests.
``elasticsearch.max-hits`` Maximum number of hits a single Elasticsearch request can fetch.
Expand All @@ -51,6 +51,7 @@ Property Name Description
``elasticsearch.node-refresh-interval`` How often to refresh the list of available Elasticsearch nodes.
``elasticsearch.max-http-connections`` Maximum number of persistent HTTP connections to Elasticsearch.
``elasticsearch.http-thread-count`` Number of threads handling HTTP connections to Elasticsearch.
``elasticsearch.ignore-publish-address`` Whether to ignore the published address and use the configured address.
============================================= ==============================================================================

``elasticsearch.host``
Expand All @@ -67,8 +68,8 @@ Specifies the port of the Elasticsearch node to connect to.

This property is optional; the default is ``9200``.

``elasticsearch.default-schema``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
``elasticsearch.default-schema-name``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Defines the schema that will contain all tables defined without
a qualifying schema name.
Expand Down Expand Up @@ -143,6 +144,15 @@ This property controls the number of threads handling HTTP connections to Elasti

This property is optional; the default is number of available processors.

``elasticsearch.ignore-publish-address``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The address is used to address Elasticsearch nodes. When running in a container environment, the
published address may not match the public address of the container. This option makes the
connector ignore the published address and use the configured address, instead.

This property is optional; the default is ``false``.

TLS Security
------------
The Elasticsearch connector provides additional security options to support Elasticsearch clusters that have been configured to use TLS.
Expand Down Expand Up @@ -275,7 +285,7 @@ as part of the table name, separated by a colon. For example:

.. code-block:: sql
SELECT * FROM "tweets: +presto DB^2"
SELECT * FROM elasticsearch.default."tweets: +presto DB^2"
.. _full text query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax

Expand Down

0 comments on commit 79c3a3f

Please sign in to comment.