DubUrl.Schema 0.107.0

DubUrl.Schema

Provider-neutral database schema models, fluent builders, SQL rendering, discovery mapping, and versioned YAML/JSON documents.

The user documentation is published as part of the single DubUrl website.

Table hierarchies

Use WithHierarchy(new Hierarchy("id")) on a table builder with a single-column scalar primary key. In schema documents, set hierarchy: { nodeKey: id } on the table. The declaration requires database enforcement of parent existence by default.

var renderer = new SchemaScriptRenderer(dialect);
var hierarchies = renderer.PreflightHierarchies(schema);

Preflight reports each table's representation, enforcement, and any diagnostic. It uses the renderer's dialect and options without connecting to a database. A plan with IsSupported set to false prevents DDL generation.

DuckDB generates a nullable parent_id with the node key's type and a self-referencing foreign key in CREATE TABLE. Each row with a null parent is a root. The foreign key checks that parents exist and permits cycles. Insert a parent before any statement that inserts a child referencing it. Set requireParentExists to false to allow storage without enforcement on a target where enforcement is unavailable.

Build and test

dotnet build DubUrl.Schema.sln -c Release
dotnet test DubUrl.Schema.Testing -c Release -f net10.0 --no-build
dotnet test DubUrl.Schema.Documents.Testing -c Release -f net10.0 --no-build

CI selects the newest stable DubUrl version available for every referenced Core and provider package at or above the local baseline. It uses that version throughout build, QA, packaging and consumer checks. Local builds default to published DubUrl 0.60.0, which includes the schema command-plan API. Override -p:DubUrlVersion=<candidate> to validate another compatible release. No companion checkout or local package feed is required. See real-database QA and validation.

Discovery identities preserve provider-native qualifiers: SQLite main and attached aliases belong to MetadataName.Database and DatabaseObjectName.Database; they are not schemas. Use DiscoveryOptions.Databases to select aliases, Schemas for actual schemas, and Catalogs for catalogs. These filters also apply to views and their inventory; table filters can match any combination of literal qualifier components. Referenced-table closure preserves each target's complete identity. Rendered attached names require the same aliases to exist in the destination connection.

Git hooks

Enable the repository's pre-push check after cloning:

git config --local core.hooksPath .githooks
dotnet restore DubUrl.Schema.sln

The hook requires the .NET SDK on PATH and Bash (provided by Git for Windows on Windows). It runs dotnet format DubUrl.Schema.sln analyzers --verify-no-changes --no-restore and rejects pushes with analyzer violations. The StyleCop rules in .editorconfig match Expressif's CodeFactor policy.

To apply available analyzer fixes, run dotnet format DubUrl.Schema.sln analyzers --no-restore, review the changes, and rerun the check. Resolve any remaining diagnostics before pushing.

Source was extracted from Seddryck/DubUrl commit 7606da8d030c869dab0dd9d9946dcdd962dfe000; earlier file history remains available there. Public namespaces, package identities, supported TFMs, and document URLs are preserved.

See provider-owned table definitions and physical options.