Console
    Contact Us Start free

    Class Client (1.11.0) 

      Client 
 ( 
 project 
 = 
 None 
 , 
 credentials 
 = 
 None 
 , 
 client_info 
 = 
< google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 object 
> , 
 user_agent 
 = 
 None 
 )

    Client for interacting with Cloud Spanner API.

    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.

    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.

    "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 
 ( 
 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 
 ( 
 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/ . Requiredfor 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.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: