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

Represents a single item from the result of collection::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 cluster::analytics_query() and scope::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 binary_collection::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 collection::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 collection::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 collection::get_any_replica operations, also returned by collection::get_all_replicas. More...
 
class  get_result
 Represents result of collection::get. More...
 
struct  get_search_index_options
 
struct  increment_options
 Options for binary_collection::increment(). More...
 
struct  insert_options
 Options for collection::insert(). More...
 
struct  lookup_in_all_replicas_options
 Options for collection::lookup_in_all_replicas(). More...
 
struct  lookup_in_any_replica_options
 Options for collection::lookup_in_any_replica(). More...
 
struct  lookup_in_options
 Options for collection::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 collection::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_tokens 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 binary_collection::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 cluster::query() and scope::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 collection::remove(). More...
 
class  replace_link_analytics_options
 
struct  replace_options
 Options for collection::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 collection::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 cluster::search() and scope::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 cluster::search() and scope::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 collection::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 collection::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 cluster::analytics_query() and scope::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 binary_collection::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 query_index_manager::build_deferred_indexes() operation.
 
using cluster_connect_handler = std::function<void(error, cluster)>
 The signature for the handler of the cluster::connect()
 
using connect_link_analytics_handler = std::function<void(error)>
 The signature for the handler of the analytics_index_manager::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 analytics_index_manager::create_dataset() operation.
 
using create_dataverse_analytics_handler = std::function<void(error)>
 The signature for the handler of the analytics_index_manager::create_dataverse() operation.
 
using create_index_analytics_handler = std::function<void(error)>
 The signature for the handler of the analytics_index_manager::create_index() operation.
 
using create_link_analytics_handler = std::function<void(error)>
 The signature for the handler of the analytics_index_manager::create_link() operation.
 
using create_primary_query_index_handler = std::function<void(error)>
 The signature for the handler of the query_index_manager::get_all_indexes() operation.
 
using create_query_index_handler = std::function<void(error)>
 The signature for the handler of the query_index_manager::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 binary_collection::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 analytics_index_manager::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 analytics_index_manager::drop_dataset() operation.
 
using drop_dataverse_analytics_handler = std::function<void(error)>
 The signature for the handler of the analytics_index_manager::drop_dataverse() operation.
 
using drop_index_analytics_handler = std::function<void(error)>
 The signature for the handler of the analytics_index_manager::drop_index() operation.
 
using drop_link_analytics_handler = std::function<void(error)>
 The signature for the handler of the analytics_index_manager::drop_link() operation.
 
using drop_primary_query_index_handler = std::function<void(error)>
 The signature for the handler of the query_index_manager::get_all_indexes() operation.
 
using drop_query_index_handler = std::function<void(error)>
 The signature for the handler of the query_index_manager::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 collection::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 analytics_index_manager::get_all_datasets() operation.
 
using get_all_indexes_analytics_handler
 The signature for the handler of the analytics_index_manager::get_all_indexes() operation.
 
using get_all_query_indexes_handler
 The signature for the handler of the query_index_manager::get_all_indexes() operation.
 
using get_all_replicas_result = std::vector<get_replica_result>
 The result for the collection::get_all_replicas() operation.
 
using get_all_replicas_handler = std::function<void(error, get_all_replicas_result)>
 The signature for the handler of the collection::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 collection::get_and_lock() operation.
 
using get_and_touch_handler = std::function<void(error, get_result)>
 The signature for the handler of the collection::get_and_touch() operation.
 
using get_any_replica_handler = std::function<void(error, get_replica_result)>
 The signature for the handler of the collection::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 analytics_index_manager::get_links() operation.
 
using get_handler = std::function<void(error, get_result)>
 The signature for the handler of the collection::get() operation.
 
using get_pending_mutations_analytics_handler
 The signature for the handler of the analytics_index_manager::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 binary_collection::increment() operation.
 
using insert_handler = std::function<void(error, mutation_result)>
 The signature for the handler of the collection::insert() operation.
 
