Enum SqlExplainFormat

java.lang.Object
java.lang.Enum<SqlExplainFormat>
org.apache.calcite.sql.SqlExplainFormat
All Implemented Interfaces:
Serializable, Comparable<SqlExplainFormat>, java.lang.constant.Constable, Symbolizable

public enum SqlExplainFormat extends Enum<SqlExplainFormat> implements Symbolizable
Output format for EXPLAIN PLAN statement.
  • Enum Constant Details

    • TEXT

      public static final SqlExplainFormat TEXT
      Indicates that the plan should be output as a piece of indented text.
    • XML

      public static final SqlExplainFormat XML
      Indicates that the plan should be output in XML format.
    • JSON

      public static final SqlExplainFormat JSON
      Indicates that the plan should be output in JSON format.
    • DOT

      public static final SqlExplainFormat DOT
      Indicates that the plan should be output in dot format.
  • Method Details

    • values

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