Package com.couchbase.client.java.query.consistency

Enum ScanConsistency

java.lang.Object

java.lang.Enum<ScanConsistency>

com.couchbase.client.java.query.consistency.ScanConsistency

All Implemented Interfaces:

Serializable, Comparable<ScanConsistency>, java.lang.constant.Constable

public enum ScanConsistency
extends Enum<ScanConsistency>

The possible values for scan_consistency in a N1QL request.

Since:

2.1

Author:

Simon Baslé

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NOT_BOUNDED	This is the default (for single-statement requests).
REQUEST_PLUS	This implements strong consistency per request.
STATEMENT_PLUS	This implements strong consistency per statement.

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOT_BOUNDED

public static final ScanConsistency NOT_BOUNDED

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

public static final ScanConsistency REQUEST_PLUS

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 is also applied within the request.

STATEMENT_PLUS

public static final ScanConsistency STATEMENT_PLUS

This implements strong consistency per statement. Before processing each statement, a current vector is obtained and used as a lower bound for that statement.

Method Details

values

public static ScanConsistency[] values()

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

Returns:

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

valueOf

public static ScanConsistency valueOf(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:

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

NullPointerException - if the argument is null

n1ql

public String n1ql()