Type Alias GroupByReturn<T, V>

The return of a query method in the collection.query namespace where the groupBy argument was specified.

type GroupByReturn<T, V> = {
    groups: Record<string, GroupByResult<T, V>>;
    objects: GroupByObject<T, V>[];
    queryProfile?: QueryProfile;
}

Type Parameters

T
V

Index

Properties

groups objects queryProfile?

Properties

groups

groups: Record<string, GroupByResult<T, V>>

The groups that were created by the query.

objects

objects: GroupByObject<T, V>[]

The objects that were found by the query.

`Optional`queryProfile

queryProfile?: QueryProfile

The metadata about the query execution. This contains different datastructures depending on the search type, e.g. vector vs keyword.