Query Azure Data Catalog Data in ColdFusion

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Azure Data Catalog JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Azure Data Catalog.



Write standard ColdFusion data access code to connect to Azure Data Catalog data.

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

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

      You can optionally set the following to read the different catalog data returned from Azure Data Catalog.

        CatalogName: Set this to the CatalogName associated with your Azure Data Catalog. To get your Catalog name, navigate to your Azure Portal home page > Data Catalog > Catalog Name

      Connect Using OAuth Authentication

      You must use OAuth to authenticate with Azure Data Catalog. OAuth requires the authenticating user to interact with Azure Data Catalog using the browser. For more information, refer to the OAuth section in the help documentation.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.azuredatacatalog.jar

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

      A typical JDBC URL is below:

      jdbc:azuredatacatalog:InitiateOAuth=GETANDREFRESH
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.azuredatacatalog.AzureDataCatalogDriver.
    • 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 Azure Data Catalog data source in the Actions column. After reporting a status of OK, the Azure Data Catalog data source is ready for use.

Execute Queries

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

<cfquery name="AzureDataCatalogQuery" dataSource="CDataAzureDataCatalog"> SELECT * FROM Tables WHERE Name = <cfqueryparam value="#Name#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#AzureDataCatalogQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Tables WHERE Name = ?", 
  [
    { value="FactProductInventory", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataAzureDataCatalog" }
);

writeDump( var= result );
</cfscript> 

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

http://MyServer:8500/query.cfm?Name=FactProductInventory