package google.datastore.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service Datastore
datastore.proto:37Each RPC normalizes the partition IDs of the keys in its input entities, and always returns entities with keys with normalized partition IDs. This applies to all keys and entities, including those in values, except keys with both an empty path and an empty or unset partition ID. Normalization of input keys sets the project ID (if not already set) to the project ID from the request.
rpc Lookup (, )
datastore.proto:39Looks up entities by key.
message
datastore.proto:100The request for [Datastore.Lookup][google.datastore.v1.Datastore.Lookup].
string project_id = 8
The ID of the project against which to make the request.
optional read_options = 1
The options for this lookup request.
repeated keys = 3
Keys of entities to look up.
message
datastore.proto:112The response for [Datastore.Lookup][google.datastore.v1.Datastore.Lookup].
repeated found = 1
Entities found as `ResultType.FULL` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.
repeated missing = 2
Entities not found as `ResultType.KEY_ONLY` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.
repeated deferred = 3
A list of keys that were not looked up due to resource constraints. The order of results in this field is undefined and has no relation to the order of the keys in the input.
rpc RunQuery (, )
datastore.proto:47Queries for entities.
message
datastore.proto:130The request for [Datastore.RunQuery][google.datastore.v1.Datastore.RunQuery].
string project_id = 8
The ID of the project against which to make the request.
optional partition_id = 2
Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.
optional read_options = 1
The options for this query.
oneof query_type
The type of query.
query = 3
The query to run.
gql_query = 7
The GQL query to run.
message
datastore.proto:155The response for [Datastore.RunQuery][google.datastore.v1.Datastore.RunQuery].
optional batch = 1
A batch of query results (always present).
optional query = 2
The parsed form of the `GqlQuery` from the request, if it was set.
rpc BeginTransaction (, )
datastore.proto:55Begins a new transaction.
message
datastore.proto:165The request for [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
string project_id = 8
The ID of the project against which to make the request.
optional transaction_options = 10
Options for a new transaction.
message
datastore.proto:175The response for [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
bytes transaction = 1
The transaction identifier (always present).
rpc Commit (, )
datastore.proto:65Commits a transaction, optionally creating, deleting or modifying some entities.
message
datastore.proto:196The request for [Datastore.Commit][google.datastore.v1.Datastore.Commit].
string project_id = 8
The ID of the project against which to make the request.
CommitRequest.Mode mode = 5
The type of commit to perform. Defaults to `TRANSACTIONAL`.
oneof transaction_selector
Must be set when mode is `TRANSACTIONAL`.
bytes transaction = 1
The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
repeated mutations = 6
The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single `Commit` request: - `insert` followed by `insert` - `update` followed by `insert` - `upsert` followed by `insert` - `delete` followed by `update` When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single entity.
message
datastore.proto:242The response for [Datastore.Commit][google.datastore.v1.Datastore.Commit].
repeated mutation_results = 3
The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request.
int32 index_updates = 4
The number of index entries updated during the commit, or zero if none were updated.
rpc Rollback (, )
datastore.proto:73Rolls back a transaction.
message
datastore.proto:181The request for [Datastore.Rollback][google.datastore.v1.Datastore.Rollback].
string project_id = 8
The ID of the project against which to make the request.
bytes transaction = 1
The transaction identifier, returned by a call to [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
message
datastore.proto:193The response for [Datastore.Rollback][google.datastore.v1.Datastore.Rollback]. (an empty message).
(message has no fields)
rpc AllocateIds (, )
datastore.proto:82Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.
message
datastore.proto:254The request for [Datastore.AllocateIds][google.datastore.v1.Datastore.AllocateIds].
string project_id = 8
The ID of the project against which to make the request.
repeated keys = 1
A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only.
message
datastore.proto:265The response for [Datastore.AllocateIds][google.datastore.v1.Datastore.AllocateIds].
repeated keys = 1
The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.
rpc ReserveIds (, )
datastore.proto:91Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.
message
datastore.proto:273The request for [Datastore.ReserveIds][google.datastore.v1.Datastore.ReserveIds].
string project_id = 8
The ID of the project against which to make the request.
string database_id = 9
If not empty, the ID of the database against which to make the request.
repeated keys = 1
A list of keys with complete key paths whose numeric IDs should not be auto-allocated.
message
datastore.proto:287The response for [Datastore.ReserveIds][google.datastore.v1.Datastore.ReserveIds].
(message has no fields)
message
entity.proto:115An array value.
Used in:
repeated values = 1
Values in the array. The order of this array may not be preserved if it contains a mix of indexed and unindexed values.
The modes available for commits.
Used in:
MODE_UNSPECIFIED = 0
Unspecified. This value must not be used.
TRANSACTIONAL = 1
Transactional: The mutations are either all applied, or none are applied. Learn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).
NON_TRANSACTIONAL = 2
Non-transactional: The mutations may not apply as all or none.
message
query.proto:167A filter that merges multiple other filters using the given operator.
Used in:
CompositeFilter.Operator op = 1
The operator for combining multiple filters.
repeated filters = 2
The list of filters to combine. Must contain at least one filter.
A composite filter operator.
Used in:
OPERATOR_UNSPECIFIED = 0
Unspecified. This value must not be used.
AND = 1
The results are required to satisfy each of the combined filters.
message
entity.proto:188A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message.
Used in: , ,
optional key = 1
The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
map<string, > properties = 3
The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
message
query.proto:32The result of fetching an entity from Datastore.
Used in: ,
optional entity = 1
The resulting entity.
int64 version = 4
The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for [`FULL`][google.datastore.v1.EntityResult.ResultType.FULL] entity results. For [missing][google.datastore.v1.LookupResponse.missing] entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
bytes cursor = 3
A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message.
Specifies what data the 'entity' field contains. A `ResultType` is either implied (for example, in `LookupResponse.missing` from `datastore.proto`, it is always `KEY_ONLY`) or specified by context (for example, in message `QueryResultBatch`, field `entity_result_type` specifies a `ResultType` for all the values in field `entity_results`).
Used in:
RESULT_TYPE_UNSPECIFIED = 0
Unspecified. This value is never used.
FULL = 1
The key and properties.
PROJECTION = 2
A projected subset of properties. The entity may have no key.
KEY_ONLY = 3
Only the key.
message
query.proto:155A holder for any type of filter.
Used in: ,
oneof filter_type
The type of filter.
composite_filter = 1
A composite filter.
property_filter = 2
A filter on a property.
message
query.proto:223A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
Used in:
string query_string = 1
A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
bool allow_literals = 2
When false, the query string must not contain any literals and instead must bind all values. For example, `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while `SELECT * FROM Kind WHERE a = @value` is.
map<string, > named_bindings = 5
For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse. Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex `__.*__`, and must not be `""`.
repeated positional_bindings = 4
Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0. For each binding site numbered i in `query_string`, there must be an i-th numbered parameter. The inverse must also be true.
message
query.proto:250A binding parameter for a GQL query.
Used in:
oneof parameter_type
The type of parameter.
value = 2
A value parameter.
bytes cursor = 3
A query cursor. Query cursors are returned in query result batches.
message
entity.proto:63A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.
Used in: , , , , , , , ,
optional partition_id = 1
Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
repeated path = 2
The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
message
entity.proto:68A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
Used in:
string kind = 1
The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
oneof id_type
The type of ID.
int64 id = 2
The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
string name = 3
The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
message
query.proto:115A representation of a kind.
Used in:
string name = 1
The name of the kind.
message
datastore.proto:290A mutation to apply to an entity.
Used in:
oneof operation
The mutation operation. For `insert`, `update`, and `upsert`: - The entity's key must not be reserved/read-only. - No property in the entity may have a reserved name, not even a property in an entity in a value. - No value in the entity may have meaning 18, not even a value in an entity in another value.
insert = 4
The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete.
update = 5
The entity to update. The entity must already exist. Must have a complete key path.
upsert = 6
The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.
delete = 7
The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only.
oneof conflict_detection_strategy
When set, the server will detect whether or not this mutation conflicts with the current version of the entity on the server. Conflicting mutations are not applied, and are marked as such in MutationResult.
int64 base_version = 8
The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts.
message
datastore.proto:328The result of applying a mutation.
Used in:
optional key = 3
The automatically allocated key. Set only when the mutation allocated a key.
int64 version = 4
The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity.
bool conflict_detected = 5
Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation.
message
entity.proto:51A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.
Used in: ,
string project_id = 2
The ID of the project to which the entities belong.
string namespace_id = 4
If not empty, the ID of the namespace to which the entities belong.
message
query.proto:128A representation of a property in a projection.
Used in:
optional property = 1
The property to project.
message
query.proto:186A filter on a specific property.
Used in:
optional property = 1
The property to filter by.
PropertyFilter.Operator op = 2
The operator to filter by.
optional value = 3
The value to compare the property to.
A property filter operator.
Used in:
OPERATOR_UNSPECIFIED = 0
Unspecified. This value must not be used.
LESS_THAN = 1
Less than.
LESS_THAN_OR_EQUAL = 2
Less than or equal.
GREATER_THAN = 3
Greater than.
GREATER_THAN_OR_EQUAL = 4
Greater than or equal.
EQUAL = 5
Equal.
HAS_ANCESTOR = 11
Has ancestor.
message
query.proto:134The desired order for a specific property.
Used in:
optional property = 1
The property to order by.
PropertyOrder.Direction direction = 2
The direction to order by. Defaults to `ASCENDING`.
The sort direction.
Used in:
DIRECTION_UNSPECIFIED = 0
Unspecified. This value must not be used.
ASCENDING = 1
Ascending.
DESCENDING = 2
Descending.
message
query.proto:121A reference to a property relative to the kind expressions.
Used in: , , ,
string name = 2
The name of the property. If name includes "."s, it may be interpreted as a property name path.
message
query.proto:72A query for entities.
Used in: ,
repeated projection = 2
The projection to return. Defaults to returning all properties.
repeated kind = 3
The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.
optional filter = 4
The filter to apply.
repeated order = 5
The order to apply to the query results (if empty, order is unspecified).
repeated distinct_on = 6
The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).
bytes start_cursor = 7
A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
bytes end_cursor = 8
An ending point for the query results. Query cursors are returned in query result batches and [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
int32 offset = 10
The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.
optional limit = 12
The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.
message
query.proto:263A batch of results produced by a query.
Used in:
int32 skipped_results = 6
The number of results skipped, typically because of an offset.
bytes skipped_cursor = 3
A cursor that points to the position after the last skipped result. Will be set when `skipped_results` != 0.
EntityResult.ResultType entity_result_type = 1
The result type for every entity in `entity_results`.
repeated entity_results = 2
The results for this batch.
bytes end_cursor = 4
A cursor that points to the position after the last result in the batch.
QueryResultBatch.MoreResultsType more_results = 5
The state of the query after the current batch.
int64 snapshot_version = 7
The version number of the snapshot this batch was returned from. This applies to the range of results from the query's `start_cursor` (or the beginning of the query if no cursor was given) to this batch's `end_cursor` (not the query's `end_cursor`). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries.
The possible values for the `more_results` field.
Used in:
MORE_RESULTS_TYPE_UNSPECIFIED = 0
Unspecified. This value is never used.
NOT_FINISHED = 1
There may be additional batches to fetch from this query.
MORE_RESULTS_AFTER_LIMIT = 2
The query is finished, but there may be more results after the limit.
MORE_RESULTS_AFTER_CURSOR = 4
The query is finished, but there may be more results after the end cursor.
NO_MORE_RESULTS = 3
The query is finished, and there are no more results.
message
datastore.proto:346The options shared by read requests.
Used in: ,
oneof consistency_type
If not specified, lookups and ancestor queries default to `read_consistency`=`STRONG`, global queries default to `read_consistency`=`EVENTUAL`.
ReadOptions.ReadConsistency read_consistency = 1
The non-transactional read consistency to use. Cannot be set to `STRONG` for global queries.
bytes transaction = 2
The identifier of the transaction in which to read. A transaction identifier is returned by a call to [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
The possible values for read consistencies.
Used in:
READ_CONSISTENCY_UNSPECIFIED = 0
Unspecified. This value must not be used.
STRONG = 1
Strong consistency.
EVENTUAL = 2
Eventual consistency.
message
datastore.proto:381Options for beginning a new transaction. Transactions can be created explicitly with calls to [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction] or implicitly by setting [ReadOptions.new_transaction][google.datastore.v1.ReadOptions.new_transaction] in read requests.
Used in:
oneof mode
The `mode` of the transaction, indicating whether write operations are supported.
read_write = 1
The transaction should allow both reads and writes.
read_only = 2
The transaction should only allow reads.
message
datastore.proto:389Options specific to read-only transactions.
Used in:
(message has no fields)
message
datastore.proto:383Options specific to read / write transactions.
Used in:
bytes previous_transaction = 1
The transaction identifier of the transaction being retried.
message
entity.proto:124A message that can hold any of the supported value types and associated metadata.
Used in: , , ,
oneof value_type
Must have a value set.
protobuf.NullValue null_value = 11
A null value.
bool boolean_value = 1
A boolean value.
int64 integer_value = 2
An integer value.
double double_value = 3
A double value.
timestamp_value = 10
A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
key_value = 5
A key value.
string string_value = 17
A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.
bytes blob_value = 18
A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
geo_point_value = 8
A geo point value representing a point on the surface of Earth.
entity_value = 6
An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
array_value = 9
An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
int32 meaning = 14
The `meaning` field should only be populated for backwards compatibility.
bool exclude_from_indexes = 19
If the value should be excluded from all indexes including those defined explicitly.