datastore

Documentation

Overview

Package datastore is a simple package for tracking of a single instance of application data.

Index

• type Finder
• type Manager
  • func New(filePath string) (*Manager, error)
  • func Open(fp string) (*Manager, error)
  • func (m *Manager) All(to interface{}, options ...func(*index.Options)) error
  • func (m *Manager) AllByIndex(fieldName string, to interface{}, options ...func(*index.Options)) error
  • func (m *Manager) Count(data interface{}) (int, error)
  • func (m *Manager) Find(fieldName string, value interface{}, to interface{}, ...) error
  • func (m *Manager) GetPath() string
  • func (m *Manager) One(fieldName string, value interface{}, to interface{}) error
  • func (m *Manager) Prefix(fieldName string, prefix string, to interface{}, ...) error
  • func (m *Manager) Range(fieldName string, min interface{}, max interface{}, to interface{}, ...) error
  • func (m *Manager) Save(data interface{}) error
  • func (m *Manager) Select(matchers ...q.Matcher) storm.Query
  • func (m *Manager) Stop()
• type WriteCloser
• type Writer

Types

type Finder

type Finder interface {
	storm.Finder
}

A Finder can fetch types from BoltDB.

type Manager

type Manager struct {
	Store *storm.DB
	// contains filtered or unexported fields
}

Manager main object for data store.

func New

func New(filePath string) (*Manager, error)

New returns a new datastore Manager.

func Open

func Open(fp string) (*Manager, error)

Open returns a datastore Manager. Error if datastore file does not exist.

func (*Manager) All

func (m *Manager) All(to interface{}, options ...func(*index.Options)) error

All gets all the records of a bucket. If there are no records it returns no error and the 'to' parameter is set to an empty slice.

func (*Manager) AllByIndex

func (m *Manager) AllByIndex(fieldName string, to interface{}, options ...func(*index.Options)) error

AllByIndex gets all the records of a bucket that are indexed in the specified index.

func (*Manager) Count

func (m *Manager) Count(data interface{}) (int, error)

Count counts all the records of a bucket.

func (*Manager) Find

func (m *Manager) Find(fieldName string, value interface{}, to interface{}, options ...func(*index.Options)) error

Find returns one or more records by the specified index.

func (*Manager) GetPath

func (m *Manager) GetPath() string

GetPath returns the filepath to db file.

func (*Manager) One

func (m *Manager) One(fieldName string, value interface{}, to interface{}) error

One returns one record by the specified index.

func (*Manager) Prefix

func (m *Manager) Prefix(fieldName string, prefix string, to interface{}, options ...func(*index.Options)) error

Prefix returns one or more records whose given field starts with the specified prefix.

func (*Manager) Range

func (m *Manager) Range(fieldName string, min interface{}, max interface{}, to interface{}, options ...func(*index.Options)) error

Range returns one or more records by the specified index within the specified range.

func (*Manager) Save

func (m *Manager) Save(data interface{}) error

Save saves data into the datastore.

func (*Manager) Select

func (m *Manager) Select(matchers ...q.Matcher) storm.Query

Select a list of records that match a list of matchers. Doesn't use indexes.

func (*Manager) Stop

func (m *Manager) Stop()

Stop stops database and any associated goroutines.

type WriteCloser

type WriteCloser interface {
	Save(data interface{}) error
	Stop()
}

A WriteCloser can write to or close a datastore.

type Writer

type Writer interface {
	Save(data interface{}) error
}

A Writer can write to a datastore.