Data.Modeler 4.0.59

There is a newer version of this package available.
See the version list below for details.
dotnet add package Data.Modeler --version 4.0.59                
NuGet\Install-Package Data.Modeler -Version 4.0.59                
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.59" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Data.Modeler --version 4.0.59                
#r "nuget: Data.Modeler, 4.0.59"                
#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.59

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

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
5.0.5 49 11/26/2024
5.0.4 93 11/26/2024
5.0.3 62 11/25/2024
5.0.2 98 11/24/2024
5.0.1 76 11/23/2024
5.0.0 77 11/23/2024
4.0.268 92 11/19/2024
4.0.267 79 11/11/2024
4.0.266 70 11/6/2024
4.0.265 70 11/5/2024
4.0.264 70 11/4/2024
4.0.263 79 11/1/2024
4.0.262 69 10/31/2024
4.0.261 71 10/30/2024
4.0.260 74 10/29/2024
4.0.259 70 10/29/2024
4.0.258 81 10/25/2024
4.0.257 73 10/24/2024
4.0.256 75 10/21/2024
4.0.255 87 10/16/2024
4.0.254 70 10/15/2024
4.0.253 82 10/11/2024
4.0.252 80 10/10/2024
4.0.251 86 10/9/2024
4.0.250 89 10/8/2024
4.0.249 82 10/2/2024
4.0.248 78 10/1/2024
4.0.247 86 9/30/2024
4.0.246 86 9/27/2024
4.0.245 84 9/24/2024
4.0.244 94 9/23/2024
4.0.243 82 9/23/2024
4.0.242 121 9/17/2024
4.0.241 112 9/10/2024
4.0.240 95 9/9/2024
4.0.239 93 9/6/2024
4.0.238 98 9/5/2024
4.0.237 103 9/3/2024
4.0.236 105 9/2/2024
4.0.235 100 8/30/2024
4.0.234 102 8/29/2024
4.0.233 103 8/28/2024
4.0.232 102 8/27/2024
4.0.231 111 8/26/2024
4.0.230 124 8/23/2024
4.0.229 117 8/22/2024
4.0.228 121 8/21/2024
4.0.227 120 8/20/2024
4.0.226 119 8/20/2024
4.0.225 140 8/19/2024
4.0.224 132 8/16/2024
4.0.223 114 8/15/2024
4.0.222 128 8/14/2024
4.0.221 95 8/5/2024
4.0.220 93 8/2/2024
4.0.219 104 8/1/2024
4.0.218 83 7/31/2024
4.0.217 102 7/26/2024
4.0.216 80 7/25/2024
4.0.215 60 7/24/2024
4.0.214 112 7/11/2024
4.0.213 95 7/10/2024
4.0.212 88 7/9/2024
4.0.211 87 7/9/2024
4.0.210 91 7/8/2024
4.0.209 106 7/5/2024
4.0.208 100 7/5/2024
4.0.207 98 7/2/2024
4.0.206 92 7/1/2024
4.0.205 110 6/27/2024
4.0.204 95 6/26/2024
4.0.203 109 6/25/2024
4.0.202 100 6/24/2024
4.0.201 953 6/19/2024
4.0.200 112 6/18/2024
4.0.199 89 6/17/2024
4.0.198 96 6/14/2024
4.0.197 94 6/13/2024
4.0.196 102 6/12/2024
4.0.195 117 6/3/2024
4.0.194 104 5/31/2024
4.0.193 118 5/30/2024
4.0.192 101 5/29/2024
4.0.191 125 5/27/2024
4.0.190 92 5/27/2024
4.0.189 97 5/23/2024
4.0.188 107 5/22/2024
4.0.187 137 5/21/2024
4.0.186 111 5/20/2024
4.0.185 117 5/17/2024
4.0.184 114 5/16/2024
4.0.183 120 5/15/2024
4.0.182 115 5/8/2024
4.0.181 96 5/7/2024
4.0.180 116 5/6/2024
4.0.179 113 5/3/2024
4.0.178 677 5/2/2024
4.0.177 82 5/1/2024
4.0.176 108 4/30/2024
4.0.175 109 4/29/2024
4.0.174 109 4/29/2024
4.0.173 114 4/25/2024
4.0.172 113 4/24/2024
4.0.171 119 4/16/2024
4.0.170 116 4/15/2024
4.0.169 101 4/12/2024
4.0.168 103 4/12/2024
4.0.167 119 4/11/2024
4.0.166 129 4/10/2024
4.0.165 117 4/9/2024
4.0.164 118 4/8/2024
4.0.163 119 4/1/2024
4.0.162 105 3/29/2024
4.0.161 104 3/28/2024
4.0.160 98 3/26/2024
4.0.159 128 3/23/2024
4.0.158 116 3/22/2024
4.0.157 111 3/21/2024
4.0.156 105 3/18/2024
4.0.155 131 3/15/2024
4.0.154 118 3/14/2024
4.0.153 128 3/13/2024
4.0.152 136 3/11/2024
4.0.151 119 3/8/2024
4.0.150 125 3/7/2024
4.0.149 120 3/6/2024
4.0.148 117 3/5/2024
4.0.147 943 3/4/2024
4.0.146 140 3/1/2024
4.0.145 133 2/29/2024
4.0.144 126 2/28/2024
4.0.143 133 2/27/2024
4.0.142 121 2/26/2024
4.0.141 150 2/23/2024
4.0.140 125 2/22/2024
4.0.139 127 2/21/2024
4.0.138 133 2/20/2024
4.0.137 376 2/19/2024
4.0.136 110 2/19/2024
4.0.135 107 2/16/2024
4.0.134 111 2/16/2024
4.0.133 108 2/15/2024
4.0.132 120 2/14/2024
4.0.131 110 2/13/2024
4.0.130 141 2/12/2024
4.0.129 111 2/9/2024
4.0.128 150 2/8/2024
4.0.127 123 2/7/2024
4.0.126 129 2/6/2024
4.0.125 97 2/6/2024
4.0.124 111 2/5/2024
4.0.123 465 2/2/2024
4.0.122 117 2/1/2024
4.0.121 114 2/1/2024
4.0.120 124 1/31/2024
4.0.119 201 1/30/2024
4.0.118 124 1/29/2024
4.0.117 140 1/26/2024
4.0.116 113 1/24/2024
4.0.115 108 1/23/2024
4.0.114 114 1/22/2024
4.0.113 307 1/16/2024
4.0.112 153 1/15/2024
4.0.111 124 1/15/2024
4.0.110 129 1/12/2024
4.0.109 109 1/11/2024
4.0.108 124 1/10/2024
4.0.107 297 1/8/2024
4.0.106 178 1/5/2024
4.0.105 307 12/26/2023
4.0.104 133 12/26/2023
4.0.103 166 12/25/2023
4.0.102 137 12/25/2023
4.0.101 218 12/22/2023
4.0.100 159 12/21/2023
4.0.99 182 12/15/2023
4.0.98 136 12/14/2023
4.0.97 122 12/13/2023
4.0.96 141 12/13/2023
4.0.95 305 12/12/2023
4.0.94 137 12/12/2023
4.0.93 141 12/11/2023
4.0.92 135 12/11/2023
4.0.91 202 12/6/2023
4.0.90 151 12/6/2023
4.0.89 142 12/5/2023
4.0.88 198 12/4/2023
4.0.87 207 11/24/2023
4.0.86 158 11/23/2023
4.0.85 145 11/21/2023
4.0.84 157 11/20/2023
4.0.83 146 11/20/2023
4.0.82 183 11/17/2023
4.0.81 440 11/16/2023
4.0.80 148 11/15/2023
4.0.79 158 11/13/2023
4.0.78 170 11/9/2023
4.0.77 182 11/8/2023
4.0.76 135 11/8/2023
4.0.75 145 11/7/2023
4.0.74 161 11/6/2023
4.0.73 159 11/3/2023
4.0.72 192 11/2/2023
4.0.71 144 11/1/2023
4.0.70 130 11/1/2023
4.0.69 179 10/31/2023
4.0.68 167 10/30/2023
4.0.67 170 10/27/2023
4.0.66 169 10/26/2023
4.0.65 179 10/25/2023
4.0.64 173 10/17/2023
4.0.63 132 10/17/2023
4.0.62 193 10/16/2023
4.0.61 196 10/13/2023
4.0.60 206 10/12/2023
4.0.59 161 10/11/2023
4.0.58 192 10/5/2023
4.0.57 162 10/4/2023
4.0.56 158 9/26/2023
4.0.55 158 9/25/2023
4.0.54 176 9/22/2023
4.0.53 176 9/20/2023
4.0.52 171 9/19/2023
4.0.51 172 9/18/2023
4.0.50 155 9/18/2023
4.0.49 218 9/14/2023
4.0.48 182 9/13/2023
4.0.47 157 9/12/2023
4.0.46 237 9/11/2023
4.0.45 147 9/11/2023
4.0.44 143 9/11/2023
4.0.43 264 9/7/2023
4.0.42 152 9/6/2023
4.0.41 206 9/5/2023
4.0.40 162 9/4/2023
4.0.39 158 9/4/2023
4.0.38 192 9/1/2023
4.0.37 205 8/31/2023
4.0.36 194 8/30/2023
4.0.35 215 8/29/2023
4.0.34 148 8/29/2023
4.0.33 234 8/28/2023
4.0.32 211 8/25/2023
4.0.31 204 8/24/2023
4.0.30 188 8/23/2023
4.0.29 198 8/22/2023
4.0.28 199 8/18/2023
4.0.27 198 8/17/2023
4.0.26 184 8/17/2023
4.0.25 171 8/16/2023
4.0.24 255 8/10/2023
4.0.23 216 8/9/2023
4.0.22 205 8/8/2023
4.0.21 187 8/8/2023
4.0.20 301 8/7/2023
4.0.19 195 8/4/2023
4.0.18 254 8/3/2023
4.0.17 219 8/2/2023
4.0.16 223 7/26/2023
4.0.15 210 7/25/2023
4.0.14 232 7/20/2023
4.0.13 212 7/19/2023
4.0.12 203 7/18/2023
4.0.11 156 7/18/2023
4.0.10 214 7/18/2023
4.0.9 167 7/18/2023
4.0.8 275 7/17/2023
4.0.7 172 7/17/2023
4.0.6 544 1/30/2023
4.0.5 399 1/30/2023
4.0.4 401 1/27/2023
4.0.3 504 12/13/2022
4.0.0 319 12/12/2022
3.0.47 1,519 6/10/2022
3.0.45 978 4/20/2022
3.0.44 999 1/11/2022
3.0.43 615 1/10/2022
3.0.42 1,086 6/17/2021
3.0.41 743 6/16/2021
3.0.40 710 6/16/2021
3.0.39 499 6/16/2021
3.0.38 976 1/7/2021
3.0.37 814 12/16/2020
3.0.36 752 12/14/2020
3.0.35 2,299 9/13/2020
3.0.34 866 6/19/2020
3.0.33 1,858 5/12/2020
3.0.32 1,379 5/12/2020
3.0.31 875 4/28/2020
3.0.30 828 4/24/2020
3.0.29 813 4/16/2020
3.0.28 884 4/16/2020
3.0.27 558 4/15/2020
3.0.26 848 4/15/2020
3.0.25 906 4/14/2020
3.0.24 588 4/14/2020
3.0.23 933 4/10/2020
3.0.22 874 4/10/2020
3.0.21 910 4/7/2020
3.0.20 2,743 3/26/2020
3.0.19 910 3/26/2020
3.0.18 575 3/25/2020
3.0.17 577 3/25/2020
3.0.16 587 3/25/2020
3.0.15 606 3/25/2020
3.0.13 587 3/25/2020
3.0.12 602 3/25/2020
3.0.11 571 3/25/2020
3.0.10 1,125 3/25/2020
3.0.9 944 3/22/2020
3.0.8 561 3/22/2020
3.0.7 944 3/21/2020
3.0.6 1,586 3/13/2020
3.0.5 604 3/13/2020
3.0.4 1,324 2/28/2020
3.0.3 1,181 2/21/2020
3.0.2 635 2/11/2020
3.0.1 610 2/11/2020
3.0.0 1,782 12/23/2019
2.0.13 626 11/4/2019
2.0.12 693 6/19/2019
2.0.11 680 6/19/2019
2.0.10 972 4/17/2019
2.0.9 1,538 2/21/2019
2.0.8 3,875 8/1/2018
2.0.7 1,217 8/1/2018
2.0.6 1,619 6/26/2018
2.0.5 986 6/14/2018
2.0.4 1,575 6/1/2018
2.0.3 1,532 5/22/2018
2.0.2 2,115 5/11/2018
2.0.1 2,189 2/13/2018
2.0.0 2,086 1/2/2018
1.0.29 3,806 11/16/2017
1.0.28 914 11/16/2017
1.0.27 6,327 10/18/2017
1.0.26 4,524 9/22/2017
1.0.24 990 9/22/2017
1.0.23 1,328 9/22/2017
1.0.22 998 9/22/2017
1.0.21 1,001 9/22/2017
1.0.19 1,009 9/22/2017
1.0.18 1,003 9/21/2017
1.0.17 2,048 8/4/2017
1.0.16 1,012 7/3/2017
1.0.15 1,033 6/16/2017
1.0.13 1,024 6/16/2017
1.0.12 1,014 6/16/2017
1.0.11 1,035 5/30/2017
1.0.9 1,027 5/25/2017
1.0.8 1,011 5/24/2017
1.0.7 1,036 5/19/2017
1.0.6 1,070 5/17/2017
1.0.4 1,130 4/3/2017
1.0.3 1,137 3/22/2017
1.0.2 1,129 2/2/2017