scope_search_index_manager Class Reference

#include <couchbase/scope_search_index_manager.hxx>

Public Member Functions
void	get_index (std::string index_name, const get_search_index_options &options, get_search_index_handler &&handler) const
	Fetches a scope-level index from the server if it exists.
auto	get_index (std::string index_name, const get_search_index_options &options={}) const -> std::future< std::pair< error, management::search::index > >
void	get_all_indexes (const get_all_search_indexes_options &options, get_all_search_indexes_handler &&handler) const
	Fetches all scope-level indexes from the server.
auto	get_all_indexes (const get_all_search_indexes_options &options={}) const -> std::future< std::pair< error, std::vector< management::search::index > > >
void	upsert_index (const management::search::index &search_index, const upsert_search_index_options &options, upsert_search_index_handler &&handler) const
	Creates, or updates a scope-level index.
auto	upsert_index (const management::search::index &search_index, const upsert_search_index_options &options={}) const -> std::future< error >
void	drop_index (std::string index_name, const drop_search_index_options &options, drop_search_index_handler &&handler) const
	Drops a scope-level index.
auto	drop_index (std::string index_name, const drop_search_index_options &options={}) const -> std::future< error >
void	get_indexed_documents_count (std::string index_name, const get_indexed_search_index_options &options, get_indexed_search_index_handler &&handler) const
	Retrieves the number of documents that have been indexed for a scope-level index.
auto	get_indexed_documents_count (std::string index_name, const get_indexed_search_index_options &options={}) const -> std::future< std::pair< error, std::uint64_t > >
void	pause_ingest (std::string index_name, const pause_ingest_search_index_options &options, pause_ingest_search_index_handler &&handler) const
	Pauses updates and maintenance for a scope-level index.
auto	pause_ingest (std::string index_name, const pause_ingest_search_index_options &options={}) const -> std::future< error >
void	resume_ingest (std::string index_name, const resume_ingest_search_index_options &options, resume_ingest_search_index_handler &&handler) const
	Resumes updates and maintenance for a scope-level index.
auto	resume_ingest (std::string index_name, const resume_ingest_search_index_options &options={}) const -> std::future< error >
void	allow_querying (std::string index_name, const allow_querying_search_index_options &options, allow_querying_search_index_handler &&handler) const
	Allows querying against a scope-level index.
auto	allow_querying (std::string index_name, const allow_querying_search_index_options &options={}) const -> std::future< error >
void	disallow_querying (std::string index_name, const disallow_querying_search_index_options &options, disallow_querying_search_index_handler &&handler) const
	Disallows querying against a scope-level index.
auto	disallow_querying (std::string index_name, const disallow_querying_search_index_options &options={}) const -> std::future< error >
void	freeze_plan (std::string index_name, const freeze_plan_search_index_options &options, freeze_plan_search_index_handler &&handler) const
	Freeze the assignment of scope-level index partitions to nodes.
auto	freeze_plan (std::string index_name, const freeze_plan_search_index_options &options={}) const -> std::future< error >
void	unfreeze_plan (std::string index_name, const unfreeze_plan_search_index_options &options, unfreeze_plan_search_index_handler &&handler) const
	Unfreeze the assignment of scope-level index partitions to nodes.
auto	unfreeze_plan (std::string index_name, const unfreeze_plan_search_index_options &options={}) const -> std::future< error >
template<typename Document >
void	analyze_document (std::string index_name, Document document, const analyze_document_options &options, analyze_document_handler &&handler) const
	Allows to see how a document is analyzed against a specific scope-level index.
template<typename Document >
auto	analyze_document (std::string index_name, Document document, const analyze_document_options &options={}) const -> std::future< std::pair< error, std::vector< std::string > > >
void	analyze_document (std::string index_name, std::string document, const analyze_document_options &options, analyze_document_handler &&handler) const
	Allows to see how a document is analyzed against a specific scope-level index.
