Class Client (3.55.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)

Parameters

NameDescription
default_transaction_optionsDefaultTransactionOptions ordict

(Optional) Default options to use for all transactions.

projectstr orunicode

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

credentialsCredentials 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_infogoogle.api_core.gapic_v1.client_info.ClientInfo

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

client_optionsgoogle.api_core.client_options.ClientOptions ordict

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

query_optionsQueryOptions ordict

(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_enabledboolean

(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_optionsDirectedReadOptions ordict

(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_optionsdict (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. DefaultTrue, please set it toFalse to turn it off or you can use the environment variableSPANNER_ENABLE_EXTENDED_TRACING= to control it. enable_end_to_end_tracing: :type:boolean when set to true will allow for spans from Spanner server side. DefaultFalse, please set it toTrue to turn it on or you can use the environment variableSPANNER_ENABLE_END_TO_END_TRACING= to control it.

Properties

credentials

Returns
TypeDescription
CredentialsThe credentials stored on the client.

database_admin_api

default_transaction_options

Returns
TypeDescription
DefaultTransactionOptions ordictThe default transaction options that are used by this client for all transactions.

directed_read_options

Returns
TypeDescription
DirectedReadOptions ordictThe directed_read_options for the client.

instance_admin_api

observability_options

Returns
TypeDescription
dictThe configured observability_options if set.

project_name

Returns
TypeDescription
strThe project name to be used with the Cloud Spanner Admin API RPC service.

route_to_leader_enabled

Returns
TypeDescription
booleanIf read-write requests will be routed to leader.

Methods

copy

Returns
TypeDescription
.ClientA copy of the current client.

instance

Parameters
NameDescription
instance_idstr

The ID of the instance.

configuration_namestring

(Optional) Name of the instance configuration used to set up the instance's cluster, in the form:projects/.Required for instances which do not yet exist.

display_namestr

(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_countint

(Optional) The number of nodes in the instance's cluster; used to set up the instance's cluster.

processing_unitsint

(Optional) The number of processing units allocated to this instance.

labelsdict (str -> str) or None

(Optional) User-assigned labels for this instance.

Returns
TypeDescription
Instancean instance owned by this client.

list_instance_configs

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
NameDescription
page_sizeint

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
TypeDescription
google.api_core.page_iterator.IteratorIterator ofInstanceConfig resources within the client's project.

list_instances

list_instances(filter_="",page_size=None)
Parameters
NameDescription
filter_string

(Optional) Filter to select instances listed. See theListInstancesRequest docs above for examples.

page_sizeint

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
TypeDescription
google.api_core.page_iterator.IteratorIterator 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.