org.apache.calcite.sql

Enum SqlExplain.Depth

java.lang.Object

java.lang.Enum<SqlExplain.Depth>

org.apache.calcite.sql.SqlExplain.Depth

All Implemented Interfaces:

Serializable, Comparable<SqlExplain.Depth>, SqlLiteral.SqlSymbol

Enclosing class:

SqlExplain

public static enum SqlExplain.Depth
extends Enum<SqlExplain.Depth>
implements SqlLiteral.SqlSymbol

The level of abstraction with which to display the plan.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOGICAL
PHYSICAL
TYPE

Method Summary

Methods

Modifier and Type	Method and 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 SqlExplain.Depth	valueOf(String name) Returns the enum constant of this type with the specified name.
static SqlExplain.Depth[]	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

Methods inherited from interface org.apache.calcite.sql.SqlLiteral.SqlSymbol

name, ordinal

Enum Constant Detail

TYPE

public static final SqlExplain.Depth TYPE

LOGICAL

public static final SqlExplain.Depth LOGICAL

PHYSICAL

public static final SqlExplain.Depth PHYSICAL

Method Detail

values

public static SqlExplain.Depth[] 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 (SqlExplain.Depth c : SqlExplain.Depth.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SqlExplain.Depth 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

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.