auto	analyze_document (std::string index_name, std::string document, const analyze_document_options &options) const -> std::future< std::pair< error, std::vector< std::string > > >

Friends
class	scope

Member Function Documentation

allow_querying() [1/2]

void allow_querying	(	std::string	index_name,
		const allow_querying_search_index_options &	options,
		allow_querying_search_index_handler &&	handler ) const

Allows querying against a scope-level index.

Parameters

index_name	the name of the search index
options	optional parameters
handler	handler that implements allow_querying_search_index_handler

Since

1.0.0

Volatile

Should not be used in production

allow_querying() [2/2]

auto allow_querying	(	std::string	index_name,
		const allow_querying_search_index_options &	options = {} ) const -> std::future< error >

analyze_document() [1/4]

template<typename Document >

void analyze_document ( std::string index_name, Document document, const analyze_document_options & options, analyze_document_handler && handler ) const

inline

Allows to see how a document is analyzed against a specific scope-level index.

Parameters

index_name	the name of the search index
document	the document to be analyzed
options	optional parameters
handler	handler that implements analyze_document_handler

Since

1.0.0

Volatile

Should not be used in production

analyze_document() [2/4]

template<typename Document >

auto analyze_document ( std::string index_name, Document document, const analyze_document_options & options = {} ) const -> std::future<std::pair<error, std::vector<std::string>>>

inline

analyze_document() [3/4]

auto analyze_document	(	std::string	index_name,
		std::string	document,
		const analyze_document_options &	options ) const -> std::future< std::pair< error, std::vector< std::string > > >

analyze_document() [4/4]

void analyze_document	(	std::string	index_name,
		std::string	document,
		const analyze_document_options &	options,
		analyze_document_handler &&	handler ) const

Allows to see how a document is analyzed against a specific scope-level index.

Parameters

index_name	the name of the search index
document	the document to be analyzed encoded in JSON
options	optional parameters
handler	handler that implements analyze_document_handler

Since

1.0.0

Volatile

Should not be used in production

disallow_querying() [1/2]

void disallow_querying	(	std::string	index_name,
		const disallow_querying_search_index_options &	options,
		disallow_querying_search_index_handler &&	handler ) const

Disallows querying against a scope-level index.

Parameters

index_name	the name of the search index
options	optional parameters
handler	handler that implements disallow_querying_search_index_handler

Since

1.0.0

Volatile

Should not be used in production

disallow_querying() [2/2]

auto disallow_querying	(	std::string	index_name,
		const disallow_querying_search_index_options &	options = {} ) const -> std::future< error >

drop_index() [1/2]

void drop_index	(	std::string	index_name,
		const drop_search_index_options &	options,
		drop_search_index_handler &&	handler ) const

Drops a scope-level index.

Parameters

index_name	the name of the search index
options	optional parameters
handler	handler that implements drop_search_index_handler

Since

1.0.0

Volatile

Should not be used in production

drop_index() [2/2]

auto drop_index	(	std::string	index_name,
		const drop_search_index_options &	options = {} ) const -> std::future< error >

freeze_plan() [1/2]

void freeze_plan	(	std::string	index_name,
		const freeze_plan_search_index_options &	options,
		freeze_plan_search_index_handler &&	handler ) const

Freeze the assignment of scope-level index partitions to nodes.

Parameters

index_name	the name of the search index
options	optional parameters
handler	handler that implements freeze_plan_search_index_handler

Since

1.0.0

Volatile

Should not be used in production

freeze_plan() [2/2]

auto freeze_plan	(	std::string	index_name,
		const freeze_plan_search_index_options &	options = {} ) const -> std::future< error >

get_all_indexes() [1/2]

void get_all_indexes	(	const get_all_search_indexes_options &	options,
		get_all_search_indexes_handler &&	handler ) const

Fetches all scope-level indexes from the server.

Parameters

options	optional parameters
handler	handler that implements get_all_search_indexes_handler