using lookup_in_all_replicas_result = std::vector<lookup_in_replica_result>
 The result for the collection::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 collection::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 collection::lookup_in_any_replica() operation.
 
using lookup_in_handler = std::function<void(error, lookup_in_result)>
 The signature for the handler of the collection::lookup_in() operation.
 
using mutate_in_handler = std::function<void(error, mutate_in_result)>
 The signature for the handler of the collection::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 binary_collection::prepend() operation.
 
using query_handler = std::function<void(error, query_result)>
 The signature for the handler of the cluster::query() and scope::query() operations.
 
using remove_handler = std::function<void(error, mutation_result)>
 The signature for the handler of the collection::remove() operation.
 
using replace_link_analytics_handler = std::function<void(error)>
 The signature for the handler of the analytics_index_manager::replace_link() operation.
 
using replace_handler = std::function<void(error, mutation_result)>
 The signature for the handler of the collection::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 collection::scan() operation.
 
using scan_item_handler = std::function<void(error, std::optional<scan_result_item>)>
 The signature for the handler of the scan_result::next() operation.
 
using search_handler = std::function<void(error, search_result)>
 The signature for the handler of the cluster::search() and scope::search() operations.
 
using touch_handler = std::function<void(error, result)>
 The signature for the handler of the collection::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 collection::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 collection::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 query_index_manager::get_all_indexes() operation.
 

Enumerations

enum class  analytics_scan_consistency { not_bounded = 0 , request_plus }
 
enum class  analytics_status {
  running , success , errors , completed ,
  stopped , timeout , closed , fatal ,
  aborted , unknown
}
 Status of the Analytics Query. More...
 
enum class  durability_level : std::uint8_t { none = 0x00 , majority = 0x01 , majority_and_persist_to_active = 0x02 , persist_to_majority = 0x03 }
 Specifies enhanced durability options for the mutation. More...
 
enum class  endpoint_state { connected , connecting , disconnected , disconnecting }
 
enum class  ping_state { ok , timeout , error }
 
enum class  error_context_json_format { compact = 0 , pretty }
 
enum class  fork_event { prepare , parent , child }
 
enum class  highlight_style { html , ansi }
 Enumeration of the highlighting styles recognized by the FTS engine. More...
 
enum class  ip_protocol { any , force_ipv4 , force_ipv6 }
 
enum class  match_operator { logical_or , logical_and }
 Defines how the individual match terms should be logically concatenated. More...
 
enum class  persist_to {
  none = 0 , active = 1 , one = 2 , two = 3 ,
  three = 4 , four = 5
}
 
enum class  query_profile { off = 0 , phases , timings }
 
enum class  query_scan_consistency { not_bounded = 0 , request_plus }
 
enum class  query_status {
  running , success , errors , completed ,
  stopped , timeout , closed , fatal ,
  aborted , unknown
}
 Status of the N1QL Query. More...
 
enum class  read_preference { no_preference , selected_server_group , selected_server_group_or_all_available }
 Select read preference (or affinity) for the replica APIs such as: More...
 
enum class  replicate_to { none = 0 , one = 1 , two = 2 , three = 3 }
 
enum class  retry_reason {
  do_not_retry , unknown , socket_not_available , service_not_available ,
  node_not_available , key_value_not_my_vbucket , key_value_collection_outdated , key_value_error_map_retry_indicated ,
  key_value_locked , key_value_temporary_failure , key_value_sync_write_in_progress , key_value_sync_write_re_commit_in_progress ,
  service_response_code_indicated , socket_closed_while_in_flight , circuit_breaker_open , query_prepared_statement_failure ,
  query_index_not_found , analytics_temporary_failure , search_too_many_requests , views_temporary_failure ,
  views_no_active_partition
}
 Enumeration of possible retry reasons for operations. More...
 
enum class  search_geo_distance_units {
  meters , miles , centimeters , millimeters ,
  nautical_miles , kilometers , feet , yards ,
  inch
}
 Enumeration of units for geo_distance sorting. More...
 
