com.couchbase.client.java.query

Enum QueryProfile

java.lang.Object

java.lang.Enum<QueryProfile>

com.couchbase.client.java.query.QueryProfile

All Implemented Interfaces:

Serializable, Comparable<QueryProfile>

@Stability.Volatile
public enum QueryProfile
extends Enum<QueryProfile>

Query profiling information received from the server query engine.

Since:

3.0.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
OFF No profiling information is added to the query response.
PHASES The query response includes a profile section with stats and details about various phases of the query plan and execution.
TIMINGS Besides the phase times, the profile section of the query response document will include a full query plan with timing and information about the number of processed documents at each phase.

Method Summary

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

OFF

public static final QueryProfile OFF

No profiling information is added to the query response.

PHASES

public static final QueryProfile PHASES

The query response includes a profile section with stats and details about various phases of the query plan and execution.

Three phase times will be included in the system:active_requests and system:completed_requests monitoring keyspaces.

TIMINGS

public static final QueryProfile TIMINGS

Besides the phase times, the profile section of the query response document will include a full query plan with timing and information about the number of processed documents at each phase.

This information will be included in the system:active_requests and system:completed_requests keyspaces.

Method Detail

values

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

Returns:

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

valueOf

public static QueryProfile 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