To use the API, the Client class defines a high-level interface which handles authorization and creating other objects:

from import Client
client = Client()

Long-lived Defaults#

When creating a Client, the user_agent and timeout_seconds arguments have sensible defaults (DEFAULT_USER_AGENT and DEFAULT_TIMEOUT_SECONDS). However, you may over-ride them and these will be used throughout all API requests made with the client you create.


  • For an overview of authentication in, see Authentication.

  • In addition to any authentication configuration, you can also set the GCLOUD_PROJECT environment variable for the Google Cloud Console project you’d like to interact with. If your code is running in Google App Engine or Google Compute Engine the project will be detected automatically. (Setting this environment variable is not required, you may instead pass the project explicitly when constructing a Client).

  • After configuring your environment, create a Client

    >>> from import spanner
    >>> client = spanner.Client()

    or pass in credentials and project explicitly

    >>> from import spanner
    >>> client = spanner.Client(project='my-project', credentials=creds)


Be sure to use the Project ID, not the Project Number.

Next Step#

After a Client, the next highest-level object is an Instance. You’ll need one before you can interact with databases.

Next, learn about the Instance Admin API.