prefix_scan Struct Reference

A prefix scan performs a scan that includes all documents whose keys start with the given prefix. More...

#include <couchbase/scan_type.hxx>

Inheritance diagram for prefix_scan:

Public Member Functions
	prefix_scan (std::string prefix)
	Creates an instance of a prefix scan type.
auto	build () const -> built override
	Returns the prefix scan type as an immutable value.
Public Member Functions inherited from scan_type
virtual	~scan_type ()=default

Detailed Description

A prefix scan performs a scan that includes all documents whose keys start with the given prefix.

Since

1.0.0

Committed

Generally available API and should be preferred in production

Constructor & Destructor Documentation

prefix_scan()

prefix_scan ( std::string prefix )

inlineexplicit

Creates an instance of a prefix scan type.

Parameters

prefix

The prefix all document keys should start with.

Since

1.0.0

Committed

Generally available API and should be preferred in production

Member Function Documentation

build()

auto build ( ) const -> built

inlinenodiscardoverridevirtual

Returns the prefix scan type as an immutable value.

Returns

scan type as an immutable value.

Since

1.0.0

Internal

Internal interface

Implements scan_type.

---

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

• couchbase/scan_type.hxx