GroupBy

Updated at:

GroupBy defines the configuration of a single group in a search index query.

Data structure

message GroupBy {
    optional string name = 1;
    optional GroupByType type = 2;
    optional bytes body = 3;
}

Parameter

Type

Required

Description

name

string

Yes

The name of the group. Names identify different groups within the same query.

type

GroupByType

Yes

The type of the group.

body

bytes

Yes

The grouping condition, encoded in protobuf format.