Documentation
¶
Index ¶
- Constants
- Variables
- func ParsePagination(pageReq *PageRequest) (page, limit int, err error)
- type PageRequest
- func (*PageRequest) Descriptor() ([]byte, []int)
- func (m *PageRequest) GetCountTotal() bool
- func (m *PageRequest) GetKey() []byte
- func (m *PageRequest) GetLimit() uint64
- func (m *PageRequest) GetOffset() uint64
- func (m *PageRequest) GetReverse() bool
- func (m *PageRequest) Marshal() (dAtA []byte, err error)
- func (m *PageRequest) MarshalTo(dAtA []byte) (int, error)
- func (m *PageRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*PageRequest) ProtoMessage()
- func (m *PageRequest) Reset()
- func (m *PageRequest) Size() (n int)
- func (m *PageRequest) String() string
- func (m *PageRequest) Unmarshal(dAtA []byte) error
- func (m *PageRequest) XXX_DiscardUnknown()
- func (m *PageRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *PageRequest) XXX_Merge(src proto.Message)
- func (m *PageRequest) XXX_Size() int
- func (m *PageRequest) XXX_Unmarshal(b []byte) error
- type PageResponse
- func FilteredPaginate(prefixStore types.KVStore, pageRequest *PageRequest, ...) (*PageResponse, error)
- func GenericFilteredPaginate[T codec.ProtoMarshaler, F codec.ProtoMarshaler](cdc codec.BinaryCodec, prefixStore types.KVStore, pageRequest *PageRequest, ...) ([]F, *PageResponse, error)
- func Paginate(prefixStore types.KVStore, pageRequest *PageRequest, ...) (*PageResponse, error)
- func (*PageResponse) Descriptor() ([]byte, []int)
- func (m *PageResponse) GetNextKey() []byte
- func (m *PageResponse) GetTotal() uint64
- func (m *PageResponse) Marshal() (dAtA []byte, err error)
- func (m *PageResponse) MarshalTo(dAtA []byte) (int, error)
- func (m *PageResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*PageResponse) ProtoMessage()
- func (m *PageResponse) Reset()
- func (m *PageResponse) Size() (n int)
- func (m *PageResponse) String() string
- func (m *PageResponse) Unmarshal(dAtA []byte) error
- func (m *PageResponse) XXX_DiscardUnknown()
- func (m *PageResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *PageResponse) XXX_Merge(src proto.Message)
- func (m *PageResponse) XXX_Size() int
- func (m *PageResponse) XXX_Unmarshal(b []byte) error
Constants ¶
const DefaultLimit = 100
DefaultLimit is the default `limit` for queries if the `limit` is not supplied, paginate will use `DefaultLimit`
const DefaultPage = 1
DefaultPage is the default `page` number for queries. If the `page` number is not supplied, `DefaultPage` will be used.
const MaxLimit = math.MaxUint64
MaxLimit is the maximum limit the paginate function can handle which equals the maximum value that can be stored in uint64
Variables ¶
Functions ¶
func ParsePagination ¶
func ParsePagination(pageReq *PageRequest) (page, limit int, err error)
ParsePagination validate PageRequest and returns page number & limit.
Types ¶
type PageRequest ¶
type PageRequest struct {
// key is a value returned in PageResponse.next_key to begin
// querying the next page most efficiently. Only one of offset or key
// should be set.
Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
// offset is a numeric offset that can be used when key is unavailable.
// It is less efficient than using key. Only one of offset or key should
// be set.
Offset uint64 `protobuf:"varint,2,opt,name=offset,proto3" json:"offset,omitempty"`
// limit is the total number of results to be returned in the result page.
// If left empty it will default to a value to be set by each app.
Limit uint64 `protobuf:"varint,3,opt,name=limit,proto3" json:"limit,omitempty"`
// count_total is set to true to indicate that the result set should include
// a count of the total number of items available for pagination in UIs.
// count_total is only respected when offset is used. It is ignored when key
// is set.
CountTotal bool `protobuf:"varint,4,opt,name=count_total,json=countTotal,proto3" json:"count_total,omitempty"`
// reverse is set to true if results are to be returned in the descending order.
//
// Since: cosmos-sdk 0.43
Reverse bool `protobuf:"varint,5,opt,name=reverse,proto3" json:"reverse,omitempty"`
}
PageRequest is to be embedded in gRPC request messages for efficient pagination. Ex:
message SomeRequest {
Foo some_parameter = 1;
PageRequest pagination = 2;
}
func (*PageRequest) Descriptor ¶
func (*PageRequest) Descriptor() ([]byte, []int)
func (*PageRequest) GetCountTotal ¶
func (m *PageRequest) GetCountTotal() bool
func (*PageRequest) GetKey ¶
func (m *PageRequest) GetKey() []byte
func (*PageRequest) GetLimit ¶
func (m *PageRequest) GetLimit() uint64
func (*PageRequest) GetOffset ¶
func (m *PageRequest) GetOffset() uint64
func (*PageRequest) GetReverse ¶
func (m *PageRequest) GetReverse() bool
func (*PageRequest) Marshal ¶
func (m *PageRequest) Marshal() (dAtA []byte, err error)
func (*PageRequest) MarshalToSizedBuffer ¶
func (m *PageRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*PageRequest) ProtoMessage ¶
func (*PageRequest) ProtoMessage()
func (*PageRequest) Reset ¶
func (m *PageRequest) Reset()
func (*PageRequest) Size ¶
func (m *PageRequest) Size() (n int)
func (*PageRequest) String ¶
func (m *PageRequest) String() string
func (*PageRequest) Unmarshal ¶
func (m *PageRequest) Unmarshal(dAtA []byte) error
func (*PageRequest) XXX_DiscardUnknown ¶
func (m *PageRequest) XXX_DiscardUnknown()
func (*PageRequest) XXX_Marshal ¶
func (m *PageRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*PageRequest) XXX_Merge ¶
func (m *PageRequest) XXX_Merge(src proto.Message)
func (*PageRequest) XXX_Size ¶
func (m *PageRequest) XXX_Size() int
func (*PageRequest) XXX_Unmarshal ¶
func (m *PageRequest) XXX_Unmarshal(b []byte) error
type PageResponse ¶
type PageResponse struct {
// next_key is the key to be passed to PageRequest.key to
// query the next page most efficiently. It will be empty if
// there are no more results.
NextKey []byte `protobuf:"bytes,1,opt,name=next_key,json=nextKey,proto3" json:"next_key,omitempty"`
// total is total number of results available if PageRequest.count_total
// was set, its value is undefined otherwise
Total uint64 `protobuf:"varint,2,opt,name=total,proto3" json:"total,omitempty"`
}
PageResponse is to be embedded in gRPC response messages where the corresponding request message has used PageRequest.
message SomeResponse {
repeated Bar results = 1;
PageResponse page = 2;
}
func FilteredPaginate ¶
func FilteredPaginate( prefixStore types.KVStore, pageRequest *PageRequest, onResult func(key []byte, value []byte, accumulate bool) (bool, error), ) (*PageResponse, error)
FilteredPaginate does pagination of all the results in the PrefixStore based on the provided PageRequest. onResult should be used to do actual unmarshaling and filter the results. If key is provided, the pagination uses the optimized querying. If offset is used, the pagination uses lazy filtering i.e., searches through all the records. The accumulate parameter represents if the response is valid based on the offset given. It will be false for the results (filtered) < offset and true for `offset > accumulate <= end`. When accumulate is set to true the current result should be appended to the result set returned to the client.
func GenericFilteredPaginate ¶
func GenericFilteredPaginate[T codec.ProtoMarshaler, F codec.ProtoMarshaler]( cdc codec.BinaryCodec, prefixStore types.KVStore, pageRequest *PageRequest, onResult func(key []byte, value T) (F, error), constructor func() T, ) ([]F, *PageResponse, error)
GenericFilteredPaginate does pagination of all the results in the PrefixStore based on the provided PageRequest. `onResult` should be used to filter or transform the results. `c` is a constructor function that needs to return a new instance of the type T (this is to workaround some generic pitfalls in which we can't instantiate a T struct inside the function). If key is provided, the pagination uses the optimized querying. If offset is used, the pagination uses lazy filtering i.e., searches through all the records. The resulting slice (of type F) can be of a different type than the one being iterated through (type T), so it's possible to do any necessary transformation inside the onResult function.
func Paginate ¶
func Paginate( prefixStore types.KVStore, pageRequest *PageRequest, onResult func(key []byte, value []byte) error, ) (*PageResponse, error)
Paginate does pagination of all the results in the PrefixStore based on the provided PageRequest. onResult should be used to do actual unmarshaling.
func (*PageResponse) Descriptor ¶
func (*PageResponse) Descriptor() ([]byte, []int)
func (*PageResponse) GetNextKey ¶
func (m *PageResponse) GetNextKey() []byte
func (*PageResponse) GetTotal ¶
func (m *PageResponse) GetTotal() uint64
func (*PageResponse) Marshal ¶
func (m *PageResponse) Marshal() (dAtA []byte, err error)
func (*PageResponse) MarshalToSizedBuffer ¶
func (m *PageResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*PageResponse) ProtoMessage ¶
func (*PageResponse) ProtoMessage()
func (*PageResponse) Reset ¶
func (m *PageResponse) Reset()
func (*PageResponse) Size ¶
func (m *PageResponse) Size() (n int)
func (*PageResponse) String ¶
func (m *PageResponse) String() string
func (*PageResponse) Unmarshal ¶
func (m *PageResponse) Unmarshal(dAtA []byte) error
func (*PageResponse) XXX_DiscardUnknown ¶
func (m *PageResponse) XXX_DiscardUnknown()
func (*PageResponse) XXX_Marshal ¶
func (m *PageResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*PageResponse) XXX_Merge ¶
func (m *PageResponse) XXX_Merge(src proto.Message)
func (*PageResponse) XXX_Size ¶
func (m *PageResponse) XXX_Size() int
func (*PageResponse) XXX_Unmarshal ¶
func (m *PageResponse) XXX_Unmarshal(b []byte) error
Source Files