Class Client (3.24.0)

Client(project=None, credentials=None, client_info=<google.api_core.gapic_v1.client_info.ClientInfo object>, client_options=None, query_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.
`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

Properties

Getter for client's credentials.

Returns
Type	Description
`Credentials`	The credentials stored on the client.

Helper for session-related API calls.

Helper for session-related API calls.

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.

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_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(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
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(filter_="", page_size=None)

List instances for the client's project.

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.