A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://cloud.google.com/python/docs/reference/spanner/latest/google.cloud.spanner_v1.client.Client below:

Class Client (3.55.0) | Python client library

Class Client (3.55.0)

Stay organized with collections Save and categorize content based on your preferences.

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, 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 dict

(Optional) Default options to use for all transactions.

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. enable_end_to_end_tracing: :type:boolean when set to true will allow for spans from Spanner server side. Default False, please set it to True to turn it on or you can use the environment variable SPANNER_ENABLE_END_TO_END_TRACING= to control it.

Properties credentials

Getter for client's credentials.

Returns Type Description Credentials 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 dict 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 dict 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 if project does not, but the return 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

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.

Returns Type Description .Client 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: projects/ . Required for 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.

Returns Type Description Instance an instance owned by this client. list_instance_configs
list_instance_configs(page_size=None)
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 google.api_core.page_iterator.Iterator Iterator of InstanceConfig resources within the client's project. list_instances
list_instances(filter_="", page_size=None)
Parameters Name Description 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.

Returns Type Description google.api_core.page_iterator.Iterator Iterator of Instance resources within the client's project.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-18 UTC.

[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-18 UTC."],[],[]]


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4