cli

package

v1.6.4 Latest Latest Go to latest Published: Feb 6, 2018 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cryptopay-dev/yaga

Links

Open Source Insights

Documentation ¶

Index ¶

func New(opts ...Option) (*cli.App, error)
type Instance
type MigrateOption
- func MigrateDirection(direction MigrationDirection) MigrateOption
- func MigrateSteps(steps int) MigrateOption
type MigrateOptions
type MigrationDirection
type MigrationLogger
- func NewMigrationLogger(logger logger.Logger) MigrationLogger
- func (m MigrationLogger) Printf(format string, v ...interface{})
- func (m MigrationLogger) Verbose() bool
type Option
type Options
- func (o Options) Migrate(opts ...MigrateOption) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(opts ...Option) (*cli.App, error)

New creates instance of cli.App with Options. Validate options with https://github.com/go-playground/validator Required: - App instance - Logger

Types ¶

type Instance ¶

type Instance interface {
	Run() error
	Shutdown(ctx context.Context) error
}

Instance abstraction layer above Application

type MigrateOption ¶

type MigrateOption func(o *MigrateOptions)

MigrateOption closure

func MigrateDirection ¶

func MigrateDirection(direction MigrationDirection) MigrateOption

MigrateDirection closure to set field in MigrateOptions

func MigrateSteps ¶

func MigrateSteps(steps int) MigrateOption

MigrateSteps closure to set field in MigrateOptions

type MigrateOptions ¶

type MigrateOptions struct {
	Steps     int
	Direction MigrationDirection
}

MigrateOptions struct used for Migrate method

type MigrationDirection ¶

type MigrationDirection int

MigrationDirection type

const (

	// MigrationUp to migrate step up
	MigrationUp MigrationDirection
	// MigrationDown to migrate step down
	MigrationDown
)

type MigrationLogger ¶

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

MigrationLogger abstraction for migrate-logger

func NewMigrationLogger ¶

func NewMigrationLogger(logger logger.Logger) MigrationLogger

NewMigrationLogger creates abstraction for migrate-logger

func (MigrationLogger) Printf ¶

func (m MigrationLogger) Printf(format string, v ...interface{})

Printf implementation of migrate.Logger

func (MigrationLogger) Verbose ¶

func (m MigrationLogger) Verbose() bool

Verbose implementation of migrate.Logger

type Option ¶

type Option func(*Options)

Option closure

func App ¶

func App(app Instance) Option

App closure to set field in Options

func BuildTime ¶

func BuildTime(buildTime string) Option

BuildTime closure to set field in Options

func BuildVersion ¶

func BuildVersion(buildVersion string) Option

BuildVersion closure to set field in Options

func DB ¶

func DB(db *pg.DB) Option

DB closure to set field in Options

func Logger ¶

func Logger(log logger.Logger) Option

Logger closure to set field in Options

func Name ¶

func Name(name string) Option

Name closure to set field in Options

func Usage ¶

func Usage(descr string) Option

Usage closure to set field in Options

func Users ¶

func Users(users []cli.Author) Option

Users closure to set field in Options

type Options ¶

type Options struct {
	App          Instance      `validate:"required"`
	Logger       logger.Logger `validate:"required"`
	DB           *pg.DB
	Users        []cli.Author
	Usage        string
	Name         string
	BuildTime    string
	BuildVersion string
}

Options for creating cli.App instance

func (Options) Migrate ¶

func (o Options) Migrate(opts ...MigrateOption) error

Migrate db using MigrateOptions

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL