 | SearchOptions Class |
Represents a number of query options that can be applied to a FTS query request.
Inheritance HierarchySystemObject
Couchbase.SearchSearchOptions
Couchbase.SearchSearchOptions
Namespace: Couchbase.Search
Assembly: Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 3.0.0-local-202004010202+047adc0837bfc29c0b8cce4322194a09afd8ea18
SyntaxC#
public class SearchOptions
The SearchOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SearchOptions | Initializes a new instance of the SearchOptions class |
Methods| Name | Description | |
|---|---|---|
| CancellationToken | |
| ConsistentWith | |
| Explain |
If true, the response will include additional search score explanations.
|
| Facets | ISearchFacets used to aggregate information collected on a particular result set.
|
| Fields |
List of fields values that should be returned in the result assuming that they were indexed.
|
| Highlight(HighLightStyle) |
Allows setting of additional highlighting on the result set of matching terms.
|
| Highlight(HighLightStyle, String) |
Allows setting of additional highlighting on the result set of matching terms.
|
| Limit |
Limits the number of matching results from a returned result-set.
|
| Raw | |
| ScanConsistency |
The SearchScanConsistency you require for you ISearchResults.
|
| Skip |
Skip indicates how many matching results to skip on the result set before returning matches.
|
| Sort(JObject) |
Configures the sorting criteria for the search results using a custom JObject.
|
| Sort(String) |
Configures the list of fields which are used for sorting the search result. Fields with a prefix of "-" indicate a descending nature.
If no sort is provided, it is equal to sort("-_score"), since the server will sort it by score in descending order by default.
|
| Sort(ISearchSort) |
Configures the sorting criteria for the search results using an implementation of ISearchSort.
|
| Timeout |
The server side timeout allows to specify an upper boundary of request execution so that it potentially doesn't run infinitely.
|
| ToJson | |
| ToString |
Returns a String that represents this instance.
(Overrides ObjectToString.) |
See Also