Data.Modeler 5.0.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package Data.Modeler --version 5.0.1
                    
NuGet\Install-Package Data.Modeler -Version 5.0.1
                    
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.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Data.Modeler" Version="5.0.1" />
                    
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.1
                    
#r "nuget: Data.Modeler, 5.0.1"
                    
#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.
#addin nuget:?package=Data.Modeler&version=5.0.1
                    
Install as a Cake Addin
#tool nuget:?package=Data.Modeler&version=5.0.1
                    
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.45 39 7/8/2025
5.0.43 121 6/30/2025
5.0.42 122 6/30/2025
5.0.41 131 6/27/2025
5.0.40 172 6/27/2025
5.0.39 120 6/27/2025
5.0.38 127 6/27/2025
5.0.37 124 6/27/2025
5.0.36 167 6/26/2025
5.0.35 140 6/18/2025
5.0.34 288 6/10/2025
5.0.33 89 5/30/2025
5.0.32 96 5/23/2025
5.0.31 235 5/14/2025
5.0.30 113 5/2/2025
5.0.29 167 4/28/2025
5.0.28 121 4/11/2025
5.0.27 159 3/17/2025
5.0.26 131 2/24/2025
5.0.25 155 2/12/2025
5.0.24 250 2/3/2025
5.0.23 174 1/30/2025
5.0.22 140 1/29/2025
5.0.21 105 1/29/2025
5.0.20 130 1/28/2025
5.0.19 126 1/24/2025
5.0.18 135 1/23/2025
5.0.17 111 1/23/2025
5.0.16 155 1/16/2025
5.0.15 131 1/15/2025
5.0.14 112 1/14/2025
5.0.13 119 1/13/2025
5.0.12 123 1/10/2025
5.0.11 129 1/9/2025
5.0.10 107 1/8/2025
5.0.9 187 12/17/2024
5.0.8 121 12/17/2024
5.0.7 166 12/10/2024
5.0.6 128 12/9/2024
5.0.5 194 11/26/2024
5.0.4 160 11/26/2024
5.0.3 113 11/25/2024
5.0.2 150 11/24/2024
5.0.1 133 11/23/2024
5.0.0 127 11/23/2024
4.0.268 147 11/19/2024
4.0.267 124 11/11/2024
4.0.266 118 11/6/2024
4.0.265 116 11/5/2024
4.0.264 116 11/4/2024
4.0.263 133 11/1/2024
4.0.262 118 10/31/2024
4.0.261 124 10/30/2024
4.0.260 119 10/29/2024
4.0.259 119 10/29/2024
4.0.258 130 10/25/2024
4.0.257 115 10/24/2024
4.0.256 124 10/21/2024
4.0.255 133 10/16/2024
4.0.254 114 10/15/2024
4.0.253 125 10/11/2024
4.0.252 120 10/10/2024
4.0.251 121 10/9/2024
4.0.250 132 10/8/2024
4.0.249 133 10/2/2024
4.0.248 129 10/1/2024
4.0.247 123 9/30/2024
4.0.246 135 9/27/2024
4.0.245 127 9/24/2024
4.0.244 135 9/23/2024
4.0.243 121 9/23/2024
4.0.242 162 9/17/2024
4.0.241 153 9/10/2024
4.0.240 130 9/9/2024
4.0.239 133 9/6/2024
4.0.238 141 9/5/2024
4.0.237 141 9/3/2024
4.0.236 141 9/2/2024
4.0.235 141 8/30/2024
4.0.234 137 8/29/2024
4.0.233 140 8/28/2024
4.0.232 141 8/27/2024
4.0.231 144 8/26/2024
4.0.230 160 8/23/2024
4.0.229 155 8/22/2024
4.0.228 156 8/21/2024
4.0.227 157 8/20/2024
4.0.226 154 8/20/2024
4.0.225 175 8/19/2024
4.0.224 170 8/16/2024
4.0.223 152 8/15/2024
4.0.222 174 8/14/2024
4.0.221 133 8/5/2024
4.0.220 128 8/2/2024
4.0.219 149 8/1/2024
4.0.218 119 7/31/2024
4.0.217 139 7/26/2024
4.0.216 118 7/25/2024
4.0.215 91 7/24/2024
4.0.214 146 7/11/2024
4.0.213 131 7/10/2024
4.0.212 123 7/9/2024
4.0.211 129 7/9/2024
4.0.210 129 7/8/2024
4.0.209 148 7/5/2024
4.0.208 143 7/5/2024
4.0.207 133 7/2/2024
4.0.206 125 7/1/2024
4.0.205 153 6/27/2024
4.0.204 142 6/26/2024
4.0.203 145 6/25/2024
4.0.202 144 6/24/2024
4.0.201 1,026 6/19/2024
4.0.200 147 6/18/2024
4.0.199 128 6/17/2024
4.0.198 134 6/14/2024
4.0.197 131 6/13/2024
4.0.196 140 6/12/2024
4.0.195 151 6/3/2024
4.0.194 137 5/31/2024
4.0.193 161 5/30/2024
4.0.192 138 5/29/2024
4.0.191 159 5/27/2024
4.0.190 138 5/27/2024
4.0.189 131 5/23/2024
4.0.188 142 5/22/2024
4.0.187 175 5/21/2024
4.0.186 147 5/20/2024
4.0.185 154 5/17/2024
4.0.184 149 5/16/2024
4.0.183 152 5/15/2024
4.0.182 154 5/8/2024
4.0.181 139 5/7/2024
4.0.180 151 5/6/2024
4.0.179 154 5/3/2024
4.0.178 712 5/2/2024
4.0.177 116 5/1/2024
4.0.176 144 4/30/2024
4.0.175 140 4/29/2024
4.0.174 142 4/29/2024
4.0.173 150 4/25/2024
4.0.172 148 4/24/2024
4.0.171 158 4/16/2024
4.0.170 149 4/15/2024
4.0.169 145 4/12/2024
4.0.168 140 4/12/2024
4.0.167 159 4/11/2024
4.0.166 171 4/10/2024
4.0.165 151 4/9/2024
4.0.164 158 4/8/2024
4.0.163 154 4/1/2024
4.0.162 135 3/29/2024
4.0.161 148 3/28/2024
4.0.160 136 3/26/2024
4.0.159 163 3/23/2024
4.0.158 155 3/22/2024
4.0.157 154 3/21/2024
4.0.156 136 3/18/2024
4.0.155 166 3/15/2024
4.0.154 158 3/14/2024
4.0.153 163 3/13/2024
4.0.152 172 3/11/2024
4.0.151 154 3/8/2024
4.0.150 158 3/7/2024
4.0.149 149 3/6/2024
4.0.148 158 3/5/2024
4.0.147 975 3/4/2024
4.0.146 172 3/1/2024
4.0.145 169 2/29/2024
4.0.144 170 2/28/2024
4.0.143 174 2/27/2024
4.0.142 164 2/26/2024
4.0.141 185 2/23/2024
4.0.140 172 2/22/2024
4.0.139 162 2/21/2024
4.0.138 173 2/20/2024
4.0.137 413 2/19/2024
4.0.136 147 2/19/2024
4.0.135 143 2/16/2024
4.0.134 147 2/16/2024
4.0.133 150 2/15/2024
4.0.132 156 2/14/2024
4.0.131 146 2/13/2024
4.0.130 176 2/12/2024
4.0.129 149 2/9/2024
4.0.128 192 2/8/2024
4.0.127 153 2/7/2024
4.0.126 164 2/6/2024
4.0.125 129 2/6/2024
4.0.124 142 2/5/2024
4.0.123 511 2/2/2024
4.0.122 159 2/1/2024
4.0.121 143 2/1/2024
4.0.120 164 1/31/2024
4.0.119 230 1/30/2024
4.0.118 160 1/29/2024
4.0.117 175 1/26/2024
4.0.116 150 1/24/2024
4.0.115 140 1/23/2024
4.0.114 147 1/22/2024
4.0.113 344 1/16/2024
4.0.112 188 1/15/2024
4.0.111 166 1/15/2024
4.0.110 160 1/12/2024
4.0.109 146 1/11/2024
4.0.108 152 1/10/2024
4.0.107 332 1/8/2024
4.0.106 214 1/5/2024
4.0.105 338 12/26/2023
4.0.104 170 12/26/2023
4.0.103 192 12/25/2023
4.0.102 169 12/25/2023
4.0.101 250 12/22/2023
4.0.100 192 12/21/2023
4.0.99 210 12/15/2023
4.0.98 173 12/14/2023
4.0.97 155 12/13/2023
4.0.96 179 12/13/2023
4.0.95 336 12/12/2023
4.0.94 170 12/12/2023
4.0.93 175 12/11/2023
4.0.92 168 12/11/2023
4.0.91 223 12/6/2023
4.0.90 167 12/6/2023
4.0.89 162 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 169 11/21/2023
4.0.84 177 11/20/2023
4.0.83 168 11/20/2023
4.0.82 206 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 188 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 216 11/2/2023
4.0.71 167 11/1/2023
4.0.70 161 11/1/2023
4.0.69 203 10/31/2023
4.0.68 190 10/30/2023
4.0.67 190 10/27/2023
4.0.66 197 10/26/2023
4.0.65 201 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 235 10/12/2023
4.0.59 182 10/11/2023
4.0.58 215 10/5/2023
4.0.57 189 10/4/2023
4.0.56 182 9/26/2023
4.0.55 184 9/25/2023
4.0.54 200 9/22/2023
4.0.53 206 9/20/2023
4.0.52 198 9/19/2023
4.0.51 195 9/18/2023
4.0.50 177 9/18/2023
4.0.49 238 9/14/2023
4.0.48 213 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 292 9/7/2023
4.0.42 178 9/6/2023
4.0.41 239 9/5/2023
4.0.40 185 9/4/2023
4.0.39 191 9/4/2023
4.0.38 225 9/1/2023
4.0.37 233 8/31/2023
4.0.36 222 8/30/2023
4.0.35 242 8/29/2023
4.0.34 177 8/29/2023
4.0.33 260 8/28/2023
4.0.32 240 8/25/2023
4.0.31 230 8/24/2023
4.0.30 212 8/23/2023
4.0.29 221 8/22/2023
4.0.28 223 8/18/2023
4.0.27 232 8/17/2023
4.0.26 211 8/17/2023
4.0.25 196 8/16/2023
4.0.24 289 8/10/2023
4.0.23 244 8/9/2023
4.0.22 240 8/8/2023
4.0.21 216 8/8/2023
4.0.20 327 8/7/2023
4.0.19 224 8/4/2023
4.0.18 283 8/3/2023
4.0.17 253 8/2/2023
4.0.16 258 7/26/2023
4.0.15 239 7/25/2023
4.0.14 259 7/20/2023
4.0.13 249 7/19/2023
4.0.12 235 7/18/2023
4.0.11 185 7/18/2023
4.0.10 241 7/18/2023
4.0.9 196 7/18/2023
4.0.8 309 7/17/2023
4.0.7 207 7/17/2023
4.0.6 580 1/30/2023
4.0.5 442 1/30/2023
4.0.4 443 1/27/2023
4.0.3 552 12/13/2022
4.0.0 357 12/12/2022
3.0.47 1,566 6/10/2022
3.0.45 1,033 4/20/2022
3.0.44 1,056 1/11/2022
3.0.43 675 1/10/2022
3.0.42 1,151 6/17/2021
3.0.41 802 6/16/2021
3.0.40 766 6/16/2021
3.0.39 557 6/16/2021
3.0.38 1,071 1/7/2021
3.0.37 887 12/16/2020
3.0.36 818 12/14/2020
3.0.35 2,366 9/13/2020
3.0.34 943 6/19/2020
3.0.33 1,935 5/12/2020
3.0.32 1,458 5/12/2020
3.0.31 949 4/28/2020
3.0.30 902 4/24/2020
3.0.29 887 4/16/2020
3.0.28 957 4/16/2020
3.0.27 631 4/15/2020
3.0.26 922 4/15/2020
3.0.25 982 4/14/2020
3.0.24 671 4/14/2020
3.0.23 1,012 4/10/2020
3.0.22 959 4/10/2020
3.0.21 995 4/7/2020
3.0.20 2,816 3/26/2020
3.0.19 986 3/26/2020
3.0.18 651 3/25/2020
3.0.17 652 3/25/2020
3.0.16 661 3/25/2020
3.0.15 678 3/25/2020
3.0.13 667 3/25/2020
3.0.12 676 3/25/2020
3.0.11 644 3/25/2020
3.0.10 1,199 3/25/2020
3.0.9 1,020 3/22/2020
3.0.8 636 3/22/2020
3.0.7 1,018 3/21/2020
3.0.6 1,657 3/13/2020
3.0.5 685 3/13/2020
3.0.4 1,400 2/28/2020
3.0.3 1,252 2/21/2020
3.0.2 706 2/11/2020
3.0.1 681 2/11/2020
3.0.0 1,851 12/23/2019
2.0.13 702 11/4/2019
2.0.12 781 6/19/2019
2.0.11 757 6/19/2019
2.0.10 1,055 4/17/2019
2.0.9 1,616 2/21/2019
2.0.8 4,036 8/1/2018
2.0.7 1,380 8/1/2018
2.0.6 1,863 6/26/2018
2.0.5 1,227 6/14/2018
2.0.4 1,818 6/1/2018
2.0.3 1,781 5/22/2018
2.0.2 2,368 5/11/2018
2.0.1 2,444 2/13/2018
2.0.0 2,345 1/2/2018
1.0.29 3,982 11/16/2017
1.0.28 1,095 11/16/2017
1.0.27 6,502 10/18/2017
1.0.26 4,701 9/22/2017
1.0.24 1,166 9/22/2017
1.0.23 1,508 9/22/2017
1.0.22 1,173 9/22/2017
1.0.21 1,184 9/22/2017
1.0.19 1,189 9/22/2017
1.0.18 1,180 9/21/2017
1.0.17 2,226 8/4/2017
1.0.16 1,192 7/3/2017
1.0.15 1,209 6/16/2017
1.0.13 1,203 6/16/2017
1.0.12 1,189 6/16/2017
1.0.11 1,209 5/30/2017
1.0.9 1,199 5/25/2017
1.0.8 1,184 5/24/2017
1.0.7 1,210 5/19/2017
1.0.6 1,247 5/17/2017
1.0.4 1,308 4/3/2017
1.0.3 1,318 3/22/2017
1.0.2 1,306 2/2/2017