fabric: github.com/hyperledger/fabric/common/ledger/blkstorage Index | Files | Directories

package blkstorage

import "github.com/hyperledger/fabric/common/ledger/blkstorage"


Package Files



const (
    IndexableAttrBlockNum        = IndexableAttr("BlockNum")
    IndexableAttrBlockHash       = IndexableAttr("BlockHash")
    IndexableAttrTxID            = IndexableAttr("TxID")
    IndexableAttrBlockNumTranNum = IndexableAttr("BlockNumTranNum")

constants for indexable attributes


var (
    // ErrNotFoundInIndex is used to indicate missing entry in the index
    ErrNotFoundInIndex = l.NotFoundInIndexErr("")

    // ErrAttrNotIndexed is used to indicate that an attribute is not indexed
    ErrAttrNotIndexed = errors.New("attribute not indexed")

type BlockStore Uses

type BlockStore interface {
    AddBlock(block *common.Block) error
    GetBlockchainInfo() (*common.BlockchainInfo, error)
    RetrieveBlocks(startNum uint64) (ledger.ResultsIterator, error)
    RetrieveBlockByHash(blockHash []byte) (*common.Block, error)
    RetrieveBlockByNumber(blockNum uint64) (*common.Block, error) // blockNum of  math.MaxUint64 will return last block
    RetrieveTxByID(txID string) (*common.Envelope, error)
    RetrieveTxByBlockNumTranNum(blockNum uint64, tranNum uint64) (*common.Envelope, error)
    RetrieveBlockByTxID(txID string) (*common.Block, error)
    RetrieveTxValidationCodeByTxID(txID string) (peer.TxValidationCode, error)

BlockStore - an interface for persisting and retrieving blocks An implementation of this interface is expected to take an argument of type `IndexConfig` which configures the block store on what items should be indexed

type BlockStoreProvider Uses

type BlockStoreProvider interface {
    CreateBlockStore(ledgerid string) (BlockStore, error)
    OpenBlockStore(ledgerid string) (BlockStore, error)
    Exists(ledgerid string) (bool, error)
    List() ([]string, error)

BlockStoreProvider provides an handle to a BlockStore

type IndexConfig Uses

type IndexConfig struct {
    AttrsToIndex []IndexableAttr

IndexConfig - a configuration that includes a list of attributes that should be indexed

func (*IndexConfig) Contains Uses

func (c *IndexConfig) Contains(indexableAttr IndexableAttr) bool

Contains returns true iff the supplied parameter is present in the IndexConfig.AttrsToIndex

type IndexableAttr Uses

type IndexableAttr string

IndexableAttr represents an indexable attribute



Package blkstorage imports 5 packages (graph) and is imported by 49 packages. Updated 2020-02-28. Refresh now. Tools for package owners.