db

Documentation

Index

• Variables
• type BoltDB
  • func NewBoltDB(path string) (*BoltDB, error)
  • func (db *BoltDB) AddRevision(id int, revision review.Revision) error
  • func (db *BoltDB) CreateReview(r review.R) (int, error)
  • func (db *BoltDB) CreateUser(u review.User) error
  • func (db *BoltDB) DeleteReview(id int) error
  • func (db *BoltDB) DeleteUser(username string) error
  • func (db *BoltDB) GetReview(id int) (review.R, error)
  • func (db *BoltDB) GetSummaries() ([]review.Summary, error)
  • func (db *BoltDB) GetUser(username string) (u review.User, err error)
  • func (db *BoltDB) SetSummary(id int, summary review.Summary) error
  • func (db *BoltDB) UpdateRevision(id, revId int, revision review.Revision) error
  • func (db *BoltDB) UpdateUser(u review.User) error
• type Database
• type ErrNoAnnotation
  • func (e ErrNoAnnotation) Error() string
• type ErrNoReview
  • func (e ErrNoReview) Error() string
• type ErrNoRevision
  • func (e ErrNoRevision) Error() string

Variables

var (
	ErrNoDB       = errors.New("the database does not exist or is corrupt")
	ErrUserExists = errors.New("this username is already taken")
	ErrNoUser     = errors.New("no such user")
)

Types

type BoltDB

type BoltDB struct {
	*bolt.DB
}

func NewBoltDB

func NewBoltDB(path string) (*BoltDB, error)

func (*BoltDB) AddRevision

func (db *BoltDB) AddRevision(id int, revision review.Revision) error

func (*BoltDB) CreateReview

func (db *BoltDB) CreateReview(r review.R) (int, error)

func (*BoltDB) CreateUser

func (db *BoltDB) CreateUser(u review.User) error

func (*BoltDB) DeleteReview

func (db *BoltDB) DeleteReview(id int) error

func (*BoltDB) DeleteUser

func (db *BoltDB) DeleteUser(username string) error

func (*BoltDB) GetReview

func (db *BoltDB) GetReview(id int) (review.R, error)

func (*BoltDB) GetSummaries

func (db *BoltDB) GetSummaries() ([]review.Summary, error)

func (*BoltDB) GetUser

func (db *BoltDB) GetUser(username string) (u review.User, err error)

func (*BoltDB) SetSummary

func (db *BoltDB) SetSummary(id int, summary review.Summary) error

func (*BoltDB) UpdateRevision

func (db *BoltDB) UpdateRevision(id, revId int, revision review.Revision) error

UpdateRevision overwrites the specified revision with a new one.

func (*BoltDB) UpdateUser

func (db *BoltDB) UpdateUser(u review.User) error

type Database

type Database interface {
	// CreateReview creates a new review. It returns the ID of the review and
	// an error if the review could not be created.
	CreateReview(review.R) (id int, err error)

	// GetReview gets a review by ID.
	GetReview(id int) (review.R, error)

	// GetSummaries gets all the ReviewSummaries.
	GetSummaries() ([]review.Summary, error)

	// SetSummary sets the Summary of a Review by ID.
	SetSummary(id int, summary review.Summary) error

	// AddRevision adds a Revision to a Review.
	AddRevision(id int, r review.Revision) error

	// UpdateRevision replaces an existing revision with the one provided.
	UpdateRevision(id, revId int, r review.Revision) error

	// DeleteReview deletes a review.
	DeleteReview(id int) error

	// CreateUser creates a user.
	CreateUser(review.User) error

	// UpdateUser replaces an existing user with the one provided.
	UpdateUser(review.User) error

	// GetUser gets a user by name
	GetUser(string) (review.User, error)

	// DeleteUser deletes a user by name.
	DeleteUser(string) error
}

Database defines erickson's storage interface. erickson will only use the methods defined here, and will not introspect types implementing Database in any way.

type ErrNoAnnotation

type ErrNoAnnotation int

func (ErrNoAnnotation) Error

func (e ErrNoAnnotation) Error() string

type ErrNoReview

type ErrNoReview int

func (ErrNoReview) Error

func (e ErrNoReview) Error() string

type ErrNoRevision

type ErrNoRevision int

func (ErrNoRevision) Error

func (e ErrNoRevision) Error() string