IReliableDictionary3<TKey,TValue>.CreateVersionedEnumerableAsync 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

CreateVersionedEnumerableAsync(ITransaction)	(Beta) Creates an asynchronous enumerator over the IReliableDictionary<TKey,TValue>.
CreateVersionedEnumerableAsync(ITransaction, Func<TKey,Boolean>)	(Beta) Creates an asynchronous enumerator over the IReliableDictionary<TKey,TValue>.
CreateVersionedEnumerableAsync(ITransaction, TKey)	(Beta) Creates an asynchronous enumerator over the IReliableDictionary<TKey,TValue>.
CreateVersionedEnumerableAsync(ITransaction, Func<TKey,Boolean>, TKey)	(Beta) Creates an asynchronous enumerator over the IReliableDictionary<TKey,TValue>.
CreateVersionedEnumerableAsync(ITransaction, TKey, TKey)	(Beta) Creates an asynchronous enumerator over the IReliableDictionary<TKey,TValue>.
CreateVersionedEnumerableAsync(ITransaction, Func<TKey,Boolean>, TKey, TKey)	(Beta) Creates an asynchronous enumerator over the IReliableDictionary<TKey,TValue>.

CreateVersionedEnumerableAsync(ITransaction)

(Beta) Creates an asynchronous enumerator over the IReliableDictionary<TKey,TValue>.

public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<TKey,TValue>>> CreateVersionedEnumerableAsync (Microsoft.ServiceFabric.Data.ITransaction txn);

abstract member CreateVersionedEnumerableAsync : Microsoft.ServiceFabric.Data.ITransaction -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<'Key, 'Value>>>

Public Function CreateVersionedEnumerableAsync (txn As ITransaction) As Task(Of IAsyncEnumerable(Of VersionedKeyValuePair(Of TKey, TValue)))

Parameters

txn

ITransaction

The transaction to associate this operation with.

Returns

Task<IAsyncEnumerable<VersionedKeyValuePair<TKey,TValue>>>

A task that represents the asynchronous create enumerable operation. The task result is an enumerator for the Reliable Dictionary.

Exceptions

FabricNotReadableException

Indicates that the IReliableDictionary cannot serve reads at the moment. This exception can be thrown in all ReplicaRoles. One reason it may be thrown in the Primary role is loss of ReadStatus. One reason it may be thrown in the ActiveSecondary role 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 returned enumerator is safe to use concurrently with reads and writes to the Reliable Dictionary. It represents a snapshot consistent view. Please note that GetAsyncEnumerator() needs to be called on the returned IAsyncEnumerable in order to enumerate. Example usage can be seen here.

CreateVersionedEnumerableAsync(ITransaction, Func<TKey,Boolean>)

(Beta) Creates an asynchronous enumerator over the IReliableDictionary<TKey,TValue>.

public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<TKey,TValue>>> CreateVersionedEnumerableAsync (Microsoft.ServiceFabric.Data.ITransaction txn, Func<TKey,bool> filter);

abstract member CreateVersionedEnumerableAsync : Microsoft.ServiceFabric.Data.ITransaction * Func<'Key, bool (requires 'Key :> IComparable<'Key> and 'Key :> IEquatable<'Key>)> -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<'Key, 'Value>>>

Public Function CreateVersionedEnumerableAsync (txn As ITransaction, filter As Func(Of TKey, Boolean)) As Task(Of IAsyncEnumerable(Of VersionedKeyValuePair(Of TKey, TValue)))

Parameters

txn

ITransaction

The transaction to associate this operation with.

filter

Func<TKey,Boolean>

Predicate that filters the versioned key-value pairs to include in the enumeration based on the key.

Returns

Task<IAsyncEnumerable<VersionedKeyValuePair<TKey,TValue>>>

A task that represents the asynchronous create enumerable operation. The task result is an enumerator for the Reliable Dictionary.

Exceptions

FabricNotReadableException

Indicates that the IReliableDictionary cannot serve reads at the moment. This exception can be thrown in all ReplicaRoles. One reason it may be thrown in the Primary role is loss of ReadStatus. One reason it may be thrown in the ActiveSecondary role 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 returned enumerator is safe to use concurrently with reads and writes to the Reliable Dictionary. It represents a snapshot consistent view. Please note that GetAsyncEnumerator() needs to be called on the returned IAsyncEnumerable in order to enumerate. Example usage can be seen here.

CreateVersionedEnumerableAsync(ITransaction, TKey)

(Beta) Creates an asynchronous enumerator over the IReliableDictionary<TKey,TValue>.

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

abstract member CreateVersionedEnumerableAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<'Key, 'Value>>>

Public Function CreateVersionedEnumerableAsync (txn As ITransaction, firstKey As TKey) As Task(Of IAsyncEnumerable(Of VersionedKeyValuePair(Of TKey, TValue)))

Parameters

txn

ITransaction

The transaction to associate this operation with.

firstKey

TKey

The key to start enumerating from in ordered enumeration.

Returns

Task<IAsyncEnumerable<VersionedKeyValuePair<TKey,TValue>>>

A task that represents the asynchronous create enumerable operation. The task result is an enumerator for the Reliable Dictionary.

Exceptions

FabricNotReadableException

