lib/VNLib.Plugins.Extensions.Loading.Sql/src/IDbContextBuilder.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

/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Extensions.Loading.Sql
* File: IDbContextBuilder.cs 
*
* IDbContextBuilder.cs is part of VNLib.Plugins.Extensions.Loading.Sql which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Extensions.Loading.Sql 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.Loading.Sql 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.ComponentModel.DataAnnotations.Schema;

namespace VNLib.Plugins.Extensions.Loading.Sql
{
    /// <summary>
    /// Passed to a <see cref="IDbTableDefinition"/> during a database creation event.
    /// </summary>
    public interface IDbContextBuilder
    {
        /// <summary>
        /// Defines the existance of a table within the database by its type name
        /// <para>
        /// If your entity defines a <see cref="TableAttribute"/>, this name value is used
        /// </para>
        /// </summary>
        /// <typeparam name="T">The entity type to build</typeparam>
        /// <returns>A new <see cref="IDbTableBuilder{T}"/> used to build the table for this entity</returns>
        IDbTableBuilder<T> DefineTable<T>();

        /// <summary>
        /// Defines the existance of a table within the database by the supplied table name
        /// </summary>
        /// <typeparam name="T">The entity type to build</typeparam>
        /// <returns>A new <see cref="IDbTableBuilder{T}"/> used to build the table for this entity</returns>
        IDbTableBuilder<T> DefineTable<T>(string tableName);
    }
}