com.google.cloud.spanner

Enum ReadContext.QueryAnalyzeMode

java.lang.Object

java.lang.Enum<ReadContext.QueryAnalyzeMode>

com.google.cloud.spanner.ReadContext.QueryAnalyzeMode

All Implemented Interfaces:

Serializable, Comparable<ReadContext.QueryAnalyzeMode>

Enclosing interface:

ReadContext

public static enum ReadContext.QueryAnalyzeMode
extends Enum<ReadContext.QueryAnalyzeMode>

Used to specify the mode in which the query should be analyzed by ReadContext.analyzeQuery(Statement,QueryAnalyzeMode).

Enum Constant Summary

Enum Constants

Enum Constant and Description
PLAN Retrieves only the query plan information.
PROFILE Retrieves both query plan and query execution statistics along with the result data.

Method Summary

Modifier and Type	Method and Description
static ReadContext.QueryAnalyzeMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReadContext.QueryAnalyzeMode[]	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

PLAN

public static final ReadContext.QueryAnalyzeMode PLAN

Retrieves only the query plan information. No result data is returned.

PROFILE

public static final ReadContext.QueryAnalyzeMode PROFILE

Retrieves both query plan and query execution statistics along with the result data.

Method Detail

values

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

Returns:

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

valueOf

public static ReadContext.QueryAnalyzeMode 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