Expand description
Native database execution, filesystem integration, and CLI APIs for Gaman.
The root crate connects the database-I/O-free gaman-core lifecycle to
migration sources, live database executors, inspection, and user-facing
commands. Offline-only builds re-export the core planning API.
Modules§
- cli
- Command-line parsing, validation, dispatch, diagnostics, and presentation.
- core
- Lower-level APIs for custom executors, sources, and integration work.
- drift
- Semantic drift reports, contracts, comparison, and formatting.
- parsers
- runner_
factory - Native adapters that construct the shared core command runner.
- schema
- Schema types and builders.
- schema_
file - Native schema file loading helpers.
Structs§
- Command
Diagnostic - Serializable host-facing diagnostic derived from one
CommandError. - Command
Envelope - Versioned portable command request envelope.
- Command
Failure - Versioned portable command failure with optional clarification payload.
- Command
Response - Versioned portable command response envelope.
- Config
- Runtime configuration for gaman. Loaded once at startup and passed through the call chain.
- Database
Tracking Store - Database-backed migration tracking implemented through the active executor.
- Embedded
Migrations - Migration
- A single migration: an ordered, dependency-aware set of operations.
idis derived from the filename at load time and is not stored in the file. - Migration
Artifact - Canonical migration content for offline presentation.
- Migration
Catalog - Immutable, validated migration history observed by one lifecycle command.
- Migration
Engine - I/O-free migration lifecycle engine over caller-provided storage and execution adapters.
- Migration
Movement - Counts forward and backward migration movement.
- Migration
Runner - Unified lifecycle façade shared by native, WASM, and other host adapters.
- Migration
Status - One migration id and its tracked application state.
- Offline
Planner - Repair
Options - Options that control one-off drift repair.
- Repair
Report - Result of planning or applying one-off repair SQL.
- Schema
Check Result - Database preparation outcome for one supplied SQL source.
- SqlInput
- One in-memory SQL source supplied by a host for database preparation.
Enums§
- Apply
Command - Requested migration-application behavior.
- Command
Result - Structured result of one lifecycle command.
- Config
Error - Errors returned when runtime configuration is internally inconsistent.
- Diagnostic
Code - Stable command failure categories shared by non-Rust hosts.
- Engine
Error - Errors returned by [
MigrationEngine]. - Executor
Error - Errors returned by a caller-owned SQL executor.
- Inspection
Error - Failure returned by a host-provided schema inspector.
- Make
Command - Requested migration-generation behavior.
- Make
Result - Outcome of migration generation with persistence semantics preserved for hosts.
- Offline
Error - Runner
Command - Resolved lifecycle command accepted by [
MigrationRunner]. - Runner
Command Error - Structured semantic or host-adapter failure from runner command execution.
- Schema
Check Failure - One structured SQL schema validation failure.
- Schema
Check Input - One host-resolved input participating in SQL schema validation.
- Schema
Check Status - Result category for one schema-check input.
- TlsMode
Constants§
- COMMAND_
PROTOCOL_ VERSION - Current version of the portable command request and response protocol.
Traits§
- Executor
- Executes SQL and transactional migration boundaries for a caller-owned target.
- Schema
Inspector - Reflects high-fidelity schema state from a live target without defining drift policy.
- Tracking
Store - Stores the applied migration IDs for a target environment.
Type Aliases§
- Command
Request - Portable command vocabulary used by textual, WASM, and other hosts.