KeyValueStoreReplica.Enumerate Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

Enumerate(TransactionBase)	Returns an enumerator that iterates through the KeyValueStoreItem values in the key/value store.
Enumerate(TransactionBase, String)	Returns an enumerator that iterates through the KeyValueStoreItem values in the key/value store, where the value keys match the specified key prefix.
Enumerate(TransactionBase, String, Boolean)	Returns an enumerator that iterates through the KeyValueStoreItem values in the key/value store.

Enumerate(TransactionBase)

Returns an enumerator that iterates through the KeyValueStoreItem values in the key/value store.

public System.Collections.Generic.IEnumerator<System.Fabric.KeyValueStoreItem> Enumerate (System.Fabric.TransactionBase transactionBase);

member this.Enumerate : System.Fabric.TransactionBase -> System.Collections.Generic.IEnumerator<System.Fabric.KeyValueStoreItem>

Public Function Enumerate (transactionBase As TransactionBase) As IEnumerator(Of KeyValueStoreItem)

Parameters

transactionBase

TransactionBase

The transaction instance.

Returns

IEnumerator<KeyValueStoreItem>

A KeyValueStoreItem enumerator.

Remarks

The items are enumerated in lexicographically increasing order by key.

Enumerate(TransactionBase, String)

Returns an enumerator that iterates through the KeyValueStoreItem values in the key/value store, where the value keys match the specified key prefix.

public System.Collections.Generic.IEnumerator<System.Fabric.KeyValueStoreItem> Enumerate (System.Fabric.TransactionBase transactionBase, string keyPrefix);

member this.Enumerate : System.Fabric.TransactionBase * string -> System.Collections.Generic.IEnumerator<System.Fabric.KeyValueStoreItem>

Public Function Enumerate (transactionBase As TransactionBase, keyPrefix As String) As IEnumerator(Of KeyValueStoreItem)

Parameters

transactionBase

TransactionBase

The transaction instance.

keyPrefix

String

The key, or index, prefix to match (as a string). Limited to 800 characters in length.

Returns

IEnumerator<KeyValueStoreItem>

A KeyValueStoreItem enumerator.

Remarks

Equivalent to calling Enumerate(TransactionBase, String, Boolean) with strictPrefix set to true.

The items are enumerated in lexicographically increasing order by key.

Enumerate(TransactionBase, String, Boolean)

Returns an enumerator that iterates through the KeyValueStoreItem values in the key/value store.

public System.Collections.Generic.IEnumerator<System.Fabric.KeyValueStoreItem> Enumerate (System.Fabric.TransactionBase transactionBase, string keyPrefix, bool strictPrefix);

member this.Enumerate : System.Fabric.TransactionBase * string * bool -> System.Collections.Generic.IEnumerator<System.Fabric.KeyValueStoreItem>

Public Function Enumerate (transactionBase As TransactionBase, keyPrefix As String, strictPrefix As Boolean) As IEnumerator(Of KeyValueStoreItem)

Parameters

transactionBase

TransactionBase

The transaction instance.

keyPrefix

String

The key, or index, prefix to match (as a string). Limited to 800 characters in length.

strictPrefix

Boolean

When true, only keys prefixed by the value specified for keyPrefix are returned. Otherwise, enumeration starts at the first key matching or lexicographically greater than keyPrefix and continues until there are no more keys. The default is true.

Returns

IEnumerator<KeyValueStoreItem>

A KeyValueStoreItem enumerator.

Remarks

The items are enumerated in lexicographically increasing order by key.