Google Spanner Connection
See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium Google Spanner connector.
Google Spanner is a contact management service developed by Google.
This topic describes how to authenticate to Google Spanner and configure any necessary connection properties in the Google Spanner connection connector.
Prerequisites
Enable the Spanner API
Follow these steps to enable the Spanner API:
Navigate to the Google Cloud Console.
Select Library from the left-hand navigation menu. This opens the Library page.
In the search field, enter “Spanner API” and select Spanner API from the search results.
On the Spanner API page, click ENABLE.
Connection Configuration
Each connection property available in the Google Spanner connector is explained below.
Connection Name
The name of the connection to be created should be provided. This is the name that will display on the list of available connections.
Auth Scheme
The type of authentication to use when connecting to Google Spanner.
Possible Values
OAuth2
Set this to use OAuth2 authentication.
If OAuth2 is selected, additional configuration parameters will get listed.
Client ID
The client ID assigned when you register your application with an OAuth authorization server.
Client Secret
The client secret assigned when you register your application with an OAuth authorization server.
Refresh Token
The OAuth refresh token for the corresponding OAuth access token.
Service Account
Set this to use Service Account as authentication.
If Service Account is selected, additional configuration parameters will get listed.
Certificate Type
The type of key store containing the Service Account Certificate.
Possible Values
JSON
Set this to use a certificate with type as JSON, for authentication.
If JSON is selected, proceed by uploading the keystore file.
PFX
Set this to use a certificate with type as P12, for authentication.
If PFX is selected, additional configuration parameters will get listed.
Certificate Issuer: Set this to the email address of the service account. This address will usually include the domain iam.gserviceaccount.com.
Certificate Password: Set this to the .pfx file password. In most cases you must provide this since Google encrypts PFX certificates.
Upload File
Upload Service Account Certificate. Use JSON file if Certificate Type is JSON, else use PFX(P12).
Database Dialect
The diealect type of the connected database.
Possible Values: GoogleStandardSQL, PostgreSQL
Database
The name of the Google Spanner database to connect to.
Instance ID
The address of the Google Spanner instance to which you are connecting.
You can find this value at instance overview.
Instances will be listed once you select Spanner from the Google Cloud Console Menu.
Project ID
The id of the project where your Google Spanner instance resides.
You can find this value by going to Google Cloud Console and clicking the project name at the top left screen.
The ProjectId is displayed on the Id column of the matching project.
UseGrpcEndpoint
This property determines whether or not the Grpc endpoint will be used.
Most proxies will not work with the Grpc endpoint.
If set to false, the protobuf endpoint will be used.
The latter has issues with NULL values, but proxies will work on it.
After entering all the details, click on the TEST button.
If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.
Click on the CREATE button to save the changes.
If the details are incorrect or the server is down, you will get a message “Connection unavailable”.
If you have any feedback on Gathr documentation, please email us!