Query SharePoint Data in ColdFusion

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SharePoint JDBC Driver

Provides Java developers with the power to easily connect their Web, Desktop, and Mobile applications to data in SharePoint Server Lists, Contacts, Calendar, Links, Tasks, and more!



Write standard ColdFusion data access code to connect to SharePoint data.

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

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

      Set the URL property to the base SharePoint site or to a sub-site. This allows you to query any lists and other SharePoint entities defined for the site or sub-site.

      The User and Password properties, under the Authentication section, must be set to valid SharePoint user credentials when using SharePoint On-Premise.

      If you are connecting to SharePoint Online, set the SharePointEdition to SHAREPOINTONLINE along with the User and Password connection string properties. For more details on connecting to SharePoint Online, see the "Getting Started" chapter of the help documentation

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.sharepoint.jar

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

      A typical JDBC URL is below:

      jdbc:sharepoint:User=myuseraccount;Password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;SharePointEdition=SharePointOnPremise;
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.sharepoint.SharePointDriver.
    • 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 SharePoint data source in the Actions column. After reporting a status of OK, the SharePoint data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to SharePoint, including INSERT, UPDATE, and DELETE.. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

<cfquery name="SharePointQuery" dataSource="CDataSharePoint"> SELECT * FROM MyCustomList WHERE Location = <cfqueryparam value="#Location#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#SharePointQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM MyCustomList WHERE Location = ?", 
  [
    { value="Chapel Hill", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataSharePoint" }
);

writeDump( var= result );
</cfscript> 

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

http://MyServer:8500/query.cfm?Location=Chapel Hill