command

Documentation

Index

• type ApplyCommand
  • func (c *ApplyCommand) Help() string
  • func (c *ApplyCommand) Run(args []string) int
  • func (c *ApplyCommand) Synopsis() string
• type FileRunner
  • func NewFileRunner(filename string, config *config.TfmigrateConfig, ...) (*FileRunner, error)
  • func (r *FileRunner) Apply(ctx context.Context) error
  • func (r *FileRunner) MigrationConfig() *tfmigrate.MigrationConfig
  • func (r *FileRunner) Plan(ctx context.Context) error
• type HistoryRunner
  • func NewHistoryRunner(ctx context.Context, filename string, config *config.TfmigrateConfig, ...) (*HistoryRunner, error)
  • func (r *HistoryRunner) Apply(ctx context.Context) (err error)
  • func (r *HistoryRunner) Plan(ctx context.Context) error
• type ListCommand
  • func (c *ListCommand) Help() string
  • func (c *ListCommand) Run(args []string) int
  • func (c *ListCommand) Synopsis() string
• type Meta
• type PlanCommand
  • func (c *PlanCommand) Help() string
  • func (c *PlanCommand) Run(args []string) int
  • func (c *PlanCommand) Synopsis() string

Types

type ApplyCommand

type ApplyCommand struct {
	Meta
	// contains filtered or unexported fields
}

ApplyCommand is a command which computes a new state and pushes it to the remote state.

func (*ApplyCommand) Help

func (c *ApplyCommand) Help() string

Help returns long-form help text.

func (*ApplyCommand) Run

func (c *ApplyCommand) Run(args []string) int

Run runs the procedure of this command.

func (*ApplyCommand) Synopsis

func (c *ApplyCommand) Synopsis() string

Synopsis returns one-line help text.

type FileRunner

type FileRunner struct {
	// contains filtered or unexported fields
}

FileRunner is a runner for a single migration file.

func NewFileRunner

func NewFileRunner(filename string, config *config.TfmigrateConfig, option *tfmigrate.MigratorOption) (*FileRunner, error)

NewFileRunner returns a new FileRunner instance.

func (*FileRunner) Apply

func (r *FileRunner) Apply(ctx context.Context) error

Apply applies a single migration.

func (*FileRunner) MigrationConfig

func (r *FileRunner) MigrationConfig() *tfmigrate.MigrationConfig

MigrationConfig returns an instance of migration. This is required for metadata stored in history

func (*FileRunner) Plan

func (r *FileRunner) Plan(ctx context.Context) error

Plan plans a single migration.

type HistoryRunner

type HistoryRunner struct {
	// contains filtered or unexported fields
}

HistoryRunner is a history-aware runner. It allows us to apply all unapplied migrations and save them to history.

func NewHistoryRunner

func NewHistoryRunner(ctx context.Context, filename string, config *config.TfmigrateConfig, option *tfmigrate.MigratorOption) (*HistoryRunner, error)

NewHistoryRunner returns a new HistoryRunner instance.

func (*HistoryRunner) Apply

func (r *HistoryRunner) Apply(ctx context.Context) (err error)

Apply applies migrations and save them to history. If a filename is set, run a single migration. If not set, run all unapplied migrations.

func (*HistoryRunner) Plan

func (r *HistoryRunner) Plan(ctx context.Context) error

Plan plans migrations with history-aware mode. If a filename is set, run a single migration. If not set, run all unapplied migrations.

type ListCommand

type ListCommand struct {
	Meta
	// contains filtered or unexported fields
}

ListCommand is a command which lists migrations.

func (*ListCommand) Help

func (c *ListCommand) Help() string

Help returns long-form help text.

func (*ListCommand) Run

func (c *ListCommand) Run(args []string) int

Run runs the procedure of this command.

func (*ListCommand) Synopsis

func (c *ListCommand) Synopsis() string

Synopsis returns one-line help text.

type Meta

type Meta struct {
	// UI is a user interface representing input and output.
	UI cli.Ui

	// Option customizes a behavior of Migrator.
	// It is used for shared settings across Migrator instances.
	Option *tfmigrate.MigratorOption
	// contains filtered or unexported fields
}

Meta are the meta-options that are available on all or most commands.

type PlanCommand

type PlanCommand struct {
	Meta
	// contains filtered or unexported fields
}

PlanCommand is a command which computes a new state by applying state migration operations to a temporary state.

func (*PlanCommand) Help

func (c *PlanCommand) Help() string

Help returns long-form help text.

func (*PlanCommand) Run

func (c *PlanCommand) Run(args []string) int

Run runs the procedure of this command.

func (*PlanCommand) Synopsis

func (c *PlanCommand) Synopsis() string

Synopsis returns one-line help text.