Learn more
 

Ready to get started?

Download a free trial of the Cosmos DB ODBC Driver to get started:

 Download Now

Learn more:

Cosmos DB Icon Cosmos DB ODBC Driver

The Cosmos DB ODBC Driver is a powerful tool that allows you to connect with live Cosmos DB document databases, directly from any applications that support ODBC connectivity.

Access Cosmos DB like you would a database - read, write, and update through a standard ODBC Driver interface.

In this article

Related articles

Import Real-Time Cosmos DB Data in ColdFusion to Build Applications


Use CData ODBC drivers to import and use Cosmos DB data in ColdFusion.

Adobe ColdFusion is a web and mobile application development platform. It uses its own scripting language, ColdFusion Markup Language (CFML), to create data-driven websites as well as generate remote services, such as REST. When ColdFusion is paired with the CData ODBC Driver for Cosmos DB, you can link your ColdFusion web and mobile applications to operational Cosmos DB data. This allows for your applications to be more robust and complete. This article details how to use the ODBC driver to create a table populated with Cosmos DB data from within a ColdFusion markup file.

To follow along with this tutorial, you need to install the CData ODBC Driver for Cosmos DB and Adobe ColdFusion.

Configuring the Connection

If you have not already, first specify connection properties in an ODBC DSN (Data Source Name). This is the last step of the driver installation process. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Adding a Data Source and Creating a Table

After creating a DSN, follow the steps below to add a new data source, test our connection to it, create a ColdFusion markup file, and, finally, import Cosmos DB Cosmos DB data and display it in a table in ColdFusion:

  1. From the ColdFusion administrator interface, choose Data & Services.
  2. Here, click "Add New Data Source". The data source name can be any name, provided it conforms to the ColdFusion variable naming conventions. For our ODBC driver, choose "ODBC Socket", then click the "Add" button.
  3. From the ODBC DSN Dropdown menu select CData Cosmos DB Sys. Under the Advanced Settings section, leave the Connection String blank. Note that any properties specified in this input field will override the ones specified in the DSN Configuration.
  4. Now, test the connection by pressing the check mark to the left of the CDataCosmos DBODBC data source you just created. When the data source reports an "OK" status, it is ready for use.
  5. Next, create a new ColdFusion Markup file (.cfm) and place it in the wwwroot directory ("C:\ColdFusion2021\cfusion\wwwroot") for ColdFusion.

    The following code queries the data source: 

                
        <cfquery name="Cosmos DBQuery" dataSource="CDataCosmos DBODBC"> 
          SELECT * FROM Customers 
        </cfquery>
    And a CFTable can be used to quickly output the table in HTML: 
                
          <cftable  
          query = "Cosmos DBQuery" 
          border = "1" 
          colHeaders 
          colSpacing = "2" 
          headerLines = "2" 
          HTMLTable 
          maxRows = "500" 
          startRow = "1"> 

          <cfcol header="<b>City</b>" align="Left" width=2 text="City"/> 

          <cfcol header="<b>CompanyName</b>" align="Left" width=15 text="CompanyName"/> 

          ...

        </cftable>
    Full code, including the HTML portion is available below: 
                
        <html> 
        <head><title>CData Software | Cosmos DB Customers Table Demo </title></head> 
        <body> 
        <cfoutput>#ucase("Cosmos DB Customers Table Demo")#</cfoutput> 
        <cfquery name="Cosmos DBQuery" dataSource="CDataCosmos DBODBC"> 

          SELECT * FROM Customers 

        </cfquery> 
        <cftable  
          query = "Cosmos DBQuery" 
          border = "1" 
          colHeaders 
          colSpacing = "2" 
          headerLines = "2" 
          HTMLTable 
          maxRows = "500" 
          startRow = "1"> 
          <cfcol header="<b>City</b>" align="Left" width=2 text="City"/> 

          <cfcol header="<b>CompanyName</b>" align="Left" width=15 text="CompanyName"/> 

          ...

        </cftable> 
        </body> 

        </html>
  6. Finally, run the code in a browser. It produces a table populated with Cosmos DB data!

As a note, the CData ODBC Drivers also support parameterized queries using the cfqueryparam element. For example: SELECT * FROM Account WHERE name =

Get Started Today

Download a free, 30-day trial of the CData ODBC Driver for Cosmos DB and start building Cosmos DB-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.