IReliableDictionary3<TKey,TValue>.CreateVersionedKeyEnumerableAsync Method

Definition

Namespace:

Microsoft.ServiceFabric.Data.Collections.Beta

Assembly:

Microsoft.ServiceFabric.Data.Interfaces.V2.dll

Package:

Microsoft.ServiceFabric.Data.Interfaces.V2 v6.1.1583

Overloads

CreateVersionedKeyEnumerableAsync(ITransaction)	(Beta) Creates an async enumerator over the IReliableDictionary3<TKey,TValue> to enumerate the versioned keys.
CreateVersionedKeyEnumerableAsync(ITransaction, TKey)	(Beta) Creates an async enumerator over the IReliableDictionary3<TKey,TValue> to enumerate the versioned keys.
CreateVersionedKeyEnumerableAsync(ITransaction, TKey, TKey)	(Beta) Creates an async enumerator over the IReliableDictionary3<TKey,TValue> to enumerate the versioned keys.

CreateVersionedKeyEnumerableAsync(ITransaction)

(Beta) Creates an async enumerator over the IReliableDictionary3<TKey,TValue> to enumerate the versioned keys.

public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKey<TKey>>> CreateVersionedKeyEnumerableAsync (Microsoft.ServiceFabric.Data.ITransaction txn);

abstract member CreateVersionedKeyEnumerableAsync : Microsoft.ServiceFabric.Data.ITransaction -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKey<'Key>>>

Public Function CreateVersionedKeyEnumerableAsync (txn As ITransaction) As Task(Of IAsyncEnumerable(Of VersionedKey(Of TKey)))

Parameters

txn

ITransaction

Transaction to associate this operation with.

Returns

Task<IAsyncEnumerable<VersionedKey<TKey>>>

An enumerable for the IReliableDictionary3<TKey,TValue> versioned keys.

Exceptions

FabricNotReadableException

Exception indicates that the Reliable Dictionary cannot serve reads at the moment. FabricNotReadableException can be thrown in all ReplicaRoles. One example for it being thrown in the Primary is loss of ReadStatus. One example for it being thrown in the ActiveSecondary is that Reliable Collection's state is not yet consistent.

TransactionFaultedException

The transaction has been internally faulted by the system. Retry the operation on a new transaction

InvalidOperationException

Thrown when a method call is invalid for the object's current state. Example, transaction used is already terminated: committed or aborted by the user. If this exception is thrown, it is highly likely that there is a bug in the service code of the use of transactions.

FabricObjectClosedException

Indicates that the Reliable Dictionary is closed or deleted.

Remarks

The enumerable returned from the IReliableDictionary3<TKey,TValue> is safe to use concurrently with reads and writes to the dictionary. It represents a snapshot consistent view of the dictionary.

CreateVersionedKeyEnumerableAsync(ITransaction, TKey)

(Beta) Creates an async enumerator over the IReliableDictionary3<TKey,TValue> to enumerate the versioned keys.

public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKey<TKey>>> CreateVersionedKeyEnumerableAsync (Microsoft.ServiceFabric.Data.ITransaction txn, TKey firstKey);

abstract member CreateVersionedKeyEnumerableAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKey<'Key>>>

Public Function CreateVersionedKeyEnumerableAsync (txn As ITransaction, firstKey As TKey) As Task(Of IAsyncEnumerable(Of VersionedKey(Of TKey)))

Parameters

txn

ITransaction

Transaction to associate this operation with.

firstKey

TKey

The key to start enumerating from in ordered enumeration.

Returns

Task<IAsyncEnumerable<VersionedKey<TKey>>>

An enumerable for the IReliableDictionary3<TKey,TValue> versioned keys.

Exceptions

FabricNotReadableException

Exception indicates that the Reliable Dictionary cannot serve reads at the moment. FabricNotReadableException can be thrown in all ReplicaRoles. One example for it being thrown in the Primary is loss of ReadStatus. One example for it being thrown in the ActiveSecondary is that Reliable Collection's state is not yet consistent.

TransactionFaultedException

The transaction has been internally faulted by the system. Retry the operation on a new transaction

InvalidOperationException

Thrown when a method call is invalid for the object's current state. Example, transaction used is already terminated: committed or aborted by the user. If this exception is thrown, it is highly likely that there is a bug in the service code of the use of transactions.

FabricObjectClosedException

Indicates that the Reliable Dictionary is closed or deleted.

Remarks

The enumerable returned from the IReliableDictionary3<TKey,TValue> is safe to use concurrently with reads and writes to the dictionary. It represents a snapshot consistent view of the dictionary.

CreateVersionedKeyEnumerableAsync(ITransaction, TKey, TKey)

(Beta) Creates an async enumerator over the IReliableDictionary3<TKey,TValue> to enumerate the versioned keys.

public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKey<TKey>>> CreateVersionedKeyEnumerableAsync (Microsoft.ServiceFabric.Data.ITransaction txn, TKey firstKey, TKey lastKey);

abstract member CreateVersionedKeyEnumerableAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key * 'Key -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKey<'Key>>>

Public Function CreateVersionedKeyEnumerableAsync (txn As ITransaction, firstKey As TKey, lastKey As TKey) As Task(Of IAsyncEnumerable(Of VersionedKey(Of TKey)))

Parameters

txn

ITransaction

Transaction to associate this operation with.

firstKey

TKey

The key to start enumerating from in ordered enumeration.

lastKey

TKey

The key to stop enumerating at in ordered enumeration.

Returns

Task<IAsyncEnumerable<VersionedKey<TKey>>>

An enumerable for the IReliableDictionary3<TKey,TValue> versioned keys.

Exceptions

FabricNotReadableException

Exception indicates that the Reliable Dictionary cannot serve reads at the moment. FabricNotReadableException can be thrown in all ReplicaRoles. One example for it being thrown in the Primary is loss of ReadStatus. One example for it being thrown in the ActiveSecondary is that Reliable Collection's state is not yet consistent.

TransactionFaultedException

The transaction has been internally faulted by the system. Retry the operation on a new transaction

InvalidOperationException

Thrown when a method call is invalid for the object's current state. Example, transaction used is already terminated: committed or aborted by the user. If this exception is thrown, it is highly likely that there is a bug in the service code of the use of transactions.

FabricObjectClosedException

Indicates that the Reliable Dictionary is closed or deleted.

Remarks

The enumerable returned from the IReliableDictionary3<TKey,TValue> is safe to use concurrently with reads and writes to the dictionary. It represents a snapshot consistent view of the dictionary.