Options
All
  • Public
  • Public/Protected
  • All
Menu

Schema for the result of a query search operation.

Hierarchy

  • SearchResult

Index

Properties

Optional bookmark

bookmark: string

Opaque bookmark token used when paginating results.

Optional by

by: string

Grouped search matches.

Optional counts

counts: JsonObject

The counts facet syntax returns the number of query results for each unique value of each named field.

Optional groups

Array of grouped search matches.

Optional ranges

ranges: JsonObject

The range facet syntax reuses the standard Lucene syntax for ranges to return counts of results that fit into each specified category.

Optional rows

Array of row objects.

total_rows

total_rows: number

Number of total rows.

Generated using TypeDoc