enum class  search_scan_consistency { not_bounded = 0 }
 
enum class  search_sort_field_missing { last , first }
 
enum class  search_sort_field_mode { server_default , min , max }
 
enum class  search_sort_field_type { automatic , string , number , date }
 
enum class  service_type {
  key_value , query , analytics , search ,
  view , management , eventing
}
 
enum class  store_semantics { replace , upsert , insert , revive }
 Describes how the outer document store semantics on subdoc should act. More...
 
enum class  tls_verify_mode { none , peer }
 
enum class  vector_query_combination { combination_and , combination_or }
 

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)
 

Detailed Description

Represents a single item from the result of collection::scan()

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

Typedef Documentation

◆ allow_querying_search_index_handler

using allow_querying_search_index_handler = std::function<void(error)>

◆ analytics_handler

using analytics_handler = std::function<void(error, analytics_result)>

The signature for the handler of the cluster::analytics_query() and scope::analytics_query() operations.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ analyze_document_handler

using analyze_document_handler = std::function<void(error, std::vector<std::string>)>

◆ append_handler

using append_handler = std::function<void(error, mutation_result)>

The signature for the handler of the binary_collection::append() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ backoff_calculator

using backoff_calculator = std::function<std::chrono::milliseconds(std::size_t retry_attempts)>

◆ build_deferred_query_indexes_handler

using build_deferred_query_indexes_handler = std::function<void(error)>

The signature for the handler of the query_index_manager::build_deferred_indexes() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ cluster_connect_handler

using cluster_connect_handler = std::function<void(error, cluster)>

The signature for the handler of the cluster::connect()

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ connect_link_analytics_handler

using connect_link_analytics_handler = std::function<void(error)>

The signature for the handler of the analytics_index_manager::connect_link() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ create_bucket_handler

using create_bucket_handler = std::function<void(error)>

◆ create_collection_handler

using create_collection_handler = std::function<void(error)>

◆ create_dataset_analytics_handler

using create_dataset_analytics_handler = std::function<void(error)>

The signature for the handler of the analytics_index_manager::create_dataset() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ create_dataverse_analytics_handler

using create_dataverse_analytics_handler = std::function<void(error)>

The signature for the handler of the analytics_index_manager::create_dataverse() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ create_index_analytics_handler

using create_index_analytics_handler = std::function<void(error)>

The signature for the handler of the analytics_index_manager::create_index() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ create_link_analytics_handler

using create_link_analytics_handler = std::function<void(error)>

The signature for the handler of the analytics_index_manager::create_link() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ create_primary_query_index_handler

using create_primary_query_index_handler = std::function<void(error)>

The signature for the handler of the query_index_manager::get_all_indexes() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ create_query_index_handler

using create_query_index_handler = std::function<void(error)>

The signature for the handler of the query_index_manager::get_all_indexes() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ create_scope_handler

using create_scope_handler = std::function<void(error)>

◆ decrement_handler

using decrement_handler = std::function<void(error, counter_result)>

The signature for the handler of the binary_collection::decrement() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ diagnostics_handler

using diagnostics_handler = std::function<void(error, diagnostics_result)>

◆ disallow_querying_search_index_handler

using disallow_querying_search_index_handler = std::function<void(error)>

◆ disconnect_link_analytics_handler

using disconnect_link_analytics_handler = std::function<void(error)>

The signature for the handler of the analytics_index_manager::disconnect_link() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ drop_bucket_handler

using drop_bucket_handler = std::function<void(error)>

◆ drop_collection_handler

using drop_collection_handler = std::function<void(error)>

◆ drop_dataset_analytics_handler

using drop_dataset_analytics_handler = std::function<void(error)>

The signature for the handler of the analytics_index_manager::drop_dataset() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ drop_dataverse_analytics_handler

using drop_dataverse_analytics_handler = std::function<void(error)>

The signature for the handler of the analytics_index_manager::drop_dataverse() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ drop_index_analytics_handler

using drop_index_analytics_handler = std::function<void(error)>

