psql

Documentation

Index

• Variables
• type User
• type UserStore
  • func (us *UserStore) Create(user *User) error
  • func (us *UserStore) Delete(id int) error
  • func (us *UserStore) Find(id int) (*User, error)

Variables

var (
	ErrNotFound = errors.New("psql: resource could not be located")
)

Common errors that you will likely want to account for in your code. Any other errors are wrapped with context vai the github.com/pkg/errors package and returned but are harder to use an if/switch to match.

Types

type User

type User struct {
	ID    int
	Name  string
	Email string
}

User is an example user model. This typically wouldn't be defined in this package but is done here for simplicity.

type UserStore

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

UserStore is used to interact with our user store.

func (*UserStore) Create

func (us *UserStore) Create(user *User) error

Create will create a new user in the DB using the provided user and will update the ID of the provided user. If there is an error it will be wrapped and returned.

func (*UserStore) Delete

func (us *UserStore) Delete(id int) error

Delete will delete a user form the DB. If there is an error it will be wrapped and returned.

func (*UserStore) Find

func (us *UserStore) Find(id int) (*User, error)

Find will retrieve a user with the provided ID or return ErrNotFount if the user isn't located. Other errors are wrapped with context but are otherwise wrapped as-is.