Helpers#
Helper functions for dealing with Cloud Datastore’s Protobuf API.
The non-private functions are part of the API.
-
class
google.cloud.datastore.helpers.
GeoPoint
(latitude, longitude)[source]# Bases:
object
Simple container for a geo point value.
-
google.cloud.datastore.helpers.
entity_from_protobuf
(pb)[source]# Factory method for creating an entity based on a protobuf.
The protobuf should be one returned from the Cloud Datastore Protobuf API.
- Parameters
pb (
entity_pb2.Entity
) – The Protobuf representing the entity.- Return type
- Returns
The entity derived from the protobuf.
-
google.cloud.datastore.helpers.
entity_to_protobuf
(entity)[source]# Converts an entity into a protobuf.
- Parameters
entity (
google.cloud.datastore.entity.Entity
) – The entity to be turned into a protobuf.- Return type
entity_pb2.Entity
- Returns
The protobuf representing the entity.
-
google.cloud.datastore.helpers.
get_read_options
(eventual, transaction_id)[source]# Validate rules for read options, and assign to the request.
Helper method for
lookup()
andrun_query
.- Parameters
- Return type
datastore_pb2.ReadOptions
- Returns
The read options corresponding to the inputs.
- Raises
ValueError
ifeventual
isTrue
and thetransaction_id
is notNone
.