Query Cosmos DB Data in ColdFusion

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Cosmos DB JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Cosmos DB document databases.



Write standard ColdFusion data access code to connect to Cosmos DB data.

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

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

      To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

      • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
      • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.cosmosdb.jar

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

      A typical JDBC URL is below:

      jdbc:cosmosdb:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.cosmosdb.CosmosDBDriver.
    • 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 Cosmos DB data source in the Actions column. After reporting a status of OK, the Cosmos DB data source is ready for use.

Execute Queries

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

<cfquery name="CosmosDBQuery" dataSource="CDataCosmosDB"> SELECT * FROM Customers WHERE Name = <cfqueryparam value="#Name#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#CosmosDBQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Customers WHERE Name = ?", 
  [
    { value="Morris Park Bake Shop", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataCosmosDB" }
);

writeDump( var= result );
</cfscript> 

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

http://MyServer:8500/query.cfm?Name=Morris Park Bake Shop