Module batch (1.15.5)

Version 1.15.5

• 2.20.1 (latest)
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.2
• 2.14.0
• 2.13.2
• 2.12.0
• 2.11.1
• 2.10.0
• 2.9.0
• 2.8.3
• 2.7.2
• 2.6.2
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.6
• 2.0.1
• 1.15.5
• 1.14.0
• 1.13.2
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0

Create / interact with a batch of updates / deletes.

Batches provide the ability to execute multiple operations in a single request to the Cloud Datastore API.

See https://cloud.google.com/datastore/docs/concepts/entities#batch_operations

Classes

Batch

Batch(client)

An abstraction representing a collected group of updates / deletes.

Used to build up a bulk mutation.

For example, the following snippet of code will put the two save operations and the delete operation into the same mutation, and send them to the server in a single API request::

from google.cloud import datastore client = datastore.Client() batch = client.batch() batch.begin() batch.put(entity1) batch.put(entity2) batch.delete(key3) batch.commit()

You can also use a batch as a context manager, in which case commit will be called automatically if its block exits without raising an exception::

with batch: ... batch.put(entity1) ... batch.put(entity2) ... batch.delete(key3)

By default, no updates will be sent if the block exits with an error::

with batch: ... do_some_work(batch) ... raise Exception() # rolls back

Parameter
Name	Description
client	Client The client used to connect to datastore.