cosmos-sdk/orm/model/ormtable/singleton.go
Aaron Craelius 531bf50845
feat(orm): add ORM Table and Indexes (#10670)
## 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)
2022-01-20 16:22:06 +00:00

94 lines
1.7 KiB
Go

package ormtable
import (
"context"
"encoding/json"
"io"
"google.golang.org/protobuf/encoding/protojson"
)
// singleton implements a Table instance for singletons.
type singleton struct {
*tableImpl
}
func (t singleton) DefaultJSON() json.RawMessage {
msg := t.MessageType().New().Interface()
bz, err := t.jsonMarshalOptions().Marshal(msg)
if err != nil {
return json.RawMessage("{}")
}
return bz
}
func (t singleton) ValidateJSON(reader io.Reader) error {
bz, err := io.ReadAll(reader)
if err != nil {
return err
}
msg := t.MessageType().New().Interface()
err = protojson.Unmarshal(bz, msg)
if err != nil {
return err
}
if t.customJSONValidator != nil {
return t.customJSONValidator(msg)
} else {
return DefaultJSONValidator(msg)
}
}
func (t singleton) ImportJSON(ctx context.Context, reader io.Reader) error {
backend, err := t.getBackend(ctx)
if err != nil {
return err
}
bz, err := io.ReadAll(reader)
if err != nil {
return err
}
msg := t.MessageType().New().Interface()
err = protojson.Unmarshal(bz, msg)
if err != nil {
return err
}
return t.save(backend, msg, saveModeDefault)
}
func (t singleton) ExportJSON(ctx context.Context, writer io.Writer) error {
msg := t.MessageType().New().Interface()
found, err := t.Get(ctx, msg)
if err != nil {
return err
}
var bz []byte
if !found {
bz = t.DefaultJSON()
} else {
bz, err = t.jsonMarshalOptions().Marshal(msg)
if err != nil {
return err
}
}
_, err = writer.Write(bz)
return err
}
func (t singleton) jsonMarshalOptions() protojson.MarshalOptions {
return protojson.MarshalOptions{
Multiline: true,
Indent: "",
UseProtoNames: true,
EmitUnpopulated: true,
Resolver: t.typeResolver,
}
}