DataDictionaryGenerator 1.0.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package DataDictionaryGenerator --version 1.0.0
                    


                    

                
NuGet\Install-Package DataDictionaryGenerator -Version 1.0.0
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="DataDictionaryGenerator" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="DataDictionaryGenerator" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="DataDictionaryGenerator" />
                    


                            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 DataDictionaryGenerator --version 1.0.0
                    


                    

                
#r "nuget: DataDictionaryGenerator, 1.0.0"
#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 DataDictionaryGenerator@1.0.0
#: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=DataDictionaryGenerator&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=DataDictionaryGenerator&version=1.0.0
                    


                            Install as a Cake Tool

Data Dictionary Generator

This library creates a rich data dictionary from a provided Entity Framework Core DbContext.

The intended use case is to provide users with a thorough description of a database without needing to read code. The generated data dictionary includes information from System.ComponentModel.DataAnnotations annotations that provides greater detail than just inspecting the SQL schema.

Generated fields include:

  • Entity name
  • Table name (for table per hierarchy)
  • Field display name
  • Field description
  • Mapped SQL column type
  • CLR type
  • Constraints (validation attributes)
  • Collected from/until dates (using additional attributes)
  • Nullability
  • Foreign keys (non-composite)
  • Options (when using enum fields)
  • Uniqueness
  • Default SQL values

The library contains built-in outputs to:

  • CSV
  • Word (docx)

The underlying DataDictionary object can be used to output the data dictionary in customised ways, such as an ASP.NET page or as part of an API.

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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 2,394 12/7/2021