Skip to main content

Glossary: IndexQuery

Properties

NameTypeDescription
PageSizeSetboolWhatever the page size was explicitly set or still at its default value
IsDistinctboolWhatever we should apply distinct operation to the query on the server side
QuerystringThe query
TotalSizeReference<int>The total size
SortHintsDictionary<string, SortOptions>The sort hints
TransformerParametersDictionary<string, RavenJToken>Additional transformer parameters
StartintThe start of records to read
PageSizeintThe page size
FieldsToFetchstring[]The fields names to fetch
SortedFieldsSortedField[]The fields to sort by
CutoffDateTime?The cutoff date
WaitForNonStaleResultsAsOfNowboolthe WaitForNonStaleResultsAsOfNow
WaitForNonStaleResultsboolthe WaitForNonStaleResults
CutoffEtagEtagCutoff etag is used to check if the index has already process a document with the given etag. Unlike Cutoff, which uses dates and is susceptible to clock synchronization issues between machines, cutoff etag doesn't rely on both the server and client having a synchronized clock and can work without it. However, when used to query map/reduce indexes, it does NOT guarantee that the document that this etag belong to is actually considered for the results. What it does it guarantee that the document has been mapped, but not that the mapped values has been reduce. Since map/reduce queries, by their nature,tend to be far less susceptible to issues with staleness, this is considered to be an acceptable tradeoff. If you need absolute no staleness with a map/reduce index, you will need to ensure synchronized clocks and use the Cutoff date option, instead.
DefaultFieldstringThe default field to use when querying directly on the Lucene query
DefaultOperatorQueryOperatorChanges the default operator mode we use for queries. When set to Or a query such as 'Name:John Age:18' will be interpreted as: Name:John OR Age:18 When set to And the query will be interpreted as: Name:John AND Age:18
AllowMultipleIndexEntriesForSameDocumentToResultTransformerboolIf set to true, this property will send multiple index entries from the same document (assuming the index project them) to the result transformer function. Otherwise, those entries will be consolidate an the transformer will be called just once for each document in the result set
SkippedResultsReference<int>the number of skipped results.
DebugOptionGetIndexEntriesboolWhatever we should get the raw index queries
HighlightedFieldsHighlightedField[]The options to highlight the fields
HighlighterPreTagsstring[]The highlighter pre tags
HighlighterPostTagsstring[]The highlighter post tags
ResultsTransformerstringThe results transformer
DisableCachingboolWhatever we should disable caching of query results
SkipDuplicateCheckingboolAllow to skip duplicate checking during queries
ExplainScoresboolWhatever a query result should contains an explanation about how docs scored against query
ShowTimingsboolIndicates if detailed timings should be calculated for various query parts (Lucene search, loading documents, transforming results). Default: false