VOOZH about

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

⇱ Configure the CData JDBC Driver for Elasticsearch in a Connection Pool in Tomcat

Configure the CData JDBC Driver for Elasticsearch in a Connection Pool in Tomcat

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Elasticsearch data from a connection pool in Tomcat.

The CData JDBC Drivers support standard JDBC interfaces to integrate with Web applications running on the JVM. This article details how to connect to Elasticsearch data from a connection pool in Tomcat.

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


Connect to Elasticsearch Data through a Connection Pool in Tomcat

  1. Copy the CData JAR and CData .lic file to $CATALINA_HOME/lib. The CData JAR is located in the lib subfolder of the installation directory.
  2. Add a definition of the resource to the context. Specify the JDBC URL here.

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

    You can see the JDBC URL specified in the resource definition below. 

    <Resource name="jdbc/elasticsearch" auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.elasticsearch.ElasticsearchDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" url="jdbc:elasticsearch:Server=127.0.0.1;Port=9200;User=admin;Password=123456;" maxActive="20" maxIdle="10" maxWait="-1" />

    To allow a single application to access Elasticsearch data, add the code above to the context.xml in the application's META-INF directory.

    For a shared resource configuration, add the code above to the context.xml located in $CATALINA_BASE/conf. A shared resource configuration provides connectivity to Elasticsearch for all applications.

  3. Add a reference to the resource to the web.xml for the application. 
     Elasticsearch data JSP
 jdbc/Elasticsearch
 javax.sql.DataSource
 Container
  4. Initialize connections from the connection pool: 
    Context initContext = new InitialContext();
Context envContext = (Context)initContext.lookup("java:/comp/env");
DataSource ds = (DataSource)envContext.lookup("jdbc/Elasticsearch");
Connection conn = ds.getConnection();

More Tomcat Integration

The steps above show how to connect to Elasticsearch data in a simple connection pooling scenario. For more use cases and information, see the JNDI Datasource How-To in the Tomcat documentation.