db

Documentation

Overview

Package db contains group related CRUD functionality.

Index

• type Group
• type Store
  • func NewStore(log *zap.SugaredLogger, db *sqlx.DB) Store
  • func (s Store) Create(ctx context.Context, group Group) error
  • func (s Store) Delete(ctx context.Context, groupID string) error
  • func (s Store) QueryByID(ctx context.Context, groupID string) (Group, error)
  • func (s Store) QueryWorkspaceGroups(ctx context.Context, workspaceID string, pageNumber, rowsPerPage int) ([]Group, error)
  • func (s Store) Tran(tx sqlx.ExtContext) Store
  • func (s Store) Update(ctx context.Context, group Group) error
  • func (s Store) WithinTran(ctx context.Context, fn func(sqlx.ExtContext) error) error

Types

type Group

type Group struct {
	ID          string    `db:"group_id"`
	Name        string    `db:"name"`
	Wid         string    `db:"wid"`
	Uid         string    `db:"uid"`
	DateCreated time.Time `db:"date_created"`
	DateUpdated time.Time `db:"date_updated"`
}

Group represent the structure we need for moving data between the app and the database.

type Store

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

Store manages the set of APIs for user access.

func NewStore

func NewStore(log *zap.SugaredLogger, db *sqlx.DB) Store

NewStore constructs a data for api access.

func (Store) Create

func (s Store) Create(ctx context.Context, group Group) error

Create inserts a new group into the database.

func (Store) Delete

func (s Store) Delete(ctx context.Context, groupID string) error

Delete removes a group from the database.

func (Store) QueryByID

func (s Store) QueryByID(ctx context.Context, groupID string) (Group, error)

QueryByID gets the specified group from the database.

func (Store) QueryWorkspaceGroups

func (s Store) QueryWorkspaceGroups(ctx context.Context, workspaceID string, pageNumber, rowsPerPage int) ([]Group, error)

QueryWorkspaceGroups retrieves a list of existing group from the database.

func (Store) Tran

func (s Store) Tran(tx sqlx.ExtContext) Store

Tran return new Store with transaction in it.

func (Store) Update

func (s Store) Update(ctx context.Context, group Group) error

Update replaces a group document in the database.

func (Store) WithinTran

func (s Store) WithinTran(ctx context.Context, fn func(sqlx.ExtContext) error) error

WithinTran runs passed function and do commit/rollback at the end.