Query OData Services in ColdFusion

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

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

     The User and Password properties, under the Authentication section, must be set to valid OData user credentials. In addition, you will need to specify a URL to a valid OData server organization root or OData services file.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.odata.jar

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

     A typical JDBC URL is below:

     jdbc:odata:URL=http://services.odata.org/V4/Northwind/Northwind.svc;UseIdUrl=True;OData Version=4.0;Data Format=ATOM;
   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.odata.ODataDriver.
   • 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 OData data source in the Actions column. After reporting a status of OK, the OData data source is ready for use.

Execute Queries

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

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

Below is the equivalent in CFScript:

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

writeDump( var= result );
</cfscript> 

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