lib/VNLib.Plugins.Extensions.Data/src/ITransactionalDbContext.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

/*
* Copyright (c) 2022 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Extensions.Data
* File: TransactionalDbContext.cs 
*
* TransactionalDbContext.cs is part of VNLib.Plugins.Extensions.Data which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Extensions.Data is free software: you can redistribute it and/or modify 
* it under the terms of the GNU Affero General Public License as 
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Extensions.Data is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program.  If not, see https://www.gnu.org/licenses/.
*/

using System.Threading;
using System.Threading.Tasks;

using Microsoft.EntityFrameworkCore.Storage;

namespace VNLib.Plugins.Extensions.Data
{
    /// <summary>
    /// Represents a database context that can manage concurrency via transactions
    /// </summary>
    public interface ITransactionalDbContext
    {
        /// <summary>
        /// The transaction that was opened on the current context
        /// </summary>
        IDbContextTransaction? Transaction { get; set; }

        /// <summary>
        /// Invokes the <see cref="IDbContextTransaction.Commit"/> on the current context
        /// </summary>
        Task CommitTransactionAsync(CancellationToken token = default);

        /// <summary>
        /// Opens a single transaction on the current context. If a transaction is already open, 
        /// it is disposed and a new transaction is begun.
        /// </summary>
        Task OpenTransactionAsync(CancellationToken cancellationToken = default);

        /// <summary>
        /// Invokes the <see cref="IDbContextTransaction.Rollback"/> on the current context
        /// </summary>
        Task RollbackTransctionAsync(CancellationToken token = default);
    }
}