Skip to content

Commit 8147700

Browse files
author
Jon Wayne Parrott
authored
Update all generated readme auth instructions [(googleapis#1121)](GoogleCloudPlatform/python-docs-samples#1121)
Change-Id: I03b5eaef8b17ac3dc3c0339fd2c7447bd3e11bd2
1 parent 211387d commit 8147700

File tree

1 file changed

+9
-29
lines changed

1 file changed

+9
-29
lines changed

samples/samples/README.rst

Lines changed: 9 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,34 +17,12 @@ Setup
1717
Authentication
1818
++++++++++++++
1919

20-
Authentication is typically done through `Application Default Credentials`_,
21-
which means you do not have to change the code to authenticate as long as
22-
your environment has credentials. You have a few options for setting up
23-
authentication:
20+
This sample requires you to have authentication setup. Refer to the
21+
`Authentication Getting Started Guide`_ for instructions on setting up
22+
credentials for applications.
2423

25-
#. When running locally, use the `Google Cloud SDK`_
26-
27-
.. code-block:: bash
28-
29-
gcloud auth application-default login
30-
31-
32-
#. When running on App Engine or Compute Engine, credentials are already
33-
set-up. However, you may need to configure your Compute Engine instance
34-
with `additional scopes`_.
35-
36-
#. You can create a `Service Account key file`_. This file can be used to
37-
authenticate to Google Cloud Platform services from any environment. To use
38-
the file, set the ``GOOGLE_APPLICATION_CREDENTIALS`` environment variable to
39-
the path to the key file, for example:
40-
41-
.. code-block:: bash
42-
43-
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service_account.json
44-
45-
.. _Application Default Credentials: https://cloud.google.com/docs/authentication#getting_credentials_for_server-centric_flow
46-
.. _additional scopes: https://cloud.google.com/compute/docs/authentication#using
47-
.. _Service Account key file: https://developers.google.com/identity/protocols/OAuth2ServiceAccount#creatinganaccount
24+
.. _Authentication Getting Started Guide:
25+
https://cloud.google.com/docs/authentication/getting-started
4826

4927
Install Dependencies
5028
++++++++++++++++++++
@@ -83,7 +61,7 @@ To run this sample:
8361
8462
usage: snippets.py [-h] [--database-id DATABASE_ID]
8563
instance_id
86-
{create_database,insert_data,query_data,read_data,add_column,update_data,query_data_with_new_column,read_write_transaction,read_only_transaction,add_index,query_data_with_index,read_data_with_index,add_storing_index,read_data_with_storing_index}
64+
{create_database,insert_data,query_data,read_data,read_stale_data,add_column,update_data,query_data_with_new_column,read_write_transaction,read_only_transaction,add_index,query_data_with_index,read_data_with_index,add_storing_index,read_data_with_storing_index}
8765
...
8866
8967
This application demonstrates how to do basic operations using Cloud
@@ -93,13 +71,15 @@ To run this sample:
9371
9472
positional arguments:
9573
instance_id Your Cloud Spanner instance ID.
96-
{create_database,insert_data,query_data,read_data,add_column,update_data,query_data_with_new_column,read_write_transaction,read_only_transaction,add_index,query_data_with_index,read_data_with_index,add_storing_index,read_data_with_storing_index}
74+
{create_database,insert_data,query_data,read_data,read_stale_data,add_column,update_data,query_data_with_new_column,read_write_transaction,read_only_transaction,add_index,query_data_with_index,read_data_with_index,add_storing_index,read_data_with_storing_index}
9775
create_database Creates a database and tables for sample data.
9876
insert_data Inserts sample data into the given database. The
9977
database and table must already exist and can be
10078
created using `create_database`.
10179
query_data Queries sample data from the database using SQL.
10280
read_data Reads sample data from the database.
81+
read_stale_data Reads sample data from the database. The data is
82+
exactly 10 seconds stale.
10383
add_column Adds a new column to the Albums table in the example
10484
database.
10585
update_data Updates sample data in the database. This updates the

0 commit comments

Comments
 (0)