Interface IEntityStore

Namespace

The.Persistence

Assembly

Instagile.dll

Core persistence abstraction, providing a store of relational data. Access to the store is through sequences of read/write commands.

public interface IEntityStore : IDependencyProvider

Inherited Members

IDependencyProvider.HarvestDependencies()

Properties

Description

Human-readable name

string Description { get; }

Property Value

string

TranslationPolicy

Preferred SQL generation config

TranslationPolicy TranslationPolicy { get; }

Property Value

TranslationPolicy

Methods

ConnectAsync(CallbackEnvironment)

Verifies that the store is available and access is permitted

Task<Response<ConnectResult>> ConnectAsync(CallbackEnvironment environment)

Parameters

environment CallbackEnvironment

Returns

Task<Response<ConnectResult>>

ExecuteReads(CallbackEnvironment, IReadOnlyList<ReadOperation>, QueryConfig)

Response<ReadResult> ExecuteReads(CallbackEnvironment environment, IReadOnlyList<ReadOperation> ops, QueryConfig config)

Parameters

environment CallbackEnvironment

ops IReadOnlyList<ReadOperation>

config QueryConfig

Returns

Response<ReadResult>

ExecuteReadsAsync(CallbackEnvironment, IReadOnlyList<ReadOperation>, QueryConfig, bool)

Task<Response<ReadResult>> ExecuteReadsAsync(CallbackEnvironment environment, IReadOnlyList<ReadOperation> ops, QueryConfig config, bool cancellable)

Parameters

environment CallbackEnvironment

Standard long-running I/O utilities.

ops IReadOnlyList<ReadOperation>

A batch of isolated commands to execute.

config QueryConfig

Settings affecting query execution.

cancellable bool

True if app code explicitly requested cancellability (cancellation may still be triggered by errors otherwise).

Returns

Task<Response<ReadResult>>

ExecuteWritesAsync(CallbackEnvironment, IReadOnlyList<WriteOperation>, bool)

Task<Response<WriteResult>> ExecuteWritesAsync(CallbackEnvironment environment, IReadOnlyList<WriteOperation> ops, bool cancellable)

Parameters

environment CallbackEnvironment

Standard long-running I/O utilities.

ops IReadOnlyList<WriteOperation>

A batch of transactional commands to execute.

cancellable bool

True if app code explicitly requested cancellability (cancellation may still be triggered by errors otherwise).

Returns

Task<Response<WriteResult>>