Connect to Elasticsearch Data in Aqua Data Studio

Jerod Johnson
Director, Technology Evangelism

Access Elasticsearch data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.

The CData JDBC Driver for Elasticsearch integrates Elasticsearch data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Elasticsearch data through the connection manager and execute queries.

About Elasticsearch Data Integration

Accessing and integrating live data from Elasticsearch has never been easier with CData. Customers rely on CData connectivity to:

Access both the SQL endpoints and REST endpoints, optimizing connectivity and offering more options when it comes to reading and writing Elasticsearch data.
Connect to virtually every Elasticsearch instance starting with v2.2 and Open Source Elasticsearch subscriptions.
Always receive a relevance score for the query results without explicitly requiring the SCORE() function, simplifying access from 3rd party tools and easily seeing how the query results rank in text relevance.
Search through multiple indices, relying on Elasticsearch to manage and process the query and results instead of the client machine.

Users frequently integrate Elasticsearch data with analytics tools such as Crystal Reports, Power BI, and Excel, and leverage our tools to enable a single, federated access layer to all of their data sources, including Elasticsearch.

For more information on CData's Elasticsearch solutions, check out our Knowledge Base article: CData Elasticsearch Driver Features & Differentiators.

Getting Started

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Elasticsearch data source can then be accessed from Aqua Data Studio tools.

In Aqua Data Studio, select Register Server from the Servers menu.
In the Register Server form, select the 'Generic - JDBC' connection.
Enter the following JDBC connection properties:
- Name: Enter a name for the data source; for example, Elasticsearch.
- Driver Location: Click the Browse button and select the cdata.jdbc.elasticsearch.jar file, located in the lib subfolder of the installation directory.
- Driver: Enter the Driver's class name, cdata.jdbc.elasticsearch.ElasticsearchDriver.
- URL: Enter the JDBC URL, which starts with jdbc:elasticsearch: and is followed by a semicolon-separated list of connection properties.
  
  Set the Server and Port connection properties to connect. To authenticate, set the User and Password properties, PKI (public key infrastructure) properties, or both. To use PKI, set the SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword properties.
  
  The data provider uses X-Pack Security for TLS/SSL and authentication. To connect over TLS/SSL, prefix the Server value with 'https://'. Note: TLS/SSL and client authentication must be enabled on X-Pack to use PKI.
  
  Once the data provider is connected, X-Pack will then perform user authentication and grant role permissions based on the realms you have configured.
  
  Built-in Connection String Designer
  
  For assistance in constructing the JDBC URL, use the connection string designer built into the Elasticsearch JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
```
java -jar cdata.jdbc.elasticsearch.jar
```
  Fill in the connection properties and copy the connection string to the clipboard.
  👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  A typical JDBC URL is below:
```
jdbc:elasticsearch:Server=127.0.0.1;Port=9200;User=admin;Password=123456;
```
👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)

Query Elasticsearch Data

You can now query the tables exposed.

👁 A query executed in the Table Data Editor. (QuickBooks is shown.)

Ready to get started?

Download a free trial of the Elasticsearch Driver to get started:

Download Now

Learn more:

👁 Elasticsearch Icon
Elasticsearch JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Elasticsearch.

URL: https://www.cdata.com/kb/tech/elasticsearch-jdbc-ads.rst