Interface IKEFCoreStreamsRetriever<TKey>

Namespace

MASES.EntityFrameworkCore.KNet.Storage.Internal

Assembly

MASES.EntityFrameworkCore.KNet.dll

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public interface IKEFCoreStreamsRetriever<TKey> : IDisposable where TKey : notnull

Type Parameters

TKey

Inherited Members

IDisposable.Dispose()

Methods

Exist(TKey)

Check if a key exist

bool Exist(TKey key)

Parameters

key TKey

The key to check for existence

Returns

bool

true if the key exist, false otherwise

GetValueBuffers()

Retrieve an IEnumerable<T> from the IKEFCoreStreamsRetriever<TKey> instance

IEnumerable<ValueBuffer> GetValueBuffers()

Returns

IEnumerable<ValueBuffer>

An IEnumerable<T>

GetValueBuffersByPrefix(IPrincipalKeyValueFactory<TKey>, object?[]?)

Retrieve the ValueBuffer using prefix scan

IEnumerable<ValueBuffer> GetValueBuffersByPrefix(IPrincipalKeyValueFactory<TKey> keyValueFactory, object?[]? prefixValues)

Parameters

keyValueFactory IPrincipalKeyValueFactory<TKey>

The key converter

prefixValues object[]

The prefix

Returns

IEnumerable<ValueBuffer>

An IEnumerable<T> of ValueBuffer

GetValueBuffersRange(IPrincipalKeyValueFactory<TKey>, object?[]?, object?[]?)

Retrieve an IEnumerable<T> in the range rangeStart/rangeEnd from the IKEFCoreStreamsRetriever<TKey> instance

IEnumerable<ValueBuffer> GetValueBuffersRange(IPrincipalKeyValueFactory<TKey> keyValueFactory, object?[]? rangeStart, object?[]? rangeEnd)

Parameters

keyValueFactory IPrincipalKeyValueFactory<TKey>

The key converter

rangeStart object[]

The start key

rangeEnd object[]

The end key

Returns

IEnumerable<ValueBuffer>

An IEnumerable<T>

GetValueBuffersReverse()

Retrieve a reverse order IEnumerable<T> from the IKEFCoreStreamsRetriever<TKey> instance

IEnumerable<ValueBuffer> GetValueBuffersReverse()

Returns

IEnumerable<ValueBuffer>

An IEnumerable<T>

GetValueBuffersReverseRange(IPrincipalKeyValueFactory<TKey>, object?[]?, object?[]?)

Retrieve an IEnumerable<T> in the reverse range rangeStart/rangeEnd from the IKEFCoreStreamsRetriever<TKey> instance

IEnumerable<ValueBuffer> GetValueBuffersReverseRange(IPrincipalKeyValueFactory<TKey> keyValueFactory, object?[]? rangeStart, object?[]? rangeEnd)

Parameters

keyValueFactory IPrincipalKeyValueFactory<TKey>

The key converter

rangeStart object[]

The start key

rangeEnd object[]

The end key

Returns

IEnumerable<ValueBuffer>

An IEnumerable<T>

TryGetProperties(TKey, out IDictionary<string, object?>, out IDictionary<string, object?>)

Returns the values associated to the key

bool TryGetProperties(TKey key, out IDictionary<string, object?> properties, out IDictionary<string, object?> complexProperties)

Parameters

key TKey

The key to retrieve

properties IDictionary<string, object>

A IDictionary<TKey, TValue> containing the property name and associated value, or null otherwise

complexProperties IDictionary<string, object>

A IDictionary<TKey, TValue> containing the complex property name and associated value, or null otherwise

Returns

bool

true if the key exist, false otherwise

TryGetValue(TKey, out ValueBuffer)

Returns the values associated to the key

bool TryGetValue(TKey key, out ValueBuffer valueBuffer)

Parameters

key TKey

The key to retrieve

valueBuffer ValueBuffer

A ValueBuffer containing the information, or null otherwise

Returns

bool

true if the key exist, false otherwise