program

Documentation

Index

• Variables
• func MysqlDSN(addr, user, password, dbName string) string
• type MigrationsStatus
• type Program
  • func NewProgram(openDatabase bool) (*Program, error)
  • func (pg *Program) AddAllUsersToCommunity(community string) error
  • func (pg *Program) ChangeUserPassword(user, password string) error
  • func (pg *Program) Close() error
  • func (pg *Program) Config() *config.Config
  • func (pg *Program) DeleteUnusedCommunities(days uint, dryRun bool) error
  • func (pg *Program) DeleteUser(user string, purge bool) error
  • func (pg *Program) FixPostHotScores() error
  • func (pg *Program) HardReset() error
  • func (pg *Program) MakeUserAdmin(username string, isAdmin bool) error
  • func (pg *Program) MakeUserMod(community, user string, isMod bool) error
  • func (pg *Program) Migrate(log bool, steps int) error
  • func (pg *Program) MigrationsStatus() (MigrationsStatus, error)
  • func (pg *Program) NewBadgeType(name string) error
  • func (pg *Program) OpenDatabase() (*sql.DB, error)
  • func (pg *Program) Serve() error

Variables

var (
	ErrMigrationsTableNotFound = errors.New("migrations table not found")
)

Functions

func MysqlDSN

func MysqlDSN(addr, user, password, dbName string) string

MysqlDSN returns a DSN that could be used to connect to a MySQL database. You may want to append mysql:// to the beginning of the returned string.

Types

type MigrationsStatus

type MigrationsStatus struct {
	Version int `json:"version"`
	Dirty   int `json:"dirty"`
}

type Program

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

func NewProgram

func NewProgram(openDatabase bool) (*Program, error)

func (*Program) AddAllUsersToCommunity

func (pg *Program) AddAllUsersToCommunity(community string) error

func (*Program) ChangeUserPassword

func (pg *Program) ChangeUserPassword(user, password string) error

func (*Program) Close

func (pg *Program) Close() error

func (*Program) Config

func (pg *Program) Config() *config.Config

func (*Program) DeleteUnusedCommunities

func (pg *Program) DeleteUnusedCommunities(days uint, dryRun bool) error

func (*Program) DeleteUser

func (pg *Program) DeleteUser(user string, purge bool) error

func (*Program) FixPostHotScores

func (pg *Program) FixPostHotScores() error

func (*Program) HardReset

func (pg *Program) HardReset() error

func (*Program) MakeUserAdmin

func (pg *Program) MakeUserAdmin(username string, isAdmin bool) error

func (*Program) MakeUserMod

func (pg *Program) MakeUserMod(community, user string, isMod bool) error

func (*Program) Migrate

func (pg *Program) Migrate(log bool, steps int) error

If steps is 0, all migrations are run. Otherwise, steps migrations are run up or down depending on steps > 0 or not.

func (*Program) MigrationsStatus

func (pg *Program) MigrationsStatus() (MigrationsStatus, error)

MigrationsStatus returns the status of the current database migrations. If the migrations table is not found, ErrMigrationsTableNotFound is returned. If the migrations table is found but it's empty, sql.ErrNoRows is returned.

func (*Program) NewBadgeType

func (pg *Program) NewBadgeType(name string) error

func (*Program) OpenDatabase

func (pg *Program) OpenDatabase() (*sql.DB, error)

OpenDatabase opens the database. If it was opened previously, the existing sql.DB object is returned.

func (*Program) Serve

func (pg *Program) Serve() error