VOOZH about

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

⇱ Manage Elasticsearch Data in DBArtisan as a JDBC Source

Manage Elasticsearch Data in DBArtisan as a JDBC Source

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use wizards in DBArtisan to create a JDBC data source for Elasticsearch.

The CData JDBC Driver for Elasticsearch seamlessly integrates Elasticsearch data into database management tools like DBArtisan by enabling you to access Elasticsearch data as a database. This article shows how to create a JDBC source for Elasticsearch in DBArtisan. You can then edit data visually and execute standard SQL.

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


Integrate Elasticsearch Data into DBArtisan Projects

Follow the steps below to register Elasticsearch data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic JDBC.
  3. Click Manage.
  4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
  5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

    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.

    👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)

    Below is a typical connection string:

    jdbc:elasticsearch:Server=127.0.0.1;Port=9200;User=admin;Password=123456;
  6. Finish the wizard to connect to Elasticsearch data. Elasticsearch entities are displayed in the Datasource Explorer.

You can now work with Elasticsearch data as you work with any other database. See the driver help documentation for more information on the queries supported by the Elasticsearch API.

👁 The results of a query. (Salesforce is shown.)