Package org.apache.calcite.sql

Enum SqlExplainFormat

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SqlExplainFormat>
    public enum SqlExplainFormat
extends java.lang.Enum<SqlExplainFormat>
    Output format for EXPLAIN PLAN statement.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      JSON
      Indicates that the plan should be output in JSON format.
      TEXT
      Indicates that the plan should be output as a piece of indented text.
      XML
      Indicates that the plan should be output in XML format.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private SqlExplainFormat()  

    • 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 SqlExplainFormat valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SqlExplainFormat[] 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

      • 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.

    • Constructor Detail

      • SqlExplainFormat

        private SqlExplainFormat()

    • Method Detail

      • values

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

      • valueOf

        public static SqlExplainFormat 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.