kvrwset

package
v0.0.0-...-6f64d5f Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 7, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package kvrwset is a generated protocol buffer package.

It is generated from these files: 

ledger/rwset/kvrwset/kv_rwset.proto

It has these top-level messages: 

KVRWSet
HashedRWSet
KVRead
KVWrite
KVMetadataWrite
KVReadHash
KVWriteHash
KVMetadataWriteHash
KVMetadataEntry
Version
RangeQueryInfo
QueryReads
QueryReadsMerkleSummary

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type HashedRWSet 

type HashedRWSet struct {
	HashedReads    []*KVReadHash          `protobuf:"bytes,1,rep,name=hashed_reads,json=hashedReads" json:"hashed_reads,omitempty"`
	HashedWrites   []*KVWriteHash         `protobuf:"bytes,2,rep,name=hashed_writes,json=hashedWrites" json:"hashed_writes,omitempty"`
	MetadataWrites []*KVMetadataWriteHash `protobuf:"bytes,3,rep,name=metadata_writes,json=metadataWrites" json:"metadata_writes,omitempty"`
}

HashedRWSet encapsulates hashed representation of a private read-write set for KV or Document data model

func (*HashedRWSet) Descriptor 

func (*HashedRWSet) Descriptor() ([]byte, []int)

func (*HashedRWSet) GetHashedReads 

func (m *HashedRWSet) GetHashedReads() []*KVReadHash

func (*HashedRWSet) GetHashedWrites 

func (m *HashedRWSet) GetHashedWrites() []*KVWriteHash

func (*HashedRWSet) GetMetadataWrites 

func (m *HashedRWSet) GetMetadataWrites() []*KVMetadataWriteHash

func (*HashedRWSet) ProtoMessage 

func (*HashedRWSet) ProtoMessage()

func (*HashedRWSet) Reset 

func (m *HashedRWSet) Reset()

func (*HashedRWSet) String 

func (m *HashedRWSet) String() string

type KVMetadataEntry 

type KVMetadataEntry struct {
	Name  string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
}

KVMetadataEntry captures a 'name'ed entry in the metadata of a key/key-hash.

func (*KVMetadataEntry) Descriptor 

func (*KVMetadataEntry) Descriptor() ([]byte, []int)

func (*KVMetadataEntry) GetName 

func (m *KVMetadataEntry) GetName() string

func (*KVMetadataEntry) GetValue 

func (m *KVMetadataEntry) GetValue() []byte

func (*KVMetadataEntry) ProtoMessage 

func (*KVMetadataEntry) ProtoMessage()

func (*KVMetadataEntry) Reset 

func (m *KVMetadataEntry) Reset()

func (*KVMetadataEntry) String 

func (m *KVMetadataEntry) String() string

type KVMetadataWrite 

type KVMetadataWrite struct {
	Key     string             `protobuf:"bytes,1,opt,name=key" json:"key,omitempty"`
	Entries []*KVMetadataEntry `protobuf:"bytes,2,rep,name=entries" json:"entries,omitempty"`
}

KVMetadataWrite captures all the entries in the metadata associated with a key

func (*KVMetadataWrite) Descriptor 

func (*KVMetadataWrite) Descriptor() ([]byte, []int)

func (*KVMetadataWrite) GetEntries 

func (m *KVMetadataWrite) GetEntries() []*KVMetadataEntry

func (*KVMetadataWrite) GetKey 

func (m *KVMetadataWrite) GetKey() string

func (*KVMetadataWrite) ProtoMessage 

func (*KVMetadataWrite) ProtoMessage()

func (*KVMetadataWrite) Reset 

func (m *KVMetadataWrite) Reset()

func (*KVMetadataWrite) String 

func (m *KVMetadataWrite) String() string

type KVMetadataWriteHash 

type KVMetadataWriteHash struct {
	KeyHash []byte             `protobuf:"bytes,1,opt,name=key_hash,json=keyHash,proto3" json:"key_hash,omitempty"`
	Entries []*KVMetadataEntry `protobuf:"bytes,2,rep,name=entries" json:"entries,omitempty"`
}

KVMetadataWriteHash captures all the upserts to the metadata associated with a key hash

func (*KVMetadataWriteHash) Descriptor 

func (*KVMetadataWriteHash) Descriptor() ([]byte, []int)

func (*KVMetadataWriteHash) GetEntries 

func (m *KVMetadataWriteHash) GetEntries() []*KVMetadataEntry

func (*KVMetadataWriteHash) GetKeyHash 

