.. Generated by tools/docgen from tools/docgen/config/layout.yaml and tools/public_api.yaml. Do not edit; run `python -m tools.docgen generate --write`. Search ====== .. module:: couchbase.search Requests -------- .. autosummary:: HighlightStyle MatchOperator SearchQuery SearchRequest SearchScanConsistency .. autoclass:: HighlightStyle :members: :undoc-members: .. autoclass:: MatchOperator :members: :undoc-members: .. autoclass:: SearchQuery :members: .. autoclass:: SearchRequest :members: .. autoclass:: SearchScanConsistency :members: :undoc-members: Queries ------- .. autosummary:: BooleanFieldQuery BooleanQuery ConjunctionQuery DateRangeQuery DisjunctionQuery DocIdQuery GeoBoundingBoxQuery GeoDistanceQuery GeoPolygonQuery MatchAllQuery MatchNoneQuery MatchPhraseQuery MatchQuery NumericRangeQuery PhraseQuery PrefixQuery QueryStringQuery RawQuery RegexQuery TermQuery TermRangeQuery WildcardQuery .. autoclass:: BooleanFieldQuery :members: .. autoclass:: BooleanQuery :members: .. autoclass:: ConjunctionQuery :members: .. autoclass:: DateRangeQuery :members: .. autoclass:: DisjunctionQuery :members: .. autoclass:: DocIdQuery :members: .. autoclass:: GeoBoundingBoxQuery :members: .. autoclass:: GeoDistanceQuery :members: .. autoclass:: GeoPolygonQuery :members: .. autoclass:: MatchAllQuery :members: .. autoclass:: MatchNoneQuery :members: .. autoclass:: MatchPhraseQuery :members: .. autoclass:: MatchQuery :members: .. autoclass:: NumericRangeQuery :members: .. autoclass:: PhraseQuery :members: .. autoclass:: PrefixQuery :members: .. autoclass:: QueryStringQuery :members: .. autoclass:: RawQuery :members: .. autoclass:: RegexQuery :members: .. autoclass:: TermQuery :members: .. autoclass:: TermRangeQuery :members: .. autoclass:: WildcardQuery :members: Facets ------ .. autosummary:: DateFacet Facet NumericFacet TermFacet .. autoclass:: DateFacet :members: .. autoclass:: Facet :members: .. autoclass:: NumericFacet :members: .. autoclass:: TermFacet :members: Sorting ------- .. autosummary:: Sort SortField SortGeoDistance SortID SortScore .. autoclass:: Sort :members: .. autoclass:: SortField :members: .. autoclass:: SortGeoDistance :members: .. autoclass:: SortID :members: .. autoclass:: SortScore :members: Results ------- .. autosummary:: SearchDateRangeFacet SearchFacetResult SearchMetaData SearchMetrics SearchNumericRangeFacet SearchRow SearchRowFields SearchRowLocation SearchRowLocations SearchTermFacet .. autoclass:: SearchDateRangeFacet :members: .. autoclass:: SearchFacetResult :members: .. autoclass:: SearchMetaData :members: .. autoclass:: SearchMetrics :members: .. autoclass:: SearchNumericRangeFacet :members: .. autoclass:: SearchRow :members: .. autoclass:: SearchRowFields :members: .. autoclass:: SearchRowLocation :members: .. autoclass:: SearchRowLocations :members: .. autoclass:: SearchTermFacet :members: