Data.Modeler 4.0.161

dotnet add package Data.Modeler --version 4.0.161
NuGet\Install-Package Data.Modeler -Version 4.0.161
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Data.Modeler" Version="4.0.161" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Data.Modeler --version 4.0.161
#r "nuget: Data.Modeler, 4.0.161"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Data.Modeler as a Cake Addin
#addin nuget:?package=Data.Modeler&version=4.0.161

// Install Data.Modeler as a Cake Tool
#tool nuget:?package=Data.Modeler&version=4.0.161

Data.Modeler

Build status

Data.Modeler is a library used to interact with model database schemas in C#. Works with .Net Core.

Basic Usage

In order to use Data.Modeler, you need to first wire up the system with your ServiceCollection. In order to do this, all you need to do is make one method call:

serviceCollection.AddCanisterModules();
				

This line is required prior to using the DataModeler class for the first time. Once Canister is set up, you can call the DataModeler class provided:

var SchemaProvider = DataModeler.GetSchemaGenerator(SqlClientFactory.Instance);

Note that the above gets the schema provider for SQL Server but for other databases you must provide the DbProviderFactory associated with it. You can also start creating a schema:

var Source = DataModeler.CreateSource("MySource");

The "MySource" string is the database name that you wish to use.

Creating a Schema

Once you have your ISource object, you can start adding on to it:

var Table = Source.AddTable("TableName", "dbo");
var Column = Table.AddColumn<int>("ColumnName",DbType.Int32);
var CheckConstraint = Table.AddCheckConstraint("CheckConstraintName", "Check Constraint Definition");
var View = Source.AddView("ViewName","View Creation Code", "dbo");
var Function = Source.AddFunction("FunctionName","Function Creation Code", "dbo");
var StoredProcedure = Source.AddStoredProcedure("StoredProcedureName","Stored Procedure Creation Code", "dbo");

From there the schema provider can be used to either generate the commands needed to create the database or what commands are needed to alter an existing database to the desired schema:

var MyCommands = SchemaProvider.GenerateSchema(DesiredSchema, SourceSchema);

If SourceSchema is null, then it will treat it as the database doesn't exist. If the SourceSchema is not null, it will act as though the database exists and the DesiredSchema is what you want the final schema to look like. Note that deleting columns, tables, etc. is not done by the system. It will, however, generate calls to drop functions, stored procedures, views, constraints, etc. if they need to be updated. Another thing you can do is have the system apply those changes for you:

SchemaProvider.Setup(DesiredSchema,new Connection(Configuration, SqlClientFactory.Instance, "Default"));

The connection object must be fed a IConfiguration object, a DbProviderFactory for the database type you wish it to connect to, and either the name of your connection string in the configuration object or a connection string:

SchemaProvider.Setup(DesiredSchema,new Connection(Configuration, SqlClientFactory.Instance, "Data Source=localhost;Initial Catalog=ExampleDatabase;Integrated Security=SSPI;Pooling=false"));

Adding a ISchemaGenerator

The schema generator is what the system uses to generate the individual commands. Data.Modeler comes with one for SQL Server but in order to add your own you must create a class that inherits from ISchemaGenerator. From there the system will automatically pick up the schema generator and allow you to use it:

var SchemaProvider = DataModeler.GetSchemaGenerator(MyDbFactoryProvider);

Note that you can also create one for SQL Server and the system will actually return the one that you create instead of the one built into the system.

Installation

The library is available via Nuget with the package name "Data.Modeler". To install it run the following command in the Package Manager Console:

Install-Package Data.Modeler

Build Process

In order to build the library you will require the following as a minimum:

  1. Visual Studio 2022

Other than that, just clone the project and you should be able to load the solution and build without too much effort.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Data.Modeler:

Package Downloads
Inflatable

