Package org.apache.flink.table.api

Enum ExplainDetail

java.lang.Object
java.lang.Enum<ExplainDetail>
org.apache.flink.table.api.ExplainDetail
All Implemented Interfaces:
Serializable, Comparable<ExplainDetail>
@PublicEvolving public enum ExplainDetail extends Enum<ExplainDetail>
ExplainDetail defines the types of details for explain result.

  • Enum Constant Details

    • ESTIMATED_COST

      public static final ExplainDetail ESTIMATED_COST
      The cost information on physical rel node estimated by optimizer. e.g. TableSourceScan(..., cumulative cost = {1.0E8 rows, 1.0E8 cpu, 2.4E9 io, 0.0 network, 0.0 memory}

    • CHANGELOG_MODE

      public static final ExplainDetail CHANGELOG_MODE
      The changelog mode produced by a physical rel node. e.g. GroupAggregate(..., changelogMode=[I,UA,D])

    • JSON_EXECUTION_PLAN

      public static final ExplainDetail JSON_EXECUTION_PLAN
      The execution plan in json format of the program.

    • PLAN_ADVICE

      public static final ExplainDetail PLAN_ADVICE
      The potential risk warnings and SQL optimizer tuning advice analyzed from the physical plan.

  • Method Details

    • values

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