Module client (1.19.2)

Parent client for calling the Cloud Spanner API.

This is the base from which all interactions with the API occur.

In the hierarchy of API concepts

Classes

Client

Client(project=None, credentials=None, client_info=<google.api_core.gapic_v1.client_info.ClientInfo object>, user_agent=None, client_options=None, query_options=None)

Client for interacting with Cloud Spanner API.

.. note::

Since the Cloud Spanner API requires the gRPC transport, no
``_http`` argument is accepted by this class.
Parameters
NameDescription
project `str` or `unicode

(Optional) The ID of the project which owns the instances, tables and data. If not provided, will attempt to determine from the environment.

credentials `Credentials

(Optional) The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment.

client_info `google.api_core.gapic_v1.client_info.ClientInfo`

(Optional) The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own library or partner tool.

user_agent str

(Deprecated) The user agent to be used with API request. Not used.

client_options `google.api_core.client_options.ClientOptions` or `dict`

(Optional) Client options used to set user options on the client. API Endpoint should be set through client_options.

query_options QueryOptions or `dict`

(Optional) Query optimizer configuration to use for the given query. If a dict is provided, it must be of the same form as the protobuf message QueryOptions

Exceptions
TypeDescription
`ValueErro

InstanceConfig

InstanceConfig(name, display_name)

Named configurations for Spanner instances.

Parameters
NameDescription
name str

ID of the instance configuration

display_name str

Name of the instance configuration