ogdb

Documentation

Index

• Constants
• Variables
• type Batch
  • func NewTableBatch(db Database, prefix string) Batch
• type Database
  • func NewTable(db Database, prefix string) Database
• type LevelDB
  • func NewLevelDB(file string, cache int, handles int) (*LevelDB, error)
  • func (db *LevelDB) Close()
  • func (db *LevelDB) Delete(key []byte) error
  • func (db *LevelDB) Get(key []byte) ([]byte, error)
  • func (db *LevelDB) Has(key []byte) (bool, error)
  • func (db *LevelDB) LDB() *leveldb.DB
  • func (db *LevelDB) Meter(prefix string)
  • func (db *LevelDB) NewBatch() Batch
  • func (db *LevelDB) NewIterator() iterator.Iterator
  • func (db *LevelDB) NewIteratorWithPrefix(prefix []byte) iterator.Iterator
  • func (db *LevelDB) Path() string
  • func (db *LevelDB) Put(key []byte, value []byte) error
• type LevelDBConfig
• type MemDBConfig
• type MemDatabase
  • func NewMemDatabase() *MemDatabase
  • func NewMemDatabaseWithCap(size int) *MemDatabase
  • func (db *MemDatabase) Close()
  • func (db *MemDatabase) Delete(key []byte) error
  • func (db *MemDatabase) Get(key []byte) ([]byte, error)
  • func (db *MemDatabase) Has(key []byte) (bool, error)
  • func (db *MemDatabase) Keys() [][]byte
  • func (db *MemDatabase) Len() int
  • func (db *MemDatabase) NewBatch() Batch
  • func (db *MemDatabase) Put(key []byte, value []byte) error
• type Putter

Constants

const IdealBatchSize = 100 * 1024

Code using batches should try to add this much data to the batch. The value was determined empirically.

Variables

var OpenFileLimit = 64

Types

type Batch

type Batch interface {
	Putter
	ValueSize() int // amount of data in the batch
	Write() error
	// Reset resets the batch for reuse
	Reset()
}

Batch is a write-only database that commits changes to its host database when Write is called. Batch cannot be used concurrently.

func NewTableBatch

func NewTableBatch(db Database, prefix string) Batch

NewTableBatch returns a Batch object which prefixes all keys with a given string.

type Database

type Database interface {
	Putter
	Get(key []byte) ([]byte, error)
	Has(key []byte) (bool, error)
	Delete(key []byte) error
	Close()
	NewBatch() Batch
}

Database wraps all database operations. All methods are safe for concurrent use.

func NewTable

func NewTable(db Database, prefix string) Database

NewTable returns a Database object that prefixes all keys with a given string.

type LevelDB

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

func NewLevelDB

func NewLevelDB(file string, cache int, handles int) (*LevelDB, error)

NewLevelDB returns a LevelDB wrapped object.

func (*LevelDB) Close

func (db *LevelDB) Close()

func (*LevelDB) Delete

func (db *LevelDB) Delete(key []byte) error

Delete deletes the key from the queue and database

func (*LevelDB) Get

func (db *LevelDB) Get(key []byte) ([]byte, error)

Get returns the given key if it's present.

func (*LevelDB) Has

func (db *LevelDB) Has(key []byte) (bool, error)

func (*LevelDB) LDB

func (db *LevelDB) LDB() *leveldb.DB

func (*LevelDB) Meter

func (db *LevelDB) Meter(prefix string)

Meter configures the database metrics collectors and

func (*LevelDB) NewBatch

func (db *LevelDB) NewBatch() Batch

func (*LevelDB) NewIterator

func (db *LevelDB) NewIterator() iterator.Iterator

func (*LevelDB) NewIteratorWithPrefix

func (db *LevelDB) NewIteratorWithPrefix(prefix []byte) iterator.Iterator

NewIteratorWithPrefix returns a iterator to iterate over subset of database content with a particular prefix.

func (*LevelDB) Path

func (db *LevelDB) Path() string

Path returns the path to the database directory.

func (*LevelDB) Put

func (db *LevelDB) Put(key []byte, value []byte) error

Put puts the given key / value to the queue

type LevelDBConfig

type LevelDBConfig struct {
	Path    string
	Cache   int
	Handles int
}

type MemDBConfig

type MemDBConfig struct{}

type MemDatabase

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

* This is a test memory database. Do not use for any production it does not get persisted

func NewMemDatabase

func NewMemDatabase() *MemDatabase

func NewMemDatabaseWithCap

func NewMemDatabaseWithCap(size int) *MemDatabase

func (*MemDatabase) Close

func (db *MemDatabase) Close()

func (*MemDatabase) Delete

func (db *MemDatabase) Delete(key []byte) error

func (*MemDatabase) Get

func (db *MemDatabase) Get(key []byte) ([]byte, error)

func (*MemDatabase) Has

func (db *MemDatabase) Has(key []byte) (bool, error)

func (*MemDatabase) Keys

func (db *MemDatabase) Keys() [][]byte

func (*MemDatabase) Len

func (db *MemDatabase) Len() int

func (*MemDatabase) NewBatch

func (db *MemDatabase) NewBatch() Batch

func (*MemDatabase) Put

func (db *MemDatabase) Put(key []byte, value []byte) error

type Putter

type Putter interface {
	Put(key []byte, value []byte) error
}

Putter wraps the database write operation supported by both batches and regular databases.