Data.Modeler 5.0.42

There is a newer version of this package available.
See the version list below for details.
dotnet add package Data.Modeler --version 5.0.42
                    
NuGet\Install-Package Data.Modeler -Version 5.0.42
                    
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="5.0.42" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Data.Modeler" Version="5.0.42" />
                    
Directory.Packages.props
<PackageReference Include="Data.Modeler" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Data.Modeler --version 5.0.42
                    
#r "nuget: Data.Modeler, 5.0.42"
                    
#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.
#:package Data.Modeler@5.0.42
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Data.Modeler&version=5.0.42
                    
Install as a Cake Addin
#tool nuget:?package=Data.Modeler&version=5.0.42
                    
Install as a Cake Tool

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 net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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.48 36 7/15/2025
5.0.47 42 7/14/2025
5.0.46 42 7/14/2025
5.0.45 157 7/8/2025
5.0.43 125 6/30/2025
5.0.42 126 6/30/2025
5.0.41 136 6/27/2025
5.0.40 175 6/27/2025
5.0.39 123 6/27/2025
5.0.38 130 6/27/2025
5.0.37 127 6/27/2025
5.0.36 171 6/26/2025
5.0.35 145 6/18/2025
5.0.34 292 6/10/2025
5.0.33 93 5/30/2025
5.0.32 98 5/23/2025
5.0.31 237 5/14/2025
5.0.30 116 5/2/2025
5.0.29 169 4/28/2025
5.0.28 125 4/11/2025
5.0.27 161 3/17/2025
5.0.26 135 2/24/2025
5.0.25 159 2/12/2025
5.0.24 253 2/3/2025
5.0.23 177 1/30/2025
5.0.22 147 1/29/2025
5.0.21 110 1/29/2025
5.0.20 133 1/28/2025
5.0.19 129 1/24/2025
5.0.18 138 1/23/2025
5.0.17 114 1/23/2025
5.0.16 158 1/16/2025
5.0.15 134 1/15/2025
5.0.14 117 1/14/2025
5.0.13 122 1/13/2025
5.0.12 129 1/10/2025
5.0.11 132 1/9/2025
5.0.10 110 1/8/2025
5.0.9 190 12/17/2024
5.0.8 128 12/17/2024
5.0.7 171 12/10/2024
5.0.6 132 12/9/2024
5.0.5 200 11/26/2024
5.0.4 163 11/26/2024
5.0.3 116 11/25/2024
5.0.2 155 11/24/2024
5.0.1 136 11/23/2024
5.0.0 130 11/23/2024
4.0.268 150 11/19/2024
4.0.267 127 11/11/2024
4.0.266 121 11/6/2024
4.0.265 119 11/5/2024
4.0.264 119 11/4/2024
4.0.263 138 11/1/2024
4.0.262 121 10/31/2024
4.0.261 129 10/30/2024
4.0.260 122 10/29/2024
4.0.259 123 10/29/2024
4.0.258 134 10/25/2024
4.0.257 118 10/24/2024
4.0.256 131 10/21/2024
4.0.255 135 10/16/2024
4.0.254 118 10/15/2024
4.0.253 128 10/11/2024
4.0.252 122 10/10/2024
4.0.251 123 10/9/2024
4.0.250 134 10/8/2024
4.0.249 136 10/2/2024
4.0.248 133 10/1/2024
4.0.247 125 9/30/2024
4.0.246 137 9/27/2024
4.0.245 130 9/24/2024
4.0.244 137 9/23/2024
4.0.243 123 9/23/2024
4.0.242 165 9/17/2024
4.0.241 156 9/10/2024
4.0.240 132 9/9/2024
4.0.239 135 9/6/2024
4.0.238 145 9/5/2024
4.0.237 143 9/3/2024
4.0.236 144 9/2/2024
4.0.235 143 8/30/2024
4.0.234 139 8/29/2024
4.0.233 143 8/28/2024
4.0.232 143 8/27/2024
4.0.231 146 8/26/2024
4.0.230 162 8/23/2024
4.0.229 157 8/22/2024
4.0.228 158 8/21/2024
4.0.227 159 8/20/2024
4.0.226 156 8/20/2024
4.0.225 177 8/19/2024
4.0.224 174 8/16/2024
4.0.223 154 8/15/2024
4.0.222 177 8/14/2024
4.0.221 135 8/5/2024
4.0.220 130 8/2/2024
4.0.219 153 8/1/2024
4.0.218 121 7/31/2024
4.0.217 143 7/26/2024
4.0.216 121 7/25/2024
4.0.215 93 7/24/2024
4.0.214 148 7/11/2024
4.0.213 133 7/10/2024
4.0.212 125 7/9/2024
4.0.211 131 7/9/2024
4.0.210 132 7/8/2024
4.0.209 150 7/5/2024
4.0.208 147 7/5/2024
4.0.207 135 7/2/2024
4.0.206 127 7/1/2024
4.0.205 156 6/27/2024
4.0.204 147 6/26/2024
4.0.203 147 6/25/2024
4.0.202 150 6/24/2024
4.0.201 1,028 6/19/2024
4.0.200 152 6/18/2024
4.0.199 130 6/17/2024
4.0.198 137 6/14/2024
4.0.197 133 6/13/2024
4.0.196 142 6/12/2024
4.0.195 153 6/3/2024
4.0.194 139 5/31/2024
4.0.193 163 5/30/2024
4.0.192 140 5/29/2024
4.0.191 161 5/27/2024
4.0.190 141 5/27/2024
4.0.189 133 5/23/2024
4.0.188 144 5/22/2024
4.0.187 177 5/21/2024
4.0.186 151 5/20/2024
4.0.185 156 5/17/2024
4.0.184 151 5/16/2024
4.0.183 155 5/15/2024
4.0.182 156 5/8/2024
4.0.181 141 5/7/2024
4.0.180 155 5/6/2024
4.0.179 157 5/3/2024
4.0.178 714 5/2/2024
4.0.177 118 5/1/2024
4.0.176 148 4/30/2024
4.0.175 142 4/29/2024
4.0.174 144 4/29/2024
4.0.173 155 4/25/2024
4.0.172 151 4/24/2024
4.0.171 163 4/16/2024
4.0.170 151 4/15/2024
4.0.169 150 4/12/2024
4.0.168 144 4/12/2024
4.0.167 162 4/11/2024
4.0.166 175 4/10/2024
4.0.165 153 4/9/2024
4.0.164 160 4/8/2024
4.0.163 156 4/1/2024
4.0.162 137 3/29/2024
4.0.161 152 3/28/2024
4.0.160 139 3/26/2024
4.0.159 165 3/23/2024
4.0.158 158 3/22/2024
4.0.157 158 3/21/2024
4.0.156 138 3/18/2024
4.0.155 169 3/15/2024
4.0.154 160 3/14/2024
4.0.153 165 3/13/2024
4.0.152 176 3/11/2024
4.0.151 159 3/8/2024
4.0.150 161 3/7/2024
4.0.149 151 3/6/2024
4.0.148 160 3/5/2024
4.0.147 977 3/4/2024
4.0.146 174 3/1/2024
4.0.145 174 2/29/2024
4.0.144 173 2/28/2024
4.0.143 176 2/27/2024
4.0.142 168 2/26/2024
4.0.141 187 2/23/2024
4.0.140 177 2/22/2024
4.0.139 164 2/21/2024
4.0.138 178 2/20/2024
4.0.137 415 2/19/2024
4.0.136 149 2/19/2024
4.0.135 145 2/16/2024
4.0.134 152 2/16/2024
4.0.133 152 2/15/2024
4.0.132 158 2/14/2024
4.0.131 148 2/13/2024
4.0.130 178 2/12/2024
4.0.129 151 2/9/2024
4.0.128 196 2/8/2024
4.0.127 156 2/7/2024
4.0.126 167 2/6/2024
4.0.125 131 2/6/2024
4.0.124 144 2/5/2024
4.0.123 514 2/2/2024
4.0.122 161 2/1/2024
4.0.121 145 2/1/2024
4.0.120 167 1/31/2024
4.0.119 233 1/30/2024
4.0.118 164 1/29/2024
4.0.117 177 1/26/2024
4.0.116 154 1/24/2024
4.0.115 142 1/23/2024
4.0.114 149 1/22/2024
4.0.113 347 1/16/2024
4.0.112 191 1/15/2024
4.0.111 168 1/15/2024
4.0.110 164 1/12/2024
4.0.109 149 1/11/2024
4.0.108 154 1/10/2024
4.0.107 336 1/8/2024
4.0.106 217 1/5/2024
4.0.105 340 12/26/2023
4.0.104 173 12/26/2023
4.0.103 194 12/25/2023
4.0.102 171 12/25/2023
4.0.101 255 12/22/2023
4.0.100 196 12/21/2023
4.0.99 212 12/15/2023
4.0.98 175 12/14/2023
4.0.97 158 12/13/2023
4.0.96 183 12/13/2023
4.0.95 338 12/12/2023
4.0.94 175 12/12/2023
4.0.93 177 12/11/2023
4.0.92 170 12/11/2023
4.0.91 225 12/6/2023
4.0.90 167 12/6/2023
4.0.89 163 12/5/2023
4.0.88 215 12/4/2023
4.0.87 224 11/24/2023
4.0.86 176 11/23/2023
4.0.85 170 11/21/2023
4.0.84 177 11/20/2023
4.0.83 169 11/20/2023
4.0.82 207 11/17/2023
4.0.81 663 11/16/2023
4.0.80 178 11/15/2023
4.0.79 180 11/13/2023
4.0.78 190 11/9/2023
4.0.77 199 11/8/2023
4.0.76 152 11/8/2023
4.0.75 170 11/7/2023
4.0.74 183 11/6/2023
4.0.73 178 11/3/2023
4.0.72 217 11/2/2023
4.0.71 167 11/1/2023
4.0.70 161 11/1/2023
4.0.69 206 10/31/2023
4.0.68 192 10/30/2023
4.0.67 190 10/27/2023
4.0.66 197 10/26/2023
4.0.65 202 10/25/2023
4.0.64 195 10/17/2023
4.0.63 157 10/17/2023
4.0.62 215 10/16/2023
4.0.61 220 10/13/2023
4.0.60 236 10/12/2023
4.0.59 182 10/11/2023
4.0.58 215 10/5/2023
4.0.57 191 10/4/2023
4.0.56 186 9/26/2023
4.0.55 186 9/25/2023
4.0.54 202 9/22/2023
4.0.53 208 9/20/2023
4.0.52 200 9/19/2023
4.0.51 195 9/18/2023
4.0.50 181 9/18/2023
4.0.49 238 9/14/2023
4.0.48 214 9/13/2023
4.0.47 180 9/12/2023
4.0.46 262 9/11/2023
4.0.45 181 9/11/2023
4.0.44 169 9/11/2023
4.0.43 295 9/7/2023
4.0.42 179 9/6/2023
4.0.41 241 9/5/2023
4.0.40 186 9/4/2023
4.0.39 193 9/4/2023
4.0.38 230 9/1/2023
4.0.37 234 8/31/2023
4.0.36 224 8/30/2023
4.0.35 245 8/29/2023
4.0.34 180 8/29/2023
4.0.33 265 8/28/2023
4.0.32 241 8/25/2023
4.0.31 231 8/24/2023
4.0.30 213 8/23/2023
4.0.29 222 8/22/2023
4.0.28 224 8/18/2023
4.0.27 233 8/17/2023
4.0.26 212 8/17/2023
4.0.25 198 8/16/2023
4.0.24 292 8/10/2023
4.0.23 245 8/9/2023
4.0.22 242 8/8/2023
4.0.21 218 8/8/2023
4.0.20 328 8/7/2023
4.0.19 226 8/4/2023
4.0.18 285 8/3/2023
4.0.17 255 8/2/2023
4.0.16 261 7/26/2023
4.0.15 241 7/25/2023
4.0.14 261 7/20/2023
4.0.13 252 7/19/2023
4.0.12 237 7/18/2023
4.0.11 188 7/18/2023
4.0.10 243 7/18/2023
4.0.9 198 7/18/2023
4.0.8 313 7/17/2023
4.0.7 212 7/17/2023
4.0.6 583 1/30/2023
4.0.5 447 1/30/2023
4.0.4 445 1/27/2023
4.0.3 555 12/13/2022
4.0.0 359 12/12/2022
3.0.47 1,568 6/10/2022
3.0.45 1,037 4/20/2022
3.0.44 1,059 1/11/2022
3.0.43 678 1/10/2022
3.0.42 1,154 6/17/2021
3.0.41 806 6/16/2021
3.0.40 771 6/16/2021
3.0.39 562 6/16/2021
3.0.38 1,077 1/7/2021
3.0.37 891 12/16/2020
3.0.36 821 12/14/2020
3.0.35 2,370 9/13/2020
3.0.34 947 6/19/2020
3.0.33 1,937 5/12/2020
3.0.32 1,460 5/12/2020
3.0.31 951 4/28/2020
3.0.30 904 4/24/2020
3.0.29 891 4/16/2020
3.0.28 960 4/16/2020
3.0.27 634 4/15/2020
3.0.26 925 4/15/2020
3.0.25 985 4/14/2020
3.0.24 676 4/14/2020
3.0.23 1,017 4/10/2020
3.0.22 962 4/10/2020
3.0.21 999 4/7/2020
3.0.20 2,819 3/26/2020
3.0.19 989 3/26/2020
3.0.18 655 3/25/2020
3.0.17 656 3/25/2020
3.0.16 667 3/25/2020
3.0.15 681 3/25/2020
3.0.13 673 3/25/2020
3.0.12 679 3/25/2020
3.0.11 647 3/25/2020
3.0.10 1,204 3/25/2020
3.0.9 1,025 3/22/2020
3.0.8 639 3/22/2020
3.0.7 1,022 3/21/2020
3.0.6 1,660 3/13/2020
3.0.5 691 3/13/2020
3.0.4 1,404 2/28/2020
3.0.3 1,255 2/21/2020
3.0.2 709 2/11/2020
3.0.1 684 2/11/2020
3.0.0 1,854 12/23/2019
2.0.13 707 11/4/2019
2.0.12 786 6/19/2019
2.0.11 760 6/19/2019
2.0.10 1,060 4/17/2019
2.0.9 1,619 2/21/2019
2.0.8 4,042 8/1/2018
2.0.7 1,386 8/1/2018
2.0.6 1,872 6/26/2018
2.0.5 1,236 6/14/2018
2.0.4 1,827 6/1/2018
2.0.3 1,790 5/22/2018
2.0.2 2,377 5/11/2018
2.0.1 2,454 2/13/2018
2.0.0 2,354 1/2/2018
1.0.29 3,992 11/16/2017
1.0.28 1,103 11/16/2017
1.0.27 6,508 10/18/2017
1.0.26 4,707 9/22/2017
1.0.24 1,172 9/22/2017
1.0.23 1,515 9/22/2017
1.0.22 1,179 9/22/2017
1.0.21 1,192 9/22/2017
1.0.19 1,197 9/22/2017
1.0.18 1,189 9/21/2017
1.0.17 2,232 8/4/2017
1.0.16 1,199 7/3/2017
1.0.15 1,216 6/16/2017
1.0.13 1,209 6/16/2017
1.0.12 1,195 6/16/2017
1.0.11 1,215 5/30/2017
1.0.9 1,205 5/25/2017
1.0.8 1,190 5/24/2017
1.0.7 1,216 5/19/2017
1.0.6 1,253 5/17/2017
1.0.4 1,314 4/3/2017
1.0.3 1,326 3/22/2017
1.0.2 1,315 2/2/2017