Struct MigrationPlan 

pub struct MigrationPlan {
    pub target: MigrationTarget,
    pub version_range: VersionRange,
    pub steps: Vec<MigrationStep>,
    pub estimated_rows: u64,
    pub overall_safety: SafetyLevel,
    pub rollback_plan: Option<Box<MigrationPlan>>,
    pub batch_size: usize,
    pub completed_steps: Vec<usize>,
    pub plan_hash: String,
    pub dry_run: bool,
    pub created_at: Option<u64>,
    pub expand_contract: Option<bool>,
}

Fields

target: MigrationTarget

version_range: VersionRange

steps: Vec<MigrationStep>

estimated_rows: u64

overall_safety: SafetyLevel

rollback_plan: Option<Box<MigrationPlan>>

batch_size: usize

completed_steps: Vec<usize>

plan_hash: String

dry_run: bool

created_at: Option<u64>

expand_contract: Option<bool>

Implementations

impl MigrationPlan

pub fn new( target: MigrationTarget, version_range: VersionRange, steps: Vec<MigrationStep>, estimated_rows: u64, overall_safety: SafetyLevel, rollback_plan: Option<Box<MigrationPlan>>, ) -> Self

pub fn new_with_config( target: MigrationTarget, version_range: VersionRange, steps: Vec<MigrationStep>, estimated_rows: u64, overall_safety: SafetyLevel, rollback_plan: Option<Box<MigrationPlan>>, config: &MigrationConfig, ) -> Self

pub fn compute_hash(&self) -> String

pub fn refresh_hash(&mut self)

pub fn is_empty(&self) -> bool

pub fn has_schema_modifying_steps(&self) -> bool

pub fn requires_backup(&self) -> bool

True when the plan destroys data that no step can reconstruct. Such plans need a pre-migration backup for rollback to be possible.

pub fn dropped_columns(&self) -> Vec<String>

Names dropped by DropColumn steps, for backup/restore merging.

pub fn remaining_steps(&self) -> Vec<usize>

pub fn print_summary(&self) -> String

Trait Implementations

impl Clone for MigrationPlan

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MigrationPlan

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MigrationPlan

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MigrationPlan

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.