Class Client (1.12.0)

Version 1.12.0

• 3.46.0 (latest)
• 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>, user_agent=None, client_options=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
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.
user_agent	str (Deprecated) The user agent to be used with API request. Not used.
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.

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.

instance_admin_api

Helper for session-related API calls.

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.

Methods

__getstate__

__getstate__()

Explicitly state that clients are not pickleable.

close

close()

Clean up transport, if set.

Suggested use:

import contextlib

with contextlib.closing(client):  # closes on exit
    do_something_with(client)

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.

Returns
Type	Description
.Client	A copy of the current client.

from_service_account_info

from_service_account_info(info, *args, **kwargs)

Factory to retrieve JSON credentials while creating client.

Parameters
Name	Description
args	tuple Remaining positional arguments to pass to constructor.
info	dict The JSON object with a private key and other credentials information (downloaded from the Google APIs console).

Exceptions
Type	Description
TypeError	if there is a conflict with the kwargs and the credentials created by the factory.

Returns
Type	Description
_ClientFactoryMixin	The client created with the retrieved JSON credentials.

from_service_account_json

from_service_account_json(json_credentials_path, *args, **kwargs)

Factory to retrieve JSON credentials while creating client.

Parameters
Name	Description
args	tuple Remaining positional arguments to pass to constructor.
json_credentials_path	str The path to a private key file (this file was given to you when you created the service account). This file must contain a JSON object with a private key and other credentials information (downloaded from the Google APIs console).

Exceptions
Type	Description
TypeError	if there is a conflict with the kwargs and the credentials created by the factory.

Returns
Type	Description
_ClientFactoryMixin	The client created with the retrieved JSON credentials.

instance

instance(instance_id, configuration_name=None, display_name=None, node_count=1)

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.

Returns
Type	Description
Instance	an instance owned by this client.

list_instance_configs

list_instance_configs(page_size=None, page_token=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_.

Parameters
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.
page_token	str Optional. If present, return the next batch of configs, using the value, which must correspond to the nextPageToken value returned in the previous response. Deprecated: use the pages property of the returned iterator instead of manually passing the token.

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, page_token=None)

List instances for the client's project.

See https://cloud.google.com/spanner/reference/rpc/google.spanner.admin.database.v1#google.spanner.admin.database.v1.InstanceAdmin.ListInstances

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.
page_token	str Optional. If present, return the next batch of instances, using the value, which must correspond to the nextPageToken value returned in the previous response. Deprecated: use the pages property of the returned iterator instead of manually passing the token.

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