userdb

Documentation

Overview

Package userdb contains user related CRUD functionality.

Index

• type Store
  • func NewStore(log *logger.Logger, db *sqlx.DB) *Store
  • func (s *Store) Count(ctx context.Context, filter userbus.QueryFilter) (int, error)
  • func (s *Store) Create(ctx context.Context, usr userbus.User) error
  • func (s *Store) Delete(ctx context.Context, usr userbus.User) error
  • func (s *Store) NewWithTx(tx sqldb.CommitRollbacker) (userbus.Storer, error)
  • func (s *Store) Query(ctx context.Context, filter userbus.QueryFilter, orderBy order.By, ...) ([]userbus.User, error)
  • func (s *Store) QueryByEmail(ctx context.Context, email mail.Address) (userbus.User, error)
  • func (s *Store) QueryByID(ctx context.Context, userID uuid.UUID) (userbus.User, error)
  • func (s *Store) Update(ctx context.Context, usr userbus.User) error

Types

type Store

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

Store manages the set of APIs for user database access.

func NewStore

func NewStore(log *logger.Logger, db *sqlx.DB) *Store

NewStore constructs the api for data access.

func (*Store) Count

func (s *Store) Count(ctx context.Context, filter userbus.QueryFilter) (int, error)

Count returns the total number of users in the DB.

func (*Store) Create

func (s *Store) Create(ctx context.Context, usr userbus.User) error

Create inserts a new user into the database.

func (*Store) Delete

func (s *Store) Delete(ctx context.Context, usr userbus.User) error

Delete removes a user from the database.

func (*Store) NewWithTx

func (s *Store) NewWithTx(tx sqldb.CommitRollbacker) (userbus.Storer, error)

NewWithTx constructs a new Store value replacing the sqlx DB value with a sqlx DB value that is currently inside a transaction.

func (*Store) Query

func (s *Store) Query(ctx context.Context, filter userbus.QueryFilter, orderBy order.By, page page.Page) ([]userbus.User, error)

Query retrieves a list of existing users from the database.

func (*Store) QueryByEmail

func (s *Store) QueryByEmail(ctx context.Context, email mail.Address) (userbus.User, error)

QueryByEmail gets the specified user from the database by email.

func (*Store) QueryByID

func (s *Store) QueryByID(ctx context.Context, userID uuid.UUID) (userbus.User, error)

QueryByID gets the specified user from the database.

func (*Store) Update

func (s *Store) Update(ctx context.Context, usr userbus.User) error

Update replaces a user document in the database.