doc_id_query Class Reference

A doc_id query is a query that directly matches the documents whose ID have been provided. More...

#include <couchbase/doc_id_query.hxx>

Inheritance diagram for doc_id_query:

Public Member Functions
	doc_id_query ()=default
	doc_id_query (std::vector< std::string > ids)
	Create a new doc_id query.
	doc_id_query (std::initializer_list< std::string > ids)
	Create a new doc_id query.
auto	doc_ids (const std::vector< std::string > &ids) -> doc_id_query &
	Add IDs to the query.
auto	doc_id (const std::string &id) -> doc_id_query &
	Add ID to the query.
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 doc_id query is a query that directly matches the documents whose ID have been provided.

It can be combined within a conjunction_query to restrict matches on the set of documents.

Since

1.0.0

Committed

Generally available API and should be preferred in production

Constructor & Destructor Documentation

doc_id_query() [1/3]

doc_id_query ( )

default

doc_id_query() [2/3]

doc_id_query ( std::vector< std::string > ids )

inlineexplicit

Create a new doc_id query.

Parameters

ids	the list of document IDs to be restricted against.

Since

1.0.0

Committed

Generally available API and should be preferred in production

doc_id_query() [3/3]

doc_id_query ( std::initializer_list< std::string > ids )

inline

Create a new doc_id query.

Parameters

ids	the list of document IDs to be restricted against.

Since

1.0.0

Committed

Generally available API and should be preferred in production

Member Function Documentation

doc_id()

auto doc_id ( const std::string & id ) -> doc_id_query&

inline

Add ID to the query.

Parameters

id	the document identifier to add

Returns

this query for chaining purposes.

Since

1.0.0

Committed

Generally available API and should be preferred in production

doc_ids()

auto doc_ids ( const std::vector< std::string > & ids ) -> doc_id_query&

inline

Add IDs to the query.

Parameters

ids	the list of document identifiers to add

Returns

this query for chaining purposes.

Since

1.0.0

Committed

Generally available API and should be preferred in production

encode()

auto encode ( ) const -> encoded_search_query

nodiscardoverridevirtual

Returns

encoded representation of the query.

Since

1.0.0

Internal

Internal interface

Implements search_query.

---

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

• couchbase/doc_id_query.hxx