Package com.couchbase.client.core.api.query

Enum CoreQueryProfile

java.lang.Object
java.lang.Enum<CoreQueryProfile>
com.couchbase.client.core.api.query.CoreQueryProfile
All Implemented Interfaces:
Serializable, Comparable<CoreQueryProfile>
@Internal public enum CoreQueryProfile extends Enum<CoreQueryProfile>
Query profiling information received from the server query engine.
Since:
3.0.0

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    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
    Description
    static CoreQueryProfile
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static CoreQueryProfile[]
    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 Details

    • OFF

      public static final CoreQueryProfile OFF
      No profiling information is added to the query response.

    • PHASES

      public static final CoreQueryProfile 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 CoreQueryProfile 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 Details

    • values

      public static CoreQueryProfile[] 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 CoreQueryProfile 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