Rhinox.Cli 0.0.41-alpha

Rhinox.Cli

A .NET global tool for managing PostgreSQL schema migrations with Rhinox.

Install

dotnet tool install --global Rhinox.Cli

Commands

rhinox introspect

Connect to an existing PostgreSQL database and write db/schema/*.sql files describing its current state. Use this once when adopting Rhinox on an existing database; commit the generated files and let the source generator drive code generation from them on subsequent builds.

rhinox introspect --connection "Host=localhost;Database=mydb;Username=postgres;Password=secret" --schema-dir db/schema --schemas public

Pass multiple schemas as a comma-separated list, e.g. --schemas public,inventory.

rhinox migrate plan

Preview pending schema changes without writing any files.

rhinox migrate plan --schema-dir db/schema --migrations-dir db/migrations

rhinox migrate generate

Generate a migration SQL file from detected schema changes.

rhinox migrate generate --schema-dir db/schema --migrations-dir db/migrations --name "add_user_phone"

rhinox migrate apply

Apply pending migrations to a PostgreSQL database. Uses a PostgreSQL advisory lock to prevent concurrent applies.

rhinox migrate apply --connection "Host=localhost;Database=mydb;Username=postgres;Password=secret" --migrations-dir db/migrations

Apply up to a specific migration:

rhinox migrate apply --connection "..." --migrations-dir db/migrations --target "20260319"

rhinox migrate status

Show which migrations have been applied and which are pending.

rhinox migrate status --connection "Host=localhost;Database=mydb;Username=postgres;Password=secret" --migrations-dir db/migrations

Options

How it works

1. (First-time only, on existing databases) Run rhinox introspect to dump the current state into db/schema/*.sql
2. Define / evolve your schema in .sql files under db/schema/
3. Run rhinox migrate generate to diff the schema against existing migrations and produce a new migration file
4. Review the generated SQL — destructive operations are marked with -- DESTRUCTIVE
5. Run rhinox migrate apply to execute pending migrations inside transactions with checksum verification

Migrations are tracked in a _rhinox_migrations table created automatically in your database.

License

MIT