SQLServerSchemaExtractor 1.0.2

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher. 
dotnet add package SQLServerSchemaExtractor --version 1.0.2
                    


                    

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


                            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.2
                    


                    

                
#r "nuget: SQLServerSchemaExtractor, 1.0.2"
#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.2
#: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.2
                    


                            Install as a Cake Addin
                        

                    

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


                            Install as a Cake Tool

SQL Server Schema Extractor

A .NET library that extracts SQL Server database schemas and converts them to JSON. The JSON output is designed for use in prompts, allowing large language models (LLMs) to translate natural language queries into SQL statements.

Features

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

Usage

  1. 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"
         ]
       }
     ]
   }
 }

  2. Usage

To support configuration, ASP.NET Core APIs have it built-in, but console apps require adding the Microsoft.Extensions.Configuration package and manually setting up sources like appsettings.json.

var config = configuration.GetSection("Nl2SqlConfig").Get<Nl2SqlConfigRoot>();
var connectionString = configuration["DatabaseConnection"];

var sqlHarness = new SqlSchemaProviderHarness(connectionString, config.Database.Description);
var jsonSchema = await sqlHarness.ReverseEngineerSchemaJSONAsync(config).ConfigureAwait(false);

Additional Notes

Adding column descriptions is crucial for large language models (LLMs) to translate natural language queries into SQL statements accurately.

To add column descriptions to your database metadata, use the sp_addextendedproperty stored procedure.

Example:

EXEC sp_addextendedproperty 
    @name = N'MS_Description', 
    @value = N'This column stores the user email address', 
    @level0type = N'SCHEMA', @level0name = 'dbo',
    @level1type = N'TABLE',  @level1name = 'Users',
    @level2type = N'COLUMN', @level2name = 'Email';
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. 
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.2 361 6/10/2025
1.0.1 309 6/9/2025
1.0.0 196 6/4/2025