Class SearchOptions

couchbase/options.py:1595–1642

Available options to for a search (FTS) query. .. warning:: Importing options from ``couchbase.search`` is deprecated. All options should be imported from ``couchbase.options``. Args: timeout (timedelta, optional): The timeout for this operation. Defaults to global

class SearchOptions(SearchOptionsBase):
    """Available options to for a search (FTS) query.

    .. warning::
        Importing options from ``couchbase.search`` is deprecated.
        All options should be imported from ``couchbase.options``.

    Args:
        timeout (timedelta, optional): The timeout for this operation. Defaults to global
            search query operation timeout.
        limit (int, optional): Specifies the limit to the number of results that should be returned.
            Defaults to None.
        skip (int, optional): Specifies the number of results to skip from the index before returning
            results. Defaults to None.
        explain (bool, optional): Configures whether the result should contain the execution plan for the
            search query. Defaults to False.
        fields (List[str], optional): Specifies the list of fields which should be searched. Defaults to None.
        highlight_style (:class:`~couchbase.search.HighlightStyle`, optional): Specifies the mode used for
            highlighting.  Defaults to None.
        highlight_fields (List[str], optional): Specifies the list of fields that should be highlighted.
            Defaults to None.
        scan_consistency (:class:`~couchbase.search.SearchScanConsistency`, optional): Specifies the consistency
            requirements when executing the search query.
        facets (Dict[str, :class:`~couchbase.search.Facet`], optional): Specifies any facets that should be included
            in the search query. Defaults to None.
        client_context_id (str, optional): The returned client context id for this query. Defaults to None.
        disable_scoring (bool, optional): Specifies that scoring should be disabled. This improves performance but
            makes it impossible to sort based on how well a particular result scored. Defaults to False.
        include_locations (bool optional): If set to True, will include the locations in the search result.
            Defaults to False.
        sort (Union[List[str],List[:class:`~couchbase.search.Sort`]], optional): Specifies a list of fields or search
            :class:`~couchbase.search.Sort`'s to use when sorting the result sets. Defaults to None.
        scope_name (string, optional): Specifies the scope which should be searched as part of the search
            query. Defaults to None.
        collections (List[str], optional):  Specifies the collections which should be searched as part of the search
            query. Defaults to None.
        consistent_with (:class:`~couchbase.mutation_state.MutationState`, optional): Specifies a
            :class:`~couchbase.mutation_state.MutationState` which the search query should be consistent with.
            Defaults to None.
        serializer (:class:`~couchbase.serializer.Serializer`, optional): Specifies an explicit serializer
            to use for this specific search query. Defaults to
            :class:`~couchbase.serializer.DefaultJsonSerializer`.
        raw (Dict[str, Any], optional): Specifies any additional parameters which should be passed to the search query
            engine when executing the search query. Defaults to None.
        show_request (bool, optional): Specifies if the search response should contain the request for the search query. Defaults to False.
        log_request (bool, optional): **UNCOMMITTED** Specifies if search request body should appear the log. Defaults to False.
        log_response (bool, optional): **UNCOMMITTED** Specifies if search response should appear in the log. Defaults to False.
    """  # noqa: E501


class VectorSearchOptions(VectorSearchOptionsBase):