query

Documentation

Index

• Constants
• Variables
• type PageRequest
  • func FormatPageRequest(pageReq *PageRequest) (*PageRequest, sdk.Error)
  • 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) 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 (*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 (
	CountTotalErrMsg = "pageRequest error: CountTotal is not supported, must be false"
	LimitErrMsg      = "pageRequest error: Limit cannot be empty and cannot exceed 100"
	OffsetKeyErrMsg  = "pageRequest error: Only one Offset or Key is allowed"
)

Variables

var (
	ErrInvalidLengthPagination        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowPagination          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupPagination = fmt.Errorf("proto: unexpected end of group")
)

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"`
}

PageRequest is to be embedded in gRPC request messages for efficient pagination. Ex:

message SomeRequest {
        Foo some_parameter = 1;
        PageRequest pagination = 2;
}

func FormatPageRequest

func FormatPageRequest(pageReq *PageRequest) (*PageRequest, sdk.Error)

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) Marshal

func (m *PageRequest) Marshal() (dAtA []byte, err error)

func (*PageRequest) MarshalTo

func (m *PageRequest) MarshalTo(dAtA []byte) (int, 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
	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 (*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) MarshalTo

func (m *PageResponse) MarshalTo(dAtA []byte) (int, 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