kv_create_simple_consistency()

#include <kvstore.h>

kv_error_tkv_create_simple_consistency(kv_consistency_t **consistency,
                                        kv_consistency_enum type)

Creates a simple consistency guarantee used for read operations.

In general, read operations may be serviced either at a master or replica node. When reads are serviced at the master node, consistency is always absolute. For reads that might be performed at a replica, you can specify ABSOLUTE consistency to force the operation to be serviced at the master. For other types of consistency, when the operation is serviced at a replica, the read transaction will not begin until the consistency policy is satisfied.

Consistency policies can be used for read operation performed in the store, such as with kv_get_with_options() or kv_store_iterator().

You release the memory allocated for the consistency structure using kv_release_consistency().

Parameters

  • consistency

    The consistency parameter references memory into which a pointer to the allocated consistency policy is copied.

  • type

    The type parameter defines the type of consistency you want to use. See kv_consistency_enum for a list of the simple consistency policies that you can specify.