cli

Documentation

Overview

Package cli can be used by client code to bootstrap and handle user commands executed via the command line interface.

Index

• func Bootstrap(args []string, registry migration.MigrationsRegistry, ...)
• type Command
• type GenerateBlankMigrationCommand
  • func (c *GenerateBlankMigrationCommand) Description() string
  • func (c *GenerateBlankMigrationCommand) Exec() error
  • func (c *GenerateBlankMigrationCommand) Name() string
• type HelpCommand
  • func (c *HelpCommand) Description() string
  • func (c *HelpCommand) Exec() error
  • func (c *HelpCommand) Name() string
• type MigrateDownCommand
  • func (c *MigrateDownCommand) Description() string
  • func (c *MigrateDownCommand) Exec() error
  • func (c *MigrateDownCommand) Name() string
• type MigrateForceDownCommand
  • func (c *MigrateForceDownCommand) Description() string
  • func (c *MigrateForceDownCommand) Exec() error
  • func (c *MigrateForceDownCommand) Name() string
• type MigrateForceUpCommand
  • func (c *MigrateForceUpCommand) Description() string
  • func (c *MigrateForceUpCommand) Exec() error
  • func (c *MigrateForceUpCommand) Name() string
• type MigrateStatsCommand
  • func (c *MigrateStatsCommand) Description() string
  • func (c *MigrateStatsCommand) Exec() error
  • func (c *MigrateStatsCommand) Name() string
• type MigrateUpCommand
  • func (c *MigrateUpCommand) Description() string
  • func (c *MigrateUpCommand) Exec() error
  • func (c *MigrateUpCommand) Name() string

Functions

func Bootstrap

func Bootstrap(
	args []string,
	registry migration.MigrationsRegistry,
	repository execution.Repository,
	dirPath migration.MigrationsDirPath,
	newHandler func(
		registry migration.MigrationsRegistry,
		repository execution.Repository,
		newExecutionPlan handler.ExecutionPlanBuilder,
	) (*handler.MigrationsHandler, error),
)

Bootstrap Will bootstrap everything needed for the user CLI input, request. Will process the user input and run the requested migration command

Types

type Command

type Command interface {
	Name() string
	Description() string
	Exec() error
}

Command The specification for all the commands the tool should expose as entrypoint, features

type GenerateBlankMigrationCommand

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

func (*GenerateBlankMigrationCommand) Description

func (c *GenerateBlankMigrationCommand) Description() string

func (*GenerateBlankMigrationCommand) Exec

func (c *GenerateBlankMigrationCommand) Exec() error

func (*GenerateBlankMigrationCommand) Name

func (c *GenerateBlankMigrationCommand) Name() string

type HelpCommand

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

func (*HelpCommand) Description

func (c *HelpCommand) Description() string

func (*HelpCommand) Exec

func (c *HelpCommand) Exec() error

func (*HelpCommand) Name

func (c *HelpCommand) Name() string

type MigrateDownCommand

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

func (*MigrateDownCommand) Description

func (c *MigrateDownCommand) Description() string

func (*MigrateDownCommand) Exec

func (c *MigrateDownCommand) Exec() error

func (*MigrateDownCommand) Name

func (c *MigrateDownCommand) Name() string

type MigrateForceDownCommand

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

func (*MigrateForceDownCommand) Description

func (c *MigrateForceDownCommand) Description() string

func (*MigrateForceDownCommand) Exec

func (c *MigrateForceDownCommand) Exec() error

func (*MigrateForceDownCommand) Name

func (c *MigrateForceDownCommand) Name() string

type MigrateForceUpCommand

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

func (*MigrateForceUpCommand) Description

func (c *MigrateForceUpCommand) Description() string

func (*MigrateForceUpCommand) Exec

func (c *MigrateForceUpCommand) Exec() error

func (*MigrateForceUpCommand) Name

func (c *MigrateForceUpCommand) Name() string

type MigrateStatsCommand

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

func (*MigrateStatsCommand) Description

func (c *MigrateStatsCommand) Description() string

func (*MigrateStatsCommand) Exec

func (c *MigrateStatsCommand) Exec() error

func (*MigrateStatsCommand) Name

func (c *MigrateStatsCommand) Name() string

type MigrateUpCommand

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

func (*MigrateUpCommand) Description

func (c *MigrateUpCommand) Description() string

func (*MigrateUpCommand) Exec

func (c *MigrateUpCommand) Exec() error

func (*MigrateUpCommand) Name

func (c *MigrateUpCommand) Name() string