Namespace Google.Cloud.Datastore.V1 (4.2.0)

Stay organized with collections Save and categorize content based on your preferences.

Classes

AllocateIdsRequest

The request for [Datastore.AllocateIds][google.datastore.v1.Datastore.AllocateIds].

AllocateIdsResponse

The response for [Datastore.AllocateIds][google.datastore.v1.Datastore.AllocateIds].

ArrayValue

An array value.

AsyncLazyDatastoreQuery

A Datastore query which is executed lazily. Iterating over this object will provide a sequence of entities; alternatively, all the results can be fetched using GetAllResultsAsync(), or for diagnostic use cases the RPC responses can be viewed using AsResponses(). The lazy evaluation is important: if you iterate over the query multiple times, it will execute multiple times, potentially returning different results each time.

BeginTransactionRequest

The request for [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].

BeginTransactionResponse

The response for [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].

CommitRequest

The request for [Datastore.Commit][google.datastore.v1.Datastore.Commit].

CommitRequest.Types

Container for nested types declared in the CommitRequest message type.

CommitResponse

The response for [Datastore.Commit][google.datastore.v1.Datastore.Commit].

CompositeFilter

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

CompositeFilter.Types

Container for nested types declared in the CompositeFilter message type.

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.

Datastore.DatastoreBase

Base class for server-side implementations of Datastore

Datastore.DatastoreClient

Client for Datastore

DatastoreClient

Datastore client wrapper, for convenient use.

DatastoreClientBuilder

Builder class for DatastoreClient to provide simple configuration of credentials, endpoint etc.

DatastoreClientImpl

Datastore client wrapper implementation, for convenient use.

DatastoreConstants

Constants for use in Datastore.

DatastoreDb

An abstraction over DatastoreClient to simplify operations. Use the Create(String, String, DatastoreClient) method to obtain an instance of this class.

DatastoreDbBuilder

Builder class for DatastoreDb to provide simple configuration of credentials, endpoint etc.

DatastoreDbImpl

Wrapper around DatastoreClient to provide simpler operations.

DatastoreQueryResults

A complete set of query results, fetched and stored in memory. Results are fetched from a LazyDatastoreQuery or AsyncLazyDatastoreQuery until the query-specified limit or end cursor is reached, or no more results are available.

DatastoreSettings

Settings for DatastoreClient instances.

DatastoreTransaction

Convenience wrapper around a Datastore transaction. All mutation operations (Insert(IEnumerable<Entity>), Delete(IEnumerable<Key>), Update(IEnumerable<Entity>) and Upsert(IEnumerable<Entity>)) merely add to a list of mutations which are performed in a single Commit(CallSettings) or CommitAsync(CallSettings) operation. This means the mutation methods are all synchronous and do not take call settings, as they don't perform any API operations.

Datastore limits the number of entities that can be modified in a Commit operation, and therefore one transaction. When modifying a large number of entities, partition the changes into multiple transactions. See Datastore limits for more details on Datastore limits.

Even though transactions aren't inherently related to a specific partition ID, the expected usage is that queries run inside a transaction are likely to be in a single partition, specified in a DatastoreDb used to create the transaction.

Disposing of a transaction calls Rollback(CallSettings) if the transaction has not already been committed or rolled back.

This is an abstract class, implemented by DatastoreTransactionImpl for production use. Users creating their own DatastoreDb subclasses may choose to create fake implementations for testing purposes. There are no abstract methods in this class; instead, all methods either delegate to another or throw NotImplementedException.

DatastoreTransactionImpl

Production implementation of DatastoreTransaction, using a DatastoreClient to implement the operations.

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.

EntityResult

The result of fetching an entity from Datastore.

EntityResult.Types

Container for nested types declared in the EntityResult message type.

Filter

A holder for any type of filter.

GqlQuery

A GQL query.

GqlQueryParameter

A binding parameter for a GQL query.

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.

Key.Types

Container for nested types declared in the Key message type.

Key.Types.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.

KeyFactory