Indicates that the IReliableDictionary cannot serve reads at the moment. This exception can be thrown in all ReplicaRoles. One reason it may be thrown in the Primary role is loss of ReadStatus. One reason it may be thrown in the ActiveSecondary role 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 returned enumerator is safe to use concurrently with reads and writes to the Reliable Dictionary. It represents a snapshot consistent view. Please note that GetAsyncEnumerator() needs to be called on the returned IAsyncEnumerable in order to enumerate. Example usage can be seen here.

CreateVersionedEnumerableAsync(ITransaction, Func<TKey,Boolean>, TKey)

(Beta) Creates an asynchronous enumerator over the IReliableDictionary<TKey,TValue>.

public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<TKey,TValue>>> CreateVersionedEnumerableAsync (Microsoft.ServiceFabric.Data.ITransaction txn, Func<TKey,bool> filter, TKey firstKey);

abstract member CreateVersionedEnumerableAsync : Microsoft.ServiceFabric.Data.ITransaction * Func<'Key, bool (requires 'Key :> IComparable<'Key> and 'Key :> IEquatable<'Key>)> * 'Key -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<'Key, 'Value>>>

Public Function CreateVersionedEnumerableAsync (txn As ITransaction, filter As Func(Of TKey, Boolean), firstKey As TKey) As Task(Of IAsyncEnumerable(Of VersionedKeyValuePair(Of TKey, TValue)))

Parameters

txn

ITransaction

The transaction to associate this operation with.

filter

Func<TKey,Boolean>

Predicate that filters the versioned key-value pairs to include in the enumeration based on the key.

firstKey

TKey

The key to start enumerating from in ordered enumeration.

Returns

Task<IAsyncEnumerable<VersionedKeyValuePair<TKey,TValue>>>

A task that represents the asynchronous create enumerable operation. The task result is an enumerator for the Reliable Dictionary.

Exceptions

FabricNotReadableException

Indicates that the IReliableDictionary cannot serve reads at the moment. This exception can be thrown in all ReplicaRoles. One reason it may be thrown in the Primary role is loss of ReadStatus. One reason it may be thrown in the ActiveSecondary role 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 returned enumerator is safe to use concurrently with reads and writes to the Reliable Dictionary. It represents a snapshot consistent view. Please note that GetAsyncEnumerator() needs to be called on the returned IAsyncEnumerable in order to enumerate. Example usage can be seen here.

CreateVersionedEnumerableAsync(ITransaction, TKey, TKey)

(Beta) Creates an asynchronous enumerator over the IReliableDictionary<TKey,TValue>.

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

abstract member CreateVersionedEnumerableAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key * 'Key -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<'Key, 'Value>>>

Public Function CreateVersionedEnumerableAsync (txn As ITransaction, firstKey As TKey, lastKey As TKey) As Task(Of IAsyncEnumerable(Of VersionedKeyValuePair(Of TKey, TValue)))

Parameters

txn

ITransaction

The 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<VersionedKeyValuePair<TKey,TValue>>>

A task that represents the asynchronous create enumerable operation. The task result is an enumerator for the Reliable Dictionary.

Exceptions

FabricNotReadableException

Indicates that the IReliableDictionary cannot serve reads at the moment. This exception can be thrown in all ReplicaRoles. One reason it may be thrown in the Primary role is loss of ReadStatus. One reason it may be thrown in the ActiveSecondary role 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 returned enumerator is safe to use concurrently with reads and writes to the Reliable Dictionary. It represents a snapshot consistent view. Please note that GetAsyncEnumerator() needs to be called on the returned IAsyncEnumerable in order to enumerate. Example usage can be seen here.

CreateVersionedEnumerableAsync(ITransaction, Func<TKey,Boolean>, TKey, TKey)

(Beta) Creates an asynchronous enumerator over the IReliableDictionary<TKey,TValue>.

public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<TKey,TValue>>> CreateVersionedEnumerableAsync (Microsoft.ServiceFabric.Data.ITransaction txn, Func<TKey,bool> filter, TKey firstKey, TKey lastKey);

abstract member CreateVersionedEnumerableAsync : Microsoft.ServiceFabric.Data.ITransaction * Func<'Key, bool (requires 'Key :> IComparable<'Key> and 'Key :> IEquatable<'Key>)> * 'Key * 'Key -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.IAsyncEnumerable<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<'Key, 'Value>>>

Public Function CreateVersionedEnumerableAsync (txn As ITransaction, filter As Func(Of TKey, Boolean), firstKey As TKey, lastKey As TKey) As Task(Of IAsyncEnumerable(Of VersionedKeyValuePair(Of TKey, TValue)))

Parameters

txn

ITransaction

The transaction to associate this operation with.

filter

Func<TKey,Boolean>

Predicate that filters the versioned key-value pairs to include in the enumeration based on the key.

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<VersionedKeyValuePair<TKey,TValue>>>

A task that represents the asynchronous create enumerable operation. The task result is an enumerator for the Reliable Dictionary.

Exceptions

FabricNotReadableException

Indicates that the IReliableDictionary cannot serve reads at the moment. This exception can be thrown in all ReplicaRoles. One reason it may be thrown in the Primary role is loss of ReadStatus. One reason it may be thrown in the ActiveSecondary role 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 returned enumerator is safe to use concurrently with reads and writes to the Reliable Dictionary. It represents a snapshot consistent view. Please note that GetAsyncEnumerator() needs to be called on the returned IAsyncEnumerable in order to enumerate. Example usage can be seen here.