binx

README

binx

Documentation

Index

• Variables
• type Bound
  • func By(idx Index) Bound
  • func LowerBound(idx Index) Bound
  • func UpperBound(idx Index) Bound
  • func Where(idx Index) Bound
• type Bucket
• type Count
  • func (c *Count) AppendBinary([]byte) error
• type Index
• type Indexable
• type Queryable
  • func Page(q Queryable, skip, limit int) Queryable
• type Tx
  • func (r *Tx) Get(q Queryable, key []byte) error
  • func (w *Tx) Put(idx Indexable) error
  • func (r *Tx) Scan(s Queryable, bns []Bound) error
• type UniqueIndex

Variables

var (
	ErrNotFound    = errors.New("not found")
	ErrIdxNotFound = errors.New("index not found")
)

Types

type Bound

type Bound interface {
	Index
	Upper() bool
	Lower() bool
}

func By

func By(idx Index) Bound

func LowerBound

func LowerBound(idx Index) Bound

func UpperBound

func UpperBound(idx Index) Bound

func Where

func Where(idx Index) Bound

type Bucket

type Bucket interface {
	BucketKey() []byte
}

type Count

type Count struct {
	Total int
}

func (*Count) AppendBinary

func (c *Count) AppendBinary([]byte) error

type Index

type Index interface {
	Bucket
	Key() []byte
}

type Indexable

type Indexable interface {
	UniqueIndex
	encoding.BinaryMarshaler
	MasterIndexBucketKey() []byte
	Indexes() []Index
}

type Queryable

type Queryable interface {
	Bucket
	AppendBinary(data []byte) (bool, error)
}

func Page

func Page(q Queryable, skip, limit int) Queryable

type Tx

type Tx struct {
	*bolt.Tx
}

func (*Tx) Get

func (r *Tx) Get(q Queryable, key []byte) error

func (*Tx) Put

func (w *Tx) Put(idx Indexable) error

func (*Tx) Scan

func (r *Tx) Scan(s Queryable, bns []Bound) error

type UniqueIndex

type UniqueIndex interface {
	Bucket
	UniqueKey() []byte
}