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
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
If you have set up an integrated cloud service, select the service instance to automatically fill in the fields in the connection form. Confirm that all the fields are complete.
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 Private connectivity, to connect to a database that is not externalized to the internet (for example, behind a firewall), you must set up a secure connection.
Choose the method for creating a connection based on where you are in the platform
- In a project
- Click Assets > New asset > 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
Where you can use this connection
You can use Elasticsearch connections in the following workspaces and tools:
Projects
- Data Refinery (watsonx.ai Studio or IBM Knowledge Catalog)
- DataStage (DataStage service). See Connecting to a data source in DataStage.
- SPSS Modeler (watsonx.ai Studio)
Catalogs
-
Platform assets catalog
-
Other catalogs (IBM Knowledge Catalog)
Elasticsearch setup
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