fabric: github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/statedb Index | Files | Directories

package statedb

import "github.com/hyperledger/fabric/core/ledger/kvledger/txmgmt/statedb"

Index

Package Files

statedb.go

func ValidateRangeMetadata Uses

func ValidateRangeMetadata(metadata map[string]interface{}) error

ValidateRangeMetadata validates the JSON containing attributes for the range query

type BulkOptimizable Uses

type BulkOptimizable interface {
    LoadCommittedVersions(keys []*CompositeKey) error
    GetCachedVersion(namespace, key string) (*version.Height, bool)
    ClearCachedVersions()
}

BulkOptimizable interface provides additional functions for databases capable of batch operations

type CompositeKey Uses

type CompositeKey struct {
    Namespace string
    Key       string
}

CompositeKey encloses Namespace and Key components

type IndexCapable Uses

type IndexCapable interface {
    GetDBType() string
    ProcessIndexesForChaincodeDeploy(namespace string, fileEntries []*ccprovider.TarFileEntry) error
}

IndexCapable interface provides additional functions for databases capable of index operations

type QueryResult Uses

type QueryResult interface{}

QueryResult - a general interface for supporting different types of query results. Actual types differ for different queries

type QueryResultsIterator Uses

type QueryResultsIterator interface {
    ResultsIterator
    GetBookmarkAndClose() string
}

QueryResultsIterator adds GetBookmarkAndClose method

type ResultsIterator Uses

type ResultsIterator interface {
    Next() (QueryResult, error)
    Close()
}

ResultsIterator iterates over query results

type UpdateBatch Uses

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

UpdateBatch encloses the details of multiple `updates`

func NewUpdateBatch Uses

func NewUpdateBatch() *UpdateBatch

NewUpdateBatch constructs an instance of a Batch

func (*UpdateBatch) Delete Uses

func (batch *UpdateBatch) Delete(ns string, key string, version *version.Height)

Delete deletes a Key and associated value

func (*UpdateBatch) Exists Uses

func (batch *UpdateBatch) Exists(ns string, key string) bool

Exists checks whether the given key exists in the batch

func (*UpdateBatch) Get Uses

func (batch *UpdateBatch) Get(ns string, key string) *VersionedValue

Get returns the VersionedValue for the given namespace and key

func (*UpdateBatch) GetRangeScanIterator Uses

func (batch *UpdateBatch) GetRangeScanIterator(ns string, startKey string, endKey string) QueryResultsIterator

GetRangeScanIterator returns an iterator that iterates over keys of a specific namespace in sorted order In other word this gives the same functionality over the contents in the `UpdateBatch` as `VersionedDB.GetStateRangeScanIterator()` method gives over the contents in the statedb This function can be used for querying the contents in the updateBatch before they are committed to the statedb. For instance, a validator implementation can used this to verify the validity of a range query of a transaction where the UpdateBatch represents the union of the modifications performed by the preceding valid transactions in the same block (Assuming Group commit approach where we commit all the updates caused by a block together).

func (*UpdateBatch) GetUpdatedNamespaces Uses

func (batch *UpdateBatch) GetUpdatedNamespaces() []string

GetUpdatedNamespaces returns the names of the namespaces that are updated

func (*UpdateBatch) GetUpdates Uses

func (batch *UpdateBatch) GetUpdates(ns string) map[string]*VersionedValue

GetUpdates returns all the updates for a namespace

func (*UpdateBatch) Put Uses

func (batch *UpdateBatch) Put(ns string, key string, value []byte, version *version.Height)

Put adds a key with value only. The metadata is assumed to be nil

func (*UpdateBatch) PutValAndMetadata Uses

func (batch *UpdateBatch) PutValAndMetadata(ns string, key string, value []byte, metadata []byte, version *version.Height)

PutValAndMetadata adds a key with value and metadata TODO introducing a new function to limit the refactoring. Later in a separate CR, the 'Put' function above should be removed

func (*UpdateBatch) Update Uses

func (batch *UpdateBatch) Update(ns string, key string, vv *VersionedValue)

Update updates the batch with a latest entry for a namespace and a key

