🔌Add a ElasticSearch connector

How to connect an elasticsearch cluster in Toucan

Connector features

You can use the Toucan Snowflake connector to connect to your Snowflake account with a key-pair authentication or basic authentication and access tables or views with a JSON query.

With this connection, you can fetch data from your Snowflake to fill your charts and dashboards.

Changelog

July 25 - We have upgraded our client ElasticSearch and v9 is now enforced

Configuring an ElasticSearch connection

Follow the steps described in Add a connector, choose ElasticSearch and fill out the form with the following info:

Field	Format / Type	Description	Example
Name (mandatory)	String	Use it to identify your connection	my_elasticsearch
URL (mandatory)	String	URL of your ElasticSearch server mandatory	https://elasticsearch-server.mydomain.com
Port (mandatory)	Integer	port number of your ElasticSearch server	9200
Scheme (mandatory)	String	connection scheme to use (e.g., "http" or"https").	https
Username (mandatory)	String	username to use for the authentication (if required)	my_login
Password (mandatory)	String	password for the authentication (if required) (will be stored as a secret)	abcD1234
Headers (optional)	Json dictionary	Allows to specify a dictionary of additional HTTP headers in the requests. It defaults to None, meaning that no additional headers are included by default. this dictionnary allows to configure: Authorization: If your Elasticsearch server requires specific authorization headers, you can include them here. Content-Type: You might include headers specifying the content type of the request, such as "application/json" if your queries are in JSON format. Custom Headers: Any other custom headers that your Elasticsearch server might expect for specific functionalities or integrations.
ES version (mandatory)	String	Specify the ElasticSearch version you aimed	9 (default)
Retry Policy (optional)	Boolean	Boolean allows to configure a retry policy if the connection is flaky. max attempts: maximum number of retries before giving up max_delay: in seconds, above the connection is dropped wait_time: time in seconds between each retry
Slow Queries' Cache Expiration Time (optional)	Integer	Slow queries' cache eexpiration time in seconds

Click on the TEST CONNECTION button then SAVE the connection

After successfully configuring the connector, you will be able to find it in the Connector section of the DataHub "Datasource" tab

Create a dataset from an ElasticSearch connection

fill out the required fields:

• SearchMethod: Select wether “search” or “msearch” (for multiple search)

• Index: Type the index of your ElasticSearch from which you want to extract data

• Configuration type: select “Type 1”

• Body: enter your query within a Json format (see an example below)

Data source configuration