org.apache.spark.sql.execution.ExplainMode.scala Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.spark.sql.execution
import java.util.Locale
sealed trait ExplainMode {
/**
* String name of the explain mode.
*/
def name: String
}
/**
* Simple mode means that when printing explain for a DataFrame, only a physical plan is
* expected to be printed to the console.
*/
case object SimpleMode extends ExplainMode { val name = "simple" }
/**
* Extended mode means that when printing explain for a DataFrame, both logical and physical
* plans are expected to be printed to the console.
*/
case object ExtendedMode extends ExplainMode { val name = "extended" }
/**
* Codegen mode means that when printing explain for a DataFrame, if generated codes are
* available, a physical plan and the generated codes are expected to be printed to the console.
*/
case object CodegenMode extends ExplainMode { val name = "codegen" }
/**
* Cost mode means that when printing explain for a DataFrame, if plan node statistics are
* available, a logical plan and the statistics are expected to be printed to the console.
*/
case object CostMode extends ExplainMode { val name = "cost" }
/**
* Formatted mode means that when printing explain for a DataFrame, explain output is
* expected to be split into two sections: a physical plan outline and node details.
*/
case object FormattedMode extends ExplainMode { val name = "formatted" }
object ExplainMode {
/**
* Returns the explain mode from the given string.
*/
def fromString(mode: String): ExplainMode = mode.toLowerCase(Locale.ROOT) match {
case SimpleMode.name => SimpleMode
case ExtendedMode.name => ExtendedMode
case CodegenMode.name => CodegenMode
case CostMode.name => CostMode
case FormattedMode.name => FormattedMode
case _ => throw new IllegalArgumentException(s"Unknown explain mode: $mode. Accepted " +
"explain modes are 'simple', 'extended', 'codegen', 'cost', 'formatted'.")
}
}