How to connect to SharePoint Data from IntelliJ

The CData JDBC Driver for SharePoint enables you to access SharePoint as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to SharePoint data in IntelliJ.

Create a JBDC Data Source for SharePoint

Follow the steps below to add the driver JAR and define connection properties required to connect to SharePoint data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.sharepoint.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.sharepoint.SharePointDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:sharepoint: and includes connection properties separated with semicolons.

     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 the following:

     jdbc:sharepoint:User=myuseraccount;Password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;SharePointEdition=SharePointOnPremise;

Edit and Save SharePoint Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.