Class UnitOfWork

Inheritance
object
UnitOfWork
Implements
System.IDisposable
Inherited Members
object.GetType()
object.MemberwiseClone()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Volo.Abp.Uow
Assembly: Volo.Abp.Uow.dll
Syntax
public class UnitOfWork : IUnitOfWork, IDatabaseApiContainer, IServiceProviderAccessor, ITransactionApiContainer, IDisposable, ITransientDependency

Constructors

UnitOfWork(IServiceProvider, IUnitOfWorkEventPublisher, IOptions<AbpUnitOfWorkDefaultOptions>)

Declaration
public UnitOfWork(IServiceProvider serviceProvider, IUnitOfWorkEventPublisher unitOfWorkEventPublisher, IOptions<AbpUnitOfWorkDefaultOptions> options)
Parameters
Type Name Description
System.IServiceProvider serviceProvider
IUnitOfWorkEventPublisher unitOfWorkEventPublisher
Microsoft.Extensions.Options.IOptions<TOptions><AbpUnitOfWorkDefaultOptions> options

Fields

UnitOfWorkReservationName

Declaration
public const string UnitOfWorkReservationName = "_AbpActionUnitOfWork"
Field Value
Type Description
string

Properties

CompletedHandlers

Declaration
protected List<Func<Task>> CompletedHandlers { get; }
Property Value
Type Description
System.Collections.Generic.List<T><System.Func<TResult><System.Threading.Tasks.Task>>

DistributedEvents

Declaration
protected List<UnitOfWorkEventRecord> DistributedEvents { get; }
Property Value
Type Description
System.Collections.Generic.List<T><UnitOfWorkEventRecord>

EnableObsoleteDbContextCreationWarning

Declaration
public static bool EnableObsoleteDbContextCreationWarning { get; }
Property Value
Type Description
bool

Id

Declaration
public Guid Id { get; }
Property Value
Type Description
System.Guid

IsCompleted

Declaration
public bool IsCompleted { get; }
Property Value
Type Description
bool

IsDisposed

Declaration
public bool IsDisposed { get; }
Property Value
Type Description
bool

IsReserved

Declaration
public bool IsReserved { get; set; }
Property Value
Type Description
bool

Items

Declaration
public Dictionary<string, object> Items { get; }
Property Value
Type Description
System.Collections.Generic.Dictionary<TKey, TValue><string, object>

LocalEvents

Declaration
protected List<UnitOfWorkEventRecord> LocalEvents { get; }
Property Value
Type Description
System.Collections.Generic.List<T><UnitOfWorkEventRecord>

Options

Declaration
public IAbpUnitOfWorkOptions? Options { get; }
Property Value
Type Description
IAbpUnitOfWorkOptions

Outer

Declaration
public IUnitOfWork? Outer { get; }
Property Value
Type Description
IUnitOfWork

ReservationName

Declaration
public string? ReservationName { get; set; }
Property Value
Type Description
string

ServiceProvider

Declaration
public IServiceProvider ServiceProvider { get; }
Property Value
Type Description
System.IServiceProvider

UnitOfWorkEventPublisher

Declaration
protected IUnitOfWorkEventPublisher UnitOfWorkEventPublisher { get; }
Property Value
Type Description
IUnitOfWorkEventPublisher

Methods

AddDatabaseApi(string, IDatabaseApi)

Declaration
public virtual void AddDatabaseApi(string key, IDatabaseApi api)
Parameters
Type Name Description
string key
IDatabaseApi api

AddOrReplaceDistributedEvent(UnitOfWorkEventRecord, Predicate<UnitOfWorkEventRecord>?)

Declaration
public virtual void AddOrReplaceDistributedEvent(UnitOfWorkEventRecord eventRecord, Predicate<UnitOfWorkEventRecord>? replacementSelector = null)
Parameters
Type Name Description
UnitOfWorkEventRecord eventRecord
System.Predicate<T><UnitOfWorkEventRecord> replacementSelector

AddOrReplaceEvent(List<UnitOfWorkEventRecord>, UnitOfWorkEventRecord, Predicate<UnitOfWorkEventRecord>?)

