Query Elasticsearch Data in ColdFusion

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Elasticsearch JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Elasticsearch.



Write standard ColdFusion data access code to connect to Elasticsearch data.

The CData JDBC Driver for Elasticsearch seamlessly integrates connectivity to Elasticsearch data with the rapid development tools in ColdFusion. This article shows how to connect to Elasticsearch data in ColdFusion and query Elasticsearch tables.

Create a JDBC Data Source for Elasticsearch in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

  1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

    The JAR and license for the driver are located in the lib subfolder of the installation directory.

    Restart the server after this step.

  2. Add the driver as a data source:

    From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

  3. Populate the driver properties:

    • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:elasticsearch: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

      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.

      A typical JDBC URL is below:

      jdbc:elasticsearch:Server=127.0.0.1;Port=9200;User=admin;Password=123456;
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.elasticsearch.ElasticsearchDriver.
    • Driver Name: Enter a user-defined name for the driver.
    • Username: Enter the username used to authenticate.
    • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Elasticsearch data source in the Actions column. After reporting a status of OK, the Elasticsearch data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Elasticsearch, including INSERT, UPDATE, and DELETE.. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

<cfquery name="ElasticsearchQuery" dataSource="CDataElasticsearch"> SELECT * FROM Orders WHERE ShipCity = <cfqueryparam value="#ShipCity#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#ElasticsearchQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Orders WHERE ShipCity = ?", 
  [
    { value="New York", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataElasticsearch" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?ShipCity=New York