io.atomix.protocols.raft

Enum ReadConsistency

java.lang.Object

java.lang.Enum<ReadConsistency>

io.atomix.protocols.raft.ReadConsistency

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ReadConsistency>

public enum ReadConsistency
extends java.lang.Enum<ReadConsistency>

Constants for specifying Raft query consistency levels.

This enum provides identifiers for configuring consistency levels for queries submitted to a Raft cluster.

Consistency levels are used to dictate how queries are routed through the Raft cluster and the requirements for completing read operations based on submitted queries. For expectations of specific consistency levels, see below.

Author:

Jordan Halterman

Enum Constant Summary

Enum Constants

Enum Constant and Description
LINEARIZABLE Enforces linearizable query consistency.
LINEARIZABLE_LEASE Enforces linearizable query consistency based on leader lease.
SEQUENTIAL Enforces sequential query consistency.

Method Summary

Modifier and Type	Method and Description
static ReadConsistency	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ReadConsistency[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SEQUENTIAL

public static final ReadConsistency SEQUENTIAL

Enforces sequential query consistency.

Sequential read consistency requires that clients always see state progress in monotonically increasing order. Note that this constraint allows reads from followers. When a sequential query is submitted to the cluster, the first server that receives the query will handle it. However, in order to ensure that state does not go back in time, the client must submit its last known index with the query as well. If the server that receives the query has not advanced past the provided client index, it will queue the query and await more entries from the leader.

LINEARIZABLE_LEASE

public static final ReadConsistency LINEARIZABLE_LEASE

Enforces linearizable query consistency based on leader lease.

Bounded linearizability is a special implementation of linearizable reads that relies on the semantics of Raft's election timers to determine whether it is safe to immediately apply a query to the Raft state machine. When a linearizable query is submitted to the Raft cluster with linearizable consistency, it must be forwarded to the current cluster leader. For lease-based linearizability, the leader will determine whether it's safe to apply the query to its state machine based on the last time it successfully contacted a majority of the cluster. If the leader contacted a majority of the cluster within the last election timeout, it assumes that no other member could have since become the leader and immediately applies the query to its state machine. Alternatively, if it hasn't contacted a majority of the cluster within an election timeout, the leader will handle the query as if it were submitted with LINEARIZABLE consistency.

LINEARIZABLE

public static final ReadConsistency LINEARIZABLE

Enforces linearizable query consistency.

The linearizable consistency level guarantees consistency by contacting a majority of the cluster on every read. When a query is submitted to the cluster with linearizable consistency, it must be forwarded to the current cluster leader. Once received by the leader, the leader will contact a majority of the cluster before applying the query to its state machine and returning the result. Note that if the leader is already in the process of contacting a majority of the cluster, it will queue the query to be processed on the next round trip. This allows the leader to batch expensive quorum based reads for efficiency.

Method Detail

values

public static ReadConsistency[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReadConsistency c : ReadConsistency.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReadConsistency valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null