Connect to Elasticsearch Data as an External Source in Dremio



Use the CData JDBC Driver to connect to Elasticsearch as an External Source in Dremio.

The CData JDBC Driver for Elasticsearch implements JDBC Standards and allows various applications, including Dremio, to work with live Elasticsearch data. Dremio is a data lakehouse platform designed to empower self-service, interactive analytics on the data lake. With the CData JDBC driver, you can include live Elasticsearch data as a part of your enterprise data lake. This article describes how to connect to Elasticsearch data from Dremio as an External Source.

The CData JDBC Driver enables high-speed access to live Elasticsearch data in Dremio. Once you install the driver, authenticate with Elasticsearch and gain immediate access to Elasticsearch data within your data lake. By surfacing Elasticsearch data using native data types and handling complex filters, aggregations, & other operations automatically, the CData JDBC Driver grants seamless access to Elasticsearch data.

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


Prerequisites

This article assumes you are utilizing Docker to run Dremio. You can create a Docker container with the Dremio service using a command similar to the follow:

docker run -d --name dremio -p 9047:9047 -p 31010:31010 dremio/dremio-oss

Where dremio is the name of the container, 9047 is the container's port for the Dremio web interface and 31010 is the port that maps to the Dremio query service. dremio/dremio-oss specifies the image to use.

Build the ARP Connector

To use the CData JDBC Driver in Dremio, you need to build an Advanced Relation Pushdown (ARP) Connector. You can view the source code for the Connector on GitHub or download the ZIP file (GitHub.com) directly. Once you copy or extract the files, run the following command from the root directory of the connector (the directory containing the pom.xml file) to build the connector.

mvn clean install

NOTE: The CData ARP Connectors are build to be compiled with Java 11. Be sure to install Java 11 and use the correct version. You can update your Java version using a command similar to the following:

sudo update-alternatives --config java

Once the JAR file for the connector is built (in the target directory), you are ready to copy the ARP connector and JDBC Driver to your Dremio instance.

Installing the Connector and JDBC Driver

Install the ARP Connector to %DREMIO_HOME%/jars/ and the JDBC Driver for Elasticsearch to %DREMIO_HOME%/jars/3rdparty. You can use commands similar to the following:

ARP Connector

docker cp PATH\TO\dremio-elasticsearch-plugin-{DREMIO_VERSION}.jar dremio_image_name:/opt/dremio/jars/

JDBC Driver for Elasticsearch

docker cp PATH\TO\cdata.jdbc.elasticsearch.jar dremio_image_name:/opt/dremio/jars/3rdparty/

Connecting to Elasticsearch

Elasticsearch will now appear as an External Source option in Dremio. The ARP Connector built uses a JDBC URL to connect to Elasticsearch data. The JDBC Driver has a built-in connection string designer that you can use (see below).

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Elasticsearch JDBC Driver. 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.

NOTE: To use the JDBC Driver in Dremio, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Add the Runtime Key (RTK) to the JDBC URL. You will end up with a JDBC URL similar to the following:

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

Access Elasticsearch as an External Source

To add Elasticsearch as an External Source, click to add a new source and select Elasticsearch. Copy the JDBC URL and paste it into the New Elasticsearch Source wizard.

Save the connection and you are ready to query live Elasticsearch data in Dremio, easily incorporating Elasticsearch data into your data lake.

More Information & Free Trial

Using the CData JDBC Driver for Elasticsearch in Dremio, you can incorporate live Elasticsearch data into your data lake. Check out our CData JDBC Driver for Elasticsearch page for more information about connecting to Elasticsearch. Download a free, 30 day trial of the CData JDBC Driver for Elasticsearch and get started today.

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.