Class PersistenceService

Namespace

The.Persistence

Assembly

Instagile.dll

Functions to load and store entities.

public sealed class PersistenceService

Inheritance

object

PersistenceService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ReadExtensions.GetAll(PersistenceService, IEntityInfo, IEntityContext)

ReadExtensions.GetAllAsync(PersistenceService, IEntityInfo, IEntityContext, CancellationToken?)

ReadExtensions.GetAllAsync<T>(PersistenceService, IEntityInfo, IEntityContext, CancellationToken?)

ReadExtensions.GetAll<T>(PersistenceService, IEntityInfo, IEntityContext)

ReadExtensions.GetByIDAsync<T>(PersistenceService, IEntityInfo, IEntityContext, Guid, RelationshipInfo[], IEntityInfo[], IEntityInfo[], CancellationToken?)

ReadExtensions.GetByID<T>(PersistenceService, IEntityInfo, IEntityContext, Guid, RelationshipInfo[], IEntityInfo[], IEntityInfo[])

Constructors

PersistenceService(IEntityStore, TransientCache?, IPersistentCache?, EntityMetadataDictionary, SecurityService, LicenseService, LogService, Options, Func<IPrincipal, IEntityContext>)

public PersistenceService(IEntityStore entityStore, TransientCache? cacheMemoryStore, IPersistentCache? cacheFileStore, EntityMetadataDictionary metadata, SecurityService security, LicenseService licensing, LogService loggerFactory, Options options, Func<IPrincipal, IEntityContext> createContext)

Parameters

entityStore IEntityStore

cacheMemoryStore TransientCache

cacheFileStore IPersistentCache

metadata EntityMetadataDictionary

security SecurityService

licensing LicenseService

loggerFactory LogService

options Options

createContext Func<IPrincipal, IEntityContext>

Properties

Cache

public EntityCache Cache { get; }

Property Value

EntityCache

Factory

public EntityFactory Factory { get; }

Property Value

EntityFactory

StoreDescription

public string StoreDescription { get; }

Property Value

string

StoreTranslationPolicy

public TranslationPolicy StoreTranslationPolicy { get; }

Property Value

TranslationPolicy

Methods

ConnectAsync(IEntityContext, CancellationToken?)

public Task<Response<ConnectResult>> ConnectAsync(IEntityContext context, CancellationToken? cancellationToken = null)

Parameters

context IEntityContext

cancellationToken CancellationToken?

Returns

Task<Response<ConnectResult>>

CreateQuery(IEntityInfo, IEntityContext)

public IEntityQuery<IEntity> CreateQuery(IEntityInfo metadata, IEntityContext context)

Parameters

metadata IEntityInfo

context IEntityContext

Returns

IEntityQuery<IEntity>

CreateQuery<T>(IEntityInfo, IEntityContext)

public IEntityQuery<T> CreateQuery<T>(IEntityInfo metadata, IEntityContext context) where T : IEntity

Parameters

metadata IEntityInfo

context IEntityContext

Returns

IEntityQuery<T>

Type Parameters

T

CreateQueryable(IEntityInfo, IEntityContext)

public IQueryable<IEntity> CreateQueryable(IEntityInfo metadata, IEntityContext context)

Parameters

metadata IEntityInfo

context IEntityContext

Returns

IQueryable<IEntity>

CreateQueryable<T>(IEntityInfo, IEntityContext)

public IQueryable<T> CreateQueryable<T>(IEntityInfo metadata, IEntityContext context) where T : IEntity

Parameters

metadata IEntityInfo

context IEntityContext

Returns

IQueryable<T>

Type Parameters

T

Read(IEntityContext, params ReadOperation[])

public ReadResult Read(IEntityContext intoContext, params ReadOperation[] ops)

Parameters

intoContext IEntityContext

ops ReadOperation[]

Returns

ReadResult

ReadAsync(IEntityContext, CancellationToken?, params IOpGenerator[])

public Task<ReadResult> ReadAsync(IEntityContext intoContext, CancellationToken? cancellationToken, params IOpGenerator[] query)

Parameters

intoContext IEntityContext

cancellationToken CancellationToken?

query IOpGenerator[]

Returns

Task<ReadResult>

ReadAsync(IEntityContext, CancellationToken?, params ReadOperation[])

public Task<ReadResult> ReadAsync(IEntityContext intoContext, CancellationToken? cancellationToken, params ReadOperation[] query)

Parameters

intoContext IEntityContext

cancellationToken CancellationToken?

query ReadOperation[]

Returns

Task<ReadResult>

ReadAsync(IEntityContext, params IOpGenerator[])

public Task<ReadResult> ReadAsync(IEntityContext intoContext, params IOpGenerator[] query)

Parameters

intoContext IEntityContext

query IOpGenerator[]

Returns

Task<ReadResult>

ReadAsync(IEntityContext, params ReadOperation[])

public Task<ReadResult> ReadAsync(IEntityContext intoContext, params ReadOperation[] query)

Parameters

intoContext IEntityContext

query ReadOperation[]

Returns

Task<ReadResult>

ResetTimeZone()

Reset to the default timezone specified in Options.

public void ResetTimeZone()

SaveForestAsync(IEnumerable<EntityKernel>, IEntityContext, CancellationToken?)

Save an entity forest with one or more roots

public Task<SaveResult> SaveForestAsync(IEnumerable<EntityKernel> nodeGenerator, IEntityContext fromContext, CancellationToken? cancellationToken)

Parameters

nodeGenerator IEnumerable<EntityKernel>

Generator which provides tree roots; if the save process adds any disconnected nodes to the graph, then nodeGenerator should yield additional roots if the goal is to save those disconnected trees.

fromContext IEntityContext

Context containing entities to save

cancellationToken CancellationToken?

Returns

Task<SaveResult>

SetTimeZone(string)

public void SetTimeZone(string tzid)

Parameters

tzid string

SetTimeZone(TimeZoneInfo)

Change the current timezone used for Instant values and RelativeDate queries.

public void SetTimeZone(TimeZoneInfo zone)

Parameters

zone TimeZoneInfo

WriteAsync(IEntityContext, CancellationToken?, params WriteOperation[])

public Task WriteAsync(IEntityContext context, CancellationToken? cancellationToken, params WriteOperation[] ops)

Parameters

context IEntityContext

cancellationToken CancellationToken?

ops WriteOperation[]

Returns

Task

WriteAsync(IEntityContext, params WriteOperation[])

public Task WriteAsync(IEntityContext context, params WriteOperation[] ops)

Parameters

context IEntityContext

ops WriteOperation[]

Returns

Task

WriteAsync(IPrincipal, CancellationToken?, params WriteOperation[])

public Task WriteAsync(IPrincipal principal, CancellationToken? cancellationToken, params WriteOperation[] ops)

Parameters

principal IPrincipal

cancellationToken CancellationToken?

ops WriteOperation[]

Returns

Task

WriteAsync(IPrincipal, params WriteOperation[])

public Task WriteAsync(IPrincipal principal, params WriteOperation[] ops)

Parameters

principal IPrincipal

ops WriteOperation[]

Returns

Task