func (m *KVMetadataWriteHash) GetKeyHash() []byte

func (*KVMetadataWriteHash) ProtoMessage 

func (*KVMetadataWriteHash) ProtoMessage()

func (*KVMetadataWriteHash) Reset 

func (m *KVMetadataWriteHash) Reset()

func (*KVMetadataWriteHash) String 

func (m *KVMetadataWriteHash) String() string

type KVRWSet 

type KVRWSet struct {
	Reads            []*KVRead          `protobuf:"bytes,1,rep,name=reads" json:"reads,omitempty"`
	RangeQueriesInfo []*RangeQueryInfo  `protobuf:"bytes,2,rep,name=range_queries_info,json=rangeQueriesInfo" json:"range_queries_info,omitempty"`
	Writes           []*KVWrite         `protobuf:"bytes,3,rep,name=writes" json:"writes,omitempty"`
	MetadataWrites   []*KVMetadataWrite `protobuf:"bytes,4,rep,name=metadata_writes,json=metadataWrites" json:"metadata_writes,omitempty"`
}

KVRWSet encapsulates the read-write set for a chaincode that operates upon a KV or Document data model This structure is used for both the public data and the private data

func (*KVRWSet) Descriptor 

func (*KVRWSet) Descriptor() ([]byte, []int)

func (*KVRWSet) GetMetadataWrites 

func (m *KVRWSet) GetMetadataWrites() []*KVMetadataWrite

func (*KVRWSet) GetRangeQueriesInfo 

func (m *KVRWSet) GetRangeQueriesInfo() []*RangeQueryInfo

func (*KVRWSet) GetReads 

func (m *KVRWSet) GetReads() []*KVRead

func (*KVRWSet) GetWrites 

func (m *KVRWSet) GetWrites() []*KVWrite

func (*KVRWSet) ProtoMessage 

func (*KVRWSet) ProtoMessage()

func (*KVRWSet) Reset 

func (m *KVRWSet) Reset()

func (*KVRWSet) String 

func (m *KVRWSet) String() string

type KVRead 

type KVRead struct {
	Key     string   `protobuf:"bytes,1,opt,name=key" json:"key,omitempty"`
	Version *Version `protobuf:"bytes,2,opt,name=version" json:"version,omitempty"`
}

KVRead captures a read operation performed during transaction simulation A 'nil' version indicates a non-existing key read by the transaction

func (*KVRead) Descriptor 

func (*KVRead) Descriptor() ([]byte, []int)

func (*KVRead) GetKey 

func (m *KVRead) GetKey() string

func (*KVRead) GetVersion 

func (m *KVRead) GetVersion() *Version

func (*KVRead) ProtoMessage 

func (*KVRead) ProtoMessage()

func (*KVRead) Reset 

func (m *KVRead) Reset()

func (*KVRead) String 

func (m *KVRead) String() string

type KVReadHash 

type KVReadHash struct {
	KeyHash []byte   `protobuf:"bytes,1,opt,name=key_hash,json=keyHash,proto3" json:"key_hash,omitempty"`
	Version *Version `protobuf:"bytes,2,opt,name=version" json:"version,omitempty"`
}

KVReadHash is similar to the KVRead in spirit. However, it captures the hash of the key instead of the key itself version is kept as is for now. However, if the version also needs to be privacy-protected, it would need to be the hash of the version and hence of 'bytes' type

func (*KVReadHash) Descriptor 

func (*KVReadHash) Descriptor() ([]byte, []int)

func (*KVReadHash) GetKeyHash 

func (m *KVReadHash) GetKeyHash() []byte

func (*KVReadHash) GetVersion 

func (m *KVReadHash) GetVersion() *Version

func (*KVReadHash) ProtoMessage 

func (*KVReadHash) ProtoMessage()

func (*KVReadHash) Reset 

func (m *KVReadHash) Reset()

func (*KVReadHash) String 

func (m *KVReadHash) String() string

type KVWrite 

