prefix_query Class Reference

The prefix query finds documents containing terms that start with the provided prefix. More...

#include <couchbase/prefix_query.hxx>

Inheritance diagram for prefix_query:

Public Member Functions
	prefix_query (std::string prefix)
	Create a new prefix query.
auto	field (std::string field_name) -> prefix_query &
	If a field is specified, only terms in that field will be matched.
auto	encode () const -> encoded_search_query override
Public Member Functions inherited from search_query
virtual	~search_query ()=default
template<typename derived_query = search_query, std::enable_if_t< std::is_base_of_v< search_query, derived_query >, bool > = true>
auto	boost (double boost) -> derived_query &
	The boost parameter is used to increase the relative weight of a clause (with a boost greater than 1) or decrease the relative weight (with a boost between 0 and 1).

Additional Inherited Members
Protected Member Functions inherited from search_query
	search_query ()=default
Protected Attributes inherited from search_query
std::optional< double >	boost_ {}

Detailed Description

The prefix query finds documents containing terms that start with the provided prefix.

Usual better alternative is match_query.

Match documents where field reviews.content contains words starting with "inter":

auto query = couchbase::prefix_query("inter").field("reviews.content");

See also

https://docs.couchbase.com/server/current/fts/fts-supported-queries-prefix-query.html server documentation

Since

1.0.0

Committed

Generally available API and should be preferred in production

Constructor & Destructor Documentation

prefix_query()

prefix_query ( std::string prefix )

inlineexplicit

Create a new prefix query.

Parameters

prefix

prefix to match

Since

1.0.0

Committed

Generally available API and should be preferred in production

Member Function Documentation

encode()

auto encode ( ) const -> encoded_search_query

nodiscardoverridevirtual

Returns

encoded representation of the query.

Since

1.0.0

Internal

Internal interface

Implements search_query.

field()

auto field ( std::string field_name ) -> prefix_query&

inline

If a field is specified, only terms in that field will be matched.

Parameters

field_name

name of the field to be matched

Returns

this query for chaining purposes.

Since

1.0.0

Committed

Generally available API and should be preferred in production

---

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

• couchbase/prefix_query.hxx