class Marten::DB::Management::Migrations::Runner

Marten::DB::Management::Migrations::Runner
Reference
Object

Defined in:

marten/db/management/migrations/runner.cr
marten/db/management/migrations/runner/pre_initial_node.cr
marten/db/management/migrations/runner/progress.cr
marten/db/management/migrations/runner/progress_type.cr

Constant Summary

PRE_INITIAL_MIGRATION_ID = "zero"

Constructors

.new(connection : Connection::Base)

Instance Method Summary

#execute(app_config : Apps::Config | Nil = nil, migration_name : String | Nil = nil, fake = false)
Executes the migrations up until the specified app config / migration name (if specified).
#execute(app_config : Apps::Config | Nil = nil, migration_name : String | Nil = nil, fake = false, &)
Executes the migrations up until the specified app config / migration name (if specified).
#execution_needed?(app_config : Apps::Config | Nil = nil, migration_name : String | Nil = nil) : Bool
Returns true if the execution of the runner is needed for the specified app config and migration name.
#mark_elligible_replacements_as_applied(&)
#plan(app_config : Apps::Config | Nil = nil, migration_name : String | Nil = nil) : Array(Tuple(Migration, Bool))
Returns the migration plan for the specified app config and migration name.

Constructor Detail

def self.new(connection : Connection::Base) #

[View source]

Instance Method Detail

def execute(app_config : Apps::Config | Nil = nil, migration_name : String | Nil = nil, fake = false) #

Executes the migrations up until the specified app config / migration name (if specified).

If no app config / migration name is specified, the method executes all the non-applied migrations.

[View source]

def execute(app_config : Apps::Config | Nil = nil, migration_name : String | Nil = nil, fake = false, &) #

Executes the migrations up until the specified app config / migration name (if specified).

If no app config / migration name is specified, the method executes all the non-applied migrations.

It should be noted that this method yields a Marten::DB::Management::Migrations::Runner::Progress object at each execution of a migration (before and after).

[View source]

def execution_needed?(app_config : Apps::Config | Nil = nil, migration_name : String | Nil = nil) : Bool #

Returns true if the execution of the runner is needed for the specified app config and migration name.

[View source]

def mark_elligible_replacements_as_applied(&) #

[View source]

def plan(app_config : Apps::Config | Nil = nil, migration_name : String | Nil = nil) : Array(Tuple(Migration, Bool)) #

Returns the migration plan for the specified app config and migration name.

This method returns an array of tuples containing (i) a migration to apply and (ii) a boolean indicating if the migration should be applied in a backward way.

[View source]