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 6.0 or later

Create a connection to Elasticsearch

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

  • Username and password
    (Optional) Anonymous access
  • SSL certificate (if required by the database server)

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 > Data access tools > Connection. 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 Add to space > Connection. See Adding connections to a deployment space.
In the Platform assets catalog
Click New connection. See Adding platform connections.

Next step: Add data assets from the connection

Where you can use this connection

You can use Elasticsearch connections in the following workspaces and tools:

Projects

Catalogs

  • Platform assets catalog

  • Other catalogs (IBM Knowledge Catalog)

Federal Information Processing Standards (FIPS) compliance

  • 4.8.0, 4.8.1, and 4.8.2: This connection is compliant with FIPS.
  • 4.8.3 and later: This connection is not compliant with FIPS, but it is FIPS-tolerant.

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

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