As with all of Deepnote's SQL-related integrations, the Google Spanner integration allows you to query databases and explore the structure of your database. Think "SQL editor" but with all the modern productivity boosters that come with Deepnote's notebook. For example,
- Write native SQL and Python in the same notebook
- Get intelligent autocomplete for columns, tables, and databases
- Interactively explore data without writing any additional code
From the panel, under Integrations, click the + button and choose Create new integration.
Select Google Spanner from the list of integrations or search for it using the search bar.
Fill out the fields in the pop up form.
A service account will provide a shared connection to Google Spanner. That is, all collaborators with at least Contributor privileges will be able run queries against databases provisioned in the service account.
To use the service account authentication, you will need to supply a JSON service account key. Click here for a guide on creating a JSON service account key. Your service account key will be encrypted and stored in Deepnote's database.
Make sure to enable Spanner API for your GCP project. The service account needs sufficient permissions for the resources you want to use. If the authorisation process fails, we recommend visiting the Spanner access control page.
Grant sufficient permissions to your service account.
For Data Boost please enable
In order to use our built in MYSQL blocks, you must run the following code in your notebook (also available from How to modal):
!printf "%s" "$YOUR_INTEGRATION_NAME_HERE_SERVICE_ACCOUNT" > /tmp/google
Make sure to replace YOUR_INTEGRATION_NAME_HERE with your a snakecased uppercased version of your integration name. Or simply add the code it from the How to Modal.
Now that you are connected to your Google Spanner you can do the following actions in Deepnote:
Create an SQL block that points to your database and begin querying your data. Autocomplete for columns, tables, and databases will be at your fingertips as you type. Click here to learn more about SQL blocks.
Explore column distributions as well as the sorting and filtering capabilities on the results set. All results are displayed as an interactive Pandas DataFrame. Click here to learn about interactive DataFrame output.
Pipe the results of your query into a chart block for rapid interactive data visualization. Click here to learn more about chart blocks.
To go beyond querying (like listing tables, creating datasets, etc.), you may need to use the official Python client library (docs).
Use this code snippet to authenticate the Python client using the integration's service account:
from google.oauth2 import service_account
from google.cloud import spanner
spanner_credentials = service_account.Credentials.from_service_account_info(
spanner_client = spanner.Client(credentials=spanner_credentials,
instance = spanner_client.instance('YOUR_INSTANCE_HERE')
database = instance.database('YOUR_DB_HERE')
Just replace the
INTEGRATION_NAME with an uppercased, underscore-connected name of your integration. If you have trouble finding it, run this one-liner to list environment variables that contain service accounts:
[var for var in os.environ if '_SERVICE_ACCOUNT' in var]
Once the Google Spanner
client is initialized, you can use it to run queries and view the results as dataframes like this:
with database.snapshot() as snapshot:
results = snapshot.execute_sql("SELECT * from YOUR_TABLE_HERE")
for row in results:
You can make use of Google Spanner's Data Boost in Deepnote. Ensure that the service account that runs the application has the
spanner.databases.useDataBoost Identity and Access Management (IAM) permission. For more information, see Access control with IAM.
Then it is as simple as passing
data_boost_enabled=True to valid queries to use Data Boost.