Class Client (3.55.0) Stay organized with collections Save and categorize content based on your preferences.
- 3.55.0 (latest)
- 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.ClientInfoobject>,client_options=None,query_options=None,route_to_leader_enabled=True,directed_read_options=None,observability_options=None,default_transaction_options:typing.Optional[google.cloud.spanner_v1.transaction.DefaultTransactionOptions]=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 | |
---|---|
Name | Description |
default_transaction_options | DefaultTransactionOptions or (Optional) Default options to use for all transactions. |
project |
(Optional) The ID of the project which owns the instances, tables and data. If not provided, will attempt to determine from the environment. |
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 |
(Optional) The client info used to send a user-agent string along with API requests. If |
client_options |
(Optional) Client options used to set user options on the client. API Endpoint should be set through client_options. |
query_options | QueryOptions or (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 messageQueryOptions |
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 (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 |
Properties
credentials
Getter for client's credentials.
Returns | |
---|---|
Type | Description |
| The credentials stored on the client. |
database_admin_api
Helper for session-related API calls.
default_transaction_options
Getter for default_transaction_options.
Returns | |
---|---|
Type | Description |
DefaultTransactionOptions or | The default transaction options that are used by this client for all transactions. |
directed_read_options
Getter for directed_read_options.
Returns | |
---|---|
Type | Description |
DirectedReadOptions or | The directed_read_options for the client. |
instance_admin_api
Helper for session-related API calls.
observability_options
Getter for observability_options.
Returns | |
---|---|
Type | Description |
dict | The configured observability_options if set. |
project_name
Project name to be used with Spanner APIs.
Note:This property will not change ifproject
does not, but thereturn value is not cached."projects/{project}"
Returns | |
---|---|
Type | Description |
str | The project name to be used with the Cloud Spanner Admin API RPC service. |
route_to_leader_enabled
Getter for if read-write or pdml requests will be routed to leader.
Returns | |
---|---|
Type | Description |
boolean | If read-write requests will be routed to leader. |
Methods
copy
copy()
Make a copy of this client.
Copies the local data stored as simple types but does not copy thecurrent state of any open connections with the Cloud Bigtable API.
Returns | |
---|---|
Type | Description |
| A copy of the current 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.
Parameters | |
---|---|
Name | Description |
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: |
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. |
Returns | |
---|---|
Type | Description |
Instance | an instance owned by this client. |
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
SeeRPC docs
_.
Parameter | |
---|---|
Name | Description |
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. |
Returns | |
---|---|
Type | Description |
| Iterator ofInstanceConfig resources within the client's project. |
list_instances
list_instances(filter_="",page_size=None)
List instances for the client's project.
Parameters | |
---|---|
Name | Description |
filter_ | string (Optional) Filter to select instances listed. See the |
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. |
Returns | |
---|---|
Type | Description |
| Iterator ofInstance resources within the client's project. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-18 UTC.