User-created Elasticsearch data source

Prerequisites

• You have a user-created Elasticsearch database.

• You have the username and password for the Elasticsearch database.

Limitations

• Elasticsearch version 7.8.1 or later with the X-Pack plugin (Platinum Edition) is required.

• Due to a syntax limitation in Elasticsearch, the LIMIT clause does not support OFFSET. This prevents paginated queries from working correctly. When creating charts that use an Elasticsearch data source, disable pagination.

• Elasticsearch does not support multi-table joins due to native syntax limitations.

Procedure

1. Add IP addresses to the allowlist.

   Before connecting to your user-created Elasticsearch data source, add the IP addresses of Quick BI to the allowlist for your Elasticsearch instance.

2. Log on to the Quick BI console.

3. Follow the instructions in Create a data source to navigate to the data source creation page.

4. On the User-created Data Source tab, select Elasticsearch.

   

5. In the Configure Connection dialog box, configure the parameters as needed.

   Parameter	Description
   Display name	The name of the data source that appears in the data source list. Do not use special characters, or leading or trailing spaces in the name.
   Database endpoint and Port	The IP address or domain name of your Elasticsearch database.
   Username and Password	The credentials for accessing the database. The user must have CREATE, INSERT, UPDATE, and DELETE permissions on the database tables.
   Time zone	The time zone where your Elasticsearch database is deployed.
   SSH	You can use an SSH tunnel through a bastion host to connect to your database. Contact your operations team or system administrator for bastion host details. If you enable this option, configure the following parameters. SSH Host: The IP address of the bastion host. SSH Username: The username for logging on to the bastion host. SSH Password: The password that corresponds to the username. SSH Port: The port of the bastion host. The default is 22.

6. Click Test Connection to verify the data source connection.

7. After a successful test, click OK.