Query Google Spanner Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Google Spanner, DataGrip can work with live Google Spanner data. This article shows how to establish a connection to Google Spanner data in DataGrip and use the table editor to load Google Spanner data.

Create a New Driver Definition for Google Spanner

The steps below describe how to create a new Data Source in DataGrip for Google Spanner.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Google Spanner Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.googlespanner.jar).
   • Set Class to cdata.jdbc.googlespanner.GoogleSpanner.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Google Spanner

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Google Spanner Driver" to create a new Google Spanner Data Source.
2. In the new window, configure the connection to Google Spanner with a JDBC URL.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.googlespanner.jar

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

   Google Spanner uses the OAuth authentication standard. To authenticate using OAuth, you can use the embedded credentials or register an app with Google.

   See the Getting Started guide in the CData driver documentation for more information.

3. Set URL to the connection string, e.g., jdbc:googlespanner:ProjectId='project1';InstanceId='instance1';Database='db1';InitiateOAuth=GETANDREFRESH
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Google Spanner

To browse through the Google Spanner entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT Name, TotalDue FROM Customer

Download a free, 30-day trial of the CData JDBC Driver for Google Spanner and start working with your live Google Spanner data in DataGrip. Reach out to our Support Team if you have any questions.