Interface IPersistentDictionary<TValue>

Represents an which is persisted to a backing store.

Namespace: Couchbase.DataStructures
Assembly: Couchbase.NetClient.dll
Syntax
public interface IPersistentDictionary<TValue> : IDictionary<string, TValue>, IAsyncEnumerable<KeyValuePair<string, TValue>>
Type Parameters
Name Description
TValue

Type of value in the set.
Remarks

If using a SystemTextJsonSerializer backed by a , be sure to include IDictionary<string, TValue> in a on the context.

Properties

| Improve this Doc View Source

CountAsync

Declaration
Task<int> CountAsync { get; }
Property Value
Type Description
Task<Int32>
| Improve this Doc View Source

KeysAsync

Declaration
Task<ICollection<string>> KeysAsync { get; }
Property Value
Type Description
Task<ICollection<String>>
| Improve this Doc View Source

ValuesAsync

Declaration
Task<ICollection<TValue>> ValuesAsync { get; }
Property Value
Type Description
Task<ICollection<TValue>>

Methods

| Improve this Doc View Source

AddAsync(KeyValuePair<String, TValue>)

Declaration
Task AddAsync(KeyValuePair<string, TValue> item)
Parameters
Type Name Description
KeyValuePair<String, TValue> item
Returns
Type Description
Task
| Improve this Doc View Source

AddAsync(String, TValue)

Declaration
Task AddAsync(string key, TValue value)
Parameters
Type Name Description
String key
TValue value
Returns
Type Description
Task
| Improve this Doc View Source

ClearAsync()

Declaration
Task ClearAsync()
Returns
Type Description
Task
| Improve this Doc View Source

ContainsAsync(KeyValuePair<String, TValue>)

Declaration
Task<bool> ContainsAsync(KeyValuePair<string, TValue> item)
Parameters
Type Name Description
KeyValuePair<String, TValue> item
Returns
Type Description
Task<Boolean>
| Improve this Doc View Source

ContainsKeyAsync(String)

Declaration
Task<bool> ContainsKeyAsync(string key)
Parameters
Type Name Description
String key
Returns
Type Description
Task<Boolean>
| Improve this Doc View Source

GetAsync(String)

Declaration
Task<TValue> GetAsync(string key)
Parameters
Type Name Description
String key
Returns
Type Description
Task<TValue>
| Improve this Doc View Source

RemoveAsync(KeyValuePair<String, TValue>)

Declaration
Task<bool> RemoveAsync(KeyValuePair<string, TValue> item)
Parameters
Type Name Description
KeyValuePair<String, TValue> item
Returns
Type Description
Task<Boolean>
| Improve this Doc View Source

RemoveAsync(String)

Declaration
Task<bool> RemoveAsync(string key)
Parameters
Type Name Description
String key
Returns
Type Description
Task<Boolean>
| Improve this Doc View Source

SetAsync(String, TValue)

Declaration
Task SetAsync(string key, TValue value)
Parameters
Type Name Description
String key
TValue value
Returns
Type Description
Task