Ready to get started?

Download a free trial of the SharePoint Driver to get started:

 Download Now

Learn more:

SharePoint Icon 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!

Connect to SharePoint Data from PowerBuilder



This article demonstrates how to access SharePoint data from PowerBuilder using the SharePoint JDBC Driver.

The CData JDBC Driver for SharePoint is a standards-based control that can be used from any platform or development technology that supports JDBC, including PowerBuilder. This article shows how to use the CData JDBC Driver for SharePoint in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for SharePoint to perform reads and writes.

Connect to SharePoint Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for SharePoint. You can use a database profile to save connection properties. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

  1. Add the driver JAR to the PowerBuilder classpath. Set the CLASSPATH system environment variable to the path to the driver JAR, located in the lib subfolder of the installation directory.

    Note: If you are using PowerBuilder Classic, you can also add the path to the driver JAR by clicking Tools -> System Options -> Java.

  2. Click Tools -> Database Painter.
  3. Right-click the JDBC node and click New Profile.
  4. In the Database Profile Setup dialog, enter the following:
    • Profile Name: Enter a user-friendly name for the profile.
    • Driver Name: Enter the class name of the driver, cdata.jdbc.sharepoint.SharePointDriver
    • URL: Enter the JDBC URL.

      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;
  5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using SharePoint Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to JDBC data sources and execute queries. The following example shows how to retrieve SharePoint data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "JDBC" SQLCA.AutoCommit = False SQLCA.DBParm = "Driver='cdata.jdbc.sharepoint.SharePointDriver',URL='jdbc:sharepoint:User=myuseraccount;Password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;SharePointEdition=SharePointOnPremise;"; CONNECT USING SQLCA; dw_mycustomlist.SetTransObject(SQLCA); dw_mycustomlist.Retrieve();