database

Documentation

Index

• Variables
• type Database
  • func New() (*Database, error)
  • func (d *Database) CheckAndReturnUser(nickname, password string) (User, error)
  • func (d *Database) ChkMigration() error
  • func (d *Database) Close() error
  • func (d *Database) CreateUser(nickname, email, password, sshPublicKey, groups string) (User, error)
  • func (d *Database) GetUserByEmail(email string) (User, error)
  • func (d *Database) GetUserByID(id int) (User, error)
  • func (d *Database) GetUserByNickname(nickname string) (User, error)
  • func (d *Database) GetVersion() (string, error)
  • func (d *Database) RunMigration() error
  • func (d *Database) VerifyMigration() (int, error)
• type User

Variables

var (
	ErrDatabaseAhead            = errors.New("database is ahead of current migration, please update the application")
	ErrDatabaseNotUpToDate      = errors.New("database is not up to date, please run migrations")
	ErrNicknameEmpty            = errors.New("nickname is required")
	ErrEmailEmpty               = errors.New("email is required")
	ErrPasswordOrSSHKeyRequired = errors.New("password or ssh public key is required")
	ErrPasswordTooShort         = errors.New("password must be at least 8 characters")
	ErrInvalidCredentials       = errors.New("invalid credentials")
)

Types

type Database

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

func New

func New() (*Database, error)

func (*Database) CheckAndReturnUser

func (d *Database) CheckAndReturnUser(nickname, password string) (User, error)

func (*Database) ChkMigration

func (d *Database) ChkMigration() error

func (*Database) Close

func (d *Database) Close() error

func (*Database) CreateUser

func (d *Database) CreateUser(nickname, email, password, sshPublicKey, groups string) (User, error)

func (*Database) GetUserByEmail

func (d *Database) GetUserByEmail(email string) (User, error)

func (*Database) GetUserByID

func (d *Database) GetUserByID(id int) (User, error)

func (*Database) GetUserByNickname

func (d *Database) GetUserByNickname(nickname string) (User, error)

func (*Database) GetVersion

func (d *Database) GetVersion() (string, error)

func (*Database) RunMigration

func (d *Database) RunMigration() error

func (*Database) VerifyMigration

func (d *Database) VerifyMigration() (int, error)

type User

type User struct {
	ID           int    `db:"id"`
	Nickname     string `db:"nickname"`
	Email        string `db:"email"`
	Password     string `db:"password"`
	SSHPublicKey string `db:"ssh_public_key"`
	Groups       string `db:"groups"`
	CreatedAt    string `db:"created_at"`
	UpdatedAt    string `db:"updated_at"`
}