Provides a convenient way of producing keys of a specific kind, from a specified parent entity or key, or for root entities based on a partition ID.

KindExpression

A representation of a kind.

LazyDatastoreQuery

A Datastore query which is executed lazily. Iterating over this object will provide a sequence of entities; alternatively, all the results can be fetched using GetAllResults(), or for diagnostic use cases the RPC responses can be viewed using AsResponses(). The lazy evaluation is important: if you iterate over the query multiple times, it will execute multiple times, potentially returning different results each time.

LookupRequest

The request for [Datastore.Lookup][google.datastore.v1.Datastore.Lookup].

LookupResponse

The response for [Datastore.Lookup][google.datastore.v1.Datastore.Lookup].

Mutation

A mutation to apply to an entity.

MutationResult

The result of applying a 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 &quot;&quot;.
  • 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.

Projection

A representation of a property in a projection.

PropertyFilter

A filter on a specific property.

PropertyFilter.Types

Container for nested types declared in the PropertyFilter message type.

PropertyOrder

The desired order for a specific property.

PropertyOrder.Types

Container for nested types declared in the PropertyOrder message type.

PropertyReference

A reference to a property relative to the kind expressions.

Query

A query for entities.

QueryExtensions

Extension methods around queries.

QueryResultBatch

A batch of results produced by a query.

QueryResultBatch.Types

Container for nested types declared in the QueryResultBatch message type.

ReadOptions

The options shared by read requests.

ReadOptions.Types

Container for nested types declared in the ReadOptions message type.

ReserveIdsRequest

The request for [Datastore.ReserveIds][google.datastore.v1.Datastore.ReserveIds].

ReserveIdsResponse

The response for [Datastore.ReserveIds][google.datastore.v1.Datastore.ReserveIds].

RollbackRequest

The request for [Datastore.Rollback][google.datastore.v1.Datastore.Rollback].

RollbackResponse

The response for [Datastore.Rollback][google.datastore.v1.Datastore.Rollback]. (an empty message).

RunQueryRequest

The request for [Datastore.RunQuery][google.datastore.v1.Datastore.RunQuery].

RunQueryResponse

The response for [Datastore.RunQuery][google.datastore.v1.Datastore.RunQuery].

TransactionOptions

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

TransactionOptions.Types

Container for nested types declared in the TransactionOptions message type.

TransactionOptions.Types.ReadOnly

Options specific to read-only transactions.

TransactionOptions.Types.ReadWrite

Options specific to read / write transactions.

Value

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

ValueExtensions

Extension methods on Value.

Enums

CommitRequest.TransactionSelectorOneofCase

Enum of possible cases for the "transaction_selector" oneof.

CommitRequest.Types.Mode

The modes available for commits.

CompositeFilter.Types.Operator

A composite filter operator.

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

Filter.FilterTypeOneofCase

Enum of possible cases for the "filter_type" oneof.

GqlQueryParameter.ParameterTypeOneofCase

Enum of possible cases for the "parameter_type" oneof.

Key.Types.PathElement.IdTypeOneofCase

Enum of possible cases for the "id_type" oneof.

Mutation.ConflictDetectionStrategyOneofCase

Enum of possible cases for the "conflict_detection_strategy" oneof.

Mutation.OperationOneofCase

Enum of possible cases for the "operation" oneof.

PropertyFilter.Types.Operator

A property filter operator.

PropertyOrder.Types.Direction

The sort direction.

QueryResultBatch.Types.MoreResultsType

The possible values for the more_results field.

ReadOptions.ConsistencyTypeOneofCase

Enum of possible cases for the "consistency_type" oneof.

ReadOptions.Types.ReadConsistency

The possible values for read consistencies.

RunQueryRequest.QueryTypeOneofCase

Enum of possible cases for the "query_type" oneof.

TransactionOptions.ModeOneofCase

Enum of possible cases for the "mode" oneof.

Value.ValueTypeOneofCase

Enum of possible cases for the "value_type" oneof.