Google Cloud Datastore v1 API - Class DatastoreDbImpl (4.3.0)

public sealed class DatastoreDbImpl : DatastoreDb

Reference documentation and code samples for the Google Cloud Datastore v1 API class DatastoreDbImpl.

Wrapper around DatastoreClient to provide simpler operations.

Inheritance

Object > DatastoreDb > DatastoreDbImpl

Inherited Members

DatastoreDb.Create(String, String, DatastoreClient)

DatastoreDb.RunQuery(Query, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

DatastoreDb.RunQueryAsync(Query, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

DatastoreDb.RunQuery(GqlQuery, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

DatastoreDb.RunQueryAsync(GqlQuery, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

DatastoreDb.AllocateId(Key, CallSettings)

DatastoreDb.AllocateIds(Key[])

DatastoreDb.AllocateIdAsync(Key, CallSettings)

DatastoreDb.AllocateIdsAsync(Key[])

DatastoreDb.Lookup(Key, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

DatastoreDb.Lookup(Key[])

DatastoreDb.LookupAsync(Key, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

DatastoreDb.LookupAsync(Key[])

DatastoreDb.Insert(Entity, CallSettings)

DatastoreDb.Insert(Entity[])

DatastoreDb.InsertAsync(Entity, CallSettings)

DatastoreDb.InsertAsync(Entity[])

DatastoreDb.Upsert(Entity, CallSettings)

DatastoreDb.Upsert(Entity[])

DatastoreDb.UpsertAsync(Entity, CallSettings)

DatastoreDb.UpsertAsync(Entity[])

DatastoreDb.Update(Entity, CallSettings)

DatastoreDb.Update(Entity[])

DatastoreDb.UpdateAsync(Entity, CallSettings)

DatastoreDb.UpdateAsync(Entity[])

DatastoreDb.Delete(Entity, CallSettings)

DatastoreDb.Delete(Entity[])

DatastoreDb.DeleteAsync(Entity, CallSettings)

DatastoreDb.DeleteAsync(Entity[])

DatastoreDb.Delete(Key, CallSettings)

DatastoreDb.Delete(Key[])

DatastoreDb.DeleteAsync(Key, CallSettings)

DatastoreDb.DeleteAsync(Key[])

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Datastore.V1

Assembly

Google.Cloud.Datastore.V1.dll

Remarks

This is the "default" implementation of DatastoreDb. Most client code should refer to DatastoreDb, creating instances with Create(String, String, DatastoreClient). The constructor of this class is public for the sake of constructor-based dependency injection.

Constructors

DatastoreDbImpl(String, String, DatastoreClient)

public DatastoreDbImpl(string projectId, string namespaceId, DatastoreClient client)

Constructs an instance from the given project ID, namespace ID and client.

Parameters
Name	Description
`projectId`	`String` The project ID. Must not be null.
`namespaceId`	`String` The namespace ID. Must not be null.
`client`	`DatastoreClient` The client to use for underlying operations. Must not be null.

Remarks

This constructor is primarily provided for constructor-based dependency injection. The static Create(String, String, DatastoreClient) method is provided for manually obtaining an instance, including automatic client creation.

Properties

Client

public override DatastoreClient Client { get; }

The DatastoreClient used for all remote operations.

Property Value
Type	Description
`DatastoreClient`

Overrides

DatastoreDb.Client

NamespaceId

public override string NamespaceId { get; }

The ID of the namespace this instance operates on.

Property Value
Type	Description
`String`

Overrides

DatastoreDb.NamespaceId

ProjectId

public override string ProjectId { get; }

The ID of the project this instance operates on.

Property Value
Type	Description
`String`

Overrides

DatastoreDb.ProjectId

Methods

AllocateIds(IEnumerable<Key>, CallSettings)

public override IReadOnlyList<Key> AllocateIds(IEnumerable<Key> keys, CallSettings callSettings = null)

Allocates IDs for a collection of incomplete keys.

Parameters
Name	Description
`keys`	`IEnumerable<Key>` The incomplete keys. Must not be null or contain null elements.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`IReadOnlyList<Key>`	A collection of complete keys with allocated IDs, in the same order as `keys`.

Overrides

DatastoreDb.AllocateIds(IEnumerable<Key>, CallSettings)

Remarks

Datastore limits the number of keys that can be allocated in a single operation. When allocating a large number of keys, partition the allocations into batches. See Datastore limits for more details on Datastore limits.

AllocateIdsAsync(IEnumerable<Key>, CallSettings)

public override async Task<IReadOnlyList<Key>> AllocateIdsAsync(IEnumerable<Key> keys, CallSettings callSettings = null)

Allocates IDs for a collection of incomplete keys asynchronously.

Parameters
Name	Description
`keys`	`IEnumerable<Key>` The incomplete keys. Must not be null or contain null elements.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<IReadOnlyList<Key>>`	A collection of complete keys with allocated IDs, in the same order as `keys`.

Overrides

DatastoreDb.AllocateIdsAsync(IEnumerable<Key>, CallSettings)

Remarks

BeginTransaction(CallSettings)

public override DatastoreTransaction BeginTransaction(CallSettings callSettings = null)

Begins a transaction, returning a DatastoreTransaction which can be used to operate on the transaction.

Parameter
Name	Description
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`DatastoreTransaction`	A new DatastoreTransaction for this object's project.

Overrides

DatastoreDb.BeginTransaction(CallSettings)

BeginTransaction(TransactionOptions, CallSettings)

public override DatastoreTransaction BeginTransaction(TransactionOptions options, CallSettings callSettings = null)

Begins a transaction, returning a DatastoreTransaction which can be used to operate on the transaction.

Parameters
Name	Description
`options`	`TransactionOptions` The options for the new transaction. May be null, for default options.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`DatastoreTransaction`	A new DatastoreTransaction for this object's project.

Overrides

DatastoreDb.BeginTransaction(TransactionOptions, CallSettings)

BeginTransactionAsync(CallSettings)

public override async Task<DatastoreTransaction> BeginTransactionAsync(CallSettings callSettings = null)

Begins a transaction asynchronously, returning a DatastoreTransaction which can be used to operate on the transaction.

Parameter
Name	Description
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<DatastoreTransaction>`	A new DatastoreTransaction for this object's project.

Overrides

DatastoreDb.BeginTransactionAsync(CallSettings)

BeginTransactionAsync(TransactionOptions, CallSettings)

public override async Task<DatastoreTransaction> BeginTransactionAsync(TransactionOptions options, CallSettings callSettings = null)

Begins a transaction asynchronously, returning a DatastoreTransaction which can be used to operate on the transaction.

Parameters
Name	Description
`options`	`TransactionOptions` The options for the new transaction. May be null, for default options.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<DatastoreTransaction>`	A new DatastoreTransaction for this object's project.

Overrides

DatastoreDb.BeginTransactionAsync(TransactionOptions, CallSettings)

CreateKeyFactory(String)

public override KeyFactory CreateKeyFactory(string kind)

Creates a key factory for root entities in this objects's partition.

Parameter
Name	Description
`kind`	`String` The kind of entity key to create. Must not be null.

Returns
Type	Description
`KeyFactory`	A key factory with the specified kind and this object's partition.

Overrides

DatastoreDb.CreateKeyFactory(String)

Delete(IEnumerable<Entity>, CallSettings)

public override void Delete(IEnumerable<Entity> entities, CallSettings callSettings = null)

Deletes a collection of entities, non-transactionally.

Parameters
Name	Description
`entities`	`IEnumerable<Entity>` The entities to delete. Must not be null or contain null entries.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

DatastoreDb.Delete(IEnumerable<Entity>, CallSettings)

Remarks

Datastore limits the number of entities that can be modified in a Commit operation. Although this method does not use an existing transaction, it still performs all the work in a single Commit operation. When modifying a large number of entities, partition the changes into batches. See Datastore limits for more details on Datastore limits.

Delete(IEnumerable<Key>, CallSettings)

public override void Delete(IEnumerable<Key> keys, CallSettings callSettings = null)

Deletes a collection of keys, non-transactionally.

Parameters
Name	Description
`keys`	`IEnumerable<Key>` The keys to delete. Must not be null or contain null entries.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

DatastoreDb.Delete(IEnumerable<Key>, CallSettings)

Remarks

DeleteAsync(IEnumerable<Entity>, CallSettings)

public override Task DeleteAsync(IEnumerable<Entity> entities, CallSettings callSettings = null)

Deletes a collection of entities, non-transactionally and asynchronously.

Parameters
Name	Description
`entities`	`IEnumerable<Entity>` The entities to delete. Must not be null or contain null entries.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A task representing the asynchronous operation.

Overrides

DatastoreDb.DeleteAsync(IEnumerable<Entity>, CallSettings)

Remarks

DeleteAsync(IEnumerable<Key>, CallSettings)

public override Task DeleteAsync(IEnumerable<Key> keys, CallSettings callSettings = null)

Deletes a collection of keys, non-transactionally and asynchronously.

Parameters
Name	Description
`keys`	`IEnumerable<Key>` The keys to delete. Must not be null or contain null entries.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`

Overrides

DatastoreDb.DeleteAsync(IEnumerable<Key>, CallSettings)

Remarks

Insert(IEnumerable<Entity>, CallSettings)

public override IReadOnlyList<Key> Insert(IEnumerable<Entity> entities, CallSettings callSettings = null)

Inserts a collection of entities, non-transactionally.

Parameters
Name	Description
`entities`	`IEnumerable<Entity>` The entities to insert. Must not be null or contain null entries.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`IReadOnlyList<Key>`	A collection of keys of inserted entities, in the same order as `entities`. Only keys allocated by the server will be returned; any entity with a predefined key will have a null value in the collection.

Overrides

DatastoreDb.Insert(IEnumerable<Entity>, CallSettings)

Remarks

On success, the entities will be updated in memory with the server-allocated keys.

InsertAsync(IEnumerable<Entity>, CallSettings)

public override Task<IReadOnlyList<Key>> InsertAsync(IEnumerable<Entity> entities, CallSettings callSettings = null)

Inserts a collection of entities, non-transactionally and asynchronously.

Parameters
Name	Description
`entities`	`IEnumerable<Entity>` The entities to insert. Must not be null or contain null entries.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<IReadOnlyList<Key>>`	A task representing the asynchronous operation. The result of the task is a collection of keys of inserted entities, in the same order as `entities`. Only keys allocated by the server will be returned; any entity with a predefined key will have a null value in the collection.

Overrides

DatastoreDb.InsertAsync(IEnumerable<Entity>, CallSettings)

Remarks

On success, the entities will be updated in memory with the server-allocated keys.

Datastore limits the number of entities that can be looked up in a single operation. When looking up a large number of entities, partition the look-ups into batches. See Datastore limits for more details on Datastore limits.

Lookup(IEnumerable<Key>, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

public override IReadOnlyList<Entity> Lookup(IEnumerable<Key> keys, ReadOptions.Types.ReadConsistency? readConsistency = null, CallSettings callSettings = null)

Looks up a collection of entities by key.

Parameters
Name	Description
`keys`	`IEnumerable<Key>` The keys to look up. Must not be null, and every element must be non-null and refer to a complete key.
`readConsistency`	`Nullable<ReadOptions.Types.ReadConsistency>` The desired read consistency of the lookup, or null to use the default.
`callSettings`	`CallSettings` If not null, applies overrides to RPC calls.

Returns
Type	Description
`IReadOnlyList<Entity>`	A collection of entities with the same size as `keys`, containing corresponding entity references, or `null` where the key was not found.

Overrides

DatastoreDb.Lookup(IEnumerable<Key>, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

Remarks

This call may perform multiple RPC operations in order to look up all keys.

LookupAsync(IEnumerable<Key>, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

public override Task<IReadOnlyList<Entity>> LookupAsync(IEnumerable<Key> keys, ReadOptions.Types.ReadConsistency? readConsistency = null, CallSettings callSettings = null)

Looks up a collection of entities by key asynchronously.

Parameters
Name	Description
`keys`	`IEnumerable<Key>` The keys to look up. Must not be null, and every element must be non-null and refer to a complete key.
`readConsistency`	`Nullable<ReadOptions.Types.ReadConsistency>` The desired read consistency of the lookup, or null to use the default.
`callSettings`	`CallSettings` If not null, applies overrides to RPC calls.

Returns
Type	Description
`Task<IReadOnlyList<Entity>>`	A collection of entities with the same size as `keys`, containing corresponding entity references, or `null` where the key was not found.

Overrides

DatastoreDb.LookupAsync(IEnumerable<Key>, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

Remarks

This call may perform multiple RPC operations in order to look up all keys.

RunQueryLazily(GqlQuery, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

public override LazyDatastoreQuery RunQueryLazily(GqlQuery gqlQuery, ReadOptions.Types.ReadConsistency? readConsistency = null, CallSettings callSettings = null)

Lazily executes the given GQL query for asynchronous consumption.

Parameters
Name	Description
`gqlQuery`	`GqlQuery` The query to execute. Must not be null.
`readConsistency`	`Nullable<ReadOptions.Types.ReadConsistency>` If not null, overrides the read consistency of the query.
`callSettings`	`CallSettings` If not null, applies overrides to RPC calls.

Returns
Type	Description
`LazyDatastoreQuery`	A LazyDatastoreQuery representing the lazy query results.

Overrides

DatastoreDb.RunQueryLazily(GqlQuery, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

Remarks

The results are requested lazily: no API calls will be made until the application starts iterating over the results. Iterating over the same LazyDatastoreQuery object multiple times will execute the query again, potentially returning different results.

RunQueryLazily(Query, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

public override LazyDatastoreQuery RunQueryLazily(Query query, ReadOptions.Types.ReadConsistency? readConsistency = null, CallSettings callSettings = null)

Lazily executes the given structured query.

Parameters
Name	Description
`query`	`Query` The query to execute. Must not be null.
`readConsistency`	`Nullable<ReadOptions.Types.ReadConsistency>` If not null, overrides the read consistency of the query.
`callSettings`	`CallSettings` If not null, applies overrides to RPC calls.

Returns
Type	Description
`LazyDatastoreQuery`	A LazyDatastoreQuery representing the lazy query results.

Overrides

DatastoreDb.RunQueryLazily(Query, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

Remarks

RunQueryLazilyAsync(GqlQuery, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

public override AsyncLazyDatastoreQuery RunQueryLazilyAsync(GqlQuery gqlQuery, ReadOptions.Types.ReadConsistency? readConsistency = null, CallSettings callSettings = null)

Lazily executes the given GQL query for asynchronous consumption.

Parameters
Name	Description
`gqlQuery`	`GqlQuery` The query to execute. Must not be null.
`readConsistency`	`Nullable<ReadOptions.Types.ReadConsistency>` If not null, overrides the read consistency of the query.
`callSettings`	`CallSettings` If not null, applies overrides to RPC calls.

Returns
Type	Description
`AsyncLazyDatastoreQuery`	An AsyncLazyDatastoreQuery representing the lazy query results.

Overrides

DatastoreDb.RunQueryLazilyAsync(GqlQuery, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

Remarks

RunQueryLazilyAsync(Query, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

public override AsyncLazyDatastoreQuery RunQueryLazilyAsync(Query query, ReadOptions.Types.ReadConsistency? readConsistency = null, CallSettings callSettings = null)

Lazily executes the given structured query for asynchronous consumption.

Parameters
Name	Description
`query`	`Query` The query to execute. Must not be null.
`readConsistency`	`Nullable<ReadOptions.Types.ReadConsistency>` If not null, overrides the read consistency of the query.
`callSettings`	`CallSettings` If not null, applies overrides to RPC calls.

Returns
Type	Description
`AsyncLazyDatastoreQuery`	An AsyncLazyDatastoreQuery representing the lazy query results.

Overrides

DatastoreDb.RunQueryLazilyAsync(Query, Nullable<ReadOptions.Types.ReadConsistency>, CallSettings)

Remarks

Update(IEnumerable<Entity>, CallSettings)

public override void Update(IEnumerable<Entity> entities, CallSettings callSettings = null)

Updates a collection of entities, non-transactionally.

Parameters
Name	Description
`entities`	`IEnumerable<Entity>` The entities to update. Must not be null or contain null entries.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

DatastoreDb.Update(IEnumerable<Entity>, CallSettings)

Remarks

UpdateAsync(IEnumerable<Entity>, CallSettings)

public override Task UpdateAsync(IEnumerable<Entity> entities, CallSettings callSettings = null)

Updates a collection of entities, non-transactionally and asynchronously.

Parameters
Name	Description
`entities`	`IEnumerable<Entity>` The entities to update. Must not be null or contain null entries.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A task representing the asynchronous operation.

Overrides

DatastoreDb.UpdateAsync(IEnumerable<Entity>, CallSettings)

Remarks

Upsert(IEnumerable<Entity>, CallSettings)

public override IReadOnlyList<Key> Upsert(IEnumerable<Entity> entities, CallSettings callSettings = null)

Upserts a collection of entities, non-transactionally.

Parameters
Name	Description
`entities`	`IEnumerable<Entity>` The entities to upsert. Must not be null or contain null entries.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`IReadOnlyList<Key>`	A collection of allocated keys, in the same order as `entities`. Each inserted entity which had an incomplete key - requiring the server to allocate a new key - will have a non-null value in the collection, equal to the new key for the entity. Each updated entity or inserted entity with a predefined key will have a null value in the collection.

Overrides

DatastoreDb.Upsert(IEnumerable<Entity>, CallSettings)

Remarks

On success, any entities with incomplete keys will be updated in memory with the server-allocated keys.

UpsertAsync(IEnumerable<Entity>, CallSettings)

public override Task<IReadOnlyList<Key>> UpsertAsync(IEnumerable<Entity> entities, CallSettings callSettings = null)

Upserts a collection of entities, non-transactionally and asynchronously.

Parameters
Name	Description
`entities`	`IEnumerable<Entity>` The entities to upsert. Must not be null or contain null entries.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns

Type Description

Task<IReadOnlyList<Key>>

A task representing the asynchronous operation. The result of the task is a collection of allocated keys, in the same order as entities. Each inserted entity which had an incomplete key - requiring the server to allocate a new key - will have a non-null value in the collection, equal to the new key for the entity. Each updated entity or inserted entity with a predefined key will have a null value in the collection.

Overrides

DatastoreDb.UpsertAsync(IEnumerable<Entity>, CallSettings)

Remarks

On success, any entities with incomplete keys will be updated with the server-allocated keys.