Atlas Migration Plan

plan

The plan block defines a schema migration for a transition between two schema states.

plan "20240806145620" {
  # Hashes generated by the 'atlas schema plan new' command.
  from      = "SMKH4vp9zdHDtpr9NrB4Li3n8x0meA3QrnRdJZuDQDM="
  to        = "oCvOMG7NOE+XUz04UA674zNYVdrN3qoFkJDZPKLPGA0="
  # Actual migratio.
  migration = <<-SQL
  -- Migration content goes here.
  SQL
}

Attributes

Name and description	Required	Value
from Hash of the current schema state computed by Atlas	true	string
migration The actual migration statements. For example: migration = <<-SQL -- Migration content goes here. SQL	true	string
to Hash of the desired schema state computed by Atlas	true	string

Constraints

Constraint	Value
Required	true
Require Name	true
Allow Qualifier	false
Repeatable	false
Allow unknown blocks	false
Allow unknown attributes	false