db

Documentation

Index

• func DoGet(bk Bucket, key []byte) ([]byte, error)
• func DoGetWithBucketID(dbase Database, bid BucketID, key []byte) ([]byte, error)
• func GetFlag(database Database, name string) interface{}
• func GetSupportedTypes() []string
• func NewNullDB() *nullDB
• func NewProxyDB() *proxyDB
• func RegisterHasher(bk BucketID, hasher Hasher)
• func RegisteredBackendTypes() []string
• type BackendType
• type Bucket
  • func BucketOf(database Database, id BucketID) Bucket
• type BucketID
  • func (bk BucketID) Hasher() Hasher
• type CodedBucket
  • func NewCodedBucket(database Database, id BucketID, c codec.Codec) (*CodedBucket, error)
  • func NewCodedBucketFromBucket(bk Bucket, hasher Hasher, c codec.Codec) *CodedBucket
  • func (b *CodedBucket) Get(key interface{}, value interface{}) error
  • func (b *CodedBucket) GetBytes(key interface{}) ([]byte, error)
  • func (b *CodedBucket) Put(value interface{}) error
  • func (b *CodedBucket) Set(key interface{}, value interface{}) error
• type Context
  • func WithFlags(database Database, flags Flags) Context
• type ContextBuilder
• type Database
  • func NewMapDB() Database
  • func Open(dir, dbtype, name string) (Database, error)
  • func Unwrap(database Database) Database
• type Flags
  • func (f Flags) Clone() Flags
  • func (f Flags) Get(n string) interface{}
  • func (f Flags) Merged(flags Flags) Flags
• type Flusher
• type GoLevelDB
  • func NewGoLevelDB(name string, dir string) (*GoLevelDB, error)
  • func NewGoLevelDBWithOpts(name string, dir string, o *opt.Options) (*GoLevelDB, error)
  • func (db *GoLevelDB) Close() error
  • func (db *GoLevelDB) GetBucket(id BucketID) (Bucket, error)
• type Hasher
• type LayerDB
  • func NewLayerDB(database Database) LayerDB
• type Raw
• type Writer
  • func NewWriter(dbase Database) Writer

Functions

func DoGet

func DoGet(bk Bucket, key []byte) ([]byte, error)

func DoGetWithBucketID

func DoGetWithBucketID(dbase Database, bid BucketID, key []byte) ([]byte, error)

func GetFlag

func GetFlag(database Database, name string) interface{}

func GetSupportedTypes

func GetSupportedTypes() []string

func NewNullDB

func NewNullDB() *nullDB

func NewProxyDB

func NewProxyDB() *proxyDB

func RegisterHasher

func RegisterHasher(bk BucketID, hasher Hasher)

func RegisteredBackendTypes

func RegisteredBackendTypes() []string

Types

type BackendType

type BackendType string

const GoLevelDBBackend BackendType = "goleveldb"

const MapDBBackend BackendType = "mapdb"

type Bucket

type Bucket interface {
	Get(key []byte) ([]byte, error)
	Has(key []byte) (bool, error)
	Set(key []byte, value []byte) error
	Delete(key []byte) error
}

Bucket

func BucketOf

func BucketOf(database Database, id BucketID) Bucket

BucketOf returns valid bucket always, but it

type BucketID

type BucketID string

const (
	// MerkleTrie maps RLP encoded data from sha3(data)
	MerkleTrie BucketID = ""

	// BytesByHash maps data except merkle trie nodes from sha3(data)
	BytesByHash BucketID = "S"

	// TransactionLocatorByHash maps transaction locator from transaction hash.
	TransactionLocatorByHash BucketID = "T"

	// BlockHeaderHashByHeight maps hash of encoded block header from height.
	BlockHeaderHashByHeight BucketID = "H"

	// ChainProperty is general key value map for chain property.
	ChainProperty BucketID = "C"

	// ListByMerkleRootBase is the base for the bucket that maps list
	// from network type dependent merkle root(list)
	ListByMerkleRootBase BucketID = "L"
)

Bucket ID

func (BucketID) Hasher

func (bk BucketID) Hasher() Hasher

type CodedBucket

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

func NewCodedBucket

func NewCodedBucket(database Database, id BucketID, c codec.Codec) (*CodedBucket, error)

func NewCodedBucketFromBucket

func NewCodedBucketFromBucket(bk Bucket, hasher Hasher, c codec.Codec) *CodedBucket

func (*CodedBucket) Get

func (b *CodedBucket) Get(key interface{}, value interface{}) error

func (*CodedBucket) GetBytes

func (b *CodedBucket) GetBytes(key interface{}) ([]byte, error)

func (*CodedBucket) Put

func (b *CodedBucket) Put(value interface{}) error

func (*CodedBucket) Set

func (b *CodedBucket) Set(key interface{}, value interface{}) error

type Context

type Context interface {
	Database
	ContextBuilder
	GetFlag(n string) interface{}
	Flags() Flags
}

func WithFlags

func WithFlags(database Database, flags Flags) Context

type ContextBuilder

type ContextBuilder interface {
	WithFlags(flags Flags) Context
}

type Database

type Database interface {
	GetBucket(id BucketID) (Bucket, error)
	Close() error
}

func NewMapDB

func NewMapDB() Database

func Open

func Open(dir, dbtype, name string) (Database, error)

func Unwrap

func Unwrap(database Database) Database

type Flags

type Flags map[string]interface{}

func (Flags) Clone

func (f Flags) Clone() Flags

func (Flags) Get

func (f Flags) Get(n string) interface{}

func (Flags) Merged

func (f Flags) Merged(flags Flags) Flags

type Flusher

type Flusher interface {
	Flush() error
}

type GoLevelDB

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

func NewGoLevelDB

func NewGoLevelDB(name string, dir string) (*GoLevelDB, error)

func NewGoLevelDBWithOpts

func NewGoLevelDBWithOpts(name string, dir string, o *opt.Options) (*GoLevelDB, error)

func (*GoLevelDB) Close

func (db *GoLevelDB) Close() error

func (*GoLevelDB) GetBucket

func (db *GoLevelDB) GetBucket(id BucketID) (Bucket, error)

type Hasher

type Hasher interface {
	Name() string
	Hash(value []byte) []byte
}

type LayerDB

type LayerDB interface {
	Database
	Flush(write bool) error
	Unwrap() Database
}

func NewLayerDB

func NewLayerDB(database Database) LayerDB

type Raw

type Raw []byte

type Writer

type Writer interface {
	Database() Database
	Add(item Flusher)
	Prepare()
	Flush() error
}

func NewWriter

func NewWriter(dbase Database) Writer