SchemaSaurus.Metadata 1.4.6

SchemaSaurus

SchemaSaurus is a .NET library for capturing a complete, immutable snapshot of a relational database's structural metadata — tables, views, indexes, foreign keys, stored procedures, functions, sequences, and user-defined types — into a single, JSON-serializable object graph.

It is designed for tools that need a stable, provider-agnostic view of a database schema: code generators, ORM tooling, migration diffing, documentation generation, and schema visualization.

Package	Version
SchemaSaurus.Metadata
SchemaSaurus.SqlServer
SchemaSaurus.PostgreSql
SchemaSaurus.MySql
SchemaSaurus.Oracle
SchemaSaurus.Sqlite

Features

• Immutable, JSON round-trippable model rooted at DatabaseModel with structural equality.
• Provider-agnostic abstraction via IDatabaseSchemaReader — a single API across every supported engine.
• Rich metadata coverage — tables, columns, primary keys, unique constraints, check constraints, indexes, foreign keys, views, stored procedures, scalar and table-valued functions, sequences, user-defined types, and triggers.
• Filtering by schema, table, and object kind through SchemaReaderOptions.
• Visitor pattern (DatabaseVisitor) for walking the model in code generators and analyzers.
• Annotations on every metadata element for engine-specific extensions (collation, identity, extended properties, etc.).
• Multi-target — netstandard2.0, net462, net8.0, net9.0, and net10.0.

Supported Providers

All providers depend on the shared SchemaSaurus.Metadata package, which defines the model and abstractions.

Installation

Install the metadata package plus the provider for your target engine:

dotnet add package SchemaSaurus.Metadata
dotnet add package SchemaSaurus.SqlServer

Quick Start

using SchemaSaurus.Metadata;
using SchemaSaurus.Metadata.Provider;
using SchemaSaurus.SqlServer;

IDatabaseSchemaReader reader = new SqlServerSchemaReader();

DatabaseModel model = await reader.ReadAsync("Server=.;Database=AdventureWorks;Integrated Security=true;TrustServerCertificate=true");

Console.WriteLine($"{model.DatabaseName} ({model.Provider} {model.ServerVersion})");
Console.WriteLine($"Tables: {model.Tables.Count}, Views: {model.Views.Count}");

Filtering

var options = new SchemaReaderOptions
{
    Schemas = ["dbo", "Sales"],
    Tables = ["Customer", "Sales.Orders"],
    IncludeStoredProcedures = false,
    IncludeScalarFunctions = false,
};

var model = await reader.ReadAsync(connectionString, options);

Tables entries may be schema qualified ("Sales.Orders"), which pins the table to that schema; the first dot separates the schema from the table name. Unqualified entries ("Customer") match that name in any schema.

Names are passed to the database as written and compared with its own identifier rules. A PostgreSQL table created unquoted as Sales.Orders is stored as sales.orders and has to be filtered with that spelling; quoted identifiers keep their case.

JSON Serialization

The model uses source-generated System.Text.Json serialization via MetadataJsonContext for AOT-friendly, allocation-light round-tripping.

using System.Text.Json;
using SchemaSaurus.Metadata;

string json = JsonSerializer.Serialize(model, MetadataJsonContext.Default.DatabaseModel);
DatabaseModel restored = JsonSerializer.Deserialize(json, MetadataJsonContext.Default.DatabaseModel)!;

Command Line Export

Install SchemaSaurus as a .NET tool, then use the export command to capture database metadata as JSON.

dotnet tool install --global SchemaSaurus

Write JSON to a file with -o / --output:

SchemaSaurus export -c "Server=.;Database=AdventureWorks;Integrated Security=true;TrustServerCertificate=true" -p SqlServer -o .\schema.json

When --output is omitted, JSON is written to stdout for piping or redirection:

SchemaSaurus export -c "Data Source=.\sample.db" -p SQLite | jq .databaseName

Supported providers are SqlServer, PostgreSQL, MySQL, Oracle, and SQLite.

Filter the exported metadata with --schema and --table, and exclude object types with boolean switches:

SchemaSaurus export -c "Server=.;Database=AdventureWorks;Integrated Security=true;TrustServerCertificate=true" -p SqlServer -o .\schema.json --schema dbo --table Customer --table Sales.Orders --exclude-stored-procedures --exclude-sequences

Available exclusion switches are --exclude-views, --exclude-stored-procedures, --exclude-scalar-functions, --exclude-table-valued-functions, --exclude-sequences, and --exclude-user-defined-types.

Visitor

Walk the model to drive code generation or analysis:

public sealed class TableLogger : DatabaseVisitor
{
    protected override void VisitTable(Table table)
    {
        Console.WriteLine($"{table.Name} ({table.Columns.Count} columns)");
        base.VisitTable(table);
    }
}

new TableLogger().VisitDatabase(model);

Model Overview

DatabaseModel is a flat container — every object carries its own SchemaQualifiedName, so consumers can group or filter by schema without traversing a hierarchy.

• Tables → Columns, PrimaryKey, UniqueConstraints, CheckConstraints, Indexes, ForeignKeys, Triggers
• Views → Columns, Definition
• StoredProcedures / ScalarFunctions / TableValuedFunctions → Parameters, ReturnColumns, Definition
• Sequences, UserDefinedTypes

Every metadata element implements IAnnotatable for engine-specific extension data.

License

MIT © LoreSoft