Package google.datastore.v1

Index

Datastore

Each 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.

AllocateIds

rpc AllocateIds(AllocateIdsRequest) returns (AllocateIdsResponse)

Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

BeginTransaction

rpc BeginTransaction(BeginTransactionRequest) returns (BeginTransactionResponse)

Begins a new transaction.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

Commit

rpc Commit(CommitRequest) returns (CommitResponse)

Commits a transaction, optionally creating, deleting or modifying some entities.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

Lookup

rpc Lookup(LookupRequest) returns (LookupResponse)

Looks up entities by key.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

ReserveIds

rpc ReserveIds(ReserveIdsRequest) returns (ReserveIdsResponse)

Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

Rollback

rpc Rollback(RollbackRequest) returns (RollbackResponse)

Rolls back a transaction.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

RunQuery

rpc RunQuery(RunQueryRequest) returns (RunQueryResponse)

Queries for entities.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

AllocateIdsRequest

The request for Datastore.AllocateIds.

Fields
project_id

string

The ID of the project against which to make the request.

keys[]

Key

A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only.

AllocateIdsResponse

The response for Datastore.AllocateIds.

Fields
keys[]

Key

The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.

ArrayValue

An array value.

Fields
values[]

Value

Values in the array. The order of this array may not be preserved if it contains a mix of indexed and unindexed values.

BeginTransactionRequest

The request for Datastore.BeginTransaction.

Fields
project_id

string

The ID of the project against which to make the request.

transaction_options

TransactionOptions

Options for a new transaction.

BeginTransactionResponse

The response for Datastore.BeginTransaction.

Fields
transaction

bytes

The transaction identifier (always present).

CommitRequest

The request for Datastore.Commit.

Fields
project_id

string

The ID of the project against which to make the request.

mode

Mode

The type of commit to perform. Defaults to TRANSACTIONAL.

mutations[]

Mutation

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.

transaction

bytes

The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.

Mode

The modes available for commits.

Enums
MODE_UNSPECIFIED Unspecified. This value must not be used.
TRANSACTIONAL Transactional: The mutations are either all applied, or none are applied. Learn about transactions here.
NON_TRANSACTIONAL Non-transactional: The mutations may not apply as all or none.

CommitResponse

The response for Datastore.Commit.

Fields
mutation_results[]

MutationResult

The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request.

index_updates

int32

The number of index entries updated during the commit, or zero if none were updated.

CompositeFilter

A filter that merges multiple other filters using the given operator.

Fields
op

Operator

The operator for combining multiple filters.

filters[]

Filter

The list of filters to combine. Must contain at least one filter.

Operator

A composite filter operator.

Enums
OPERATOR_UNSPECIFIED Unspecified. This value must not be used.
AND The results are required to satisfy each of the combined filters.

Entity

A 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.

Fields
key

Key

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.

properties

map<string, Value>

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 "".

EntityResult

The result of fetching an entity from Datastore.

Fields
entity

Entity

The resulting entity.

version

int64

The version of the entity, a strictly positive number that monotonically increases with changes to the entity.

This field is set for FULL entity results.

For 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.

cursor

bytes

A cursor that points to the position after the result entity. Set only when the EntityResult is part of a QueryResultBatch message.

ResultType

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).

Enums
RESULT_TYPE_UNSPECIFIED Unspecified. This value is never used.
FULL The key and properties.
PROJECTION A projected subset of properties. The entity may have no key.
KEY_ONLY Only the key.

Filter

A holder for any type of filter.

Fields
Union field filter_type. The type of filter. filter_type can be only one of the following:
composite_filter

CompositeFilter

A composite filter.

property_filter

PropertyFilter

A filter on a property.

GqlQuery

A GQL query.

Fields
query_string

string

A string of the format described here.

allow_literals

bool

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.

named_bindings

map<string, GqlQueryParameter>

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 "".

positional_bindings[]

GqlQueryParameter

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.

GqlQueryParameter

A binding parameter for a GQL query.

Fields
Union field parameter_type. The type of parameter. parameter_type can be only one of the following:
value

Value

A value parameter.

cursor

bytes

A query cursor. Query cursors are returned in query result batches.

Key

A 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.

Fields
partition_id

PartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

path[]

PathElement

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.

PathElement

