Enum AutoMigrateStep 

pub enum AutoMigrateStep<'def> {
    RemoveIndex(<IndexDef as ModuleDefLookup>::Key<'def>),
    RemoveConstraint(<ConstraintDef as ModuleDefLookup>::Key<'def>),
    RemoveSequence(<SequenceDef as ModuleDefLookup>::Key<'def>),
    RemoveSchedule(<ScheduleDef as ModuleDefLookup>::Key<'def>),
    RemoveView(<ViewDef as ModuleDefLookup>::Key<'def>),
    RemoveRowLevelSecurity(<RawRowLevelSecurityDefV9 as ModuleDefLookup>::Key<'def>),
    RemoveTable(<TableDef as ModuleDefLookup>::Key<'def>),
    ChangeColumns(<TableDef as ModuleDefLookup>::Key<'def>),
    AddColumns(<TableDef as ModuleDefLookup>::Key<'def>),
    AddTable(<TableDef as ModuleDefLookup>::Key<'def>),
    AddIndex(<IndexDef as ModuleDefLookup>::Key<'def>),
    AddSequence(<SequenceDef as ModuleDefLookup>::Key<'def>),
    AddSchedule(<ScheduleDef as ModuleDefLookup>::Key<'def>),
    AddView(<ViewDef as ModuleDefLookup>::Key<'def>),
    AddRowLevelSecurity(<RawRowLevelSecurityDefV9 as ModuleDefLookup>::Key<'def>),
    ChangeAccess(<TableDef as ModuleDefLookup>::Key<'def>),
    ChangePrimaryKey(<TableDef as ModuleDefLookup>::Key<'def>),
    UpdateView(<ViewDef as ModuleDefLookup>::Key<'def>),
    DisconnectAllUsers,
}

A step in an automatic migration.

Variants

RemoveIndex(<IndexDef as ModuleDefLookup>::Key<'def>)

Remove an index.

RemoveConstraint(<ConstraintDef as ModuleDefLookup>::Key<'def>)

Remove a constraint.

RemoveSequence(<SequenceDef as ModuleDefLookup>::Key<'def>)

Remove a sequence.

RemoveSchedule(<ScheduleDef as ModuleDefLookup>::Key<'def>)

Remove a schedule annotation from a table.

RemoveView(<ViewDef as ModuleDefLookup>::Key<'def>)

Remove a view and corresponding view table

RemoveRowLevelSecurity(<RawRowLevelSecurityDefV9 as ModuleDefLookup>::Key<'def>)

Remove a row-level security query.

RemoveTable(<TableDef as ModuleDefLookup>::Key<'def>)

Remove an empty table and all its sub-objects (indexes, constraints, sequences). Validated at execution time: fails if the table contains data.

ChangeColumns(<TableDef as ModuleDefLookup>::Key<'def>)

Change the column types of a table, in a layout compatible way.

This should be done before any new indices are added.

AddColumns(<TableDef as ModuleDefLookup>::Key<'def>)

Add columns to a table, in a layout-INCOMPATIBLE way.

This is a destructive operation that requires first running a DisconnectAllUsers.

The added columns are guaranteed to be contiguous and at the end of the table. They are also guaranteed to have default values set.

When this step is present, no ChangeColumns steps will be, for the same table.

AddTable(<TableDef as ModuleDefLookup>::Key<'def>)

Add a table, including all indexes, constraints, and sequences. There will NOT be separate steps in the plan for adding indexes, constraints, and sequences.

AddIndex(<IndexDef as ModuleDefLookup>::Key<'def>)

Add an index.

AddSequence(<SequenceDef as ModuleDefLookup>::Key<'def>)

Add a sequence.

AddSchedule(<ScheduleDef as ModuleDefLookup>::Key<'def>)

Add a schedule annotation to a table.

AddView(<ViewDef as ModuleDefLookup>::Key<'def>)

Add a view and corresponding view table

AddRowLevelSecurity(<RawRowLevelSecurityDefV9 as ModuleDefLookup>::Key<'def>)

Add a row-level security query.

ChangeAccess(<TableDef as ModuleDefLookup>::Key<'def>)

Change the access of a table.

ChangePrimaryKey(<TableDef as ModuleDefLookup>::Key<'def>)

Change the primary key of a table.

This updates the table_primary_key field in st_table to match the new module definition. Without this step, a stale primary key in the stored schema causes check_compatible to fail on the next publish. See: https://github.com/clockworklabs/SpacetimeDB/issues/3934

UpdateView(<ViewDef as ModuleDefLookup>::Key<'def>)

Recompute a view, update its backing table, and push updates to clients

DisconnectAllUsers

Disconnect all users connected to the module.

Trait Implementations

impl<'def> Debug for AutoMigrateStep<'def>

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

Formats the value using the given formatter.

impl<'def> Ord for AutoMigrateStep<'def>

fn cmp(&self, other: &AutoMigrateStep<'def>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'def> PartialEq for AutoMigrateStep<'def>

fn eq(&self, other: &AutoMigrateStep<'def>) -> 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<'def> PartialOrd for AutoMigrateStep<'def>

fn partial_cmp(&self, other: &AutoMigrateStep<'def>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'def> Eq for AutoMigrateStep<'def>

impl<'def> StructuralPartialEq for AutoMigrateStep<'def>