Module helpers (2.17.0)

Helper functions for dealing with Cloud Datastore's Protobuf API.

The non-private functions are part of the API.

Classes

GeoPoint

GeoPoint(latitude, longitude)

Simple container for a geo point value.

Parameters
NameDescription
latitude float

Latitude of a point.

longitude float

Longitude of a point.

Modules Functions

entity_from_protobuf

entity_from_protobuf(pb)

Factory method for creating an entity based on a protobuf.

The protobuf should be one returned from the Cloud Datastore Protobuf API.

Parameter
NameDescription
pb .entity_pb2.Entity

The Protobuf representing the entity.

Returns
TypeDescription
EntityThe entity derived from the protobuf.

entity_to_protobuf

entity_to_protobuf(entity)

Converts an entity into a protobuf.

Parameter
NameDescription
entity Entity

The entity to be turned into a protobuf.

Returns
TypeDescription
.entity_pb2.EntityThe protobuf representing the entity.

get_read_options

get_read_options(eventual, transaction_id, read_time=None)

Validate rules for read options, and assign to the request.

Helper method for lookup() and run_query.

Parameters
NameDescription
eventual bool

Flag indicating if EVENTUAL or STRONG consistency should be used.

transaction_id bytes

A transaction identifier (may be null).

read_time datetime

Read data from the specified time (may be null). This feature is in private preview.

Exceptions
TypeDescription
`ValueErrorif more than one of eventual==True, transaction, and read_time is specified.
Returns
TypeDescription
.datastore_pb2.ReadOptionsThe read options corresponding to the inputs.

key_from_protobuf

key_from_protobuf(pb)

Factory method for creating a key based on a protobuf.

The protobuf should be one returned from the Cloud Datastore Protobuf API.

Parameter
NameDescription
pb .entity_pb2.Key

The Protobuf representing the key.

Returns
TypeDescription
Keya new Key instance

set_database_id_to_request

set_database_id_to_request(request, database_id=None)

Set the "database_id" field to the request only if it was provided.