Elasticsearch Source Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium Elasticsearch connector.

This topic describes how to authenticate to Elasticsearch and configure any necessary connection properties in the Elasticsearch connection connector.

Connection Configuration #

Each connection property available in the Elasticsearch connector is explained below.

Connection Name #

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.

Connection Type #

Option to choose between either connecting securely using SSH Tunnel or, proceed with a direct connection.

If Connection Type value is SSH Tunnel, additional fields will be displayed as given below:

To know more about SSH Tunneling with Gathr, see SSH Tunneling.

SSH Key #

The SSH key should be provided to authenticate the associated SSH host and SSH user.

SSH Host #

Public IP address of your SSH host.

SSH User #

Default SSH username.

If Connection Type value is Direct Connection, then proceed by updating the following fields.

Auth Scheme #

The type of authentication to use when connecting to Elasticsearch.

Possible Values

• Basic: Set to this to perform a basic authentication.

• API Key: The API Key used to authenticate to Elasticsearch.

Basic #

If Basic is selected, additional configuration parameters will get listed.

User #

The user who is authenticating to Elasticsearch.

Password #

The password used to authenticate to Elasticsearch.

Server #

The host name or IP address of the Elasticsearch REST server.

Alternatively, multiple nodes in a single cluster can be specified, though all such nodes must be able to support REST API calls.

To use SSL, prefix the host name or IP address with ‘https://’ and set SSL connection properties such as SSLServerCert.

To specify multiple nodes, set the property to a comma delimited list of addresses, with ports optionally specified after the address and delimited from the address by a colon.

Example: You could specify two dedicated, coordinating nodes for your cluster with https://01.01.01.01:1234,https://02.02.02.02:5678.

If a port is specified with a node, that port will take precedence over the Port property for connections to that node only.

Port #

The port for the Elasticsearch REST server.

DataModel #

Specifies the data model to use when parsing Elasticsearch documents and generating the database metadata.

Possible Values:

• Document: Returns a single table representing a row for each document. In this data model, any nested documents will not be flattened and will be returned as aggregates.

• Flattened Documents: Returns a single table representing a JOIN of the parent and nested documents. In this data model, nested documents will act in the same manner as a SQL JOIN. Additionally, nested sibling documents (nested documents at same height), will be treated as a SQL CROSS JOIN. The connector will identify the nested documents available by parsing the returned document.

• Relational: Returns multiple tables, one for each nested document (including the parent document) in the document. In this data model, any nested documents will be returned as relational tables that contain a primary key and a foreign key that links to the parent table.

Enable SSL #

Check mark to enable SSL option for HTTPS.

Upload Keystore File #

Option to upload keystore file.

After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.