org.springframework.data.mongodb.core.query

Enum Meta.CursorOption

java.lang.Object

java.lang.Enum<Meta.CursorOption>

org.springframework.data.mongodb.core.query.Meta.CursorOption

All Implemented Interfaces:

Serializable, Comparable<Meta.CursorOption>

Enclosing class:

Meta

public static enum Meta.CursorOption
extends Enum<Meta.CursorOption>

Meta.CursorOption represents OP_QUERY wire protocol flags to change the behavior of queries.

Since:

1.10

Author:

Christoph Strobl

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXHAUST Sets the cursor to return all data returned by the query at once rather than splitting the results into batches.
NO_TIMEOUT Prevents the server from timing out idle cursors.
PARTIAL Sets the cursor to return partial data from a query against a sharded cluster in which some shards do not respond rather than throwing an error.
SECONDARY_READS Allows querying of a replica.
SLAVE_OK Deprecated. since 3.0.2, use SECONDARY_READS instead.

Method Summary

Modifier and Type	Method and Description
static Meta.CursorOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static Meta.CursorOption[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_TIMEOUT

public static final Meta.CursorOption NO_TIMEOUT

Prevents the server from timing out idle cursors.

EXHAUST

public static final Meta.CursorOption EXHAUST

Sets the cursor to return all data returned by the query at once rather than splitting the results into batches.

SLAVE_OK

@Deprecated
public static final Meta.CursorOption SLAVE_OK

Deprecated. since 3.0.2, use SECONDARY_READS instead.

Allows querying of a replica.

SECONDARY_READS

public static final Meta.CursorOption SECONDARY_READS

Allows querying of a replica.

Since:

3.0.2

PARTIAL

public static final Meta.CursorOption PARTIAL

Sets the cursor to return partial data from a query against a sharded cluster in which some shards do not respond rather than throwing an error.

Method Detail

values

public static Meta.CursorOption[] 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 (Meta.CursorOption c : Meta.CursorOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static Meta.CursorOption 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