Interface SearchResult

Schema for the result of a query search operation.

Hierarchy

  • SearchResult

Properties

bookmark by counts groups ranges rows total_rows

Properties

Optional bookmark

bookmark?: string

Opaque bookmark token used when paginating results.

Optional by

by?: string

Grouped search matches.

Optional counts

counts?: export=.JsonObject

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

Optional groups

groups?: export=.SearchResultProperties[]

Array of grouped search matches.

Optional ranges

ranges?: export=.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

rows?: export=.SearchResultRow[]

Array of row objects.

total_rows

total_rows: number

Number of total rows.

Settings

Member Visibility

Theme

Generated using TypeDoc