Package org.apache.calcite.sql

Enum SqlExplainLevel

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SqlExplainLevel>
    public enum SqlExplainLevel
extends java.lang.Enum<SqlExplainLevel>
    SqlExplainLevel defines detail levels for EXPLAIN PLAN.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private SqlExplainLevel()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      SqlLiteral symbol​(SqlParserPos pos)
      Creates a parse-tree node representing an occurrence of this symbol at a particular position in the parsed text.
      static SqlExplainLevel valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SqlExplainLevel[] 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_ATTRIBUTES

        public static final SqlExplainLevel NO_ATTRIBUTES
        Suppress all attributes.

      • EXPPLAN_ATTRIBUTES

        public static final SqlExplainLevel EXPPLAN_ATTRIBUTES
        Display only attributes which contribute to the plan output.

      • DIGEST_ATTRIBUTES

        public static final SqlExplainLevel DIGEST_ATTRIBUTES
        Display only attributes which contribute to an expression's digest.

      • NON_COST_ATTRIBUTES

        public static final SqlExplainLevel NON_COST_ATTRIBUTES
        Display all attributes, including id, except cost.

      • ALL_ATTRIBUTES

        public static final SqlExplainLevel ALL_ATTRIBUTES
        Display all attributes, including cost.

    • Constructor Detail

      • SqlExplainLevel

        private SqlExplainLevel()

    • Method Detail

      • values

        public static SqlExplainLevel[] 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 (SqlExplainLevel c : SqlExplainLevel.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SqlExplainLevel valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • symbol

        public SqlLiteral symbol​(SqlParserPos pos)
        Creates a parse-tree node representing an occurrence of this symbol at a particular position in the parsed text.