database

Documentation

Index

• type DBWrapper
  • func GetDB() (*DBWrapper, error)
  • func (db *DBWrapper) AddCredentialToUser(username string, cred models.Credential) error
  • func (db *DBWrapper) AddUser(user models.User) error
  • func (db *DBWrapper) DeleteUserByID(id uint) error
  • func (db *DBWrapper) DeleteUserByUsername(username string) error
  • func (db *DBWrapper) GetUserByID(id uint) (models.User, error)
  • func (db *DBWrapper) GetUserByUsername(username string) (models.User, error)
  • func (db *DBWrapper) UpdateUser(username string, userUpdates models.User) error

Types

type DBWrapper

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

This wrapper exists solely so that member functions can be written to work on the database.

func GetDB

func GetDB() (*DBWrapper, error)

The singleton pattern for a database connection.

func (*DBWrapper) AddCredentialToUser

func (db *DBWrapper) AddCredentialToUser(username string, cred models.Credential) error

Adds the given credential to the user with the given username

func (*DBWrapper) AddUser

func (db *DBWrapper) AddUser(user models.User) error

Adds User to database

func (*DBWrapper) DeleteUserByID

func (db *DBWrapper) DeleteUserByID(id uint) error

Deletes the user with the given ID

func (*DBWrapper) DeleteUserByUsername

func (db *DBWrapper) DeleteUserByUsername(username string) error

Deletes user with the given username

func (*DBWrapper) GetUserByID

func (db *DBWrapper) GetUserByID(id uint) (models.User, error)

Gets the user object based on the given ID

func (*DBWrapper) GetUserByUsername

func (db *DBWrapper) GetUserByUsername(username string) (models.User, error)

Gets the user object based on the given username

func (*DBWrapper) UpdateUser

func (db *DBWrapper) UpdateUser(username string, userUpdates models.User) error

Updates the given user to the values given in the object