Interface SearchQueryOptions

interface SearchQueryOptions {
    collections?: string[];
    consistency?: NotBounded;
    consistentWith?: MutationState;
    disableScoring?: boolean;
    explain?: boolean;
    facets?: {
        [name: string]: SearchFacet;
    };
    fields?: string[];
    highlight?: {
        fields?: string[];
        style?: HighlightStyle;
    };
    includeLocations?: boolean;
    limit?: number;
    logRequest?: boolean;
    logResponse?: boolean;
    raw?: {
        [key: string]: any;
    };
    showRequest?: boolean;
    skip?: number;
    sort?: string[] | SearchSort[];
    timeout?: number;
}

Properties

collections? consistency? consistentWith? disableScoring? explain? facets? fields? highlight? includeLocations? limit? logRequest? logResponse? raw? showRequest? skip? sort? timeout?

Properties

Optional collections

collections?: string[]

Specifies the collections which should be searched as part of the query.

Optional consistency

consistency?: NotBounded

Specifies the consistency requirements when executing the query.

See

SearchScanConsistency

Optional consistentWith

consistentWith?: MutationState

Specifies a MutationState which the query should be consistent with.

See

MutationState

Optional disableScoring

disableScoring?: boolean

Specifies that scoring should be disabled. This improves performance but makes it impossible to sort based on how well a particular result scored.

Optional explain

explain?: boolean

Configures whether the result should contain the execution plan for the query.

Optional facets

facets?: {
    [name: string]: SearchFacet;
}

Specifies any facets that should be included in the query.

Type declaration

Optional fields

fields?: string[]

Specifies the list of fields which should be searched.

Optional highlight

highlight?: {
    fields?: string[];
    style?: HighlightStyle;
}

Specifies how the highlighting should behave. Specifically which mode should be used for highlighting as well as which fields should be highlighted.

Type declaration

Optional Experimental includeLocations

includeLocations?: boolean

If set to true, will include the locations in the search result.

This API is subject to change without notice.

Optional limit

limit?: number

Specifies the limit to the number of results that should be returned.

Optional logRequest

logRequest?: boolean

Uncommitted: This API is subject to change in the future. Specifies that the search request should appear in the log.

Optional logResponse

logResponse?: boolean

Uncommitted: This API is subject to change in the future. Specifies that the search response should appear in the log.

Optional raw

raw?: {
    [key: string]: any;
}

Specifies any additional parameters which should be passed to the query engine when executing the query.

Type declaration

  • [key: string]: any

Optional showRequest

showRequest?: boolean

Specifies that the search response should include the request JSON.

Optional skip

skip?: number

Specifies the number of results to skip from the index before returning results.

Optional sort

sort?: string[] | SearchSort[]

Specifies a list of fields or SearchSort's to use when sorting the result sets.

Optional timeout

timeout?: number

The timeout for this operation, represented in milliseconds.

Settings

Member Visibility

Theme

On This Page

collectionsconsistencyconsistentWithdisableScoringexplainfacetsfieldshighlightincludeLocationslimitlogRequestlogResponserawshowRequestskipsorttimeout