Ready to get started?

Learn more about the CData JDBC Driver for HPCC or download a free trial:

Download Now

Query HPCC Systems Data in ColdFusion

Write standard ColdFusion data access code to connect to HPCC Systems data.

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

Create a JDBC Data Source for HPCC Systems 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:hpcc: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

      To connect, set the following connection properties: Set URL to the machine name or IP address of the server and the port the server is running on, for example, https://server:port. The User and Password are required to authenticate to the HPCC Systems cluster specified in the URL. Note that LDAP authentication is not currently supported by our ODBC driver.

      Set Version to the WsSQL Web server version. Note that if you have not already done so, you will need to install the WsSQL service on the HPCC Systems server. The WsSQL Web service is used to interact with the underlying HPCC Systems platform.

      Set Cluster to the target cluster.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the HPCC Systems JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.hpcc.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      A typical JDBC URL is below:

      jdbc:hpcc:URL=http://127.0.0.1:8510;User=test;password=xA123456;Version=1;Cluster=hthor;
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.hpcc.HPCCDriver.
    • 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 HPCC Systems data source in the Actions column. After reporting a status of OK, the HPCC Systems data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to HPCC Systems. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

<cfquery name="HPCCQuery" dataSource="CDataHPCC"> SELECT * FROM hpcc::test::orders WHERE ShipCity = <cfqueryparam value="#ShipCity#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#HPCCQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM hpcc::test::orders WHERE ShipCity = ?", 
  [
    { value="New York", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataHPCC" }
);

writeDump( var= result );
</cfscript> 

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

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