Skip to content
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

Jump to bottom

Fix Batch object creation instructions #7341

Merged
merged 1 commit into from
Feb 14, 2019
Merged

Fix Batch object creation instructions #7341

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions spanner/docs/batch-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Batching Modifications
######################

A :class:`~google.cloud.spanner.batch.Batch` represents a set of data
modification operations to be performed on tables in a dataset. Use of a
modification operations to be performed on tables in a database. Use of a
``Batch`` does not require creating an explicit
:class:`~google.cloud.spanner.snapshot.Snapshot` or
:class:`~google.cloud.spanner.transaction.Transaction`. Until
Expand All @@ -13,9 +13,17 @@ no changes are propagated to the back-end.
Starting a Batch
----------------

Construct a :class:`~google.cloud.spanner.batch.Batch` object from a :class:`~google.cloud.spanner.database.Database` object:

.. code:: python

batch = client.batch()
from google.cloud import spanner

client = spanner.Client()
instance = client.instance(INSTANCE_NAME)
database = instance.database(DATABASE_NAME)

batch = database.batch()


Inserting records using a Batch
Expand Down Expand Up @@ -159,12 +167,16 @@ if the ``with`` block exits without raising an exception.

from google.cloud.spanner.keyset import KeySet

client = spanner.Client()
instance = client.instance(INSTANCE_NAME)
database = instance.database(DATABASE_NAME)

to_delete = KeySet(keys=[
('bharney@example.com',)
('nonesuch@example.com',)
])

with session.batch() as batch:
with database.batch() as batch:

batch.insert(
'citizens', columns=['email', 'first_name', 'last_name', 'age'],
Expand Down