VOOZH about

URL: https://www.cdata.com/kb/tech/sharepoint-odbc-dbeaver.rst

⇱ Connect to SharePoint Data in DBeaver

Connect to SharePoint Data in DBeaver

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use the CData ODBC Driver to connect to SharePoint data in DBeaver.

NOTE: The Legacy ODBC driver was removed in DBeaver Community Edition 23.1. As an alternative, you can use a CData JDBC Driver (learn how here: How to Connect DBeaver to SharePoint via JDBC). If you need to use ODBC Drivers, refer to the DBeaver Documentation.


The CData ODBC Driver for SharePoint enables access to live data from SharePoint under the ODBC standard, allowing you work with SharePoint data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to manage SharePoint data with visual tools in DBeaver like the query browser.

The CData ODBC drivers offer unmatched performance for interacting with live SharePoint data in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver to SharePoint, the driver pushes supported SQL operations, like filters and aggregations, directly to SharePoint and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can manage and analyze SharePoint data.

About SharePoint Data Integration

Accessing and integrating live data from SharePoint has never been easier with CData. Customers rely on CData connectivity to:

  • Access data from a wide range of SharePoint versions, including Windows SharePoint Services 3.0, Microsoft Office SharePoint Server 2007 and above, and SharePoint Online.
  • Access all of SharePoint thanks to support for Hidden and Lookup columns.
  • Recursively scan folders to create a relational model of all SharePoint data.
  • Use SQL stored procedures to upload and download documents and attachments.

Most customers rely on CData solutions to integrate SharePoint data into their database or data warehouse, while others integrate their SharePoint data with preferred data tools, like Power BI, Tableau, or Excel.

For more information on how customers are solving problems with CData's SharePoint solutions, refer to our blog: Drivers in Focus: Collaboration Tools.


Getting Started


Connect to SharePoint

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the Microsoft ODBC Data Source Administrator. 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

Finally, set the "Map To WVarchar connection property to False in the DSN Configuration window for the driver. This configuration will allow string types to be mapped to SQL_VARCHAR and prevent SQL_WVARCHAR types from being displayed as NULL.

👁 Setting the Map To WVarchar property

Connecting to the SharePoint ODBC Data Source in DBeaver

  1. Open the DBeaver application and in the Database menu, select the New Database Connection option. 👁 Creating a new Database Connection
  2. In the 'Connect to a database' window, select ODBC and click Next. 👁 Creating a new Database Connection
  3. In the Database/Schema field, enter the DSN name (CData SharePoint Source by default). It will be automatically added to the JDBC URL as well.
  4. Click the Test Connection button. You should receive a 'Connected' message after DBeaver has detected the DSN, along with details about the driver if the connection is successful. 👁 Successfully tested connection

Query SharePoint Data

You can now query information from the tables exposed by the data source connection. You can expand the database structure in order to view all the tables. You can retrieve the table's data by right-clicking on a table name and selecting View data. The data will then be available in the Data tab.

👁 Viewing data (Salesforce is shown)

Free Trial & More Information

At this point, you have connected to live SharePoint data from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live SharePoint data DBeaver today.

Ready to get started?

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

 Download Now

Learn more:

👁 SharePoint Icon
SharePoint ODBC Driver

The SharePoint ODBC Driver is a powerful tool that allows you to connect with live data from SharePoint and SharePoint Online, directly from any applications that support ODBC connectivity.

Access SharePoint data like you would a database - read, write, and update SharePoint Lists, Contacts, Calendar, Links, Tasks, etc. through a standard ODBC Driver interface.