A wildcard query is a query in which term the character * will match 0..n occurrences of any characters and ? will match 1 occurrence of any character. More...

#include <couchbase/wildcard_query.hxx>

Inheritance diagram for wildcard_query:

Public Member Functions
	wildcard_query (std::string regexp)
	Create a new wildcard query.

auto	field (std::string field_name) -> wildcard_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

A wildcard query is a query in which term the character * will match 0..n occurrences of any characters and ? will match 1 occurrence of any character.

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

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

See also: https://docs.couchbase.com/server/current/fts/fts-supported-queries-wildcard.html server documentation

Since: 1.0.0

Committed: Generally available API and should be preferred in production

Constructor & Destructor Documentation

◆ wildcard_query()

wildcard_query ( std::string regexp )

inlineexplicit

Create a new wildcard query.

Parameters

regexp the wildcard-containing term to be analyzed and searched

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 ) -> wildcard_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/wildcard_query.hxx