Elasticsearch connection

To access your data in Elasticsearch, create a connection asset for it.

Elasticsearch is a distributed, open source search and analytics engine. Use the Elasticsearch connection to access JSON documents in Elasticsearch indexes.

Supported versions

Elasticsearch version 8.15.

Note:

Elasticsearch version 8.15.0 is not supported. If you are on version 8.15.0, upgrade to version 8.15.2. For more information, see Elasticsearch release notes.

Create a connection to Elasticsearch

To create the connection asset, you need these connection details:

  • URL: the URL to access Elasticsearch
  • SSL certificate (if required by the database server)

For credentials, choose one of the following methods:

  • Username and password
    (Optional) Anonymous access
  • API key
    (Optional) Anonymous access

For Credentials and Certificates, you can use secrets if a vault is configured for the platform and the service supports vaults. For information, see Using secrets from vaults in connections.

Choose the method for creating a connection based on where you are in the platform

In a project
Click Assets > New asset > Prepare data > Connect to a data source. See Adding a connection to a project.
In a catalog
Click Add to catalog > Connection. See Adding a connection asset to a catalog.
In a deployment space
Click Import assets > Data access > Connection. See Adding data assets to a deployment space.
In the Platform assets catalog
Click New connection. See Adding platform connections.

Next step: Add data assets from the connection

Federal Information Processing Standards (FIPS) compliance

This connection can be used on a FIPS-enabled cluster (FIPS tolerant); however, it is not FIPS-compliant.

For Elasticsearch connections in the DataStage service, see Known issues on FIPS-enabled clusters in the IBM Software Hub documentation.

Elasticsearch setup

Set up Elasticsearch

Restrictions

  • For Elasticsearch versions earlier than version 7, read is limited to 10,000 rows.
  • For Data Refinery, the only supported action on the target file is to append all the rows of the Data Refinery flow output to the existing data set.

Running SQL statements

To ensure that your SQL statements run correctly, refer to the Elasticsearch Guide for SQL for the correct syntax.

Learn more

Parent topic: Supported connections