- 3.46.0 (latest)
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.1
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.1
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.27.1
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.2
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.1
- 3.14.1
- 3.13.0
- 3.12.1
- 3.11.1
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.1.1
- 2.0.0
- 1.19.3
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.1
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
Spanner Client Usage
Instantiating a Client
To use the API, the Client
class defines a high-level interface which handles authorization
and creating other objects:
from google.cloud import spanner
client = spanner.Client()
Configuration
For an overview of authentication in
google.cloud-python
, 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 theproject
explicitly when constructing aClient
).After configuring your environment, create a
Client
>>> from google.cloud import spanner
>>> client = spanner.Client()
or pass in credentials
and project
explicitly
>>> from google.cloud import spanner
>>> client = spanner.Client(project='my-project', credentials=creds)
Using a Cloud Spanner Emulator
There are two ways to use the client with a Cloud Spanner emulator: programmatically or via an environment variable.
To programmatically use an emulator, you must specify the project, the endpoint of the emulator, and use anonymous credentials:
from google.cloud import spanner
from google.auth.credentials import AnonymousCredentials
client = spanner.Client(
project='my-project',
client_options={"api_endpoint": "0.0.0.0:9010"},
credentials=AnonymousCredentials()
)
To use an emulator via an environment variable, set the SPANNER_EMULATOR_HOST environment variable to the emulator endpoint:
export SPANNER_EMULATOR_HOST=0.0.0.0:9010
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 Usage.