Module client (3.55.0)

Classes

Client

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.

Exceptions
TypeDescription
`ValueErro

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.