Since

1.0.0

Volatile

Should not be used in production

get_all_indexes() [2/2]

auto get_all_indexes

(

const get_all_search_indexes_options &

options = {}

)

const -> std::future< std::pair< error, std::vector< management::search::index > > >

get_index() [1/2]

void get_index	(	std::string	index_name,
		const get_search_index_options &	options,
		get_search_index_handler &&	handler ) const

Fetches a scope-level index from the server if it exists.

Parameters

index_name	the name of the index
options	optional parameters
handler	handler that implements get_search_index_handler

Since

1.0.0

Volatile

Should not be used in production

get_index() [2/2]

auto get_index	(	std::string	index_name,
		const get_search_index_options &	options = {} ) const -> std::future< std::pair< error, management::search::index > >

get_indexed_documents_count() [1/2]

void get_indexed_documents_count	(	std::string	index_name,
		const get_indexed_search_index_options &	options,
		get_indexed_search_index_handler &&	handler ) const

Retrieves the number of documents that have been indexed for a scope-level index.

Parameters

index_name	the name of the search index
options	optional parameters
handler	handler that implements get_indexed_search_index_handler

Since

1.0.0

Volatile

Should not be used in production

get_indexed_documents_count() [2/2]

auto get_indexed_documents_count	(	std::string	index_name,
		const get_indexed_search_index_options &	options = {} ) const -> std::future< std::pair< error, std::uint64_t > >

pause_ingest() [1/2]

void pause_ingest	(	std::string	index_name,
		const pause_ingest_search_index_options &	options,
		pause_ingest_search_index_handler &&	handler ) const

Pauses updates and maintenance for a scope-level index.

Parameters

index_name	the name of the search index
options	optional parameters
handler	handler that implements pause_ingest_search_index_handler

Since

1.0.0

Volatile

Should not be used in production

pause_ingest() [2/2]

auto pause_ingest	(	std::string	index_name,
		const pause_ingest_search_index_options &	options = {} ) const -> std::future< error >

resume_ingest() [1/2]

void resume_ingest	(	std::string	index_name,
		const resume_ingest_search_index_options &	options,
		resume_ingest_search_index_handler &&	handler ) const

Resumes updates and maintenance for a scope-level index.

Parameters

index_name	the name of the search index
options	optional parameters
handler	handler that implements resume_ingest_search_index_handler

Since

1.0.0

Volatile

Should not be used in production

resume_ingest() [2/2]

auto resume_ingest	(	std::string	index_name,
		const resume_ingest_search_index_options &	options = {} ) const -> std::future< error >

unfreeze_plan() [1/2]

void unfreeze_plan	(	std::string	index_name,
		const unfreeze_plan_search_index_options &	options,
		unfreeze_plan_search_index_handler &&	handler ) const

Unfreeze the assignment of scope-level index partitions to nodes.

Parameters

index_name	the name of the search index
options	optional parameters
handler	handler that implements unfreeze_plan_search_index_handler

Since

1.0.0

Volatile

Should not be used in production

unfreeze_plan() [2/2]

auto unfreeze_plan	(	std::string	index_name,
		const unfreeze_plan_search_index_options &	options = {} ) const -> std::future< error >

upsert_index() [1/2]

void upsert_index	(	const management::search::index &	search_index,
		const upsert_search_index_options &	options,
		upsert_search_index_handler &&	handler ) const

Creates, or updates a scope-level index.

Parameters

search_index	the index definition including name and settings
options	optional parameters
handler	handler that implements upsert_search_index_handler

Since

1.0.0

Volatile

Should not be used in production

upsert_index() [2/2]

auto upsert_index	(	const management::search::index &	search_index,
		const upsert_search_index_options &	options = {} ) const -> std::future< error >

Friends And Related Symbol Documentation

scope

friend class scope

friend

---

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

• couchbase/scope_search_index_manager.hxx