Couchbase C++ SDK 1.0.2 (rev. 51f4775)
|
#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 |
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.
index_name | the name of the search index |
options | optional parameters |
handler | handler that implements allow_querying_search_index_handler |
|
nodiscard |
|
inline |
Allows to see how a document is analyzed against a specific index.
index_name | the name of the search index |
document | the document to be analyzed |
options | optional parameters |
handler | handler that implements analyze_document_handler |
|
inlinenodiscard |
|
nodiscard |
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.
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 |
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.
index_name | the name of the search index |
options | optional parameters |
handler | handler that implements disallow_querying_search_index_handler |
|
nodiscard |
void drop_index | ( | std::string | index_name, |
const drop_search_index_options & | options, | ||
drop_search_index_handler && | handler ) const |
Drops an index.
index_name | the name of the search index |
options | optional parameters |
handler | handler that implements drop_search_index_handler |
|
nodiscard |
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.
index_name | the name of the search index |
options | optional parameters |
handler | handler that implements freeze_plan_search_index_handler |
|
nodiscard |
void get_all_indexes | ( | const get_all_search_indexes_options & | options, |
get_all_search_indexes_handler && | handler ) const |
Fetches all indexes from the server.
options | optional parameters |
handler | handler that implements get_all_search_indexes_handler |
|
nodiscard |
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.
index_name | the name of the index |
options | optional parameters |
handler | handler that implements get_search_index_handler |
|
nodiscard |
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.
index_name | the name of the search index |
options | optional parameters |
handler | handler that implements get_indexed_search_index_handler |
|
nodiscard |
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.
index_name | the name of the search index |
options | optional parameters |
handler | handler that implements pause_ingest_search_index_handler |
|
nodiscard |
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.
index_name | the name of the search index |
options | optional parameters |
handler | handler that implements resume_ingest_search_index_handler |
|
nodiscard |
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.
index_name | the name of the search index |
options | optional parameters |
handler | handler that implements unfreeze_plan_search_index_handler |
|
nodiscard |
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.
search_index | the index definition including name and settings |
options | optional parameters |
handler | handler that implements upsert_search_index_handler |
|
nodiscard |
|
friend |