Connect to Elasticsearch Data in Aqua Data Studio

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.

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.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. 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.

     A typical JDBC URL is below:
     jdbc:elasticsearch:Server=127.0.0.1;Port=9200;User=admin;Password=123456;

Query Elasticsearch Data

You can now query the tables exposed.