Declaration
public virtual void AddOrReplaceEvent(List<UnitOfWorkEventRecord> eventRecords, UnitOfWorkEventRecord eventRecord, Predicate<UnitOfWorkEventRecord>? replacementSelector = null)
Parameters
Type Name Description
System.Collections.Generic.List<T><UnitOfWorkEventRecord> eventRecords
UnitOfWorkEventRecord eventRecord
System.Predicate<T><UnitOfWorkEventRecord> replacementSelector

AddOrReplaceLocalEvent(UnitOfWorkEventRecord, Predicate<UnitOfWorkEventRecord>?)

Declaration
public virtual void AddOrReplaceLocalEvent(UnitOfWorkEventRecord eventRecord, Predicate<UnitOfWorkEventRecord>? replacementSelector = null)
Parameters
Type Name Description
UnitOfWorkEventRecord eventRecord
System.Predicate<T><UnitOfWorkEventRecord> replacementSelector

AddTransactionApi(string, ITransactionApi)

Declaration
public virtual void AddTransactionApi(string key, ITransactionApi api)
Parameters
Type Name Description
string key
ITransactionApi api

CommitTransactionsAsync(CancellationToken)

Declaration
protected virtual Task CommitTransactionsAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task

CompleteAsync(CancellationToken)

Declaration
public virtual Task CompleteAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task

Dispose()

Declaration
public virtual void Dispose()

FindDatabaseApi(string)

Declaration
public virtual IDatabaseApi? FindDatabaseApi(string key)
Parameters
Type Name Description
string key
Returns
Type Description
IDatabaseApi

FindTransactionApi(string)

Declaration
public virtual ITransactionApi? FindTransactionApi(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ITransactionApi

GetAllActiveDatabaseApis()

Declaration
public virtual IReadOnlyList<IDatabaseApi> GetAllActiveDatabaseApis()
Returns
Type Description
System.Collections.Generic.IReadOnlyList<T><IDatabaseApi>

GetAllActiveTransactionApis()

Declaration
public virtual IReadOnlyList<ITransactionApi> GetAllActiveTransactionApis()
Returns
Type Description
System.Collections.Generic.IReadOnlyList<T><ITransactionApi>

GetOrAddDatabaseApi(string, Func<IDatabaseApi>)

Declaration
public virtual IDatabaseApi GetOrAddDatabaseApi(string key, Func<IDatabaseApi> factory)
Parameters
Type Name Description
string key
System.Func<TResult><IDatabaseApi> factory
Returns
Type Description
IDatabaseApi

GetOrAddTransactionApi(string, Func<ITransactionApi>)

Declaration
public virtual ITransactionApi GetOrAddTransactionApi(string key, Func<ITransactionApi> factory)
Parameters
Type Name Description
string key
System.Func<TResult><ITransactionApi> factory
Returns
Type Description
ITransactionApi

Initialize(AbpUnitOfWorkOptions)

Declaration
public virtual void Initialize(AbpUnitOfWorkOptions options)
Parameters
Type Name Description
AbpUnitOfWorkOptions options

OnCompleted(Func<Task>)

Declaration
public virtual void OnCompleted(Func<Task> handler)
Parameters
Type Name Description
System.Func<TResult><System.Threading.Tasks.Task> handler

OnCompletedAsync()

Declaration
protected virtual Task OnCompletedAsync()
Returns
Type Description
System.Threading.Tasks.Task

OnDisposed()

Declaration
protected virtual void OnDisposed()

OnFailed()

Declaration
protected virtual void OnFailed()

Reserve(string)

Declaration
public virtual void Reserve(string reservationName)
Parameters
Type Name Description
string reservationName

RollbackAllAsync(CancellationToken)

Declaration
protected virtual Task RollbackAllAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task

RollbackAsync(CancellationToken)

Declaration
public virtual Task RollbackAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task

SaveChangesAsync(CancellationToken)

Declaration
public virtual Task SaveChangesAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task

SetOuter(IUnitOfWork?)

Declaration
public virtual void SetOuter(IUnitOfWork? outer)
Parameters
Type Name Description
IUnitOfWork outer

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

Events

Disposed

Declaration
public event EventHandler<UnitOfWorkEventArgs> Disposed
Event Type
Type Description
System.EventHandler<TEventArgs><UnitOfWorkEventArgs>

Failed

Declaration
public event EventHandler<UnitOfWorkFailedEventArgs> Failed
Event Type
Type Description
System.EventHandler<TEventArgs><UnitOfWorkFailedEventArgs>

Implements

System.IDisposable

Extension Methods