org.apache.calcite.sql

Enum SqlExplainLevel

java.lang.Object

java.lang.Enum<SqlExplainLevel>

org.apache.calcite.sql.SqlExplainLevel

All Implemented Interfaces:

Serializable, Comparable<SqlExplainLevel>, Symbolizable

public enum SqlExplainLevel
extends Enum<SqlExplainLevel>
implements Symbolizable

SqlExplainLevel defines detail levels for EXPLAIN PLAN.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_ATTRIBUTES Display all attributes, including cost.
DIGEST_ATTRIBUTES Display only attributes which contribute to an expression's digest.
EXPPLAN_ATTRIBUTES Display only attributes which contribute to the plan output.
NO_ATTRIBUTES Suppress all attributes.
NON_COST_ATTRIBUTES Display all attributes, including id, except cost.

Method Summary

Modifier and Type	Method and Description
static SqlExplainLevel	valueOf(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

Methods inherited from interface org.apache.calcite.sql.Symbolizable

symbol

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.

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(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