SQLServerSchemaExtractor 1.0.0

There is a newer version of this package available.
See the version list below for details.

dotnet add package SQLServerSchemaExtractor --version 1.0.0

NuGet\Install-Package SQLServerSchemaExtractor -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="SQLServerSchemaExtractor" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="SQLServerSchemaExtractor" Version="1.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="SQLServerSchemaExtractor" />
                    

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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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

                            Install as a Cake Addin

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

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

SQL Server Schema Extractor

A .NET tool for extracting SQL Server database schemas and serializing them to JSON or YAML. Designed for reverse engineering, documentation, and seamless integration with natural language to SQL (NL2SQL) systems powered by large language models (LLMs).

Features

Extracts schema from SQL Server databases.
Outputs schema in JSON or YAML format.
Configurable via appsettings.json.

Usage

Configure Connection and Schema

Edit appsettings.json (or appsettings.Local.json) to set your database connection and schema extraction options:

   "DatabaseConnection": "your-connection-string-here",
   "Nl2SqlConfig": {
     "database": {
     "description": "Your database description",
     "schemas": [
       {
         "name": "SchemaName",
         "tables": [
           "Table1",
           "Table2"
         ]
       }
     ]
   }
 }

Run the Extractor

Build and run the SqlSchemaProviderHarnessTester project: dotnet run --project SqlSchemaProviderHarnessTester

The tool will connect to your database, extract the schema, and print the result as JSON.

Product	Compatible and additional computed target framework versions.
.NET	net9.0 is compatible. 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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net9.0
- Microsoft.Data.SqlClient (>= 6.0.2)
- System.Linq.Async (>= 6.0.1)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.