Connecting to Elasticsearch

This article explains how to connect Dataedo to Elasticsearch and import metadata - indexes and fields.

Add new connection

To connect to an Elasticsearch 7 instance, create new documentation by clicking Add and choosing Database connection.

Connection details

On the Add documentation screen, choose Elasticsearch.

On the next screen, select Connection Type:

• Elasticsearch - when using the on-prem version of Elasticsearch.
• Elasticsearch cloud - when using the cloud version of Elasticsearch.

When selected Elasticsearch:

• Host - provide a host name or address where the database is located. E.g. http://server17, http://server17.ourdomain.com or http://192.168.0.37.
• Port - port on which your database is available. Do not change it unless you are sure that it is not the default 9200.
• User and password - if authentication is required for connection, provide your username and password. Both fields are optional.
• When Elasticsearch has configured SSL, check the CA Fingerprint checkbox and provide the CA fingerprint.

When selected Elasticsearch cloud:

There are two types of authentication:

• Username and password
• API key

When selected username and password authentication type:

• Cloud ID - provide the Cloud ID, which can be found in the Elasticsearch Service web console.
• User and password - if authentication is required for connection, provide your username and password. Both fields are optional.

When selected API key authentication type:

• Cloud ID - provide the Cloud ID, which can be found in the Elasticsearch Service web console.
• API key - provide the API key, which can be found in the Elasticsearch Service web console.

Saving password

You can save the password for later connections by checking the Save password option. Passwords are saved in the repository database.

Importing indexes

When the connection is successful, Dataedo will read objects and show a list of objects found. You can choose which objects to import. You can also use advanced filter to narrow down the list of objects.

Confirm the list of objects to import by clicking Next.

The next screen allows you to change the name of the documentation under which it will be visible in the Dataedo repository.

Click Import to start the import.

When done, close the import window with the Finish button.

Output

Your Elasticsearch metadata has been imported to new documentation in the repository.