User-created Elasticsearch data source

Prerequisites

• A user-created Elasticsearch database is available.

• The username and password for the Elasticsearch database are obtained.

Limitations

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

• The LIMIT clause in Elasticsearch does not support OFFSET, so paginated queries do not work. Disable pagination when you create charts that use an Elasticsearch data source.

• Multi-table joins are not supported in Elasticsearch.

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 display name of the data source 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 the Elasticsearch database.
   Username and Password	The credentials used to access the database. The user must have CREATE, INSERT, UPDATE, and DELETE permissions on the database tables.
   Time zone	The time zone of the Elasticsearch database.
   SSH	Enable this option to connect to the database through an SSH tunnel via a bastion host. Contact your operations team or system administrator for bastion host details. If enabled, 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.