The signature for the handler of the analytics_index_manager::drop_index() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ drop_link_analytics_handler

using drop_link_analytics_handler = std::function<void(error)>

The signature for the handler of the analytics_index_manager::drop_link() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ drop_primary_query_index_handler

using drop_primary_query_index_handler = std::function<void(error)>

The signature for the handler of the query_index_manager::get_all_indexes() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ drop_query_index_handler

using drop_query_index_handler = std::function<void(error)>

The signature for the handler of the query_index_manager::get_all_indexes() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ drop_scope_handler

using drop_scope_handler = std::function<void(error)>

◆ drop_search_index_handler

using drop_search_index_handler = std::function<void(error)>

◆ exists_handler

using exists_handler = std::function<void(error, exists_result)>

The signature for the handler of the collection::exists() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ flush_bucket_handler

using flush_bucket_handler = std::function<void(error)>

◆ freeze_plan_search_index_handler

using freeze_plan_search_index_handler = std::function<void(error)>

◆ get_all_buckets_handler

Initial value:
std::function<void(error, std::vector<management::cluster::bucket_settings>)>

◆ get_all_datasets_analytics_handler

Initial value:
std::function<void(error, std::vector<management::analytics_dataset>)>

The signature for the handler of the analytics_index_manager::get_all_datasets() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ get_all_indexes_analytics_handler

Initial value:
std::function<void(error, std::vector<management::analytics_index>)>

The signature for the handler of the analytics_index_manager::get_all_indexes() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ get_all_query_indexes_handler

Initial value:
std::function<void(error, std::vector<management::query_index>)>

The signature for the handler of the query_index_manager::get_all_indexes() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ get_all_replicas_handler

The signature for the handler of the collection::get_all_replicas() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ get_all_replicas_result

The result for the collection::get_all_replicas() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ get_all_scopes_handler

Initial value:
std::function<void(error, std::vector<management::bucket::scope_spec>)>

◆ get_all_search_indexes_handler

Initial value:
std::function<void(error, std::vector<management::search::index>)>

◆ get_and_lock_handler

using get_and_lock_handler = std::function<void(error, get_result)>

The signature for the handler of the collection::get_and_lock() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ get_and_touch_handler

using get_and_touch_handler = std::function<void(error, get_result)>

The signature for the handler of the collection::get_and_touch() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ get_any_replica_handler

using get_any_replica_handler = std::function<void(error, get_replica_result)>

The signature for the handler of the collection::get_any_replica() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ get_bucket_handler

◆ get_handler

using get_handler = std::function<void(error, get_result)>

The signature for the handler of the collection::get() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ get_indexed_search_index_handler

using get_indexed_search_index_handler = std::function<void(error, std::uint64_t)>

◆ get_links_analytics_handler

Initial value:
std::function<void(error, std::vector<std::unique_ptr<management::analytics_link>>)>

The signature for the handler of the analytics_index_manager::get_links() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ get_pending_mutations_analytics_handler

Initial value:
std::function<void(error, std::map<std::string, std::map<std::string, std::int64_t>>)>

The signature for the handler of the analytics_index_manager::get_pending_mutations() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ get_search_index_handler

◆ increment_handler

using increment_handler = std::function<void(error, counter_result)>

The signature for the handler of the binary_collection::increment() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ insert_handler

using insert_handler = std::function<void(error, mutation_result)>

The signature for the handler of the collection::insert() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ lookup_in_all_replicas_handler

The signature for the handler of the collection::lookup_in_all_replicas() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ lookup_in_all_replicas_result

The result for the collection::lookup_in_all_replicas() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ lookup_in_any_replica_handler

The signature for the handler of the collection::lookup_in_any_replica() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ lookup_in_handler

using lookup_in_handler = std::function<void(error, lookup_in_result)>

The signature for the handler of the collection::lookup_in() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ mutate_in_handler

using mutate_in_handler = std::function<void(error, mutate_in_result)>

The signature for the handler of the collection::mutate_in() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ pause_ingest_search_index_handler

