kv

Documentation

Index

• func IndexAllEvents() func(*TxIndex)
• func IndexEvents(compositeKeys []string) func(*TxIndex)
• type TxIndex
  • func NewTxIndex(store dbm.DB, options ...func(*TxIndex)) *TxIndex
  • func (txi *TxIndex) AddBatch(b *txindex.Batch) error
  • func (txi *TxIndex) Get(hash []byte) (*types.TxResult, error)
  • func (txi *TxIndex) Index(result *types.TxResult) error
  • func (txi *TxIndex) Search(ctx context.Context, q *query.Query) ([]*types.TxResult, error)

Functions

func IndexAllEvents

func IndexAllEvents() func(*TxIndex)

IndexAllEvents is an option for indexing all events.

func IndexEvents

func IndexEvents(compositeKeys []string) func(*TxIndex)

IndexEvents is an option for setting which composite keys to index.

Types

type TxIndex

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

TxIndex is the simplest possible indexer, backed by key-value storage (levelDB).

func NewTxIndex

func NewTxIndex(store dbm.DB, options ...func(*TxIndex)) *TxIndex

NewTxIndex creates new KV indexer.

func (*TxIndex) AddBatch

func (txi *TxIndex) AddBatch(b *txindex.Batch) error

AddBatch indexes a batch of transactions using the given list of events. Each key that indexed from the tx's events is a composite of the event type and the respective attribute's key delimited by a "." (eg. "account.number"). Any event with an empty type is not indexed.

func (*TxIndex) Get

func (txi *TxIndex) Get(hash []byte) (*types.TxResult, error)

Get gets transaction from the TxIndex storage and returns it or nil if the transaction is not found.

func (*TxIndex) Index

func (txi *TxIndex) Index(result *types.TxResult) error

Index indexes a single transaction using the given list of events. Each key that indexed from the tx's events is a composite of the event type and the respective attribute's key delimited by a "." (eg. "account.number"). Any event with an empty type is not indexed.

func (*TxIndex) Search

func (txi *TxIndex) Search(ctx context.Context, q *query.Query) ([]*types.TxResult, error)

Search performs a search using the given query.

It breaks the query into conditions (like "tx.height > 5"). For each condition, it queries the DB index. One special use cases here: (1) if "tx.hash" is found, it returns tx result for it (2) for range queries it is better for the client to provide both lower and upper bounds, so we are not performing a full scan. Results from querying indexes are then intersected and returned to the caller, in no particular order.

Search will exit early and return any result fetched so far, when a message is received on the context chan.