Skip to content
This repository was archived by the owner on Mar 31, 2026. It is now read-only.

docs: add instructions for using a Cloud Spanner emulator #136

Merged
larkee merged 3 commits into from
Aug 24, 2020
Merged

docs: add instructions for using a Cloud Spanner emulator #136

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb9e2a2
docs: add instructions for using a Cloud Spanner emulator
larkee Aug 19, 2020
586a208
docs: address comment
larkee Aug 21, 2020
6bd0c52
Merge branch 'master' into add-instructions
larkee Aug 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/client-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,29 @@ Configuration

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

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:

.. code:: python

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:

.. code::

export SPANNER_EMULATOR_HOST=0.0.0.0:9010

Next Step
---------
Expand Down