package com.google.appengine.datastore_v3
Get desktop application:
View/edit binary Protocol Buffers messages
The datastore's RPC call endpoints.
begin, commit, and rollback a transaction
rpc Commit (, )
datastore_v3.proto:235rpc Count (, )
datastore_v3.proto:225get a query's histogram (not really, just a result count). this is the total number of result for the query, *not* the number of results left in the query.
rpc CreateIndex (, )
datastore_v3.proto:244create a new composite index. the request index's id should be 0. returns the id assigned to the newly created index.
rpc Delete (, )
datastore_v3.proto:214Deletes one or more entities. If the request includes a transaction, then the entities are deleted in the context of that transaction, and the writes will happen when the transaction is committed.
message
datastore_v3.proto:155repeated key = 6
optional transaction = 5
rpc DeleteCursor (, )
datastore_v3.proto:231deletes a query cursor and flushes any associated state
rpc DeleteIndex (, )
datastore_v3.proto:267deletes a composite index definition. only the app_id and definition fields of the CompositeIndex request PB are used. like UpdateIndex, this call is idempotent. deleting a nonexistent index is a noop. note that this deletes the index definition, but it does *not* delete the index's rows in the EntitiesByCompositeProperty index.
rpc Explain (, )
datastore_v3.proto:228get an explanation of the query plan that would be executed by RunQuery
message
datastore_v3.proto:95optional bool native_ancestor = 1
If true, the ancestor constraint was satisfied natively.
repeated native_index = 2
The native property indexes that were used to satisfy the query, if any. Multiple property indexes may be used, even in conjunction with a native ancestor, in the case of merge join queries. In other cases, only a single index is used.
optional int32 native_offset = 3
The native offset, if any.
optional int32 native_limit = 4
The native limit, if any.
rpc Get (, )
datastore_v3.proto:195Looks up one or more entities by their ids. The GetResponse has an Entity element for each key in the GetRequest. Each Entity.entity field will be filled if its corresponding key matched an existing entity. Otherwise, it will be unset. If the request specifies a transaction, then the lookups occur in the context of that transaction, and the entities must all be in the same group.
message
datastore_v3.proto:131repeated key = 1
optional transaction = 2
message
datastore_v3.proto:136repeated group com.google.appengine.datastore_v3.GetResponse.Entity = 1
rpc GetIndices (, )
datastore_v3.proto:257returns all composite indices defined for a given app. the request StringProto should contain the app id.
message
datastore_v3.proto:178repeated index = 1
rpc GetSchema (, )
datastore_v3.proto:240makes an educated guess at an app's schema based on the entities in its datastore. the request StringProto should contain the app id.
message
datastore_v3.proto:172repeated kind = 1
includes one entity per kind found in the datastore. each one includes all property names and types found in entities of that kind.
rpc Next (, )
datastore_v3.proto:220get more results for a query
message
datastore_v3.proto:160required cursor = 1
optional int32 count = 2
rpc Put (, )
datastore_v3.proto:207Store one or more entities. New entities are inserted, while existing entities are updated. The response contains the keys of the entities written to the datastore, in the same order as the request. Newly inserted entities will have the primary key and app name filled in in the response. If the request specifies a transaction, then the entities are put in the context of that transaction, and the writes will happen when the transaction is committed.
message
datastore_v3.proto:145repeated entity = 1
optional transaction = 2
repeated composite_index = 3
message
datastore_v3.proto:151repeated key = 1
rpc Rollback (, )
datastore_v3.proto:236rpc RunQuery (, )
datastore_v3.proto:217run a query
rpc UpdateIndex (, )
datastore_v3.proto:252update a composite index's state. only the state field will be changed. the index id field is ignored. this call is idempotent. if the index already has the desired state, UpdateIndex is a noop.
message
datastore_v3.proto:113A query cursor.
Used as request type in: DatastoreService.DeleteCursor
Used as field type in: ,
required fixed64 cursor = 1
all possible values from 0 to 2^64 - 1 are valid cursors. there is no special "error" or "unset" value.
message
datastore_v3.proto:121RPC request and response objects, along with response error codes for error handling.
(message has no fields)
BAD_REQUEST = 1
CONCURRENT_TRANSACTION = 2
INTERNAL_ERROR = 3
NEED_INDEX = 4
TIMEOUT = 5
message
datastore_v3.proto:140the Entity elements here will match the keys in the GetRequest. The entity field will be set for keys that were found, unset for keys that weren't found.
Used in:
optional entity = 2
message
datastore_v3.proto:24Query API
Used as request type in: DatastoreService.Count, DatastoreService.Explain, DatastoreService.RunQuery
required string app = 1
optional bytes kind = 3
kind and ancestor both restrict the query results. if kind is provided, only entities of that kind are returned. if ancestor is provided, only entities descended from that ancestor by path, including the ancestor itself, are returned. either or both must be provided.
optional ancestor = 17
repeated group com.google.appengine.datastore_v3.Query.Filter = 4
optional bytes search_query = 8
currently not implemented. eventually, when provided, this will be used as a plain-text search query. ideally, it will be combined with any filters, sort orders, and ancestor.
repeated group com.google.appengine.datastore_v3.Query.Order = 9
optional int32 offset = 12
start returning results at this offset. useful for paging.
optional int32 limit = 16
an optional upper bound on the number of results returned for this query.
repeated composite_index = 19
the composite indexes, if any, that are available to the query planner
optional bool require_perfect_plan = 20
if true, the datastore will only run this query if there's an index or set of indices that perfectly match it. if not, it will return an error.
optional bool keys_only = 21
optional transaction = 22
if specified, the query must be an ancestor query, and the ancestor must be in the same entity group as the other operations in the transaction.
message
datastore_v3.proto:40filter based on property values. these AND, not OR, together. when filters are evaluated in memory, they're evaluated in the order they're provided here. you can take advantage of this by putting the most restrictive filters, ie the ones that match the least number of results, first.
Used in:
required int32 op = 6
repeated property = 14
LESS_THAN = 1
LESS_THAN_OR_EQUAL = 2
GREATER_THAN = 3
GREATER_THAN_OR_EQUAL = 4
EQUAL = 5
IN = 6
NOT_EQUAL is intentionally omitted. use IN instead, or use the GQL != operator: http://code.google.com/appengine/docs/datastore/gqlreference.html
EXISTS = 7
message
datastore_v3.proto:65these apply in the order they're added, e.g. adding ("date", DESC), then adding ("rank", DESC) would sort first by date, descending, then by rank, descending.
Used in:
required bytes property = 10
optional int32 direction = 11
default to ASCENDING
ASCENDING = 1
DESCENDING = 2
message
datastore_v3.proto:165Used as response type in: DatastoreService.Next, DatastoreService.RunQuery
optional cursor = 1
cursor is set in RunQuery() responses, but not in Next() responses
repeated result = 2
required bool more_results = 3
message
datastore_v3.proto:15A transaction handle.
Used as request type in: DatastoreService.Commit, DatastoreService.Rollback
Used as response type in: DatastoreService.BeginTransaction
Used as field type in: , , ,
required fixed64 handle = 1
all possible values from 0 to 2^64 - 1 are valid handles. there is no special "error" or "unset" value.