Struct MigrationPlan 

pub struct MigrationPlan {
    pub id: String,
    pub comment: Option<String>,
    pub created_at: Option<String>,
    pub version: u32,
    pub actions: Vec<MigrationAction>,
}

A single versioned migration, grouping a set of MigrationActions under a version number.

Migration plans are auto-generated by vespertide revision and stored as JSON or YAML files in the migrations/ directory. Never create or edit these files manually.

The version field is a monotonically increasing integer. The id is a UUID that guards against accidental plan substitution when the same version number appears in two different migration histories.

Fields

id: String

Unique identifier for this migration (UUID format). Defaults to empty string for backward compatibility with old migration files.

comment: Option<String>

Human-readable description of what this migration does (from -m "message").

created_at: Option<String>

ISO 8601 timestamp of when the migration file was generated.

version: u32

Monotonically increasing version number, starting at 1.

actions: Vec<MigrationAction>

Ordered list of schema changes to apply in this migration.

Implementations

impl MigrationPlan

pub fn with_prefix(self, prefix: &str) -> Self

Apply a prefix to all table names in the migration plan. This modifies all table references in all actions.

Trait Implementations

impl Clone for MigrationPlan

fn clone(&self) -> MigrationPlan

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 Eq for MigrationPlan

impl JsonSchema for MigrationPlan

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for MigrationPlan

fn eq(&self, other: &MigrationPlan) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for MigrationPlan