soda

Documentation

Index

• Variables
• func Plugins(migrations fs.FS) []core.Plugin
• type Command
  • func NewCommand(folder fs.FS) *Command
  • func (m *Command) Flags() *pflag.FlagSet
  • func (m Command) HelpText() string
  • func (m *Command) Name() string
  • func (m *Command) ParentName() string
  • func (m *Command) ParseFlags(args []string)
  • func (m *Command) Run(ctx context.Context, root string, args []string) error
  • func (mu *Command) RunBeforeTest(ctx context.Context, root string, args []string) error
  • func (mu *Command) RunDown() error
  • func (mu *Command) RunUp() error
• type Creator
• type Creators
  • func (c Creators) CreatorFor(name string) Creator
• type Generator
  • func (g *Generator) Flags() *pflag.FlagSet
  • func (g Generator) Generate(ctx context.Context, root string, args []string) error
  • func (g Generator) InvocationName() string
  • func (g Generator) Name() string
  • func (g *Generator) ParseFlags(args []string)
  • func (g *Generator) Receive(pls []core.Plugin)
• type Initializer
  • func (in Initializer) Initialize(ctx context.Context, options new.Options) error
  • func (in Initializer) Name() string
• type Logger
  • func (l *Logger) Log(lvl logging.Level, s string, args ...interface{})

Variables

var (
	ErrCouldNotFindConnection = errors.New("could not find connection by name")
	ErrNotEnoughArgs          = errors.New("not enough args, please specify direction p.e ox pop migrate up")
	ErrInvalidInstruction     = errors.New("invalid instruction for migrate command")
)

Functions

func Plugins

func Plugins(migrations fs.FS) []core.Plugin

Types

type Command

type Command struct {
	*Logger
	// contains filtered or unexported fields
}

func NewCommand

func NewCommand(folder fs.FS) *Command

func (*Command) Flags

func (m *Command) Flags() *pflag.FlagSet

func (Command) HelpText

func (m Command) HelpText() string

HelpText returns the help Text of build function

func (*Command) Name

func (m *Command) Name() string

func (*Command) ParentName

func (m *Command) ParentName() string

func (*Command) ParseFlags

func (m *Command) ParseFlags(args []string)

func (*Command) Run

func (m *Command) Run(ctx context.Context, root string, args []string) error

func (*Command) RunBeforeTest

func (mu *Command) RunBeforeTest(ctx context.Context, root string, args []string) error

func (*Command) RunDown

func (mu *Command) RunDown() error

RunDown will run migrations on the current folder, it will look for the migrations folder and attempt to run the migrations using internal pop tooling

func (*Command) RunUp

func (mu *Command) RunUp() error

Run will run migrations on the current folder, it will look for the migrations folder and attempt to run the migrations using internal pop tooling

type Creator

type Creator interface {
	// Receives a migration type string and returns if it
	// applies to it or not.
	Creates(string) bool

	// Creates the migration.
	Create(dir, name string, args []string) error
}

type Creators

type Creators []Creator

func (Creators) CreatorFor

func (c Creators) CreatorFor(name string) Creator

type Generator

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

Generator allows to identify model as a plugin

func (*Generator) Flags

func (g *Generator) Flags() *pflag.FlagSet

func (Generator) Generate

func (g Generator) Generate(ctx context.Context, root string, args []string) error

Generate generates an empty [name].plush.html file

func (Generator) InvocationName

func (g Generator) InvocationName() string

InvocationName is used to identify the generator when the generate command is called.

func (Generator) Name

func (g Generator) Name() string

Name returns the name of the plugin

func (*Generator) ParseFlags

func (g *Generator) ParseFlags(args []string)

func (*Generator) Receive

func (g *Generator) Receive(pls []core.Plugin)

type Initializer

type Initializer struct{}

func (Initializer) Initialize

func (in Initializer) Initialize(ctx context.Context, options new.Options) error

func (Initializer) Name

func (in Initializer) Name() string

type Logger

type Logger struct{}

func (*Logger) Log

func (l *Logger) Log(lvl logging.Level, s string, args ...interface{})