package cosmos.orm.query.v1alpha1

Get desktop application:
View/edit binary Protocol Buffers messages

Query is a generic gRPC service for querying ORM data.

• rpc Get (GetRequest, GetResponse)

  query.proto:14

  Get queries an ORM table against an unique index.

  message GetRequest

  query.proto:21

  GetRequest is the Query/Get request type.

  • string message_name = 1

    message_name is the fully-qualified message name of the ORM table being queried.

  • string index = 2

    index is the index fields expression used in orm definitions. If it is empty, the table's primary key is assumed. If it is non-empty, it must refer to an unique index.

  • repeated IndexValue values = 3

    values are the values of the fields corresponding to the requested index. There must be as many values provided as there are fields in the index and these values must correspond to the index field types.

  message GetResponse

  query.proto:37

  GetResponse is the Query/Get response type.

  • optional google.protobuf.Any result = 1

    result is the result of the get query. If no value is found, the gRPC status code NOT_FOUND will be returned.

• rpc List (ListRequest, ListResponse)

  query.proto:17

  List queries an ORM table against an index.

  message ListRequest

  query.proto:45

  ListRequest is the Query/List request type.

  • string message_name = 1

    message_name is the fully-qualified message name of the ORM table being queried.

  • string index = 2

    index is the index fields expression used in orm definitions. If it is empty, the table's primary key is assumed.

  • oneof query

    query is the query expression corresponding to the provided index. If neither prefix nor range is specified, the query will list all the fields in the index.

    • ListRequest.Prefix prefix = 3

      prefix defines a prefix query.

    • ListRequest.Range range = 4

      range defines a range query.

  • optional base.query.v1beta1.PageRequest pagination = 5

    pagination is the pagination request.

  message ListResponse

  query.proto:91

  ListResponse is the Query/List response type.

  • repeated google.protobuf.Any results = 1

    results are the results of the query.

  • optional base.query.v1beta1.PageResponse pagination = 5

    pagination is the pagination response.

IndexValue represents the value of a field in an ORM index expression.

Used in: GetRequest, ListRequest.Prefix, ListRequest.Range

• oneof value

  value specifies the index value

  • uint64 uint = 1

    uint specifies a value for an uint32, fixed32, uint64, or fixed64 index field.

  • int64 int = 2

    int64 specifies a value for an int32, sfixed32, int64, or sfixed64 index field.

  • string str = 3

    str specifies a value for a string index field.

  • bytes bytes = 4

    bytes specifies a value for a bytes index field.

  • string enum = 5

    enum specifies a value for an enum index field.

  • bool bool = 6

    bool specifies a value for a bool index field.

  • google.protobuf.Timestamp timestamp = 7

    timestamp specifies a value for a timestamp index field.

  • google.protobuf.Duration duration = 8

    duration specifies a value for a duration index field.

Prefix specifies the arguments to a prefix query.

Used in: ListRequest

• repeated IndexValue values = 1

  values specifies the index values for the prefix query. It is valid to special a partial prefix with fewer values than the number of fields in the index.

Range specifies the arguments to a range query.

Used in: ListRequest

• repeated IndexValue start = 1

  start specifies the starting index values for the range query. It is valid to provide fewer values than the number of fields in the index.

• repeated IndexValue end = 2

  end specifies the inclusive ending index values for the range query. It is valid to provide fewer values than the number of fields in the index.