Query Azure Synapse Data in ColdFusion



Write standard ColdFusion data access code to connect to Azure Synapse data.

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

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

      Connecting to Azure Synapse

      In addition to providing authentication (see below), set the following properties to connect to a Azure Synapse database:

      • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to Azure Synapse Analytics -> Select your database -> Overview -> Server name.
      • Database: The name of the database, as seen in the Azure portal on the Azure Synapse Analytics page.

      Authenticating to Azure Synapse

      Connect to Azure Synapse using the following properties:

      • User: The username provided for authentication with Azure.
      • Password: The password associated with the authenticating user.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.azuresynapse.jar

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

      A typical JDBC URL is below:

      jdbc:azuresynapse:User=myuser;Password=mypassword;Server=localhost;Database=Northwind;
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.azuresynapse.AzureSynapseDriver.
    • 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 Synapse data source in the Actions column. After reporting a status of OK, the Azure Synapse data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Azure Synapse, 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.

<cfquery name="AzureSynapseQuery" dataSource="CDataAzureSynapse"> SELECT * FROM Products WHERE ProductName = <cfqueryparam value="#ProductName#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#AzureSynapseQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Products WHERE ProductName = ?", 
  [
    { value="Konbu", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataAzureSynapse" }
);

writeDump( var= result );
</cfscript> 

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

http://MyServer:8500/query.cfm?ProductName=Konbu

Ready to get started?

Download a free trial of the Azure Synapse Driver to get started:

 Download Now

Learn more:

Azure Synapse Icon Azure Synapse JDBC Driver

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