boltdd

Documentation

Overview

Package boltdd contains a wrapper around BBoltDB to deduplicate writes and encode values using mgspack. (dd stands for de-duplicate)

Index

• func IsErrNotFound(e error) bool
• func NotFound(name string) error
• type Bucket
  • func (b *Bucket) BoltBucket() *bbolt.Bucket
  • func (b *Bucket) Bucket(name []byte) *Bucket
  • func (b *Bucket) CreateBucket(name []byte) (*Bucket, error)
  • func (b *Bucket) CreateBucketIfNotExists(name []byte) (*Bucket, error)
  • func (b *Bucket) Delete(key []byte) error
  • func (b *Bucket) DeleteBucket(name []byte) error
  • func (b *Bucket) Get(key []byte, obj interface{}) error
  • func (b *Bucket) Put(key []byte, val interface{}) error
• type DB
  • func New(bdb *bbolt.DB) *DB
  • func Open(path string, mode os.FileMode, options *bbolt.Options) (*DB, error)
  • func (db *DB) Batch(fn func(*Tx) error) error
  • func (db *DB) BoltDB() *bbolt.DB
  • func (db *DB) Close() error
  • func (db *DB) Update(fn func(*Tx) error) error
  • func (db *DB) View(fn func(*Tx) error) error
• type ErrNotFound
  • func (e *ErrNotFound) Error() string
• type Tx
  • func (tx *Tx) BoltTx() *bbolt.Tx
  • func (tx *Tx) Bucket(name []byte) *Bucket
  • func (tx *Tx) CreateBucket(name []byte) (*Bucket, error)
  • func (tx *Tx) CreateBucketIfNotExists(name []byte) (*Bucket, error)
  • func (tx *Tx) Writable() bool

Functions

func IsErrNotFound

func IsErrNotFound(e error) bool

IsErrNotFound returns true if the error is an ErrNotFound error.

func NotFound

func NotFound(name string) error

NotFound returns a new error for a key that was not found.

Types

type Bucket

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

func (*Bucket) BoltBucket

func (b *Bucket) BoltBucket() *bbolt.Bucket

BoltBucket returns the internal bolt.Bucket for this Bucket. Only valid for the duration of the current transaction.

func (*Bucket) Bucket

func (b *Bucket) Bucket(name []byte) *Bucket

Bucket represents a boltdb Bucket and its associated metadata necessary for write deduplication. Like bolt.Buckets it is only valid for the duration of the transaction that created it.

func (*Bucket) CreateBucket

func (b *Bucket) CreateBucket(name []byte) (*Bucket, error)

CreateBucket creates a new bucket at the given key and returns the new bucket. Returns an error if the key already exists, if the bucket name is blank, or if the bucket name is too long. The bucket instance is only valid for the lifetime of the transaction.

func (*Bucket) CreateBucketIfNotExists

func (b *Bucket) CreateBucketIfNotExists(name []byte) (*Bucket, error)

CreateBucketIfNotExists creates a new bucket if it doesn't already exist and returns a reference to it. The bucket instance is only valid for the lifetime of the transaction.

func (*Bucket) Delete

func (b *Bucket) Delete(key []byte) error

Delete removes a key from the bucket. If the key does not exist then nothing is done and a nil error is returned. Returns an error if the bucket was created from a read-only transaction.

func (*Bucket) DeleteBucket

func (b *Bucket) DeleteBucket(name []byte) error

DeleteBucket deletes a child bucket. Returns an error if the bucket corresponds to a non-bucket key or another error is encountered. No error is returned if the bucket does not exist.

func (*Bucket) Get

func (b *Bucket) Get(key []byte, obj interface{}) error

Get value by key from boltdb or return an ErrNotFound error if key not found.

func (*Bucket) Put

func (b *Bucket) Put(key []byte, val interface{}) error

Put into boltdb iff it has changed since the last write.

type DB

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

DB wraps an underlying bolt.DB to create write de-duplicating buckets and msgpack encoded values.

func New

func New(bdb *bbolt.DB) *DB

New de-duplicating wrapper for the given bboltdb.

func Open

func Open(path string, mode os.FileMode, options *bbolt.Options) (*DB, error)

Open a bolt.DB and wrap it in a write-de-duplicating msgpack-encoding implementation.

func (*DB) Batch

func (db *DB) Batch(fn func(*Tx) error) error

func (*DB) BoltDB

func (db *DB) BoltDB() *bbolt.DB

BoltDB returns the underlying bolt.DB.

func (*DB) Close

func (db *DB) Close() error

Close closes the underlying bolt.DB and clears all bucket hashes. DB is unusable after closing.

func (*DB) Update

func (db *DB) Update(fn func(*Tx) error) error

func (*DB) View

func (db *DB) View(fn func(*Tx) error) error

type ErrNotFound

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

ErrNotFound is returned when a key is not found.

func (*ErrNotFound) Error

func (e *ErrNotFound) Error() string

type Tx

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

func (*Tx) BoltTx

func (tx *Tx) BoltTx() *bbolt.Tx

BoltTx returns the underlying bolt.Tx.

func (*Tx) Bucket

func (tx *Tx) Bucket(name []byte) *Bucket

Bucket returns a root bucket or nil if it doesn't exist.

func (*Tx) CreateBucket

func (tx *Tx) CreateBucket(name []byte) (*Bucket, error)

func (*Tx) CreateBucketIfNotExists

func (tx *Tx) CreateBucketIfNotExists(name []byte) (*Bucket, error)

CreateBucketIfNotExists returns a root bucket or creates a new one if it doesn't already exist.

func (*Tx) Writable

func (tx *Tx) Writable() bool

Writable wraps boltdb Tx.Writable.