Package com.google.spanner.v1

Enum ExecuteSqlRequest.QueryMode

java.lang.Object
java.lang.Enum<ExecuteSqlRequest.QueryMode>
com.google.spanner.v1.ExecuteSqlRequest.QueryMode
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<ExecuteSqlRequest.QueryMode>
Enclosing class:
ExecuteSqlRequest
public static enum ExecuteSqlRequest.QueryMode extends Enum<ExecuteSqlRequest.QueryMode> implements com.google.protobuf.ProtocolMessageEnum
 Mode in which the statement must be processed.
Protobuf enum google.spanner.v1.ExecuteSqlRequest.QueryMode

  • Enum Constant Details

    • NORMAL

      public static final ExecuteSqlRequest.QueryMode NORMAL
       The default mode. Only the statement results are returned.
      NORMAL = 0;

    • PLAN

      public static final ExecuteSqlRequest.QueryMode PLAN
       This mode returns only the query plan, without any results or
 execution statistics information.
      PLAN = 1;

    • PROFILE

      public static final ExecuteSqlRequest.QueryMode PROFILE
       This mode returns the query plan, overall execution statistics,
 operator level execution statistics along with the results. This has a
 performance overhead compared to the other modes. It is not recommended
 to use this mode for production traffic.
      PROFILE = 2;

    • WITH_STATS

      public static final ExecuteSqlRequest.QueryMode WITH_STATS
       This mode returns the overall (but not operator-level) execution
 statistics along with the results.
      WITH_STATS = 3;

    • WITH_PLAN_AND_STATS

      public static final ExecuteSqlRequest.QueryMode WITH_PLAN_AND_STATS
       This mode returns the query plan, overall (but not operator-level)
 execution statistics along with the results.
      WITH_PLAN_AND_STATS = 4;

    • UNRECOGNIZED

      public static final ExecuteSqlRequest.QueryMode UNRECOGNIZED

  • Field Details

    • NORMAL_VALUE

      public static final int NORMAL_VALUE
       The default mode. Only the statement results are returned.
      NORMAL = 0;
      See Also:

    • PLAN_VALUE

      public static final int PLAN_VALUE
       This mode returns only the query plan, without any results or
 execution statistics information.
      PLAN = 1;
      See Also:

    • PROFILE_VALUE

      public static final int PROFILE_VALUE
       This mode returns the query plan, overall execution statistics,
 operator level execution statistics along with the results. This has a
 performance overhead compared to the other modes. It is not recommended
 to use this mode for production traffic.
      PROFILE = 2;
      See Also:

    • WITH_STATS_VALUE

      public static final int WITH_STATS_VALUE
       This mode returns the overall (but not operator-level) execution
 statistics along with the results.
      WITH_STATS = 3;
      See Also:

    • WITH_PLAN_AND_STATS_VALUE

      public static final int WITH_PLAN_AND_STATS_VALUE
       This mode returns the query plan, overall (but not operator-level)
 execution statistics along with the results.
      WITH_PLAN_AND_STATS = 4;
      See Also:

  • Method Details

    • values

      public static ExecuteSqlRequest.QueryMode[] 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 ExecuteSqlRequest.QueryMode 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

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static ExecuteSqlRequest.QueryMode valueOf(int value)
      Deprecated.
      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:
      value - 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

    • forNumber

      public static ExecuteSqlRequest.QueryMode forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<ExecuteSqlRequest.QueryMode> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static ExecuteSqlRequest.QueryMode valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      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:
      desc - 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