A (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.

Fields
kind

string

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 "".

Union field id_type. The type of ID. id_type can be only one of the following:
id

int64

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.

name

string

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 "".

KindExpression

A representation of a kind.

Fields
name

string

The name of the kind.

LookupRequest

The request for Datastore.Lookup.

Fields
project_id

string

The ID of the project against which to make the request.

read_options

ReadOptions

The options for this lookup request.

keys[]

Key

Keys of entities to look up.

LookupResponse

The response for Datastore.Lookup.

Fields
found[]

EntityResult

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.

missing[]

EntityResult

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.

deferred[]

Key

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.

Mutation

A mutation to apply to an entity.

Fields

Union field 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. operation can be only one of the following:

insert

Entity

The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete.

update

Entity

The entity to update. The entity must already exist. Must have a complete key path.

upsert

Entity

The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.

delete

Key

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.

base_version

int64

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.

MutationResult

The result of applying a mutation.

Fields
key

Key

The automatically allocated key. Set only when the mutation allocated a key.

version

int64

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.

conflict_detected

bool

Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation.

PartitionId

A 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.

Fields
project_id

string

The ID of the project to which the entities belong.

namespace_id

string

If not empty, the ID of the namespace to which the entities belong.

Projection

A representation of a property in a projection.

Fields
property

PropertyReference

The property to project.

PropertyFilter

A filter on a specific property.

Fields
property

PropertyReference

The property to filter by.

op

Operator

The operator to filter by.

value

Value

The value to compare the property to.

Operator

A property filter operator.

Enums
OPERATOR_UNSPECIFIED Unspecified. This value must not be used.
LESS_THAN Less than.
LESS_THAN_OR_EQUAL Less than or equal.
GREATER_THAN Greater than.
GREATER_THAN_OR_EQUAL Greater than or equal.
EQUAL Equal.
HAS_ANCESTOR Has ancestor.

PropertyOrder

The desired order for a specific property.

Fields
property

PropertyReference

The property to order by.

direction

Direction

The direction to order by. Defaults to ASCENDING.

Direction

The sort direction.

Enums
DIRECTION_UNSPECIFIED Unspecified. This value must not be used.
ASCENDING Ascending.
DESCENDING Descending.

PropertyReference

A reference to a property relative to the kind expressions.

Fields
name

string

The name of the property. If name includes "."s, it may be interpreted as a property name path.

Query

A query for entities.

Fields
projection[]

Projection

The projection to return. Defaults to returning all properties.

kind[]

KindExpression

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

filter

Filter

The filter to apply.

order[]

PropertyOrder

The order to apply to the query results (if empty, order is unspecified).

distinct_on[]

PropertyReference

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).

start_cursor

bytes

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.

end_cursor

bytes

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.

offset

int32

The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.

limit

Int32Value

The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.

QueryResultBatch

A batch of results produced by a query.

Fields
skipped_results

int32

The number of results skipped, typically because of an offset.

skipped_cursor

bytes

A cursor that points to the position after the last skipped result. Will be set when skipped_results != 0.

entity_result_type

ResultType

The result type for every entity in entity_results.

entity_results[]

EntityResult

The results for this batch.

end_cursor

bytes

A cursor that points to the position after the last result in the batch.

more_results

MoreResultsType

The state of the query after the current batch.

snapshot_version

int64

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.

MoreResultsType

The possible values for the more_results field.

Enums
MORE_RESULTS_TYPE_UNSPECIFIED Unspecified. This value is never used.
NOT_FINISHED There may be additional batches to fetch from this query.
MORE_RESULTS_AFTER_LIMIT The query is finished, but there may be more results after the limit.
MORE_RESULTS_AFTER_CURSOR The query is finished, but there may be more results after the end cursor.
NO_MORE_RESULTS The query is finished, and there are no more results.

ReadOptions

The options shared by read requests.

Fields
Union field consistency_type. If not specified, lookups and ancestor queries default to read_consistency=STRONG, global queries default to read_consistency=EVENTUAL. consistency_type can be only one of the following:
read_consistency

ReadConsistency

The non-transactional read consistency to use. Cannot be set to STRONG for global queries.

transaction

bytes

The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction.

ReadConsistency

The possible values for read consistencies.

Enums
READ_CONSISTENCY_UNSPECIFIED Unspecified. This value must not be used.
STRONG Strong consistency.
EVENTUAL Eventual consistency.

ReserveIdsRequest

The request for Datastore.ReserveIds.

Fields
project_id

string

The ID of the project against which to make the request.

database_id

string

If not empty, the ID of the database against which to make the request.

keys[]

Key

A list of keys with complete key paths whose numeric IDs should not be auto-allocated.

ReserveIdsResponse

The response for Datastore.ReserveIds.

RollbackRequest

The request for Datastore.Rollback.

Fields
project_id

string

The ID of the project against which to make the request.

transaction

bytes

The transaction identifier, returned by a call to Datastore.BeginTransaction.

RollbackResponse

The response for Datastore.Rollback. (an empty message).

RunQueryRequest

The request for Datastore.RunQuery.

Fields
project_id

string

The ID of the project against which to make the request.

partition_id

PartitionId

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.

read_options

ReadOptions

The options for this query.

Union field query_type. The type of query. query_type can be only one of the following:
query

Query

The query to run.

gql_query

GqlQuery

The GQL query to run.

RunQueryResponse

The response for Datastore.RunQuery.

Fields
batch

QueryResultBatch

A batch of query results (always present).

query

Query

The parsed form of the GqlQuery from the request, if it was set.

TransactionOptions

Options for beginning a new transaction.

Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests.

Fields
Union field mode. The mode of the transaction, indicating whether write operations are supported. mode can be only one of the following:
read_write

ReadWrite

The transaction should allow both reads and writes.

read_only

ReadOnly

The transaction should only allow reads.

ReadOnly

Options specific to read-only transactions.

ReadWrite

Options specific to read / write transactions.

Fields
previous_transaction

bytes

The transaction identifier of the transaction being retried.

Value

A message that can hold any of the supported value types and associated metadata.

Fields
meaning

int32

The meaning field should only be populated for backwards compatibility.

exclude_from_indexes

bool

If the value should be excluded from all indexes including those defined explicitly.

Union field value_type. Must have a value set. value_type can be only one of the following:
null_value

NullValue

A null value.

boolean_value

bool

A boolean value.

integer_value

int64

An integer value.

double_value

double

A double value.

timestamp_value

Timestamp

A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.

key_value

Key

A key value.

string_value

string

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.

blob_value

bytes

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

LatLng

A geo point value representing a point on the surface of Earth.

entity_value

Entity

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

ArrayValue

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.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Cloud Datastore