type VersionedDB Uses

type VersionedDB interface {
    // GetState gets the value for given namespace and key. For a chaincode, the namespace corresponds to the chaincodeId
    GetState(namespace string, key string) (*VersionedValue, error)
    // GetVersion gets the version for given namespace and key. For a chaincode, the namespace corresponds to the chaincodeId
    GetVersion(namespace string, key string) (*version.Height, error)
    // GetStateMultipleKeys gets the values for multiple keys in a single call
    GetStateMultipleKeys(namespace string, keys []string) ([]*VersionedValue, error)
    // GetStateRangeScanIterator returns an iterator that contains all the key-values between given key ranges.
    // startKey is inclusive
    // endKey is exclusive
    // The returned ResultsIterator contains results of type *VersionedKV
    GetStateRangeScanIterator(namespace string, startKey string, endKey string) (ResultsIterator, error)
    // GetStateRangeScanIteratorWithMetadata returns an iterator that contains all the key-values between given key ranges.
    // startKey is inclusive
    // endKey is exclusive
    // metadata is a map of additional query parameters
    // The returned ResultsIterator contains results of type *VersionedKV
    GetStateRangeScanIteratorWithMetadata(namespace string, startKey string, endKey string, metadata map[string]interface{}) (QueryResultsIterator, error)
    // ExecuteQuery executes the given query and returns an iterator that contains results of type *VersionedKV.
    ExecuteQuery(namespace, query string) (ResultsIterator, error)
    // ExecuteQueryWithMetadata executes the given query with associated query options and
    // returns an iterator that contains results of type *VersionedKV.
    // metadata is a map of additional query parameters
    ExecuteQueryWithMetadata(namespace, query string, metadata map[string]interface{}) (QueryResultsIterator, error)
    // ApplyUpdates applies the batch to the underlying db.
    // height is the height of the highest transaction in the Batch that
    // a state db implementation is expected to ues as a save point
    ApplyUpdates(batch *UpdateBatch, height *version.Height) error
    // GetLatestSavePoint returns the height of the highest transaction upto which
    // the state db is consistent
    GetLatestSavePoint() (*version.Height, error)
    // ValidateKeyValue tests whether the key and value is supported by the db implementation.
    // For instance, leveldb supports any bytes for the key while the couchdb supports only valid utf-8 string
    // TODO make the function ValidateKeyValue return a specific error say ErrInvalidKeyValue
    // However, as of now, the both implementations of this function (leveldb and couchdb) are deterministic in returing an error
    // i.e., an error is returned only if the key-value are found to be invalid for the underlying db
    ValidateKeyValue(key string, value []byte) error
    // BytesKeySupported returns true if the implementation (underlying db) supports the any bytes to be used as key.
    // For instance, leveldb supports any bytes for the key while the couchdb supports only valid utf-8 string
    BytesKeySupported() bool
    // Open opens the db
    Open() error
    // Close closes the db
    Close()
}

VersionedDB lists methods that a db is supposed to implement

type VersionedDBProvider Uses

type VersionedDBProvider interface {
    // GetDBHandle returns a handle to a VersionedDB
    GetDBHandle(id string) (VersionedDB, error)
    // Close closes all the VersionedDB instances and releases any resources held by VersionedDBProvider
    Close()
}

VersionedDBProvider provides an instance of an versioned DB

type VersionedKV Uses

type VersionedKV struct {
    CompositeKey
    VersionedValue
}

VersionedKV encloses key and corresponding VersionedValue

type VersionedValue Uses

type VersionedValue struct {
    Value    []byte
    Metadata []byte
    Version  *version.Height
}

VersionedValue encloses value and corresponding version

func (*VersionedValue) IsDelete Uses

func (vv *VersionedValue) IsDelete() bool

IsDelete returns true if this update indicates delete of a key

Directories

PathSynopsis
commontests
mockCode generated by counterfeiter.
statecouchdb
statecouchdb/msgs
stateleveldb
stateleveldb/msgs

Package statedb imports 5 packages (graph) and is imported by 16 packages. Updated 2019-07-12. Refresh now. Tools for package owners.