How to Connect DBeaver to Google Sheets via a JDBC Driver

The CData JDBC Driver for Google Spreadsheets implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Google Sheets data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Google Sheets Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for Google Spreadsheets).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.googlesheets.GoogleSheetsDriver.
   • Set URL Template to jdbc:googlesheets:.
   👁 Configure the new driver settings (Salesforce is shown).
   
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.GoogleSheets.jar). 👁 Loading the JDBC JAR file (Salesforce is shown).
   

Create a Connection to Google Sheets Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for Google Spreadsheets) and click "Next >." 👁 Selecting the driver (Salesforce is shown).
   
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   You can connect to a spreadsheet by providing authentication to Google and then setting the Spreadsheet connection property to the name or feed link of the spreadsheet. If you want to view a list of information about the spreadsheets in your Google Drive, execute a query to the Spreadsheets view after you authenticate.

   ClientLogin (username/password authentication) has been officially deprecated since April 20, 2012 and is now no longer available. Instead, use the OAuth 2.0 authentication standard. To access Google APIs on behalf on individual users, you can use the embedded credentials or you can register your own OAuth app.

   OAuth also enables you to use a service account to connect on behalf of users in a Google Apps domain. To authenticate with a service account, register an application to obtain the OAuth JWT values.

   See the Getting Started chapter in the help documentation to connect to Google Sheets from different types of accounts: Google accounts, Google Apps accounts, and accounts using two-step verification.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.googlesheets.jar
   

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

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   Below is a typical connection string:

   jdbc:googlesheets:Spreadsheet=MySheet;InitiateOAuth=GETANDREFRESH;
   

   👁 Configuring the JDBC URL (Salesforce is shown).
   
4. Click "Test Connection ..." to ensure you have configured the connection properly. 👁 A successfully configured connection (Salesforce is shown).
   
5. Click "Finish."

Query Google Sheets Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

👁 The results of a query in DBeaver. (Salesforce is shown.)

More Information & Free Trial

Download a free, 30-day trial of the CData JDBC Driver for Google Spreadsheets and start working with your live Google Sheets data in DBeaver. Join the CData Community or reach out to our Support Team if you have any questions.