search_sort_score Class Reference

Sorts by the hit score. More...

#include <couchbase/search_sort_score.hxx>

Inheritance diagram for search_sort_score:

Public Member Functions
	search_sort_score ()=default
	search_sort_score (bool descending)
auto	descending (bool desc) -> search_sort_score &
	Set the sorting direction.
auto	encode () const -> encoded_search_sort override
Public Member Functions inherited from search_sort
virtual	~search_sort ()=default

Additional Inherited Members
Protected Member Functions inherited from search_sort
	search_sort ()=default
	search_sort (bool descending)
Protected Attributes inherited from search_sort
std::optional< bool >	descending_ {}

Detailed Description

Sorts by the hit score.

See also

https://docs.couchbase.com/server/current/fts/fts-search-request.html#sorting-with-objects

Since

1.0.0

Constructor & Destructor Documentation

search_sort_score() [1/2]

search_sort_score ( )

default

search_sort_score() [2/2]

search_sort_score ( bool descending )

inlineexplicit

Member Function Documentation

descending()

auto descending

(

bool

desc

)

-> search_sort_score &

Set the sorting direction.

Parameters

desc	true for descending order, false for ascending

Returns

pointer to this

Since

1.0.0

Committed

Generally available API and should be preferred in production

encode()

auto encode ( ) const -> encoded_search_sort

nodiscardoverridevirtual

Returns

encoded representation of the search facet.

Since

1.0.0

Internal

Internal interface

Implements search_sort.

---

The documentation for this class was generated from the following file:

• couchbase/search_sort_score.hxx