diff options
author | vnugent <public@vaughnnugent.com> | 2023-04-13 11:36:37 -0400 |
---|---|---|
committer | vnugent <public@vaughnnugent.com> | 2023-04-13 11:36:37 -0400 |
commit | 8c5e9dae712227bef7cede73fac16bf3e48b19c6 (patch) | |
tree | 388ae13e89c9ab256e2aa65c29a664b14b54fcc6 /lib/VNLib.Plugins.Extensions.Loading.Sql/src/IDbContextBuilder.cs | |
parent | e77477b81e5623502b19db0fb29d4ea88c26b934 (diff) |
Database creation helpers w/ fluent api
Diffstat (limited to 'lib/VNLib.Plugins.Extensions.Loading.Sql/src/IDbContextBuilder.cs')
-rw-r--r-- | lib/VNLib.Plugins.Extensions.Loading.Sql/src/IDbContextBuilder.cs | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/lib/VNLib.Plugins.Extensions.Loading.Sql/src/IDbContextBuilder.cs b/lib/VNLib.Plugins.Extensions.Loading.Sql/src/IDbContextBuilder.cs new file mode 100644 index 0000000..01e9b2f --- /dev/null +++ b/lib/VNLib.Plugins.Extensions.Loading.Sql/src/IDbContextBuilder.cs @@ -0,0 +1,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); + } +} |