Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Latest commit

 

History

History
History
87 lines (61 loc) · 2.85 KB

File metadata and controls

87 lines (61 loc) · 2.85 KB
Copy raw file
Download raw file
Outline
Edit and raw actions

Spanner Client

Instantiating a Client

To use the API, the :class:`~google.cloud.spanner_v1.client.Client` class defines a high-level interface which handles authorization and creating other objects:

from google.cloud import spanner_v1
client = spanner_v1.Client()

Long-lived Defaults

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

Configuration

  • For an overview of authentication in google.cloud-python, see Authentication.

  • In addition to any authentication configuration, you can also set the :envvar:`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 :class:`~google.cloud.spanner_v1.client.Client`).

  • After configuring your environment, create a :class:`~google.cloud.spanner_v1.client.Client`

    >>> from google.cloud import spanner_v1
    >>> client = spanner_v1.Client()
    

    or pass in credentials and project explicitly

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

Tip

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

Warnings about Multiprocessing

Warning

When using multiprocessing, the application may hang if a :class:`Client <google.cloud.spanner_v1.client.Client>` instance is created before :class:`multiprocessing.Pool` or :class:`multiprocessing.Process` invokes :func:`os.fork`. The issue is under investigation, but may be only happening on Macintosh and not Linux. See GRPC/GRPC#12455 for more information.

Next Step

After a :class:`~google.cloud.spanner_v1.client.Client`, the next highest-level object is an :class:`~google.cloud.spanner_v1.instance.Instance`. You'll need one before you can interact with databases.

Next, learn about the :doc:`instance-usage`.

Morty Proxy This is a proxified and sanitized view of the page, visit original site.