bolt

Documentation

Index

• type Driver
  • func (d *Driver) Close() error
  • func (d *Driver) Open(path string) error
  • func (d *Driver) ResetSequence(maxID int) error
• type PaperRepository
  • func (s *PaperRepository) Delete(id int) error
  • func (s *PaperRepository) Get(ids ...int) ([]papernet.Paper, error)
  • func (s *PaperRepository) List() ([]papernet.Paper, error)
  • func (s *PaperRepository) Upsert(paper *papernet.Paper) error
• type TagIndex
  • func (s *TagIndex) Index(tag string) error
  • func (s *TagIndex) Search(prefix string) ([]string, error)

Types

type Driver

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

func (*Driver) Close

func (d *Driver) Close() error

Close closes the underlying database.

func (*Driver) Open

func (d *Driver) Open(path string) error

Open opens the connection to the bolt database defined by path.

func (*Driver) ResetSequence

func (d *Driver) ResetSequence(maxID int) error

type PaperRepository

type PaperRepository struct {
	Driver *Driver
}

PaperRepository is used to store and retrieve papers from a bolt database.

func (*PaperRepository) Delete

func (s *PaperRepository) Delete(id int) error

func (*PaperRepository) Get

func (s *PaperRepository) Get(ids ...int) ([]papernet.Paper, error)

Get retrieves the paper defined by id in the database. If no paper can be found with the given id, Get returns nil.

func (*PaperRepository) List

func (s *PaperRepository) List() ([]papernet.Paper, error)

func (*PaperRepository) Upsert

func (s *PaperRepository) Upsert(paper *papernet.Paper) error

Upsert inserts or update a paper in the database, depending on paper.ID.

type TagIndex

type TagIndex struct {
	Driver *Driver
}

func (*TagIndex) Index

func (s *TagIndex) Index(tag string) error

func (*TagIndex) Search

func (s *TagIndex) Search(prefix string) ([]string, error)