Manage Elasticsearch Data in DBArtisan as a JDBC Source

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.

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.
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.

   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.