Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
search_index_manager Class Reference

#include <couchbase/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 an 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 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 an 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 an 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 an 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 an 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 an 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 an 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 an 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 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 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 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 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 cluster
 

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 an index.

Parameters
index_namethe name of the search index
optionsoptional parameters
handlerhandler that implements allow_querying_search_index_handler
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ allow_querying() [2/2]

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

◆ 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 index.

Parameters
index_namethe name of the search index
documentthe document to be analyzed
optionsoptional parameters
handlerhandler that implements analyze_document_handler
Since
1.0.0
Committed
Generally available API and should be preferred 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>>>
inlinenodiscard

◆ 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 > > >
nodiscard

◆ 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 index.

Parameters
index_namethe name of the search index
documentthe document to be analyzed encoded in JSON
optionsoptional parameters
handlerhandler that implements analyze_document_handler
Since
1.0.0
Committed
Generally available API and should be preferred 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 an index.

Parameters
index_namethe name of the search index
optionsoptional parameters
handlerhandler that implements disallow_querying_search_index_handler
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ disallow_querying() [2/2]

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

◆ drop_index() [1/2]

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

Drops an index.

Parameters
index_namethe name of the search index
optionsoptional parameters
handlerhandler that implements drop_search_index_handler
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ drop_index() [2/2]

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

◆ 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 index partitions to nodes.

Parameters
index_namethe name of the search index
optionsoptional parameters
handlerhandler that implements freeze_plan_search_index_handler
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ freeze_plan() [2/2]

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

◆ 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 indexes from the server.

Parameters
optionsoptional parameters
handlerhandler that implements get_all_search_indexes_handler
Since
1.0.0
Committed
Generally available API and should be preferred 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 > > >
nodiscard

◆ get_index() [1/2]

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

Fetches an index from the server if it exists.

Parameters
index_namethe name of the index
optionsoptional parameters
handlerhandler that implements get_search_index_handler
Since
1.0.0
Committed
Generally available API and should be preferred 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 > >
nodiscard

◆ 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 an index.

Parameters
index_namethe name of the search index
optionsoptional parameters
handlerhandler that implements get_indexed_search_index_handler
Since
1.0.0
Committed
Generally available API and should be preferred 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 > >
nodiscard

◆ 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 an index.

Parameters
index_namethe name of the search index
optionsoptional parameters
handlerhandler that implements pause_ingest_search_index_handler
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ pause_ingest() [2/2]

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

◆ 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 an index.

Parameters
index_namethe name of the search index
optionsoptional parameters
handlerhandler that implements resume_ingest_search_index_handler
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ resume_ingest() [2/2]

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

◆ 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 index partitions to nodes.

Parameters
index_namethe name of the search index
optionsoptional parameters
handlerhandler that implements unfreeze_plan_search_index_handler
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ unfreeze_plan() [2/2]

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

◆ 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 an index.

Parameters
search_indexthe index definition including name and settings
optionsoptional parameters
handlerhandler that implements upsert_search_index_handler
Since
1.0.0
Committed
Generally available API and should be preferred 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 >
nodiscard

Friends And Related Symbol Documentation

◆ cluster

friend class cluster
friend

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