How to Query SharePoint Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for SharePoint to query SharePoint data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live SharePoint data in MySQL Workbench.

Connect to SharePoint Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to SharePoint data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query SharePoint from MySQL Workbench

The steps below outline connecting to the virtual SharePoint database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live SharePoint data.

Connect to SharePoint through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for SharePoint).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query SharePoint Data

1. Open the connection you just created (CData SQL Gateway for SharePoint).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve SharePoint data, like SELECT * FROM `CData SharePoint Sys`.MyCustomList;

With access to live SharePoint data from MySQL Workbench, you can easily query and update SharePoint, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for SharePoint and the CData SQL Gateway.