using pause_ingest_search_index_handler = std::function<void(error)>

◆ ping_handler

using ping_handler = std::function<void(error, ping_result)>

◆ prepend_handler

using prepend_handler = std::function<void(error, mutation_result)>

The signature for the handler of the binary_collection::prepend() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ query_handler

using query_handler = std::function<void(error, query_result)>

The signature for the handler of the cluster::query() and scope::query() operations.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ remove_handler

using remove_handler = std::function<void(error, mutation_result)>

The signature for the handler of the collection::remove() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ replace_handler

using replace_handler = std::function<void(error, mutation_result)>

The signature for the handler of the collection::replace() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ replace_link_analytics_handler

using replace_link_analytics_handler = std::function<void(error)>

The signature for the handler of the analytics_index_manager::replace_link() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ resume_ingest_search_index_handler

using resume_ingest_search_index_handler = std::function<void(error)>

◆ scan_handler

using scan_handler = std::function<void(error, scan_result)>

The signature for the handler of the collection::scan() operation.

Since
1.0.0
Volatile
Should not be used in production

◆ scan_item_handler

using scan_item_handler = std::function<void(error, std::optional<scan_result_item>)>

The signature for the handler of the scan_result::next() operation.

Since
1.0.0
Volatile
Should not be used in production

◆ search_handler

using search_handler = std::function<void(error, search_result)>

The signature for the handler of the cluster::search() and scope::search() operations.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ touch_handler

using touch_handler = std::function<void(error, result)>

The signature for the handler of the collection::touch() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ unfreeze_plan_search_index_handler

using unfreeze_plan_search_index_handler = std::function<void(error)>

◆ unlock_handler

using unlock_handler = std::function<void(error)>

The signature for the handler of the collection::unlock() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ update_bucket_handler

using update_bucket_handler = std::function<void(error)>

◆ update_collection_handler

using update_collection_handler = std::function<void(error)>

◆ upsert_handler

using upsert_handler = std::function<void(error, mutation_result)>

The signature for the handler of the collection::upsert() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

◆ upsert_search_index_handler

using upsert_search_index_handler = std::function<void(error)>

◆ watch_query_indexes_handler

using watch_query_indexes_handler = std::function<void(error)>

The signature for the handler of the query_index_manager::get_all_indexes() operation.

Since
1.0.0
Uncommitted
Might be changed in the future, and eventually promoted to committed

Enumeration Type Documentation

◆ analytics_scan_consistency

enum class analytics_scan_consistency
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.

Since
1.0.0
Committed
Generally available API and should be preferred in production
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.

Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ analytics_status

enum class analytics_status
strong

Status of the Analytics Query.

Since
1.0.0
Committed
Generally available API and should be preferred in production
Enumerator
running 
success 
errors 
completed 
stopped 
timeout 
closed 
fatal 
aborted 
unknown 

◆ durability_level

enum class durability_level : std::uint8_t
strong

Specifies enhanced durability options for the mutation.

Since
1.0.0
Committed
Generally available API and should be preferred in production
Enumerator
none 

No enhanced durability required for the mutation.

Since
1.0.0
Committed
Generally available API and should be preferred in production
majority 

The mutation must be replicated to a majority of the Data Service nodes (that is, held in the memory allocated to the bucket)

Since
1.0.0
Committed
Generally available API and should be preferred in production
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.

Since
1.0.0
Committed
Generally available API and should be preferred in production
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.

Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ endpoint_state

enum class endpoint_state
strong
Enumerator
connected 

The endpoint is connected and ready.

Since
1.0.0
Committed
Generally available API and should be preferred in production
connecting 

The endpoint is disconnected but trying to connect right now.

Since
1.0.0
Committed
Generally available API and should be preferred in production
disconnected 

The endpoint is disconnected (not reachable) and not trying to connect.

Since
1.0.0
Committed
Generally available API and should be preferred in production
disconnecting 

The endpoint is currently disconnecting.

Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ error_context_json_format

