Data.Modeler 4.0.191

There is a newer version of this package available.
See the version list below for details.
dotnet add package Data.Modeler --version 4.0.191
                    
NuGet\Install-Package Data.Modeler -Version 4.0.191
                    
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.191" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Data.Modeler" Version="4.0.191" />
                    
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 4.0.191
                    
#r "nuget: Data.Modeler, 4.0.191"
                    
#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=4.0.191
                    
Install Data.Modeler as a Cake Addin
#tool nuget:?package=Data.Modeler&version=4.0.191
                    
Install Data.Modeler 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 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.  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.34 38 6/10/2025
5.0.33 73 5/30/2025
5.0.32 82 5/23/2025
5.0.31 222 5/14/2025
5.0.30 105 5/2/2025
5.0.29 159 4/28/2025
5.0.28 109 4/11/2025
5.0.27 151 3/17/2025
5.0.26 120 2/24/2025
5.0.25 150 2/12/2025
5.0.24 231 2/3/2025
5.0.23 168 1/30/2025
5.0.22 126 1/29/2025
5.0.21 96 1/29/2025
5.0.20 125 1/28/2025
5.0.19 120 1/24/2025
5.0.18 128 1/23/2025
5.0.17 105 1/23/2025
5.0.16 147 1/16/2025
5.0.15 125 1/15/2025
5.0.14 106 1/14/2025
5.0.13 112 1/13/2025
5.0.12 114 1/10/2025
5.0.11 124 1/9/2025
5.0.10 98 1/8/2025
5.0.9 181 12/17/2024
5.0.8 109 12/17/2024
5.0.7 158 12/10/2024
5.0.6 121 12/9/2024
5.0.5 187 11/26/2024
5.0.4 152 11/26/2024
5.0.3 107 11/25/2024
5.0.2 140 11/24/2024
5.0.1 125 11/23/2024
5.0.0 120 11/23/2024
4.0.268 134 11/19/2024
4.0.267 119 11/11/2024
4.0.266 109 11/6/2024
4.0.265 107 11/5/2024
4.0.264 111 11/4/2024
4.0.263 120 11/1/2024
4.0.262 110 10/31/2024
4.0.261 114 10/30/2024
4.0.260 111 10/29/2024
4.0.259 109 10/29/2024
4.0.258 118 10/25/2024
4.0.257 110 10/24/2024
4.0.256 110 10/21/2024
4.0.255 123 10/16/2024
4.0.254 103 10/15/2024
4.0.253 113 10/11/2024
4.0.252 110 10/10/2024
4.0.251 115 10/9/2024
4.0.250 122 10/8/2024
4.0.249 113 10/2/2024
4.0.248 113 10/1/2024
4.0.247 117 9/30/2024
4.0.246 120 9/27/2024
4.0.245 115 9/24/2024
4.0.244 126 9/23/2024
4.0.243 112 9/23/2024
4.0.242 152 9/17/2024
4.0.241 139 9/10/2024
4.0.240 124 9/9/2024
4.0.239 123 9/6/2024
4.0.238 132 9/5/2024
4.0.237 133 9/3/2024
4.0.236 134 9/2/2024
4.0.235 134 8/30/2024
4.0.234 130 8/29/2024
4.0.233 130 8/28/2024
4.0.232 132 8/27/2024
4.0.231 137 8/26/2024
4.0.230 153 8/23/2024
4.0.229 146 8/22/2024
4.0.228 147 8/21/2024
4.0.227 150 8/20/2024
4.0.226 148 8/20/2024
4.0.225 168 8/19/2024
4.0.224 161 8/16/2024
4.0.223 140 8/15/2024
4.0.222 159 8/14/2024
4.0.221 124 8/5/2024
4.0.220 122 8/2/2024
4.0.219 132 8/1/2024
4.0.218 111 7/31/2024
4.0.217 131 7/26/2024
4.0.216 108 7/25/2024
4.0.215 85 7/24/2024
4.0.214 140 7/11/2024
4.0.213 124 7/10/2024
4.0.212 115 7/9/2024
4.0.211 116 7/9/2024
4.0.210 122 7/8/2024
4.0.209 137 7/5/2024
4.0.208 128 7/5/2024
4.0.207 127 7/2/2024
4.0.206 120 7/1/2024
4.0.205 138 6/27/2024
4.0.204 128 6/26/2024
4.0.203 138 6/25/2024
4.0.202 130 6/24/2024
4.0.201 1,017 6/19/2024
4.0.200 140 6/18/2024
4.0.199 119 6/17/2024
4.0.198 124 6/14/2024
4.0.197 121 6/13/2024
4.0.196 130 6/12/2024
4.0.195 145 6/3/2024
4.0.194 129 5/31/2024
4.0.193 144 5/30/2024
4.0.192 128 5/29/2024
4.0.191 154 5/27/2024
4.0.190 123 5/27/2024
4.0.189 124 5/23/2024
4.0.188 136 5/22/2024
4.0.187 168 5/21/2024
4.0.186 138 5/20/2024
4.0.185 148 5/17/2024
4.0.184 143 5/16/2024
4.0.183 146 5/15/2024
4.0.182 143 5/8/2024
4.0.181 131 5/7/2024
4.0.180 139 5/6/2024
4.0.179 143 5/3/2024
4.0.178 705 5/2/2024
4.0.177 109 5/1/2024
4.0.176 135 4/30/2024
4.0.175 135 4/29/2024
4.0.174 133 4/29/2024
4.0.173 141 4/25/2024
4.0.172 138 4/24/2024
4.0.171 147 4/16/2024
4.0.170 145 4/15/2024
4.0.169 128 4/12/2024
4.0.168 129 4/12/2024
4.0.167 147 4/11/2024
4.0.166 158 4/10/2024
4.0.165 144 4/9/2024
4.0.164 148 4/8/2024
4.0.163 144 4/1/2024
4.0.162 130 3/29/2024
4.0.161 136 3/28/2024
4.0.160 127 3/26/2024
4.0.159 155 3/23/2024
4.0.158 148 3/22/2024
4.0.157 139 3/21/2024
4.0.156 130 3/18/2024
4.0.155 160 3/15/2024
4.0.154 145 3/14/2024
4.0.153 154 3/13/2024
4.0.152 162 3/11/2024
4.0.151 146 3/8/2024
4.0.150 149 3/7/2024
4.0.149 143 3/6/2024
4.0.148 146 3/5/2024
4.0.147 968 3/4/2024
4.0.146 167 3/1/2024
4.0.145 162 2/29/2024
4.0.144 155 2/28/2024
4.0.143 165 2/27/2024
4.0.142 150 2/26/2024
4.0.141 178 2/23/2024
4.0.140 157 2/22/2024
4.0.139 156 2/21/2024
4.0.138 163 2/20/2024
4.0.137 406 2/19/2024
4.0.136 141 2/19/2024
4.0.135 136 2/16/2024
4.0.134 140 2/16/2024
4.0.133 141 2/15/2024
4.0.132 147 2/14/2024
4.0.131 137 2/13/2024
4.0.130 166 2/12/2024
4.0.129 141 2/9/2024
4.0.128 177 2/8/2024
4.0.127 145 2/7/2024
4.0.126 154 2/6/2024
4.0.125 124 2/6/2024
4.0.124 134 2/5/2024
4.0.123 491 2/2/2024
4.0.122 143 2/1/2024
4.0.121 137 2/1/2024
4.0.120 151 1/31/2024
4.0.119 224 1/30/2024
4.0.118 147 1/29/2024
4.0.117 164 1/26/2024
4.0.116 137 1/24/2024
4.0.115 131 1/23/2024
4.0.114 138 1/22/2024
4.0.113 334 1/16/2024
4.0.112 177 1/15/2024
4.0.111 154 1/15/2024
4.0.110 152 1/12/2024
4.0.109 132 1/11/2024
4.0.108 145 1/10/2024
4.0.107 323 1/8/2024
4.0.106 200 1/5/2024
4.0.105 333 12/26/2023
4.0.104 159 12/26/2023
4.0.103 187 12/25/2023
4.0.102 158 12/25/2023
4.0.101 241 12/22/2023
4.0.100 183 12/21/2023
4.0.99 205 12/15/2023
4.0.98 162 12/14/2023
4.0.97 145 12/13/2023
4.0.96 171 12/13/2023
4.0.95 332 12/12/2023
4.0.94 162 12/12/2023
4.0.93 166 12/11/2023
4.0.92 162 12/11/2023
4.0.91 215 12/6/2023
4.0.90 165 12/6/2023
4.0.89 156 12/5/2023
4.0.88 213 12/4/2023
4.0.87 221 11/24/2023
4.0.86 174 11/23/2023
4.0.85 161 11/21/2023
4.0.84 171 11/20/2023
4.0.83 160 11/20/2023
4.0.82 197 11/17/2023
4.0.81 657 11/16/2023
4.0.80 166 11/15/2023
4.0.79 174 11/13/2023
4.0.78 184 11/9/2023
4.0.77 197 11/8/2023
4.0.76 149 11/8/2023
4.0.75 158 11/7/2023
4.0.74 178 11/6/2023
4.0.73 174 11/3/2023
4.0.72 209 11/2/2023
4.0.71 160 11/1/2023
4.0.70 155 11/1/2023
4.0.69 193 10/31/2023
4.0.68 182 10/30/2023
4.0.67 185 10/27/2023
4.0.66 184 10/26/2023
4.0.65 192 10/25/2023
4.0.64 188 10/17/2023
4.0.63 147 10/17/2023
4.0.62 208 10/16/2023
4.0.61 211 10/13/2023
4.0.60 222 10/12/2023
4.0.59 174 10/11/2023
4.0.58 208 10/5/2023
4.0.57 177 10/4/2023
4.0.56 172 9/26/2023
4.0.55 174 9/25/2023
4.0.54 192 9/22/2023
4.0.53 191 9/20/2023
4.0.52 186 9/19/2023
4.0.51 188 9/18/2023
4.0.50 168 9/18/2023
4.0.49 231 9/14/2023
4.0.48 199 9/13/2023
4.0.47 173 9/12/2023
4.0.46 255 9/11/2023
4.0.45 168 9/11/2023
4.0.44 161 9/11/2023
4.0.43 283 9/7/2023
4.0.42 169 9/6/2023
4.0.41 226 9/5/2023
4.0.40 178 9/4/2023
4.0.39 177 9/4/2023
4.0.38 212 9/1/2023
4.0.37 222 8/31/2023
4.0.36 210 8/30/2023
4.0.35 233 8/29/2023
4.0.34 165 8/29/2023
4.0.33 251 8/28/2023
4.0.32 228 8/25/2023
4.0.31 221 8/24/2023
4.0.30 205 8/23/2023
4.0.29 214 8/22/2023
4.0.28 216 8/18/2023
4.0.27 217 8/17/2023
4.0.26 201 8/17/2023
4.0.25 189 8/16/2023
4.0.24 277 8/10/2023
4.0.23 235 8/9/2023
4.0.22 225 8/8/2023
4.0.21 206 8/8/2023
4.0.20 318 8/7/2023
4.0.19 215 8/4/2023
4.0.18 274 8/3/2023
4.0.17 241 8/2/2023
4.0.16 245 7/26/2023
4.0.15 228 7/25/2023
4.0.14 250 7/20/2023
4.0.13 232 7/19/2023
4.0.12 224 7/18/2023
4.0.11 175 7/18/2023
4.0.10 232 7/18/2023
4.0.9 187 7/18/2023
4.0.8 298 7/17/2023
4.0.7 194 7/17/2023
4.0.6 570 1/30/2023
4.0.5 427 1/30/2023
4.0.4 433 1/27/2023
4.0.3 538 12/13/2022
4.0.0 349 12/12/2022
3.0.47 1,553 6/10/2022
3.0.45 1,017 4/20/2022
3.0.44 1,039 1/11/2022
3.0.43 660 1/10/2022
3.0.42 1,137 6/17/2021
3.0.41 787 6/16/2021
3.0.40 752 6/16/2021
3.0.39 541 6/16/2021
3.0.38 1,036 1/7/2021
3.0.37 868 12/16/2020
3.0.36 803 12/14/2020
3.0.35 2,351 9/13/2020
3.0.34 919 6/19/2020
3.0.33 1,917 5/12/2020
3.0.32 1,437 5/12/2020
3.0.31 933 4/28/2020
3.0.30 887 4/24/2020
3.0.29 871 4/16/2020
3.0.28 942 4/16/2020
3.0.27 615 4/15/2020
3.0.26 905 4/15/2020
3.0.25 967 4/14/2020
3.0.24 649 4/14/2020
3.0.23 994 4/10/2020
3.0.22 940 4/10/2020
3.0.21 975 4/7/2020
3.0.20 2,801 3/26/2020
3.0.19 969 3/26/2020
3.0.18 634 3/25/2020
3.0.17 636 3/25/2020
3.0.16 645 3/25/2020
3.0.15 663 3/25/2020
3.0.13 647 3/25/2020
3.0.12 660 3/25/2020
3.0.11 629 3/25/2020
3.0.10 1,184 3/25/2020
3.0.9 1,003 3/22/2020
3.0.8 618 3/22/2020
3.0.7 1,000 3/21/2020
3.0.6 1,642 3/13/2020
3.0.5 663 3/13/2020
3.0.4 1,381 2/28/2020
3.0.3 1,237 2/21/2020
3.0.2 690 2/11/2020
3.0.1 665 2/11/2020
3.0.0 1,836 12/23/2019
2.0.13 683 11/4/2019
2.0.12 757 6/19/2019
2.0.11 740 6/19/2019
2.0.10 1,035 4/17/2019
2.0.9 1,599 2/21/2019
2.0.8 4,004 8/1/2018
2.0.7 1,347 8/1/2018
2.0.6 1,811 6/26/2018
2.0.5 1,179 6/14/2018
2.0.4 1,767 6/1/2018
2.0.3 1,730 5/22/2018
2.0.2 2,318 5/11/2018
2.0.1 2,392 2/13/2018
2.0.0 2,294 1/2/2018
1.0.29 3,945 11/16/2017
1.0.28 1,056 11/16/2017
1.0.27 6,468 10/18/2017
1.0.26 4,666 9/22/2017
1.0.24 1,129 9/22/2017
1.0.23 1,469 9/22/2017
1.0.22 1,138 9/22/2017
1.0.21 1,145 9/22/2017
1.0.19 1,151 9/22/2017
1.0.18 1,145 9/21/2017
1.0.17 2,191 8/4/2017
1.0.16 1,153 7/3/2017
1.0.15 1,173 6/16/2017
1.0.13 1,164 6/16/2017
1.0.12 1,155 6/16/2017
1.0.11 1,176 5/30/2017
1.0.9 1,165 5/25/2017
1.0.8 1,150 5/24/2017
1.0.7 1,176 5/19/2017
1.0.6 1,212 5/17/2017
1.0.4 1,272 4/3/2017
1.0.3 1,279 3/22/2017
1.0.2 1,268 2/2/2017