api

Documentation

Index

• func InitFromConfig(ctx context.Context, a *API, cfg *Config) (err error)
• type API
  • func (a *API) Close(ctx context.Context)
  • func (a *API) InitFromCli(ctx context.Context, c *cli.Context) error
  • func (a *API) Name() string
  • func (a *API) Start() error
• type Config
  • func NewConfigFromCliContext(c *cli.Context) (*Config, error)
• type DB

Functions

func InitFromConfig

func InitFromConfig(ctx context.Context, a *API, cfg *Config) (err error)

InitFromConfig inits a new Server from a provided Config struct

Types

type API

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

func (*API) Close

func (a *API) Close(ctx context.Context)

func (*API) InitFromCli

func (a *API) InitFromCli(ctx context.Context, c *cli.Context) error

func (*API) Name

func (a *API) Name() string

func (*API) Start

func (a *API) Start() error

type Config

type Config struct {
	DatabaseUsername        string
	DatabasePassword        string
	DatabaseName            string
	DatabaseHost            string
	DatabaseMaxIdleConns    uint64
	DatabaseMaxOpenConns    uint64
	DatabaseMaxConnLifetime uint64
	OpenDBFunc              func() (DB, error)
	Port                    uint
}

func NewConfigFromCliContext

func NewConfigFromCliContext(c *cli.Context) (*Config, error)

NewConfigFromCliContext creates a new config instance from command line flags.

type DB

type DB interface {
	DB() (*sql.DB, error)
	GormDB() *gorm.DB
}

DB is a local interface that lets us narrow down a database type for testing.