enum class error_context_json_format
strong
Enumerator
compact 
pretty 

◆ fork_event

enum class fork_event
strong
Enumerator
prepare 

Notify the cluster that the process is about to fork.

parent 

Notify the context that the process has forked and is the parent.

child 

Notify the context that the process has forked and is the child.

◆ highlight_style

enum class highlight_style
strong

Enumeration of the highlighting styles recognized by the FTS engine.

Since
1.0.0
Committed
Generally available API and should be preferred in production
Enumerator
html 

Use HTML tags <mark> and </mark> to indicate matches in the fields.

Since
1.0.0
Committed
Generally available API and should be preferred in production
ansi 

Use ANSI code sequences \\x1b[43m> and \\x1b[0m to indicate matches in the fields.

Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ ip_protocol

enum class ip_protocol
strong
Enumerator
any 
force_ipv4 
force_ipv6 

◆ match_operator

enum class match_operator
strong

Defines how the individual match terms should be logically concatenated.

Since
1.0.0
Committed
Generally available API and should be preferred in production
Enumerator
logical_or 

Individual match terms are concatenated with a logical OR - this is the default if not provided.

Since
1.0.0
Committed
Generally available API and should be preferred in production
logical_and 

Individual match terms are concatenated with a logical AND.

Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ persist_to

enum class persist_to
strong
Enumerator
none 

Do not apply any persistence requirements.

Since
1.0.0
Committed
Generally available API and should be preferred in production
active 

Wait for persistence to active node.

Since
1.0.0
Committed
Generally available API and should be preferred in production
one 

Wait for persistence to at least one node.

Since
1.0.0
Committed
Generally available API and should be preferred in production
two 

Wait for persistence to at least two nodes.

Since
1.0.0
Committed
Generally available API and should be preferred in production
three 

Wait for persistence to at least three nodes.

Since
1.0.0
Committed
Generally available API and should be preferred in production
four 

Wait for persistence to at least all nodes nodes.

This is maximum possible persistence requirement, that includes active and all three replica nodes.

Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ ping_state

enum class ping_state
strong
Enumerator
ok 

Indicates that the ping operation was successful.

Since
1.0.0
Committed
Generally available API and should be preferred in production
timeout 

Indicates that the ping operation timed out.

Since
1.0.0
Committed
Generally available API and should be preferred in production
error 

Indicates that the ping operation failed.

Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ query_profile

enum class query_profile
strong
Enumerator
off 

No profiling information is added to the query response.

Since
1.0.0
Committed
Generally available API and should be preferred in production
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.

Since
1.0.0
Committed
Generally available API and should be preferred in production
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.

Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ query_scan_consistency

enum class query_scan_consistency
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.

Since
1.0.0
Committed
Generally available API and should be preferred in production
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.

Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ query_status

enum class query_status
strong

Status of the N1QL Query.

Since
1.0.0
Committed
Generally available API and should be preferred in production
Enumerator
running 
success 
errors 
completed 
stopped 
timeout 
closed 
fatal 
aborted 
unknown 

◆ read_preference

enum class read_preference
strong

Select read preference (or affinity) for the replica APIs such as:

Note
all strategies except read_preference::no_preference, reduce number of the nodes that the SDK will use for replica read operations. In other words, it will increase likelihood of getting errc::key_value::document_irretrievable error code if the filtered set of the nodes is empty, or do not have any documents available.
See also
https://docs.couchbase.com/server/current/manage/manage-groups/manage-groups.html
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).

◆ replicate_to

enum class replicate_to
strong
Enumerator
none 

Do not apply any replication requirements.

Since
1.0.0
Committed
Generally available API and should be preferred in production
one 

Wait for replication to at least one node.

Since
1.0.0
Committed
Generally available API and should be preferred in production
two 

Wait for replication to at least two nodes.

Since
1.0.0
Committed
Generally available API and should be preferred in production
three 

Wait for replication to all three replica nodes.

Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ retry_reason

enum class retry_reason
strong

Enumeration of possible retry reasons for operations.

Since
1.0.0
Committed
Generally available API and should be preferred in production
Enumerator
do_not_retry 

default value, e.g.

when we don't need to retry

unknown 

All unexpected/unknown retry errors must not be retried to avoid accidental data loss and non-deterministic behavior.

socket_not_available 

The socket is not available into which the operation should’ve been written.

service_not_available 

The service on a node (i.e.

key_value, query) is not available.

node_not_available 

The node where the operation is supposed to be dispatched to is not available.

key_value_not_my_vbucket 

A not my vbucket response has been received.

key_value_collection_outdated 

A KV response has been received which signals an outdated collection.

key_value_error_map_retry_indicated 

An unknown response was returned and the consulted KV error map indicated a retry.

key_value_locked 
key_value_temporary_failure 
key_value_sync_write_in_progress 
key_value_sync_write_re_commit_in_progress 
service_response_code_indicated 
socket_closed_while_in_flight 

While an operation was in-flight, the underlying socket has been closed.

circuit_breaker_open 

The circuit breaker is open for the given socket/endpoint and as a result the operation is not sent into it.

query_prepared_statement_failure 
query_index_not_found 
analytics_temporary_failure 
search_too_many_requests 
views_temporary_failure 
views_no_active_partition 

◆ search_geo_distance_units

enum class search_geo_distance_units
strong

Enumeration of units for geo_distance sorting.

Enumerator
meters 
miles 
centimeters 
millimeters 
nautical_miles 
kilometers 
feet 
yards 
inch 

◆ search_scan_consistency

enum class search_scan_consistency
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.

Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ search_sort_field_missing

enum class search_sort_field_missing
strong
Enumerator
last 
first 

◆ search_sort_field_mode

enum class search_sort_field_mode
strong
Enumerator
server_default 
min 
max 

◆ search_sort_field_type

enum class search_sort_field_type
strong
Enumerator
automatic 
string 
number 
date 

◆ service_type

enum class service_type
strong
Enumerator
key_value 

The Key-Value service (KV)

query 

The Query service (SQL++)

analytics 

The Analytics service.

search 

The Search service (FTS)

view 

The View service.

management 

The Cluster Manager service (ns_server)

eventing 

The Eventing service.

◆ store_semantics

enum class store_semantics
strong

Describes how the outer document store semantics on subdoc should act.

Since
1.0.0
Committed
Generally available API and should be preferred in production
Enumerator
replace 

Replace the document, fail if it does not exist.

This is the default.

Since
1.0.0
Committed
Generally available API and should be preferred in production
upsert 

Replace the document or create it if it does not exist.

Since
1.0.0
Committed
Generally available API and should be preferred in production
insert 

Create the document, fail if it exists.

Since
1.0.0
Committed
Generally available API and should be preferred in production
revive 

Convert from a tombstone to a document.

Since
1.0.0
Internal
Internal interface

◆ tls_verify_mode

enum class tls_verify_mode
strong
Enumerator
none 
peer 

◆ vector_query_combination

enum class vector_query_combination
strong
Enumerator
combination_and 
combination_or 

Function Documentation

◆ allows_non_idempotent_retry()

bool allows_non_idempotent_retry ( retry_reason reason)

◆ always_retry()

bool always_retry ( retry_reason reason)

◆ controlled_backoff()

auto controlled_backoff ( std::size_t retry_attempts) -> std::chrono::milliseconds

calculates a backoff time duration from the retry attempts on a given request.

Examples
distributed_mutex.cxx.

◆ exponential_backoff()

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.

Parameters
min_backoff
max_backoff
backoff_factor
Returns
backoff calculator

◆ make_best_effort_retry_strategy()

auto make_best_effort_retry_strategy ( backoff_calculator calculator = controlled_backoff) -> std::shared_ptr< best_effort_retry_strategy >
nodiscard

◆ make_fail_fast_retry_strategy()

auto make_fail_fast_retry_strategy ( ) -> std::shared_ptr< fail_fast_retry_strategy >
nodiscard