Skip to content

docs: fix snapshot usage #291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gcf-merge-on-green merged 2 commits into from
Mar 25, 2021
Merged

docs: fix snapshot usage #291

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65268ca
docs: fix sample code of `snapshot.read()`
kit494way Mar 24, 2021
3da9f63
docs: remove unnecessary `list()`
kit494way Mar 24, 2021
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
8 changes: 4 additions & 4 deletions docs/snapshot-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,16 @@ Read Table Data

To read data for selected rows from a table in the database, call
:meth:`~google.cloud.spanner_v1.snapshot.Snapshot.read` which will return
all rows specified in ``key_set``, or fail if the result set is too large,
all rows specified in ``keyset``, or fail if the result set is too large,

.. code:: python

with database.snapshot() as snapshot:
result = snapshot.read(
table='table-name', columns=['first_name', 'last_name', 'age'],
key_set=['[email protected]', '[email protected]'])
keyset=spanner.KeySet([['[email protected]'], ['[email protected]']]))

for row in result.rows:
for row in result:
print(row)

.. note::
Expand All @@ -100,7 +100,7 @@ result set is too large,
'WHERE p.employee_id == e.employee_id')
result = snapshot.execute_sql(QUERY)

for row in list(result):
for row in result:
print(row)

.. note::
Expand Down