Query SQL Server Data in ColdFusion

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

Create a JDBC Data Source for SQL Server 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.

   👁 Adding a JDBC data source to ColdFusion. (Salesforce is shown.)
   

3. Populate the driver properties:

   • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:sql: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

     Connecting to Microsoft SQL Server

     Connect to Microsoft SQL Server using the following properties:

     • Server: The name of the server running SQL Server.
     • User: The username provided for authentication with SQL Server.
     • Password: The password associated with the authenticating user.
     • Database: The name of the SQL Server database.

     Connecting to Azure SQL Server and Azure Data Warehouse

     You can authenticate to Azure SQL Server or Azure Data Warehouse by setting the following connection properties:

     • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to "SQL databases" (or "SQL data warehouses") -> "Select your database" -> "Overview" -> "Server name."
     • User: The name of the user authenticating to Azure.
     • Password: The password associated with the authenticating user.
     • Database: The name of the database, as seen in the Azure portal on the SQL databases (or SQL warehouses) page.

     SSH Connectivity for SQL Server

     You can use SSH (Secure Shell) to authenticate with SQL Server, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

     SSH Connections to SQL Server in Password Auth Mode

     To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:

     • User: SQL Server User name
     • Password: SQL Server Password
     • Database: SQL Server database name
     • Server: SQL Server Server name
     • Port: SQL Server port number like 3306
     • UserSSH: "true"
     • SSHAuthMode: "Password"
     • SSHPort: SSH Port number
     • SSHServer: SSH Server name
     • SSHUser: SSH User name
     • SSHPassword: SSH Password

     SSH Connections to SQL Server in Public Key Auth Mode

     To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:

     • User: SQL Server User name
     • Password: SQL Server Password
     • Database: SQL Server database name
     • Server: SQL Server Server name
     • Port: SQL Server port number like 3306
     • UserSSH: "true"
     • SSHAuthMode: "Public_Key"
     • SSHPort: SSH Port number
     • SSHServer: SSH Server name
     • SSHUser: SSH User name
     • SSHClientCret: the path for the public key certificate file

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.sql.jar
     

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

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is below:

     jdbc:sql:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=1433;

   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.sql.SQLDriver.
   • 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 SQL Server data source in the Actions column. After reporting a status of OK, the SQL Server data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to SQL Server, 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="SQLQuery" dataSource="CDataSQL">
 SELECT * FROM Orders WHERE ShipCountry = <cfqueryparam value="#ShipCountry#" cfsqltype="cf_sql_varchar">
</cfquery>
<cfdump var="#SQLQuery#">

Below is the equivalent in CFScript:

<cfscript>
result = queryExecute(
 "SELECT * FROM Orders WHERE ShipCountry = ?", 
 [
 { value="USA", cfsqltype="cf_sql_varchar" }
 ],
 { datasource="CDataSQL" }
);

writeDump( var= result );
</cfscript> 

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

http://MyServer:8500/query.cfm?ShipCountry=USA