homedb

package

v0.0.0-...-d0aa484 Latest Latest Go to latest Published: May 2, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package homedb contains home related CRUD functionality.

This section is empty.

This section is empty.

This section is empty.

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

Store manages the set of APIs for home database access.

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

NewStore constructs the api for data access.

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

Count returns the total number of homes in the DB.

func (s *Store) Create(ctx context.Context, hme homebus.Home) error

Create inserts a new home into the database.

func (s *Store) Delete(ctx context.Context, hme homebus.Home) error

Delete removes a home from the database.

func (s *Store) NewWithTx(tx transaction.CommitRollbacker) (homebus.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 (s *Store) Query(ctx context.Context, filter homebus.QueryFilter, orderBy order.By, pageNumber int, rowsPerPage int) ([]homebus.Home, error)

Query retrieves a list of existing homes from the database.

func (s *Store) QueryByID(ctx context.Context, homeID uuid.UUID) (homebus.Home, error)

QueryByID gets the specified home from the database.

func (s *Store) QueryByUserID(ctx context.Context, userID uuid.UUID) ([]homebus.Home, error)

QueryByUserID gets the specified home from the database by user id.

func (s *Store) Update(ctx context.Context, hme homebus.Home) error

Update replaces a home document in the database.