Validate Elasticsearch Data with QuerySurge

QuerySurge is a smart data testing solution that automates data validation and testing. When paired with the CData JDBC Driver for Elasticsearch, QuerySurge can work with live Elasticsearch data. This article explains how to connect to Elasticsearch data from QuerySurge.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Elasticsearch data. When you issue complex SQL queries to Elasticsearch, the driver pushes supported SQL operations, like filters and aggregations, directly to Elasticsearch and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Elasticsearch data using native data types.

Getting Started

---

Connecting to Elasticsearch Data in QuerySurge

To connect to live Elasticsearch data from QuerySurge, you need to deploy the JDBC Driver JAR file to your QuerySurge Agent(s) and add a new connection from the QuerySurge Admin view.

Deploy the JDBC Driver

1. Download the CData JDBC Driver for Elasticsearch installer, unzip the package, and run the JAR file to install the driver.
2. Once the driver is installed, stop the Agent Service.
3. Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for Elasticsearch\lib\) to your Agent(s) (QuerySurge_install_dir\agent\jdbc).
4. Restart the Agent Service.

For more information on deploying JDBC drivers for QuerySurge, refer to the QuerySurge Knowledge Base.

Configure a New Connection to Elasticsearch

1. Log into QuerySurge and navigate to the Admin view.
2. Click Configuration -> Connections in the Administration Tree.
3. Click Add to create a new connection.
4. In the QuerySurge Connection Wizard, click Next. 👁 Creating a new connection
   
5. Name the connection (e.g. CData JDBC Connection to Elasticsearch).
6. Set the Data Source to "All Other JDBC Connections (Connection Extensibility)" and click Next. 👁 Naming the connection and choosing a Data Source
   
7. Set the Driver Class to cdata.jdbc.elasticsearch.ElasticsearchDriver and click Next. 👁 Setting the Driver Class
   

8. Set the Connection URL using the necessary connection properties to authenticate with Elasticsearch. Your Connection URL will look something like the following:

   jdbc:elasticsearch:Server=127.0.0.1;Port=9200;User=admin;Password=123456;

   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.

   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.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   
9. Set the Test Query to enable the Test Connection button for the Connection (e.g. SELECT * FROM Orders LIMIT 1) and click Next. 👁 Setting the Connection URL and Test Query (NetSuite is shown)
   
10. Click Test Connection to ensure the connection is configured properly and click Save to add the connection.

Once the connection is added, you can write SQL queries against your Elasticsearch data in QuerySurge.

Compare Elasticsearch Data Queries with a QueryPair

With the connection configured, you can follow the steps below to compare querying Elasticsearch data with a QueryPair.

1. Select "Design Library" from the Design Menu
2. Click QueryPairs under QuerySurge Design
3. Click "Create New QueryPair"
4. Name the QueryPair and click Save
5. In either the Source or Target panes, select the connection created above (select the same connection to query Elasticsearch twice or another connection to perform a comparison)
6. Write queries in the Editor for each pane, e.g. SELECT * FROM Orders 👁 Setting the Connection URL and Test Query (NetSuite is shown)
   
7. Click the "Design-Time Run" tab to execute the queries
8. When the query execution is finished, click "View Query Results" to see the Elasticsearch data returned by the query 👁 Setting the Connection URL and Test Query (NetSuite is shown)
   

Download a free, 30-day trial of the CData JDBC Driver for Elasticsearch and start working with your live Elasticsearch data in QuerySurge. Reach out to our Support Team if you have any questions.