VOOZH about

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

⇱ Connect to Elasticsearch Data in NetBeans

Connect to Elasticsearch Data in NetBeans

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Elasticsearch data in NetBeans with the data source configuration wizard.

The CData JDBC Driver for Elasticsearch integrates connectivity to live Elasticsearch data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to Elasticsearch data in NetBeans. You will create a connection and edit and save Elasticsearch data in the Table Editor.

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


Create a JDBC Data Source for Elasticsearch in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

  • Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.elasticsearch.jar file. The driver JAR is located in the lib subfolder of the installation directory.
  • Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.elasticsearch.ElasticsearchDriver from the menu.
  • Name: Enter the name for the driver.
👁 The JDBC driver definition. (Salesforce is shown.)

Define Connection Parameters

Follow the steps below to define required connection properties:

  1. In the Service window, right-click the Database node and click New Connection.

  2. In the New Connection Wizard, enter the following connection properties:

    • Driver Name: In the menu, select the CData JDBC Driver for Elasticsearch.
    • User Name: Enter the username. This can also be defined in the JDBC URL.
    • Password: Enter the password. This can also be defined in the JDBC URL.

    • JDBC URL: Specify 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.

      👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

      A typical JDBC URL is the following:

      jdbc:elasticsearch:Server=127.0.0.1;Port=9200;User=admin;Password=123456;
👁 Required connection properties defined in the JDBC URL. (Salesforce is shown.)

Query Elasticsearch Data

To connect to Elasticsearch data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data. You can also insert, update, or delete records in the Data Views window.

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