boltdb

Documentation

Overview

Package boltdb implements a store.KVStore on top of BoltDB. It supports the following options:

"bucket" (string): the name of BoltDB bucket to use, defaults to "bleve".

"nosync" (bool): if true, set boltdb.DB.NoSync to true. It speeds up index operations in exchange of losing integrity guarantees if indexation aborts without closing the index. Use it when rebuilding indexes from zero.

Index

• Constants
• func New(mo store.MergeOperator, config map[string]interface{}) (store.KVStore, error)
• type Iterator
  • func (i *Iterator) Close() error
  • func (i *Iterator) Current() ([]byte, []byte, bool)
  • func (i *Iterator) Key() []byte
  • func (i *Iterator) Next()
  • func (i *Iterator) Seek(k []byte)
  • func (i *Iterator) Valid() bool
  • func (i *Iterator) Value() []byte
• type Reader
  • func (r *Reader) Close() error
  • func (r *Reader) Get(key []byte) ([]byte, error)
  • func (r *Reader) MultiGet(keys [][]byte) ([][]byte, error)
  • func (r *Reader) PrefixIterator(prefix []byte) store.KVIterator
  • func (r *Reader) RangeIterator(start, end []byte) store.KVIterator
• type Store
  • func (bs *Store) Close() error
  • func (bs *Store) Compact() error
  • func (bs *Store) CompactWithBatchSize(batchSize int) error
  • func (bs *Store) Reader() (store.KVReader, error)
  • func (bs *Store) Stats() json.Marshaler
  • func (bs *Store) Writer() (store.KVWriter, error)
• type Writer
  • func (w *Writer) Close() error
  • func (w *Writer) ExecuteBatch(batch store.KVBatch) (err error)
  • func (w *Writer) NewBatch() store.KVBatch
  • func (w *Writer) NewBatchEx(options store.KVBatchOptions) ([]byte, store.KVBatch, error)

Constants

const (
	Name = "boltdb"
)

Functions

func New

func New(mo store.MergeOperator, config map[string]interface{}) (store.KVStore, error)

Types

type Iterator

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

func (*Iterator) Close

func (i *Iterator) Close() error

func (*Iterator) Current

func (i *Iterator) Current() ([]byte, []byte, bool)

func (*Iterator) Key

func (i *Iterator) Key() []byte

func (*Iterator) Next

func (i *Iterator) Next()

func (*Iterator) Seek

func (i *Iterator) Seek(k []byte)

func (*Iterator) Valid

func (i *Iterator) Valid() bool

func (*Iterator) Value

func (i *Iterator) Value() []byte

type Reader

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

func (*Reader) Close

func (r *Reader) Close() error

func (*Reader) Get

func (r *Reader) Get(key []byte) ([]byte, error)

func (*Reader) MultiGet

func (r *Reader) MultiGet(keys [][]byte) ([][]byte, error)

func (*Reader) PrefixIterator

func (r *Reader) PrefixIterator(prefix []byte) store.KVIterator

func (*Reader) RangeIterator

func (r *Reader) RangeIterator(start, end []byte) store.KVIterator

type Store

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

func (*Store) Close

func (bs *Store) Close() error

func (*Store) Compact

func (bs *Store) Compact() error

Compact calls CompactWithBatchSize with a default batch size of 100. This is a workaround for github issue #374.

func (*Store) CompactWithBatchSize

func (bs *Store) CompactWithBatchSize(batchSize int) error

CompactWithBatchSize removes DictionaryTerm entries with a count of zero (in batchSize batches) Removing entries is a workaround for github issue #374.

func (*Store) Reader

func (bs *Store) Reader() (store.KVReader, error)

func (*Store) Stats

func (bs *Store) Stats() json.Marshaler

func (*Store) Writer

func (bs *Store) Writer() (store.KVWriter, error)

type Writer

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

func (*Writer) Close

func (w *Writer) Close() error

func (*Writer) ExecuteBatch

func (w *Writer) ExecuteBatch(batch store.KVBatch) (err error)

func (*Writer) NewBatch

func (w *Writer) NewBatch() store.KVBatch

func (*Writer) NewBatchEx

func (w *Writer) NewBatchEx(options store.KVBatchOptions) ([]byte, store.KVBatch, error)