type KVWrite struct {
	Key      string `protobuf:"bytes,1,opt,name=key" json:"key,omitempty"`
	IsDelete bool   `protobuf:"varint,2,opt,name=is_delete,json=isDelete" json:"is_delete,omitempty"`
	Value    []byte `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
}

KVWrite captures a write (update/delete) operation performed during transaction simulation

func (*KVWrite) Descriptor 

func (*KVWrite) Descriptor() ([]byte, []int)

func (*KVWrite) GetIsDelete 

func (m *KVWrite) GetIsDelete() bool

func (*KVWrite) GetKey 

func (m *KVWrite) GetKey() string

func (*KVWrite) GetValue 

func (m *KVWrite) GetValue() []byte

func (*KVWrite) ProtoMessage 

func (*KVWrite) ProtoMessage()

func (*KVWrite) Reset 

func (m *KVWrite) Reset()

func (*KVWrite) String 

func (m *KVWrite) String() string

type KVWriteHash 

type KVWriteHash struct {
	KeyHash   []byte `protobuf:"bytes,1,opt,name=key_hash,json=keyHash,proto3" json:"key_hash,omitempty"`
	IsDelete  bool   `protobuf:"varint,2,opt,name=is_delete,json=isDelete" json:"is_delete,omitempty"`
	ValueHash []byte `protobuf:"bytes,3,opt,name=value_hash,json=valueHash,proto3" json:"value_hash,omitempty"`
}

KVWriteHash is similar to the KVWrite. It captures a write (update/delete) operation performed during transaction simulation

func (*KVWriteHash) Descriptor 

func (*KVWriteHash) Descriptor() ([]byte, []int)

func (*KVWriteHash) GetIsDelete 

func (m *KVWriteHash) GetIsDelete() bool

func (*KVWriteHash) GetKeyHash 

func (m *KVWriteHash) GetKeyHash() []byte

func (*KVWriteHash) GetValueHash 

func (m *KVWriteHash) GetValueHash() []byte

func (*KVWriteHash) ProtoMessage 

func (*KVWriteHash) ProtoMessage()

func (*KVWriteHash) Reset 

func (m *KVWriteHash) Reset()

func (*KVWriteHash) String 

func (m *KVWriteHash) String() string

type QueryReads 

type QueryReads struct {
	KvReads []*KVRead `protobuf:"bytes,1,rep,name=kv_reads,json=kvReads" json:"kv_reads,omitempty"`
}

QueryReads encapsulates the KVReads for the items read by a transaction as a result of a query execution

func (*QueryReads) Descriptor 

func (*QueryReads) Descriptor() ([]byte, []int)

func (*QueryReads) GetKvReads 

func (m *QueryReads) GetKvReads() []*KVRead

func (*QueryReads) ProtoMessage 

func (*QueryReads) ProtoMessage()

func (*QueryReads) Reset 

func (m *QueryReads) Reset()

func (*QueryReads) String 

func (m *QueryReads) String() string

type QueryReadsMerkleSummary 

type QueryReadsMerkleSummary struct {
	MaxDegree      uint32   `protobuf:"varint,1,opt,name=max_degree,json=maxDegree" json:"max_degree,omitempty"`
	MaxLevel       uint32   `protobuf:"varint,2,opt,name=max_level,json=maxLevel" json:"max_level,omitempty"`
	MaxLevelHashes [][]byte `protobuf:"bytes,3,rep,name=max_level_hashes,json=maxLevelHashes,proto3" json:"max_level_hashes,omitempty"`
}

QueryReadsMerkleSummary encapsulates the Merkle-tree hashes for the QueryReads This allows to reduce the size of RWSet in the presence of query results by storing certain hashes instead of actual results. maxDegree field refers to the maximum number of children in the tree at any level maxLevel field contains the lowest level which has lesser nodes than maxDegree (starting from leaf level)

func (*QueryReadsMerkleSummary) Descriptor 

func (*QueryReadsMerkleSummary) Descriptor() ([]byte, []int)

func (*QueryReadsMerkleSummary) Equal 

func (ms *QueryReadsMerkleSummary) Equal(anotherMS *QueryReadsMerkleSummary) bool

Equal verifies whether the give MerkleSummary is equals to this

func (*QueryReadsMerkleSummary) GetMaxDegree 

func (m *QueryReadsMerkleSummary) GetMaxDegree() uint32

func (*QueryReadsMerkleSummary) GetMaxLevel 

func (m *QueryReadsMerkleSummary) GetMaxLevel() uint32

func (*QueryReadsMerkleSummary) GetMaxLevelHashes 

func (m *QueryReadsMerkleSummary) GetMaxLevelHashes() [][]byte

func (*QueryReadsMerkleSummary) ProtoMessage 

func (*QueryReadsMerkleSummary) ProtoMessage()

func (*QueryReadsMerkleSummary) Reset 

func (m *QueryReadsMerkleSummary) Reset()

func (*QueryReadsMerkleSummary) String 

func (m *QueryReadsMerkleSummary) String() string

type RangeQueryInfo 

type RangeQueryInfo struct {
	StartKey     string `protobuf:"bytes,1,opt,name=start_key,json=startKey" json:"start_key,omitempty"`
	EndKey       string `protobuf:"bytes,2,opt,name=end_key,json=endKey" json:"end_key,omitempty"`
	ItrExhausted bool   `protobuf:"varint,3,opt,name=itr_exhausted,json=itrExhausted" json:"itr_exhausted,omitempty"`
	// Types that are valid to be assigned to ReadsInfo:
	//	*RangeQueryInfo_RawReads
	//	*RangeQueryInfo_ReadsMerkleHashes
	ReadsInfo isRangeQueryInfo_ReadsInfo `protobuf_oneof:"reads_info"`
}

RangeQueryInfo encapsulates the details of a range query performed by a transaction during simulation. This helps protect transactions from phantom reads by varifying during validation whether any new items got committed within the given range between transaction simuation and validation (in addition to regular checks for updates/deletes of the existing items). readInfo field contains either the KVReads (for the items read by the range query) or a merkle-tree hash if the KVReads exceeds a pre-configured numbers

func (*RangeQueryInfo) Descriptor 

func (*RangeQueryInfo) Descriptor() ([]byte, []int)

func (*RangeQueryInfo) GetEndKey 

func (m *RangeQueryInfo) GetEndKey() string

func (*RangeQueryInfo) GetItrExhausted 

func (m *RangeQueryInfo) GetItrExhausted() bool

func (*RangeQueryInfo) GetRawReads 

func (m *RangeQueryInfo) GetRawReads() *QueryReads

func (*RangeQueryInfo) GetReadsInfo 

func (m *RangeQueryInfo) GetReadsInfo() isRangeQueryInfo_ReadsInfo

func (*RangeQueryInfo) GetReadsMerkleHashes 

func (m *RangeQueryInfo) GetReadsMerkleHashes() *QueryReadsMerkleSummary

func (*RangeQueryInfo) GetStartKey 

func (m *RangeQueryInfo) GetStartKey() string

func (*RangeQueryInfo) ProtoMessage 

func (*RangeQueryInfo) ProtoMessage()

func (*RangeQueryInfo) Reset 

func (m *RangeQueryInfo) Reset()

func (*RangeQueryInfo) SetMerkelSummary 

func (rqi *RangeQueryInfo) SetMerkelSummary(merkleSummary *QueryReadsMerkleSummary)

SetMerkelSummary sets the 'readsInfo' field to merkle summary of the raw KVReads of query results

func (*RangeQueryInfo) SetRawReads 

func (rqi *RangeQueryInfo) SetRawReads(kvReads []*KVRead)

SetRawReads sets the 'readsInfo' field to raw KVReads performed by the query

func (*RangeQueryInfo) String 

func (m *RangeQueryInfo) String() string

func (*RangeQueryInfo) XXX_OneofFuncs 

func (*RangeQueryInfo) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type RangeQueryInfo_RawReads 

type RangeQueryInfo_RawReads struct {
	RawReads *QueryReads `protobuf:"bytes,4,opt,name=raw_reads,json=rawReads,oneof"`
}

type RangeQueryInfo_ReadsMerkleHashes 

type RangeQueryInfo_ReadsMerkleHashes struct {
	ReadsMerkleHashes *QueryReadsMerkleSummary `protobuf:"bytes,5,opt,name=reads_merkle_hashes,json=readsMerkleHashes,oneof"`
}

type Version 

type Version struct {
	BlockNum uint64 `protobuf:"varint,1,opt,name=block_num,json=blockNum" json:"block_num,omitempty"`
	TxNum    uint64 `protobuf:"varint,2,opt,name=tx_num,json=txNum" json:"tx_num,omitempty"`
}

Version encapsulates the version of a Key A version of a committed key is maintained as the height of the transaction that committed the key. The height is represenetd as a tuple <blockNum, txNum> where the txNum is the position of the transaction (starting with 0) within block

func (*Version) Descriptor 

func (*Version) Descriptor() ([]byte, []int)

func (*Version) GetBlockNum 

func (m *Version) GetBlockNum() uint64

func (*Version) GetTxNum 

func (m *Version) GetTxNum() uint64

func (*Version) ProtoMessage 

func (*Version) ProtoMessage()

func (*Version) Reset 

func (m *Version) Reset()

func (*Version) String 

func (m *Version) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.