Inflatable is a simple ORM.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.161 24 3/28/2024
4.0.160 44 3/26/2024
4.0.159 78 3/23/2024
4.0.158 74 3/22/2024
4.0.157 73 3/21/2024
4.0.156 60 3/18/2024
4.0.155 86 3/15/2024
4.0.154 71 3/14/2024
4.0.153 90 3/13/2024
4.0.152 77 3/11/2024
4.0.151 74 3/8/2024
4.0.150 78 3/7/2024
4.0.149 81 3/6/2024
4.0.148 81 3/5/2024
4.0.147 342 3/4/2024
4.0.146 92 3/1/2024
4.0.145 78 2/29/2024
4.0.144 83 2/28/2024
4.0.143 75 2/27/2024
4.0.142 79 2/26/2024
4.0.141 81 2/23/2024
4.0.140 81 2/22/2024
4.0.139 88 2/21/2024
4.0.138 89 2/20/2024
4.0.137 267 2/19/2024
4.0.136 69 2/19/2024
4.0.135 70 2/16/2024
4.0.134 63 2/16/2024
4.0.133 74 2/15/2024
4.0.132 83 2/14/2024
4.0.131 71 2/13/2024
4.0.130 84 2/12/2024
4.0.129 73 2/9/2024
4.0.128 78 2/8/2024
4.0.127 62 2/7/2024
4.0.126 87 2/6/2024
4.0.125 60 2/6/2024
4.0.124 77 2/5/2024
4.0.123 353 2/2/2024
4.0.122 76 2/1/2024
4.0.121 76 2/1/2024
4.0.120 76 1/31/2024
4.0.119 142 1/30/2024
4.0.118 95 1/29/2024
4.0.117 95 1/26/2024
4.0.116 75 1/24/2024
4.0.115 75 1/23/2024
4.0.114 74 1/22/2024
4.0.113 231 1/16/2024
4.0.112 101 1/15/2024
4.0.111 79 1/15/2024
4.0.110 87 1/12/2024
4.0.109 72 1/11/2024
4.0.108 91 1/10/2024
4.0.107 225 1/8/2024
4.0.106 126 1/5/2024
4.0.105 233 12/26/2023
4.0.104 96 12/26/2023
4.0.103 116 12/25/2023
4.0.102 109 12/25/2023
4.0.101 163 12/22/2023
4.0.100 115 12/21/2023
4.0.99 136 12/15/2023
4.0.98 105 12/14/2023
4.0.97 97 12/13/2023
4.0.96 106 12/13/2023
4.0.95 225 12/12/2023
4.0.94 104 12/12/2023
4.0.93 105 12/11/2023
4.0.92 101 12/11/2023
4.0.91 155 12/6/2023
4.0.90 112 12/6/2023
4.0.89 106 12/5/2023
4.0.88 150 12/4/2023
4.0.87 158 11/24/2023
4.0.86 121 11/23/2023
4.0.85 108 11/21/2023
4.0.84 118 11/20/2023
4.0.83 113 11/20/2023
4.0.82 135 11/17/2023
4.0.81 219 11/16/2023
4.0.80 114 11/15/2023
4.0.79 112 11/13/2023
4.0.78 125 11/9/2023
4.0.77 133 11/8/2023
4.0.76 98 11/8/2023
4.0.75 107 11/7/2023
4.0.74 115 11/6/2023
4.0.73 122 11/3/2023
4.0.72 139 11/2/2023
4.0.71 104 11/1/2023
4.0.70 102 11/1/2023
4.0.69 117 10/31/2023
4.0.68 123 10/30/2023
4.0.67 128 10/27/2023
4.0.66 124 10/26/2023
4.0.65 135 10/25/2023
4.0.64 132 10/17/2023
4.0.63 101 10/17/2023
4.0.62 143 10/16/2023
4.0.61 154 10/13/2023
4.0.60 160 10/12/2023
4.0.59 123 10/11/2023
4.0.58 150 10/5/2023
4.0.57 122 10/4/2023
4.0.56 121 9/26/2023
4.0.55 124 9/25/2023
4.0.54 130 9/22/2023
4.0.53 133 9/20/2023
4.0.52 129 9/19/2023
4.0.51 135 9/18/2023
4.0.50 118 9/18/2023
4.0.49 173 9/14/2023
4.0.48 135 9/13/2023
4.0.47 120 9/12/2023
4.0.46 195 9/11/2023
4.0.45 110 9/11/2023
4.0.44 109 9/11/2023
4.0.43 216 9/7/2023
4.0.42 117 9/6/2023
4.0.41 162 9/5/2023
4.0.40 120 9/4/2023
4.0.39 124 9/4/2023
4.0.38 135 9/1/2023
4.0.37 165 8/31/2023
4.0.36 152 8/30/2023
4.0.35 170 8/29/2023
4.0.34 115 8/29/2023
4.0.33 183 8/28/2023
4.0.32 171 8/25/2023
4.0.31 159 8/24/2023
4.0.30 155 8/23/2023
4.0.29 156 8/22/2023
4.0.28 157 8/18/2023
4.0.27 155 8/17/2023
4.0.26 148 8/17/2023
4.0.25 132 8/16/2023
4.0.24 209 8/10/2023
4.0.23 176 8/9/2023
4.0.22 172 8/8/2023
4.0.21 144 8/8/2023
4.0.20 254 8/7/2023
4.0.19 160 8/4/2023
4.0.18 217 8/3/2023
4.0.17 181 8/2/2023
4.0.16 188 7/26/2023
4.0.15 170 7/25/2023
4.0.14 191 7/20/2023
4.0.13 171 7/19/2023
4.0.12 161 7/18/2023
4.0.11 130 7/18/2023
4.0.10 170 7/18/2023
4.0.9 135 7/18/2023
4.0.8 215 7/17/2023
4.0.7 140 7/17/2023
4.0.6 487 1/30/2023
4.0.5 361 1/30/2023
4.0.4 362 1/27/2023
4.0.3 467 12/13/2022
4.0.0 292 12/12/2022
3.0.47 1,452 6/10/2022
3.0.45 922 4/20/2022
3.0.44 945 1/11/2022
3.0.43 575 1/10/2022
3.0.42 1,030 6/17/2021
3.0.41 705 6/16/2021
3.0.40 665 6/16/2021
3.0.39 477 6/16/2021
3.0.38 933 1/7/2021
3.0.37 750 12/16/2020
3.0.36 709 12/14/2020
3.0.35 2,201 9/13/2020
3.0.34 815 6/19/2020
3.0.33 1,760 5/12/2020
3.0.32 1,320 5/12/2020
3.0.31 838 4/28/2020
3.0.30 799 4/24/2020
3.0.29 778 4/16/2020
3.0.28 840 4/16/2020
3.0.27 534 4/15/2020
3.0.26 804 4/15/2020
3.0.25 857 4/14/2020
3.0.24 561 4/14/2020
3.0.23 877 4/10/2020
3.0.22 835 4/10/2020
3.0.21 873 4/7/2020
3.0.20 2,636 3/26/2020
3.0.19 870 3/26/2020
3.0.18 544 3/25/2020
3.0.17 548 3/25/2020
3.0.16 564 3/25/2020
3.0.15 570 3/25/2020
3.0.13 557 3/25/2020
3.0.12 573 3/25/2020
3.0.11 540 3/25/2020
3.0.10 1,090 3/25/2020
3.0.9 898 3/22/2020
3.0.8 531 3/22/2020
3.0.7 909 3/21/2020
3.0.6 1,514 3/13/2020
3.0.5 579 3/13/2020
3.0.4 1,259 2/28/2020
3.0.3 1,128 2/21/2020
3.0.2 605 2/11/2020
3.0.1 580 2/11/2020
3.0.0 1,700 12/23/2019
2.0.13 600 11/4/2019
2.0.12 666 6/19/2019
2.0.11 641 6/19/2019
2.0.10 944 4/17/2019
2.0.9 1,480 2/21/2019
2.0.8 3,753 8/1/2018
2.0.7 1,170 8/1/2018
2.0.6 1,565 6/26/2018
2.0.5 952 6/14/2018
2.0.4 1,515 6/1/2018
2.0.3 1,496 5/22/2018
2.0.2 2,060 5/11/2018
2.0.1 2,120 2/13/2018
2.0.0 2,015 1/2/2018
1.0.29 3,701 11/16/2017
1.0.28 885 11/16/2017
1.0.27 6,107 10/18/2017
1.0.26 4,391 9/22/2017
1.0.24 978 9/22/2017
1.0.23 1,291 9/22/2017
1.0.22 963 9/22/2017
1.0.21 969 9/22/2017
1.0.19 985 9/22/2017
1.0.18 971 9/21/2017
1.0.17 1,978 8/4/2017
1.0.16 978 7/3/2017
1.0.15 995 6/16/2017
1.0.13 982 6/16/2017
1.0.12 990 6/16/2017
1.0.11 1,009 5/30/2017
1.0.9 1,004 5/25/2017
1.0.8 982 5/24/2017
1.0.7 1,006 5/19/2017
1.0.6 1,047 5/17/2017
1.0.4 1,099 4/3/2017
1.0.3 1,108 3/22/2017
1.0.2 1,091 2/2/2017