Data.Modeler 5.0.5

There is a newer version of this package available.
See the version list below for details.
dotnet add package Data.Modeler --version 5.0.5
                    
NuGet\Install-Package Data.Modeler -Version 5.0.5
                    
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.5" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Data.Modeler" Version="5.0.5" />
                    
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.5
                    
#r "nuget: Data.Modeler, 5.0.5"
                    
#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.5
                    
Install as a Cake Addin
#tool nuget:?package=Data.Modeler&version=5.0.5
                    
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.41 27 6/27/2025
5.0.40 73 6/27/2025
5.0.39 75 6/27/2025
5.0.38 75 6/27/2025
5.0.37 76 6/27/2025
5.0.36 87 6/26/2025
5.0.35 132 6/18/2025
5.0.34 284 6/10/2025
5.0.33 86 5/30/2025
5.0.32 92 5/23/2025
5.0.31 231 5/14/2025
5.0.30 110 5/2/2025
5.0.29 164 4/28/2025
5.0.28 117 4/11/2025
5.0.27 156 3/17/2025
5.0.26 126 2/24/2025
5.0.25 152 2/12/2025
5.0.24 247 2/3/2025
5.0.23 170 1/30/2025
5.0.22 136 1/29/2025
5.0.21 101 1/29/2025
5.0.20 127 1/28/2025
5.0.19 123 1/24/2025
5.0.18 132 1/23/2025
5.0.17 108 1/23/2025
5.0.16 151 1/16/2025
5.0.15 128 1/15/2025
5.0.14 108 1/14/2025
5.0.13 116 1/13/2025
5.0.12 118 1/10/2025
5.0.11 126 1/9/2025
5.0.10 103 1/8/2025
5.0.9 184 12/17/2024
5.0.8 117 12/17/2024
5.0.7 162 12/10/2024
5.0.6 123 12/9/2024
5.0.5 189 11/26/2024
5.0.4 156 11/26/2024
5.0.3 110 11/25/2024
5.0.2 147 11/24/2024
5.0.1 129 11/23/2024
5.0.0 123 11/23/2024
4.0.268 144 11/19/2024
4.0.267 121 11/11/2024
4.0.266 114 11/6/2024
4.0.265 112 11/5/2024
4.0.264 113 11/4/2024
4.0.263 129 11/1/2024
4.0.262 116 10/31/2024
4.0.261 120 10/30/2024
4.0.260 116 10/29/2024
4.0.259 115 10/29/2024
4.0.258 125 10/25/2024
4.0.257 112 10/24/2024
4.0.256 118 10/21/2024
4.0.255 130 10/16/2024
4.0.254 110 10/15/2024
4.0.253 121 10/11/2024
4.0.252 117 10/10/2024
4.0.251 118 10/9/2024
4.0.250 129 10/8/2024
4.0.249 127 10/2/2024
4.0.248 125 10/1/2024
4.0.247 120 9/30/2024
4.0.246 130 9/27/2024
4.0.245 122 9/24/2024
4.0.244 132 9/23/2024
4.0.243 118 9/23/2024
4.0.242 158 9/17/2024
4.0.241 149 9/10/2024
4.0.240 126 9/9/2024
4.0.239 129 9/6/2024
4.0.238 136 9/5/2024
4.0.237 138 9/3/2024
4.0.236 138 9/2/2024
4.0.235 138 8/30/2024
4.0.234 134 8/29/2024
4.0.233 137 8/28/2024
4.0.232 138 8/27/2024
4.0.231 141 8/26/2024
4.0.230 157 8/23/2024
4.0.229 152 8/22/2024
4.0.228 153 8/21/2024
4.0.227 154 8/20/2024
4.0.226 151 8/20/2024
4.0.225 172 8/19/2024
4.0.224 165 8/16/2024
4.0.223 147 8/15/2024
4.0.222 169 8/14/2024
4.0.221 129 8/5/2024
4.0.220 125 8/2/2024
4.0.219 145 8/1/2024
4.0.218 116 7/31/2024
4.0.217 135 7/26/2024
4.0.216 113 7/25/2024
4.0.215 88 7/24/2024
4.0.214 143 7/11/2024
4.0.213 128 7/10/2024
4.0.212 119 7/9/2024
4.0.211 124 7/9/2024
4.0.210 124 7/8/2024
4.0.209 145 7/5/2024
4.0.208 139 7/5/2024
4.0.207 129 7/2/2024
4.0.206 122 7/1/2024
4.0.205 149 6/27/2024
4.0.204 137 6/26/2024
4.0.203 142 6/25/2024
4.0.202 138 6/24/2024
4.0.201 1,024 6/19/2024
4.0.200 143 6/18/2024
4.0.199 125 6/17/2024
4.0.198 131 6/14/2024
4.0.197 128 6/13/2024
4.0.196 133 6/12/2024
4.0.195 148 6/3/2024
4.0.194 134 5/31/2024
4.0.193 157 5/30/2024
4.0.192 134 5/29/2024
4.0.191 156 5/27/2024
4.0.190 133 5/27/2024
4.0.189 128 5/23/2024
4.0.188 139 5/22/2024
4.0.187 172 5/21/2024
4.0.186 144 5/20/2024
4.0.185 151 5/17/2024
4.0.184 146 5/16/2024
4.0.183 149 5/15/2024
4.0.182 151 5/8/2024
4.0.181 136 5/7/2024
4.0.180 147 5/6/2024
4.0.179 150 5/3/2024
4.0.178 709 5/2/2024
4.0.177 112 5/1/2024
4.0.176 139 4/30/2024
4.0.175 137 4/29/2024
4.0.174 139 4/29/2024
4.0.173 147 4/25/2024
4.0.172 143 4/24/2024
4.0.171 154 4/16/2024
4.0.170 147 4/15/2024
4.0.169 141 4/12/2024
4.0.168 136 4/12/2024
4.0.167 154 4/11/2024
4.0.166 166 4/10/2024
4.0.165 148 4/9/2024
4.0.164 154 4/8/2024
4.0.163 151 4/1/2024
4.0.162 132 3/29/2024
4.0.161 144 3/28/2024
4.0.160 133 3/26/2024
4.0.159 160 3/23/2024
4.0.158 152 3/22/2024
4.0.157 150 3/21/2024
4.0.156 132 3/18/2024
4.0.155 163 3/15/2024
4.0.154 155 3/14/2024
4.0.153 160 3/13/2024
4.0.152 168 3/11/2024
4.0.151 151 3/8/2024
4.0.150 154 3/7/2024
4.0.149 145 3/6/2024
4.0.148 155 3/5/2024
4.0.147 972 3/4/2024
4.0.146 169 3/1/2024
4.0.145 165 2/29/2024
4.0.144 164 2/28/2024
4.0.143 170 2/27/2024
4.0.142 160 2/26/2024
4.0.141 183 2/23/2024
4.0.140 167 2/22/2024
4.0.139 158 2/21/2024
4.0.138 169 2/20/2024
4.0.137 410 2/19/2024
4.0.136 144 2/19/2024
4.0.135 140 2/16/2024
4.0.134 143 2/16/2024
4.0.133 147 2/15/2024
4.0.132 153 2/14/2024
4.0.131 143 2/13/2024
4.0.130 173 2/12/2024
4.0.129 146 2/9/2024
4.0.128 186 2/8/2024
4.0.127 150 2/7/2024
4.0.126 161 2/6/2024
4.0.125 126 2/6/2024
4.0.124 139 2/5/2024
4.0.123 505 2/2/2024
4.0.122 154 2/1/2024
4.0.121 140 2/1/2024
4.0.120 159 1/31/2024
4.0.119 227 1/30/2024
4.0.118 155 1/29/2024
4.0.117 171 1/26/2024
4.0.116 145 1/24/2024
4.0.115 136 1/23/2024
4.0.114 144 1/22/2024
4.0.113 340 1/16/2024
4.0.112 183 1/15/2024
4.0.111 163 1/15/2024
4.0.110 156 1/12/2024
4.0.109 142 1/11/2024
4.0.108 148 1/10/2024
4.0.107 329 1/8/2024
4.0.106 211 1/5/2024
4.0.105 336 12/26/2023
4.0.104 165 12/26/2023
4.0.103 190 12/25/2023
4.0.102 167 12/25/2023
4.0.101 248 12/22/2023
4.0.100 188 12/21/2023
4.0.99 208 12/15/2023
4.0.98 171 12/14/2023
4.0.97 151 12/13/2023
4.0.96 176 12/13/2023
4.0.95 334 12/12/2023
4.0.94 164 12/12/2023
4.0.93 173 12/11/2023
4.0.92 166 12/11/2023
4.0.91 223 12/6/2023
4.0.90 167 12/6/2023
4.0.89 160 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 167 11/21/2023
4.0.84 174 11/20/2023
4.0.83 165 11/20/2023
4.0.82 205 11/17/2023
4.0.81 663 11/16/2023
4.0.80 175 11/15/2023
4.0.79 176 11/13/2023
4.0.78 187 11/9/2023
4.0.77 199 11/8/2023
4.0.76 152 11/8/2023
4.0.75 169 11/7/2023
4.0.74 183 11/6/2023
4.0.73 177 11/3/2023
4.0.72 214 11/2/2023
4.0.71 167 11/1/2023
4.0.70 160 11/1/2023
4.0.69 201 10/31/2023
4.0.68 188 10/30/2023
4.0.67 189 10/27/2023
4.0.66 191 10/26/2023
4.0.65 198 10/25/2023
4.0.64 191 10/17/2023
4.0.63 153 10/17/2023
4.0.62 211 10/16/2023
4.0.61 214 10/13/2023
4.0.60 227 10/12/2023
4.0.59 178 10/11/2023
4.0.58 211 10/5/2023
4.0.57 185 10/4/2023
4.0.56 176 9/26/2023
4.0.55 179 9/25/2023
4.0.54 195 9/22/2023
4.0.53 202 9/20/2023
4.0.52 193 9/19/2023
4.0.51 191 9/18/2023
4.0.50 171 9/18/2023
4.0.49 234 9/14/2023
4.0.48 209 9/13/2023
4.0.47 176 9/12/2023
4.0.46 258 9/11/2023
4.0.45 171 9/11/2023
4.0.44 164 9/11/2023
4.0.43 288 9/7/2023
4.0.42 174 9/6/2023
4.0.41 234 9/5/2023
4.0.40 181 9/4/2023
4.0.39 187 9/4/2023
4.0.38 221 9/1/2023
4.0.37 227 8/31/2023
4.0.36 218 8/30/2023
4.0.35 236 8/29/2023
4.0.34 172 8/29/2023
4.0.33 255 8/28/2023
4.0.32 235 8/25/2023
4.0.31 226 8/24/2023
4.0.30 208 8/23/2023
4.0.29 217 8/22/2023
4.0.28 219 8/18/2023
4.0.27 226 8/17/2023
4.0.26 206 8/17/2023
4.0.25 192 8/16/2023
4.0.24 284 8/10/2023
4.0.23 239 8/9/2023
4.0.22 233 8/8/2023
4.0.21 212 8/8/2023
4.0.20 323 8/7/2023
4.0.19 220 8/4/2023
4.0.18 279 8/3/2023
4.0.17 249 8/2/2023
4.0.16 253 7/26/2023
4.0.15 235 7/25/2023
4.0.14 255 7/20/2023
4.0.13 243 7/19/2023
4.0.12 229 7/18/2023
4.0.11 181 7/18/2023
4.0.10 237 7/18/2023
4.0.9 192 7/18/2023
4.0.8 304 7/17/2023
4.0.7 202 7/17/2023
4.0.6 576 1/30/2023
4.0.5 438 1/30/2023
4.0.4 439 1/27/2023
4.0.3 546 12/13/2022
4.0.0 353 12/12/2022
3.0.47 1,562 6/10/2022
3.0.45 1,028 4/20/2022
3.0.44 1,050 1/11/2022
3.0.43 670 1/10/2022
3.0.42 1,147 6/17/2021
3.0.41 798 6/16/2021
3.0.40 762 6/16/2021
3.0.39 553 6/16/2021
3.0.38 1,066 1/7/2021
3.0.37 882 12/16/2020
3.0.36 814 12/14/2020
3.0.35 2,362 9/13/2020
3.0.34 938 6/19/2020
3.0.33 1,930 5/12/2020
3.0.32 1,453 5/12/2020
3.0.31 946 4/28/2020
3.0.30 899 4/24/2020
3.0.29 884 4/16/2020
3.0.28 954 4/16/2020
3.0.27 628 4/15/2020
3.0.26 917 4/15/2020
3.0.25 979 4/14/2020
3.0.24 667 4/14/2020
3.0.23 1,008 4/10/2020
3.0.22 955 4/10/2020
3.0.21 991 4/7/2020
3.0.20 2,813 3/26/2020
3.0.19 983 3/26/2020
3.0.18 648 3/25/2020
3.0.17 648 3/25/2020
3.0.16 658 3/25/2020
3.0.15 675 3/25/2020
3.0.13 663 3/25/2020
3.0.12 673 3/25/2020
3.0.11 641 3/25/2020
3.0.10 1,196 3/25/2020
3.0.9 1,016 3/22/2020
3.0.8 633 3/22/2020
3.0.7 1,013 3/21/2020
3.0.6 1,654 3/13/2020
3.0.5 680 3/13/2020
3.0.4 1,397 2/28/2020
3.0.3 1,249 2/21/2020
3.0.2 703 2/11/2020
3.0.1 678 2/11/2020
3.0.0 1,848 12/23/2019
2.0.13 698 11/4/2019
2.0.12 776 6/19/2019
2.0.11 753 6/19/2019
2.0.10 1,052 4/17/2019
2.0.9 1,613 2/21/2019
2.0.8 4,030 8/1/2018
2.0.7 1,374 8/1/2018
2.0.6 1,854 6/26/2018
2.0.5 1,218 6/14/2018
2.0.4 1,807 6/1/2018
2.0.3 1,770 5/22/2018
2.0.2 2,357 5/11/2018
2.0.1 2,432 2/13/2018
2.0.0 2,334 1/2/2018
1.0.29 3,974 11/16/2017
1.0.28 1,088 11/16/2017
1.0.27 6,495 10/18/2017
1.0.26 4,693 9/22/2017
1.0.24 1,159 9/22/2017
1.0.23 1,500 9/22/2017
1.0.22 1,166 9/22/2017
1.0.21 1,176 9/22/2017
1.0.19 1,179 9/22/2017
1.0.18 1,173 9/21/2017
1.0.17 2,219 8/4/2017
1.0.16 1,184 7/3/2017
1.0.15 1,201 6/16/2017
1.0.13 1,193 6/16/2017
1.0.12 1,182 6/16/2017
1.0.11 1,202 5/30/2017
1.0.9 1,191 5/25/2017
1.0.8 1,177 5/24/2017
1.0.7 1,203 5/19/2017
1.0.6 1,239 5/17/2017
1.0.4 1,301 4/3/2017
1.0.3 1,309 3/22/2017
1.0.2 1,299 2/2/2017