Class Client

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.

Inheritance

builtins.object > google.cloud.client._ClientFactoryMixin > google.cloud.client.Client > builtins.object > google.cloud.client._ClientProjectMixin > google.cloud.client.ClientWithProject > Client

Properties

credentials

Getter for client's credentials.

Returns
TypeDescription
`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.

The project name is of the form

``"projects/{project}"``
Returns
TypeDescription
strThe project name to be used with the Cloud Spanner Admin API RPC service.

Methods

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
TypeDescription
`.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
NameDescription
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/<project>/instanceConfigs/ <config>. 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
TypeDescription
Instancean 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

See RPC docs_.

Parameter
NameDescription
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
TypeDescription
`google.api_core.page_iterator.Iterator`Iterator of InstanceConfig 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 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
TypeDescription
`google.api_core.page_iterator.Iterator`Iterator of Instance resources within the client's project.