Learn more
 

Ready to get started?

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

 Download Now

Learn more:

CockroachDB Icon CockroachDB ODBC Driver

The CockroachDB ODBC Driver is a powerful tool that allows you to connect with live data from CockroachDB, directly from any applications that support ODBC connectivity.

Access CockroachDB data like you would a database - read, write, and update CockroachDB NewSQLDB, etc. through a standard ODBC Driver interface.

In this article

Related articles

Import Real-Time CockroachDB Data in ColdFusion to Build Applications


Use CData ODBC drivers to import and use CockroachDB 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 CockroachDB, you can link your ColdFusion web and mobile applications to operational CockroachDB 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 CockroachDB data from within a ColdFusion markup file.

To follow along with this tutorial, you need to install the CData ODBC Driver for CockroachDB 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.

Set the following to connect to CockroachDB.

  • Server: The host name or IP address of the server.
  • Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
  • Database: The name of the Cockroach database. If not specified, you connect to the user's default database.
  • User: The Cockroach DB user account used to authenticate.
  • Password: The password used to authenticate the user.

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 CockroachDB CockroachDB 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 CockroachDB 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 CDataCockroachDBODBC 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="CockroachDBQuery" dataSource="CDataCockroachDBODBC"> 
          SELECT * FROM Orders 
        </cfquery>
    And a CFTable can be used to quickly output the table in HTML: 
                
          <cftable  
          query = "CockroachDBQuery" 
          border = "1" 
          colHeaders 
          colSpacing = "2" 
          headerLines = "2" 
          HTMLTable 
          maxRows = "500" 
          startRow = "1"> 

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

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

          ...

        </cftable>
    Full code, including the HTML portion is available below: 
                
        <html> 
        <head><title>CData Software | CockroachDB Orders Table Demo </title></head> 
        <body> 
        <cfoutput>#ucase("CockroachDB Orders Table Demo")#</cfoutput> 
        <cfquery name="CockroachDBQuery" dataSource="CDataCockroachDBODBC"> 

          SELECT * FROM Orders 

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

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

          ...

        </cftable> 
        </body> 

        </html>
  6. Finally, run the code in a browser. It produces a table populated with CockroachDB 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 CockroachDB and start building CockroachDB-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.