Expand description
Database migration planning, schema diff, verification SQL, and tabular IO.
This crate is intentionally execution-free by default: it builds plans, SQL, scripts, manifests, and import/export streams, while host applications own credentials, network access, scheduling, and approval UX.
Re-exports§
pub use canonical::canonical_cell_sql;pub use canonical::canonical_row_sql;pub use canonical::canonical_value_sql;pub use canonical::canonicalization_warnings;pub use canonical::CanonicalColumn;pub use canonical::CanonicalType;pub use canonical::CanonicalizationPolicy;pub use canonical::TimestampMode;pub use checksum::build_sync_repair_plan;pub use checksum::checksum_diff_sql;pub use checksum::checksum_manifest_table_sql;pub use checksum::chunk_checksum_select_sql;pub use checksum::pt_table_checksum_model;pub use checksum::AdaptiveChunking;pub use checksum::ChecksumAggregate;pub use checksum::ChecksumFunction;pub use checksum::ChunkBounds;pub use checksum::ChunkChecksumConfig;pub use checksum::SyncAlgorithm;pub use checksum::SyncRepairAction;pub use checksum::SyncRepairPlan;pub use checksum::SyncRepairTemplate;pub use export::export_rows;pub use export::ExportConfig;pub use export::ExportControl;pub use export::ExportReport;pub use io::generate_inserts_from_csv;pub use io::infer_csv_schema;pub use io::preview_delimited;pub use io::preview_json;pub use io::preview_ndjson;pub use io::Cell;pub use io::ColumnMapping;pub use io::DelimitedEncoder;pub use io::DelimitedImportOptions;pub use io::DelimitedOptions;pub use io::ImportColumn;pub use io::ImportPreview;pub use io::ImportPreviewOptions;pub use io::InferredColumn;pub use io::InferredType;pub use io::JsonEncoder;pub use io::NdjsonEncoder;pub use io::OwnedCell;pub use io::QuoteStyle;pub use io::SqlColumnSpec;pub use io::SqlInsertEncoder;pub use io::SqlScriptEncoder;pub use io::SqlScriptOptions;pub use io::SqlWriteMode;pub use io::TabularEncoder;pub use io::UpsertStyle;pub use plan::build_migration_plan;pub use plan::build_migration_snippets;pub use plan::checkpoint_mark_completed_sql;pub use plan::checkpoint_resume_sql;pub use plan::checkpoint_table_sql;pub use plan::chunk_iteration_sql;pub use plan::chunk_manifest_table_sql;pub use plan::failed_bucket_row_diff_sql;pub use plan::fingerprint_sql;pub use plan::foreign_key_integrity_sql;pub use plan::foreign_key_load_order;pub use plan::hash_bucket_diff_sql;pub use plan::hash_bucket_fingerprint_sql;pub use plan::key_hash_expression;pub use plan::key_hash_profile_sql;pub use plan::keyed_diff_sql;pub use plan::manifest_table_sql;pub use plan::map_column_type;pub use plan::parse_column_list;pub use plan::partition_fingerprint_sql;pub use plan::row_hash_expression;pub use plan::row_hash_select_sql;pub use plan::target_table_ddl_sql;pub use plan::try_build_migration_plan;pub use plan::vscode_snippet_body;pub use plan::ChunkIterationConfig;pub use plan::ColumnTypeMapping;pub use plan::ForeignKeyLoadOrder;pub use plan::ForeignKeySpec;pub use plan::MigrationCheckpointConfig;pub use plan::MigrationEngine;pub use plan::MigrationExportFormat;pub use plan::MigrationPlan;pub use plan::MigrationPlanError;pub use plan::MigrationPlanIssue;pub use plan::MigrationSnippet;pub use plan::MigrationSnippetKind;pub use plan::MigrationSnippetVariable;pub use plan::MigrationSpec;pub use plan::MigrationTask;pub use plan::MigrationTaskLevel;pub use plan::SourceColumnSpec;pub use recipe::dry_run_text_recipe;pub use recipe::recipe_run_summary;pub use recipe::MigrationRecipe;pub use recipe::RecipePhase;pub use recipe::RecipePreview;pub use rollout::attach_validation_gates;pub use rollout::expand_contract_rollout;pub use rollout::shadow_read_runbook;pub use rollout::validation_rollout_gates;pub use rollout::MigrationValidationSummary;pub use rollout::RolloutGate;pub use rollout::RolloutPhase;pub use rollout::RolloutPlan;pub use rollout::RolloutStep;pub use rollout::ShadowReadExperiment;pub use schema::diff_schemas;pub use schema::AlterColumnStyle;pub use schema::AlteredColumn;pub use schema::AlteredTable;pub use schema::CheckConstraint;pub use schema::Column;pub use schema::ColumnChange;pub use schema::ForeignKeyConstraint;pub use schema::Index;pub use schema::MigrationScript;pub use schema::MigrationStatement;pub use schema::PrimaryKeyChange;pub use schema::Rename;pub use schema::RenameHint;pub use schema::Schema;pub use schema::SchemaDiff;pub use schema::Table;pub use schema::TableConstraint;pub use schema::UniqueConstraint;pub use schema::UnsupportedMigration;pub use io::AvroEncoder;pub use io::ParquetEncoder;
Modules§
- canonical
- Cross-engine value canonicalization for stable row hashing.
- checksum
- Chunked checksum SQL builders inspired by pt-table-checksum and reladiff.
- dialect
- SQL dialect quoting, placeholders, paging, and diagnostics formatting.
- export
- Standalone row export runner.
- io
- plan
- Cross-engine migration planning and data validation SQL builders.
- recipe
- Recipe-style dry-run reporting for generated migration artifacts.
- rollout
- Zero-downtime rollout plans for database migrations.
- schema
- ADV-001 — schema comparison and migration preview.