- 3.57.0 (latest)
- 3.56.0
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.51.0
- 3.50.1
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.1
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.1
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.27.1
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.2
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.1
- 3.14.1
- 3.13.0
- 3.12.1
- 3.11.1
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.1.1
- 2.0.0
- 1.19.3
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.1
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
Client
(
project
=
None
,
credentials
=
None
,
client_info
=
< google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
object
> ,
client_options
=
None
,
query_options
=
None
,
route_to_leader_enabled
=
True
,
directed_read_options
=
None
,
observability_options
=
None
)
Client for interacting with Cloud Spanner API.
Parameters
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
or :data: NoneType
(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.
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
route_to_leader_enabled
boolean
(Optional) Default True. Set route_to_leader_enabled as False to disable leader aware routing. Disabling leader aware routing would route all requests in RW/PDML transactions to the closest region.
directed_read_options
DirectedReadOptions
or dict
(Optional) Client options used to set the directed_read_options for all ReadRequests and ExecuteSqlRequests that indicates which replicas or regions should be used for non-transactional reads or queries.
observability_options
dict (str -> any) or None
(Optional) the configuration to control the tracer's behavior. tracer_provider is the injected tracer provider enable_extended_tracing: :type:boolean when set to true will allow for spans that issue SQL statements to be annotated with SQL. Default True
, please set it to False
to turn it off or you can use the environment variable SPANNER_ENABLE_EXTENDED_TRACING=
to control it.
Properties
credentials
Getter for client's credentials.
Credentials
database_admin_api
Helper for session-related API calls.
directed_read_options
Getter for directed_read_options.
DirectedReadOptions
or dict
instance_admin_api
Helper for session-related API calls.
observability_options
Getter for observability_options.
dict
project_name
Project name to be used with Spanner APIs.
"projects/{project}"
str
route_to_leader_enabled
Getter for if read-write or pdml requests will be routed to leader.
boolean
Methods
copy
copy
()
Make a copy of this client.
Copies the local data stored as simple types but does not copy the current state of any open connections with the Cloud Bigtable API.
.Client
instance
instance
(
instance_id
,
configuration_name
=
None
,
display_name
=
None
,
node_count
=
None
,
labels
=
None
,
processing_units
=
None
,
)
Factory to create a instance associated with this client.
instance_id
str
The ID of the instance.
configuration_name
string
(Optional) Name of the instance configuration used to set up the instance's cluster, in the form: projects/
. Requiredfor instances which do not yet exist.
display_name
str
(Optional) The display name for the instance in the Cloud Console UI. (Must be between 4 and 30 characters.) If this value is not set in the constructor, will fall back to the instance ID.
node_count
int
(Optional) The number of nodes in the instance's cluster; used to set up the instance's cluster.
processing_units
int
(Optional) The number of processing units allocated to this instance.
labels
dict (str -> str) or None
(Optional) User-assigned labels for this instance.
list_instance_configs
list_instance_configs
(
page_size
=
None
)
List available instance configurations for the client's project.
.. _RPC docs: https://cloud.google.com/spanner/docs/reference/rpc/ google.spanner.admin.instance.v1#google.spanner.admin. instance.v1.InstanceAdmin.ListInstanceConfigs
See RPC docs
_.
page_size
int
Optional. The maximum number of configs in each page of results from this request. Non-positive values are ignored. Defaults to a sensible value set by the API.
google.api_core.page_iterator.Iterator
list_instances
list_instances
(
filter_
=
""
,
page_size
=
None
)
List instances for the client's project.
filter_
string
(Optional) Filter to select instances listed. See the ListInstancesRequest
docs above for examples.
page_size
int
Optional. The maximum number of instances in each page of results from this request. Non-positive values are ignored. Defaults to a sensible value set by the API.
google.api_core.page_iterator.Iterator
