Represents a single item from the result of scan() More...
Namespaces | |
namespace | codec |
namespace | core |
namespace | errc |
namespace | logger |
namespace | management |
namespace | metrics |
namespace | subdoc |
namespace | tracing |
namespace | transactions |
Classes | |
struct | allow_querying_search_index_options |
class | analytics_index_manager |
class | analytics_meta_data |
Stores any non-rows results related to the execution of a particular Analytics query. More... | |
class | analytics_metrics |
Analytics Metrics contains the query result metrics containing counts and timings. More... | |
struct | analytics_options |
Options for cluster::analytics_query() and scope::analytics_query(). More... | |
class | analytics_result |
Represents result of analytics_query() and analytics_query() calls. More... | |
class | analytics_warning |
Represents a single warning returned from the analytics engine. More... | |
struct | analyze_document_options |
struct | append_options |
Options for append(). More... | |
class | behavior_options |
class | best_effort_retry_strategy |
class | binary_collection |
Allows to perform certain operations on non-JSON documents. More... | |
class | boolean_field_query |
Allow to match true /false in a field mapped as boolean. More... | |
class | boolean_query |
The boolean query is a useful combination of conjunction and disjunction queries. More... | |
class | bucket |
Provides access to Couchbase bucket. More... | |
class | bucket_manager |
class | build_query_index_options |
Options for query_index_manager::build_deferred_indexes(). More... | |
class | cas |
CAS is a special type that represented in protocol using unsigned 64-bit integer, but only equality checks allowed. More... | |
class | certificate_authenticator |
class | cluster |
The cluster is the main entry point when connecting to a Couchbase cluster. More... | |
class | cluster_options |
class | collection |
The collection provides access to all collection APIs. More... | |
class | collection_manager |
class | collection_query_index_manager |
The Query Index Manager interface contains the means for managing indexes used for queries. More... | |
class | common_durability_options |
Common options that used by most operations. More... | |
class | common_options |
Common options that used by most operations. More... | |
class | compression_options |
class | configuration_profile |
Base class for all defined configuration profiles. More... | |
class | configuration_profiles_registry |
Registry for defining configuration profiles. More... | |
class | conjunction_query |
The conjunction query is a compound query. More... | |
class | connect_link_analytics_options |
class | counter_result |
Represents result of counter operations. More... | |
struct | create_bucket_options |
struct | create_collection_options |
struct | create_collection_settings |
The settings to use when creating the collection. More... | |
class | create_dataset_analytics_options |
class | create_dataverse_analytics_options |
class | create_index_analytics_options |
class | create_link_analytics_options |
class | create_primary_query_index_options |
class | create_query_index_options |
struct | create_scope_options |
class | date_range |
Date range for date_range_facet. More... | |
class | date_range_facet |
A facet that categorizes rows into dateal ranges (or buckets) provided by the user. More... | |
class | date_range_facet_result |
class | date_range_query |
The date range query finds documents containing a date value in the specified field within the specified range. More... | |
struct | decrement_options |
Options for collection#decrement(). More... | |
struct | diagnostics_options |
class | diagnostics_result |
struct | disallow_querying_search_index_options |
class | disconnect_link_analytics_options |
class | disjunction_query |
The disjunction query is a compound query. More... | |
class | dns_options |
class | doc_id_query |
A doc_id query is a query that directly matches the documents whose ID have been provided. More... | |
struct | drop_bucket_options |
struct | drop_collection_options |
class | drop_dataset_analytics_options |
class | drop_dataverse_analytics_options |
class | drop_index_analytics_options |
class | drop_link_analytics_options |
class | drop_primary_query_index_options |
class | drop_query_index_options |
struct | drop_scope_options |
struct | drop_search_index_options |
class | endpoint_diagnostics |
class | endpoint_ping_report |
class | error |
class | error_context |
struct | exists_options |
Options for exists(). More... | |
class | exists_result |
Represents result of exists operations. More... | |
class | fail_fast_retry_strategy |
struct | flush_bucket_options |
struct | freeze_plan_search_index_options |
class | geo_bounding_box_query |
This query finds all geo_point indexed matches within a given area (identified by the list of geo_point coordinates). More... | |
class | geo_distance_query |
This query finds all matches from a given location as geo_point within the given distance. More... | |
struct | geo_point |
Tuple representing geographical point. More... | |
class | geo_polygon_query |
A search query which allows to match inside a geo polygon. More... | |
struct | get_all_buckets_options |
class | get_all_datasets_analytics_options |
class | get_all_indexes_analytics_options |
class | get_all_query_indexes_options |
struct | get_all_replicas_options |
Options for get_all_replicas(). More... | |
struct | get_all_scopes_options |
struct | get_all_search_indexes_options |
struct | get_and_lock_options |
Options for collection::get_and_lock(). More... | |
struct | get_and_touch_options |
Options for collection::get_and_touch(). More... | |
struct | get_any_replica_options |
Options for collection::get_any_replica(). More... | |
struct | get_bucket_options |
struct | get_indexed_search_index_options |
class | get_links_analytics_options |
struct | get_options |
Options for collection::get(). More... | |
class | get_pending_mutations_analytics_options |
class | get_replica_result |
Represents result of get_any_replica operations, also returned by get_all_replicas. More... | |
class | get_result |
Represents result of get. More... | |
struct | get_search_index_options |
struct | increment_options |
Options for binary_collection::increment(). More... | |
struct | insert_options |
Options for insert(). More... | |
struct | lookup_in_all_replicas_options |
Options for lookup_in_all_replicas(). More... | |
struct | lookup_in_any_replica_options |
Options for lookup_in_any_replica(). More... | |
struct | lookup_in_options |
Options for lookup_in(). More... | |
class | lookup_in_replica_result |
Represents result of lookup_in_replica operations. More... | |
class | lookup_in_result |
Represents result of lookup_in operations. More... | |
class | lookup_in_specs |
class | match_all_query |
A query that matches all indexed documents. More... | |
class | match_none_query |
A query that matches nothing. More... | |
class | match_phrase_query |
The input text is analyzed and a phrase query is built with the terms resulting from the analysis. More... | |
class | match_query |
A match query analyzes the input text and uses that analyzed text to query the index. More... | |
class | metrics_options |
struct | mutate_in_options |
Options for mutate_in(). More... | |
class | mutate_in_result |
Represents result of mutate_in operations. More... | |
class | mutate_in_specs |
class | mutation_result |
Represents result of mutation operations. More... | |
class | mutation_state |
Aggregation of one or more mutation_token s for specifying consistency requirements of N1QL or FTS queries. More... | |
class | mutation_token |
Value object to contain partition details and sequence number. More... | |
class | network_options |
class | numeric_range |
Numeric range for numeric_range_facet. More... | |
class | numeric_range_facet |
A facet that categorizes rows into numerical ranges (or buckets) provided by the user. More... | |
class | numeric_range_facet_result |
class | numeric_range_query |
The numeric range query finds documents containing a numeric value in the specified field within the specified range. More... | |
class | password_authenticator |
struct | pause_ingest_search_index_options |
class | phrase_query |
A query that looks for exact match of several terms (in the exact order) in the index. More... | |
struct | ping_options |
class | ping_result |
class | prefix_query |
The prefix query finds documents containing terms that start with the provided prefix. More... | |
struct | prefix_scan |
A prefix scan performs a scan that includes all documents whose keys start with the given prefix. More... | |
struct | prepend_options |
Options for prepend(). More... | |
class | query_index_manager |
The Query Index Manager interface contains the means for managing indexes used for queries. More... | |
class | query_meta_data |
Stores any non-rows results related to the execution of a particular N1QL query. More... | |
class | query_metrics |
Query Metrics contains the query result metrics containing counts and timings. More... | |
struct | query_options |
Options for cluster::query() and scope::query(). More... | |
class | query_result |
Represents result of query() and query() calls. More... | |
class | query_string_query |
The query string query allows humans to describe complex queries using a simple syntax. More... | |
class | query_warning |
Represents a single warning returned from the query engine. More... | |
struct | range_scan |
A range scan performs a scan on a range of keys. More... | |
class | regexp_query |
Finds documents containing terms that match the specified regular expression. More... | |
struct | remove_options |
Options for remove(). More... | |
class | replace_link_analytics_options |
struct | replace_options |
Options for replace(). More... | |
class | result |
Base class for operations of data service. More... | |
struct | resume_ingest_search_index_options |
class | retry_action |
class | retry_request |
class | retry_strategy |
struct | sampling_scan |
A sampling scan performs a scan that randomly selects documents up to a configured limit. More... | |
struct | scan_options |
Options for scan(). More... | |
class | scan_result |
class | scan_result_item |
struct | scan_term |
A scan term used to specify the bounds of a range scan operation. More... | |
struct | scan_type |
The base class for the different scan types. More... | |
class | scope |
The scope identifies a group of collections and allows high application density as a result. More... | |
class | scope_search_index_manager |
class | search_date_range |
class | search_facet |
Base class for full text facets of search queries. More... | |
class | search_facet_result |
class | search_index_manager |
class | search_meta_data |
Stores any non-rows results related to the execution of a particular N1QL search. More... | |
class | search_metrics |
Search Metrics contains the search result metrics containing counts and timings. More... | |
class | search_numeric_range |
struct | search_options |
Options for search() and search(). More... | |
class | search_query |
Base class for full text search queries. More... | |
class | search_request |
A search_request is used to perform operations against the Full Text Search (FTS) Couchbase service. More... | |
class | search_result |
Represents result of search() and search() calls. More... | |
class | search_row |
Search Metrics contains the search result metrics containing counts and timings. More... | |
class | search_row_location |
class | search_row_locations |
class | search_sort |
Base class for full text sort objects of search queries. More... | |
class | search_sort_field |
Sorts by a field in the hits. More... | |
class | search_sort_geo_distance |
Sorts by location in the hits. More... | |
class | search_sort_id |
Sorts by the document ID. More... | |
class | search_sort_score |
Sorts by the hit score. More... | |
class | search_term_range |
class | security_options |
class | term_facet |
A facet that gives the number of occurrences of the most recurring terms in all rows. More... | |
class | term_facet_result |
class | term_query |
A query that looks for exact matches of the term in the index (no analyzer, no stemming). More... | |
class | term_range_query |
The term range query finds documents containing a string value in the specified field within the specified range. More... | |
class | timeout_options |
struct | touch_options |
Options for collection::touch(). More... | |
class | tracing_options |
struct | unfreeze_plan_search_index_options |
struct | unlock_options |
Options for unlock(). More... | |
struct | update_bucket_options |
struct | update_collection_options |
struct | update_collection_settings |
The settings that should be updated for the collection. More... | |
struct | upsert_options |
Options for upsert(). More... | |
struct | upsert_search_index_options |
class | vector_query |
class | vector_search |
A vector_search allows one or more vector_query to be executed. More... | |
struct | vector_search_options |
Options related to executing a vector_search. More... | |
class | wan_development_configuration_profile |
class | watch_query_indexes_options |
class | wildcard_query |
A wildcard query is a query in which term the character * will match 0..n occurrences of any characters and ? will match 1 occurrence of any character. More... | |
Typedefs | |
using | allow_querying_search_index_handler = std::function<void(error)> |
using | analytics_handler = std::function<void(error, analytics_result)> |
The signature for the handler of the analytics_query() and analytics_query() operations. | |
using | analyze_document_handler = std::function<void(error, std::vector<std::string>)> |
using | append_handler = std::function<void(error, mutation_result)> |
The signature for the handler of the append() operation. | |
using | backoff_calculator = std::function<std::chrono::milliseconds(std::size_t retry_attempts)> |
using | build_deferred_query_indexes_handler = std::function<void(error)> |
The signature for the handler of the build_deferred_indexes() operation. | |
using | cluster_connect_handler = std::function<void(error, cluster)> |
The signature for the handler of the connect() | |
using | connect_link_analytics_handler = std::function<void(error)> |
The signature for the handler of the connect_link() operation. | |
using | create_bucket_handler = std::function<void(error)> |
using | create_collection_handler = std::function<void(error)> |
using | create_dataset_analytics_handler = std::function<void(error)> |
The signature for the handler of the create_dataset() operation. | |
using | create_dataverse_analytics_handler = std::function<void(error)> |
The signature for the handler of the create_dataverse() operation. | |
using | create_index_analytics_handler = std::function<void(error)> |
The signature for the handler of the create_index() operation. | |
using | create_link_analytics_handler = std::function<void(error)> |
The signature for the handler of the create_link() operation. | |
using | create_primary_query_index_handler = std::function<void(error)> |
The signature for the handler of the get_all_indexes() operation. | |
using | create_query_index_handler = std::function<void(error)> |
The signature for the handler of the get_all_indexes() operation. | |
using | create_scope_handler = std::function<void(error)> |
using | decrement_handler = std::function<void(error, counter_result)> |
The signature for the handler of the decrement() operation. | |
using | diagnostics_handler = std::function<void(error, diagnostics_result)> |
using | disallow_querying_search_index_handler = std::function<void(error)> |
using | disconnect_link_analytics_handler = std::function<void(error)> |
The signature for the handler of the disconnect_link() operation. | |
using | drop_bucket_handler = std::function<void(error)> |
using | drop_collection_handler = std::function<void(error)> |
using | drop_dataset_analytics_handler = std::function<void(error)> |
The signature for the handler of the drop_dataset() operation. | |
using | drop_dataverse_analytics_handler = std::function<void(error)> |
The signature for the handler of the drop_dataverse() operation. | |
using | drop_index_analytics_handler = std::function<void(error)> |
The signature for the handler of the drop_index() operation. | |
using | drop_link_analytics_handler = std::function<void(error)> |
The signature for the handler of the drop_link() operation. | |
using | drop_primary_query_index_handler = std::function<void(error)> |
The signature for the handler of the get_all_indexes() operation. | |
using | drop_query_index_handler = std::function<void(error)> |
The signature for the handler of the get_all_indexes() operation. | |
using | drop_scope_handler = std::function<void(error)> |
using | drop_search_index_handler = std::function<void(error)> |
using | exists_handler = std::function<void(error, exists_result)> |
The signature for the handler of the exists() operation. | |
using | flush_bucket_handler = std::function<void(error)> |
using | freeze_plan_search_index_handler = std::function<void(error)> |
using | get_all_buckets_handler |
using | get_all_datasets_analytics_handler |
The signature for the handler of the get_all_datasets() operation. | |
using | get_all_indexes_analytics_handler |
The signature for the handler of the get_all_indexes() operation. | |
using | get_all_query_indexes_handler |
The signature for the handler of the get_all_indexes() operation. | |
using | get_all_replicas_result = std::vector<get_replica_result> |
The result for the get_all_replicas() operation. | |
using | get_all_replicas_handler = std::function<void(error, get_all_replicas_result)> |
The signature for the handler of the get_all_replicas() operation. | |
using | get_all_scopes_handler |
using | get_all_search_indexes_handler |
using | get_and_lock_handler = std::function<void(error, get_result)> |
The signature for the handler of the get_and_lock() operation. | |
using | get_and_touch_handler = std::function<void(error, get_result)> |
The signature for the handler of the get_and_touch() operation. | |
using | get_any_replica_handler = std::function<void(error, get_replica_result)> |
The signature for the handler of the get_any_replica() operation. | |
using | get_bucket_handler = std::function<void(error, management::cluster::bucket_settings)> |
using | get_indexed_search_index_handler = std::function<void(error, std::uint64_t)> |
using | get_links_analytics_handler |
The signature for the handler of the get_links() operation. | |
using | get_handler = std::function<void(error, get_result)> |
The signature for the handler of the get() operation. | |
using | get_pending_mutations_analytics_handler |
The signature for the handler of the get_pending_mutations() operation. | |
using | get_search_index_handler = std::function<void(error, management::search::index)> |
using | increment_handler = std::function<void(error, counter_result)> |
The signature for the handler of the increment() operation. | |
using | insert_handler = std::function<void(error, mutation_result)> |
The signature for the handler of the insert() operation. | |
using | lookup_in_all_replicas_result = std::vector<lookup_in_replica_result> |
The result for the lookup_in_all_replicas() operation. | |
using | lookup_in_all_replicas_handler = std::function<void(error, lookup_in_all_replicas_result)> |
The signature for the handler of the lookup_in_all_replicas() operation. | |
using | lookup_in_any_replica_handler = std::function<void(error, lookup_in_replica_result)> |
The signature for the handler of the lookup_in_any_replica() operation. | |
using | lookup_in_handler = std::function<void(error, lookup_in_result)> |
The signature for the handler of the lookup_in() operation. | |
using | mutate_in_handler = std::function<void(error, mutate_in_result)> |
The signature for the handler of the mutate_in() operation. | |
using | pause_ingest_search_index_handler = std::function<void(error)> |
using | ping_handler = std::function<void(error, ping_result)> |
using | prepend_handler = std::function<void(error, mutation_result)> |
The signature for the handler of the prepend() operation. | |
using | query_handler = std::function<void(error, query_result)> |
The signature for the handler of the query() and query() operations. | |
using | remove_handler = std::function<void(error, mutation_result)> |
The signature for the handler of the remove() operation. | |
using | replace_link_analytics_handler = std::function<void(error)> |
The signature for the handler of the replace_link() operation. | |
using | replace_handler = std::function<void(error, mutation_result)> |
The signature for the handler of the replace() operation. | |
using | resume_ingest_search_index_handler = std::function<void(error)> |
using | scan_handler = std::function<void(error, scan_result)> |
The signature for the handler of the scan() operation. | |
using | scan_item_handler = std::function<void(error, std::optional<scan_result_item>)> |
The signature for the handler of the next() operation. | |
using | search_handler = std::function<void(error, search_result)> |
The signature for the handler of the search() and search() operations. | |
using | touch_handler = std::function<void(error, result)> |
The signature for the handler of the touch() operation. | |
using | unfreeze_plan_search_index_handler = std::function<void(error)> |
using | unlock_handler = std::function<void(error)> |
The signature for the handler of the unlock() operation. | |
using | update_bucket_handler = std::function<void(error)> |
using | update_collection_handler = std::function<void(error)> |
using | upsert_handler = std::function<void(error, mutation_result)> |
The signature for the handler of the upsert() operation. | |
using | upsert_search_index_handler = std::function<void(error)> |
using | watch_query_indexes_handler = std::function<void(error)> |
The signature for the handler of the get_all_indexes() operation. | |
Functions | |
auto | controlled_backoff (std::size_t retry_attempts) -> std::chrono::milliseconds |
calculates a backoff time duration from the retry attempts on a given request. | |
auto | exponential_backoff (std::chrono::milliseconds min_backoff, std::chrono::milliseconds max_backoff, double backoff_factor) -> backoff_calculator |
calculates a backoff time duration from the retry attempts on a given request. | |
auto | make_best_effort_retry_strategy (backoff_calculator calculator=controlled_backoff) -> std::shared_ptr< best_effort_retry_strategy > |
auto | make_fail_fast_retry_strategy () -> std::shared_ptr< fail_fast_retry_strategy > |
bool | allows_non_idempotent_retry (retry_reason reason) |
bool | always_retry (retry_reason reason) |
Represents a single item from the result of scan()
using allow_querying_search_index_handler = std::function<void(error)> |
using analytics_handler = std::function<void(error, analytics_result)> |
The signature for the handler of the analytics_query() and analytics_query() operations.
using analyze_document_handler = std::function<void(error, std::vector<std::string>)> |
using append_handler = std::function<void(error, mutation_result)> |
The signature for the handler of the append() operation.
using backoff_calculator = std::function<std::chrono::milliseconds(std::size_t retry_attempts)> |
using build_deferred_query_indexes_handler = std::function<void(error)> |
The signature for the handler of the build_deferred_indexes() operation.
using cluster_connect_handler = std::function<void(error, cluster)> |
The signature for the handler of the connect()
using connect_link_analytics_handler = std::function<void(error)> |
The signature for the handler of the connect_link() operation.
using create_bucket_handler = std::function<void(error)> |
using create_collection_handler = std::function<void(error)> |
using create_dataset_analytics_handler = std::function<void(error)> |
The signature for the handler of the create_dataset() operation.
using create_dataverse_analytics_handler = std::function<void(error)> |
The signature for the handler of the create_dataverse() operation.
using create_index_analytics_handler = std::function<void(error)> |
The signature for the handler of the create_index() operation.
using create_link_analytics_handler = std::function<void(error)> |
The signature for the handler of the create_link() operation.
using create_primary_query_index_handler = std::function<void(error)> |
The signature for the handler of the get_all_indexes() operation.
using create_query_index_handler = std::function<void(error)> |
The signature for the handler of the get_all_indexes() operation.
using create_scope_handler = std::function<void(error)> |
using decrement_handler = std::function<void(error, counter_result)> |
The signature for the handler of the decrement() operation.
using diagnostics_handler = std::function<void(error, diagnostics_result)> |
using disallow_querying_search_index_handler = std::function<void(error)> |
using disconnect_link_analytics_handler = std::function<void(error)> |
The signature for the handler of the disconnect_link() operation.
using drop_bucket_handler = std::function<void(error)> |
using drop_collection_handler = std::function<void(error)> |
using drop_dataset_analytics_handler = std::function<void(error)> |
The signature for the handler of the drop_dataset() operation.
using drop_dataverse_analytics_handler = std::function<void(error)> |
The signature for the handler of the drop_dataverse() operation.
using drop_index_analytics_handler = std::function<void(error)> |
The signature for the handler of the drop_index() operation.
using drop_link_analytics_handler = std::function<void(error)> |
The signature for the handler of the drop_link() operation.
using drop_primary_query_index_handler = std::function<void(error)> |
The signature for the handler of the get_all_indexes() operation.
using drop_query_index_handler = std::function<void(error)> |
The signature for the handler of the get_all_indexes() operation.
using drop_scope_handler = std::function<void(error)> |
using drop_search_index_handler = std::function<void(error)> |
using exists_handler = std::function<void(error, exists_result)> |
The signature for the handler of the exists() operation.
using flush_bucket_handler = std::function<void(error)> |
using freeze_plan_search_index_handler = std::function<void(error)> |
using get_all_buckets_handler |
The signature for the handler of the get_all_datasets() operation.
The signature for the handler of the get_all_indexes() operation.
The signature for the handler of the get_all_indexes() operation.
using get_all_replicas_handler = std::function<void(error, get_all_replicas_result)> |
The signature for the handler of the get_all_replicas() operation.
using get_all_replicas_result = std::vector<get_replica_result> |
The result for the get_all_replicas() operation.
using get_all_scopes_handler |
using get_and_lock_handler = std::function<void(error, get_result)> |
The signature for the handler of the get_and_lock() operation.
using get_and_touch_handler = std::function<void(error, get_result)> |
The signature for the handler of the get_and_touch() operation.
using get_any_replica_handler = std::function<void(error, get_replica_result)> |
The signature for the handler of the get_any_replica() operation.
using get_bucket_handler = std::function<void(error, management::cluster::bucket_settings)> |
using get_handler = std::function<void(error, get_result)> |
The signature for the handler of the get() operation.
using get_indexed_search_index_handler = std::function<void(error, std::uint64_t)> |
The signature for the handler of the get_links() operation.
The signature for the handler of the get_pending_mutations() operation.
using get_search_index_handler = std::function<void(error, management::search::index)> |
using increment_handler = std::function<void(error, counter_result)> |
The signature for the handler of the increment() operation.
using insert_handler = std::function<void(error, mutation_result)> |
The signature for the handler of the insert() operation.
using lookup_in_all_replicas_handler = std::function<void(error, lookup_in_all_replicas_result)> |
The signature for the handler of the lookup_in_all_replicas() operation.
using lookup_in_all_replicas_result = std::vector<lookup_in_replica_result> |
The result for the lookup_in_all_replicas() operation.
using lookup_in_any_replica_handler = std::function<void(error, lookup_in_replica_result)> |
The signature for the handler of the lookup_in_any_replica() operation.
using lookup_in_handler = std::function<void(error, lookup_in_result)> |
The signature for the handler of the lookup_in() operation.
using mutate_in_handler = std::function<void(error, mutate_in_result)> |
The signature for the handler of the mutate_in() operation.
using pause_ingest_search_index_handler = std::function<void(error)> |
using ping_handler = std::function<void(error, ping_result)> |
using prepend_handler = std::function<void(error, mutation_result)> |
The signature for the handler of the prepend() operation.
using query_handler = std::function<void(error, query_result)> |
The signature for the handler of the query() and query() operations.
using remove_handler = std::function<void(error, mutation_result)> |
The signature for the handler of the remove() operation.
using replace_handler = std::function<void(error, mutation_result)> |
The signature for the handler of the replace() operation.
using replace_link_analytics_handler = std::function<void(error)> |
The signature for the handler of the replace_link() operation.
using resume_ingest_search_index_handler = std::function<void(error)> |
using scan_handler = std::function<void(error, scan_result)> |
using scan_item_handler = std::function<void(error, std::optional<scan_result_item>)> |
using search_handler = std::function<void(error, search_result)> |
The signature for the handler of the search() and search() operations.
using touch_handler = std::function<void(error, result)> |
The signature for the handler of the touch() operation.
using unfreeze_plan_search_index_handler = std::function<void(error)> |
using unlock_handler = std::function<void(error)> |
The signature for the handler of the unlock() operation.
using update_bucket_handler = std::function<void(error)> |
using update_collection_handler = std::function<void(error)> |
using upsert_handler = std::function<void(error, mutation_result)> |
The signature for the handler of the upsert() operation.
using upsert_search_index_handler = std::function<void(error)> |
using watch_query_indexes_handler = std::function<void(error)> |
The signature for the handler of the get_all_indexes() operation.
|
strong |
Enumerator | |
---|---|
not_bounded | The indexer will return whatever state it has to the query engine at the time of query. This is the default (for single-statement requests). No timestamp vector is used in the index scan. This is also the fastest mode, because we avoid the cost of obtaining the vector, and we also avoid any wait for the index to catch up to the vector.
|
request_plus | The indexer will wait until all mutations have been processed at the time of request before returning to the query engine. This implements strong consistency per request. Before processing the request, a current vector is obtained. The vector is used as a lower bound for the statements in the request. If there are DML statements in the request, RYOW ("read your own write") is also applied within the request.
|
|
strong |
Status of the Analytics Query.
Enumerator | |
---|---|
running | |
success | |
errors | |
completed | |
stopped | |
timeout | |
closed | |
fatal | |
aborted | |
unknown |
|
strong |
Specifies enhanced durability options for the mutation.
Enumerator | |
---|---|
none | No enhanced durability required for the mutation.
|
majority | The mutation must be replicated to a majority of the Data Service nodes (that is, held in the memory allocated to the bucket)
|
majority_and_persist_to_active | The mutation must be replicated to a majority of the Data Service nodes. Additionally, it must be persisted (that is, written and synchronised to disk) on the node hosting the active partition (vBucket) for the data.
|
persist_to_majority | The mutation must be persisted to a majority of the Data Service nodes. Accordingly, it will be written to disk on those nodes.
|
|
strong |
Enumerator | |
---|---|
connected | The endpoint is connected and ready.
|
connecting | The endpoint is disconnected but trying to connect right now.
|
disconnected | The endpoint is disconnected (not reachable) and not trying to connect.
|
disconnecting | The endpoint is currently disconnecting.
|
|
strong |
|
strong |
|
strong |
Enumeration of the highlighting styles recognized by the FTS engine.
Enumerator | |
---|---|
html | Use HTML tags
|
ansi | Use ANSI code sequences
|
|
strong |
|
strong |
Defines how the individual match terms should be logically concatenated.
Enumerator | |
---|---|
logical_or | Individual match terms are concatenated with a logical OR - this is the default if not provided.
|
logical_and | Individual match terms are concatenated with a logical AND.
|
|
strong |
Enumerator | |
---|---|
none | Do not apply any persistence requirements.
|
active | Wait for persistence to active node.
|
one | Wait for persistence to at least one node.
|
two | Wait for persistence to at least two nodes.
|
three | Wait for persistence to at least three nodes.
|
four | Wait for persistence to at least all nodes nodes. This is maximum possible persistence requirement, that includes active and all three replica nodes.
|
|
strong |
Enumerator | |
---|---|
ok | Indicates that the ping operation was successful.
|
timeout | Indicates that the ping operation timed out.
|
error | Indicates that the ping operation failed.
|
|
strong |
Enumerator | |
---|---|
off | No profiling information is added to the query response.
|
phases | The query response includes a profile section with stats and details about various phases of the query plan and execution. Three phase times will be included in the system:active_requests and system:completed_requests monitoring keyspaces.
|
timings | Besides the phase times, the profile section of the query response document will include a full query plan with timing and information about the number of processed documents at each phase. This information will be included in the system:active_requests and system:completed_requests keyspaces.
|
|
strong |
Enumerator | |
---|---|
not_bounded | The indexer will return whatever state it has to the query engine at the time of query. This is the default (for single-statement requests). No timestamp vector is used in the index scan. This is also the fastest mode, because we avoid the cost of obtaining the vector, and we also avoid any wait for the index to catch up to the vector.
|
request_plus | The indexer will wait until all mutations have been processed at the time of request before returning to the query engine. This implements strong consistency per request. Before processing the request, a current vector is obtained. The vector is used as a lower bound for the statements in the request. If there are DML statements in the request, RYOW ("read your own write") is also applied within the request.
|
|
strong |
Status of the N1QL Query.
Enumerator | |
---|---|
running | |
success | |
errors | |
completed | |
stopped | |
timeout | |
closed | |
fatal | |
aborted | |
unknown |
|
strong |
Select read preference (or affinity) for the replica APIs such as:
errc::key_value::document_irretrievable
error code if the filtered set of the nodes is empty, or do not have any documents available.Enumerator | |
---|---|
no_preference | Do not enforce any filtering for replica set. |
selected_server_group | Exclude any nodes that do not belong to local group selected during cluster instantiation with network_options::preferred_server_group(). |
selected_server_group_or_all_available | The same as read_preference::selected_server_group, but if the filtered replica set is empty, expand it to all available nodes (fall back to read_preference::no_preference effectively). |
|
strong |
Enumerator | |
---|---|
none | Do not apply any replication requirements.
|
one | Wait for replication to at least one node.
|
two | Wait for replication to at least two nodes.
|
three | Wait for replication to all three replica nodes.
|
|
strong |
Enumeration of possible retry reasons for operations.
|
strong |
|
strong |
Enumerator | |
---|---|
not_bounded | This is the default, the indexer does not wait for certain index updates until it returns the current hits. This is also the fastest mode, because we avoid the cost of obtaining the vector, and we also avoid any wait for the index to catch up to the vector.
|
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
Describes how the outer document store semantics on subdoc should act.
Enumerator | |
---|---|
replace | Replace the document, fail if it does not exist. This is the default.
|
upsert | Replace the document or create it if it does not exist.
|
insert | Create the document, fail if it exists.
|
revive | Convert from a tombstone to a document.
|
|
strong |
|
strong |
bool allows_non_idempotent_retry | ( | retry_reason | reason | ) |
bool always_retry | ( | retry_reason | reason | ) |
auto controlled_backoff | ( | std::size_t | retry_attempts | ) | -> std::chrono::milliseconds |
calculates a backoff time duration from the retry attempts on a given request.
auto exponential_backoff | ( | std::chrono::milliseconds | min_backoff, |
std::chrono::milliseconds | max_backoff, | ||
double | backoff_factor ) -> backoff_calculator |
calculates a backoff time duration from the retry attempts on a given request.
min_backoff | |
max_backoff | |
backoff_factor |
|
nodiscard |
|
nodiscard |