schema-sql-generator 0.6.8

A set of tools to manage relational database schemas
Documentation

schema-sql-generator

Generates vendor-specific SQL CREATE statements from a DatabaseModel. Supports PostgreSQL, SQL Server and SQLite with customizable boolean and foreign key handling.

Usage

CLI

cargo run -p schema-sql-generator -- \
  --database-type postgresql \
  --schema-file schema.xml \
  --foreign-key-mode relations \
  --boolean-mode native \
  --output-mode all \
  --postgresql-version 17

Arguments:

  • --database-type (required): postgresql, sqlserver or sqlite
  • --schema-file (required): Path to XML schema file
  • --foreign-key-mode (optional): How to represent foreign keys — none, relations, or triggers (default: relations)
  • --boolean-mode (optional): Boolean column representation — native, yesno, or yn (default: native)
  • --output-mode (optional): What to generate — all, indexes-only, or triggers-only (default: all)
  • --postgresql-version (optional): Target PostgreSQL version (e.g. 17, 18); affects UUID generation function

Output:

Writes SQL to a file named {schema-stem}-{database-type}.sql in the same directory as the input schema file. For example, schema.xml → schema-postgresql.sql.

Architecture

Uses the Strategy Pattern with trait-based abstraction:

  • Component Traits: TableGenerator, ColumnTypeGenerator, ColumnConstraintGenerator, RelationGenerator, FunctionGenerator, ProcedureGenerator, TriggerGenerator, ViewGenerator, IndexGenerator, OtherSqlGenerator
  • Database Implementations: Each database folder (postgresql/, sqlserver/, etc.) overrides only the traits that differ from common defaults
  • Shared Context: GeneratorContext wraps settings and SQL writer, passed by reference to all component generators

Database-Specific Behavior

Database Sequence Type String Type UUID Support Array Support
PostgreSQL SERIAL / BIGSERIAL text or citext RFC 4122 v7 function Yes
SQL Server INT IDENTITY(1,1) NVARCHAR CHAR(36) No
SQLite INTEGER PRIMARY KEY AUTOINCREMENT TEXT TEXT No

Part of schema-rs

See the workspace README for an overview of the full schema-rs toolchain.