Google Spanner

Spanner is reached over the Google Cloud REST API — the connection is provided by the spanner-driver plugin (install it from the plugins page). You identify the target by instance path and database name, and authenticate with an OAuth2 access token.

Overview

TableR calls the Spanner REST API (spanner.googleapis.com) — there is no host/port to run. The host field takes the instance path projects/<project>/instances/<instance>, the database field the database name, and the password field a Google OAuth2 access token. Set SPANNER_EMULATOR_HOST to point at a local emulator instead.

• REST API — reached at spanner.googleapis.com over HTTPS; emulator via SPANNER_EMULATOR_HOST.
• Instance path — the host field carries projects/<p>/instances/<i>, not a hostname.
• OAuth2 token — the password field takes a Google access token; stored in the keyring.
• Plugin-gated — the Spanner card appears once the spanner-driver plugin is installed.

Before you start

• The spanner-driver plugin installed (Plugins → Google Spanner → Install).
• The instance path projects/<project>/instances/<instance>.
• The database name inside that instance.
• A Google OAuth2 access token with Spanner read access.

Connection fields

These fields match TableR's Spanner connection form. The access token is stored in the operating system keyring, never in plain configuration files.

Connect with the form

1. 1
   Install the Spanner plugin

   Open Plugins, find Google Spanner, and install the spanner-driver plugin.

2. 2
   Choose Google Spanner

   Open the launcher and pick the Google Spanner card.

3. 3
   Enter the instance path

   Use projects/<project>/instances/<instance> in the host field.

4. 4
   Enter the database name

   Name the database inside that instance.

5. 5
   Add the access token

   Paste a Google OAuth2 access token in the password field; it is saved to the keyring.

6. 6
   Save and connect

   Save the profile so it reappears in the launcher, then connect.

Verify the connection

Once connected, open a query tab and run GoogleSQL:

SELECT 1;
SELECT table_name FROM information_schema.tables;

If both statements return, the instance path, database, and token are all correct.

Troubleshooting

Next steps