531bf50845
## Description Closes: #10729 Includes: * table, auto-increment table, and singleton `Table` implementations * primary key, index and unique index `Index` implementations * store wrappers based on tm-db but that could be retargeted to the new ADR 040 db which separate index and commitment stores, with a debug wrapper * streaming JSON import and export * full logical decoding (and encoding) --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [x] included comments for [documenting Go code](https://blog.golang.org/godoc) - [x] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
49 lines
1.9 KiB
Go
49 lines
1.9 KiB
Go
package ormkv
|
|
|
|
import "google.golang.org/protobuf/reflect/protoreflect"
|
|
|
|
// EntryCodec defines an interfaces for decoding and encoding entries in the
|
|
// kv-store backing an ORM instance. EntryCodec's enable full logical decoding
|
|
// of ORM data.
|
|
type EntryCodec interface {
|
|
|
|
// DecodeEntry decodes a kv-pair into an Entry.
|
|
DecodeEntry(k, v []byte) (Entry, error)
|
|
|
|
// EncodeEntry encodes an entry into a kv-pair.
|
|
EncodeEntry(entry Entry) (k, v []byte, err error)
|
|
}
|
|
|
|
// IndexCodec defines an interfaces for encoding and decoding index-keys in the
|
|
// kv-store.
|
|
type IndexCodec interface {
|
|
EntryCodec
|
|
|
|
// MessageType returns the message type this index codec applies to.
|
|
MessageType() protoreflect.MessageType
|
|
|
|
// GetFieldNames returns the field names in the key of this index.
|
|
GetFieldNames() []protoreflect.Name
|
|
|
|
// DecodeIndexKey decodes a kv-pair into index-fields and primary-key field
|
|
// values. These fields may or may not overlap depending on the index.
|
|
DecodeIndexKey(k, v []byte) (indexFields, primaryKey []protoreflect.Value, err error)
|
|
|
|
// EncodeKVFromMessage encodes a kv-pair for the index from a message.
|
|
EncodeKVFromMessage(message protoreflect.Message) (k, v []byte, err error)
|
|
|
|
// CompareKeys compares the provided values which must correspond to the
|
|
// fields in this key. Prefix keys of different lengths are supported but the
|
|
// function will panic if either array is too long. A negative value is returned
|
|
// if values1 is less than values2, 0 is returned if the two arrays are equal,
|
|
// and a positive value is returned if values2 is greater.
|
|
CompareKeys(key1, key2 []protoreflect.Value) int
|
|
|
|
// EncodeKeyFromMessage encodes the key part of this index and returns both
|
|
// index values and encoded key.
|
|
EncodeKeyFromMessage(message protoreflect.Message) (keyValues []protoreflect.Value, key []byte, err error)
|
|
|
|
// IsFullyOrdered returns true if all fields in the key are also ordered.
|
|
IsFullyOrdered() bool
|
|
}
|