repo

package

v0.0.0-...-1c92e5d Latest Latest Go to latest Published: Jun 1, 2020 License: MIT Imports: 18 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

This section is empty.

View Source

var (
	ErrUserNotFound = errors.New("user could not be found")
)

Errors that can be returned from the repo.

This section is empty.

type OrderBy int

OrderBy is an enumeration over sort orders

const (
	OrderByName OrderBy = iota
	OrderByCreateTime
)

Cover all the supported sort orders

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

Repository is used to store and fetch users from a database.

func NewRepository(dbURL string, logger *logrus.Logger) (*Repository, error)

NewRepository creates a new, database-backed repository.

func (r Repository) Close() error

Close releases the resources of the Repository.

func (r Repository) CreateUser(ctx context.Context, name string) (User, error)

CreateUser creates a new user in the repository.

func (r Repository) GetUser(ctx context.Context, id string) (User, error)

GetUser retrieves any information held for a given user ID.

func (r Repository) ListUsers(ctx context.Context, names []string, order *SortOrder) (_ []User, err error)

ListUsers will return all users matching the filters.

type SortOrder struct {
	By         OrderBy
	Descending bool
}

SortOrder describes how to sort results

func (s *SortOrder) SQL() string

SQL returns the SQL representation of SortOrder, suitable for use in an OrderBy clause.

type User struct {
	ID         string
	Name       string
	CreateTime time.Time
}

User describes the database model for a User.

Path	Synopsis
migrations