couchbase::transactions Namespace Reference

Classes
class	async_attempt_context
	The async_attempt_context is used for all asynchronous transaction operations. More...
class	attempt_context
	The attempt_context is used for all synchronous transaction operations. More...
class	transaction_get_multi_options
class	transaction_get_multi_replicas_from_preferred_server_group_options
class	transaction_get_multi_replicas_from_preferred_server_group_result
class	transaction_get_multi_replicas_from_preferred_server_group_spec
class	transaction_get_multi_result
class	transaction_get_multi_spec
class	transaction_get_result
	The representation of the document in context of distributed transaction. More...
struct	transaction_keyspace
	Offline, serializable representation of a bucket, scope, and collection. More...
class	transaction_options
	The transaction_options can be passed in to override some elements of the global transactions_config. More...
class	transaction_query_options
	The transaction_query_options are options specific to a query. More...
class	transaction_query_result
	Transactional queries will return a transaction_query_result. More...
struct	transaction_result
	Results of a transaction. More...
class	transactions
	The transactions object is used to initiate a transaction. More...
class	transactions_cleanup_config
	Configuration parameters for the background transaction cleanup threads. More...
class	transactions_config
	Configuration parameters for transactions. More...
class	transactions_query_config
	The transactions_query_config sets the defaults for all queries in the transactions. More...

Typedefs
using	txn_logic = std::function<error(std::shared_ptr<attempt_context>)>
using	async_txn_logic = std::function<error(std::shared_ptr<async_attempt_context>)>
using	async_txn_complete_logic = std::function<void(error, transaction_result)>
using	async_result_handler = std::function<void(error, transaction_get_result)>
using	async_query_handler = std::function<void(error, transaction_query_result)>
using	async_err_handler = std::function<void(error)>

Enumerations
enum class	transaction_get_multi_mode : std::uint8_t { prioritise_latency , disable_read_skew_detection , prioritise_read_skew_detection }
	Strategy to deal with potential read skews while reading multiple documents. More...
enum class	transaction_get_multi_replicas_from_preferred_server_group_mode : std::uint8_t { prioritise_latency , disable_read_skew_detection , prioritise_read_skew_detection }
	Strategy to deal with potential read skews while reading multiple documents. More...

Typedef Documentation

async_err_handler

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

async_query_handler

using async_query_handler = std::function<void(error, transaction_query_result)>

async_result_handler

using async_result_handler = std::function<void(error, transaction_get_result)>

async_txn_complete_logic

using async_txn_complete_logic = std::function<void(error, transaction_result)>

async_txn_logic

using async_txn_logic = std::function<error(std::shared_ptr<async_attempt_context>)>

txn_logic

using txn_logic = std::function<error(std::shared_ptr<attempt_context>)>

Enumeration Type Documentation

transaction_get_multi_mode

enum class transaction_get_multi_mode : std::uint8_t

strong

Strategy to deal with potential read skews while reading multiple documents.

Essentially when a transaction reads document X and then Y, and another transaction commits a change to Y inbetween those reads - read skew has occurred.

Enumerator
prioritise_latency	Some time-bounded effort will be made to detect and avoid read skew.
disable_read_skew_detection	No read skew detection should be attempted. Once the documents are fetched, they will be returned immediately.
prioritise_read_skew_detection	Great effort will be made to detect and avoid read skew.

transaction_get_multi_replicas_from_preferred_server_group_mode

enum class transaction_get_multi_replicas_from_preferred_server_group_mode : std::uint8_t

strong

Strategy to deal with potential read skews while reading multiple documents.

Essentially when a transaction reads document X and then Y, and another transaction commits a change to Y inbetween those reads - read skew has occurred.

Enumerator
prioritise_latency	Some time-bounded effort will be made to detect and avoid read skew.
disable_read_skew_detection	No read skew detection should be attempted. Once the documents are fetched, they will be returned immediately.
prioritise_read_skew_detection	Great effort will be made to detect and avoid read skew.