org.apache.spark.sql.execution.command

DescribeFunctionCommand

case class DescribeFunctionCommand(functionName: FunctionIdentifier, isExtended: Boolean) extends LeafNode with RunnableCommand with Product with Serializable

A command for users to get the usage of a registered function. The syntax of using this command in SQL is

DESCRIBE FUNCTION [EXTENDED] upper;
Linear Supertypes
Serializable, Serializable, RunnableCommand, Command, LeafNode, LogicalPlan, Logging, QueryPlan[LogicalPlan], TreeNode[LogicalPlan], Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DescribeFunctionCommand
  2. Serializable
  3. Serializable
  4. RunnableCommand
  5. Command
  6. LeafNode
  7. LogicalPlan
  8. Logging
  9. QueryPlan
  10. TreeNode
  11. Product
  12. Equals
  13. AnyRef
  14. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DescribeFunctionCommand(functionName: FunctionIdentifier, isExtended: Boolean)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. lazy val allAttributes: AttributeSeq

    Definition Classes
    QueryPlan

  7. def analyzed: Boolean

    Definition Classes
    LogicalPlan

  8. def apply(number: Int): TreeNode[_]

    Definition Classes
    TreeNode

  9. def argString: String

    Definition Classes
    TreeNode

  10. def asCode: String

    Definition Classes
    TreeNode

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  12. lazy val canonicalized: LogicalPlan

    Definition Classes
    QueryPlan

  13. final def children: Seq[LogicalPlan]

    Definition Classes
    LeafNode → TreeNode

  14. def childrenResolved: Boolean

    Definition Classes
    LogicalPlan

  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  16. def collect[B](pf: PartialFunction[LogicalPlan, B]): Seq[B]

    Definition Classes
    TreeNode

  17. def collectFirst[B](pf: PartialFunction[LogicalPlan, B]): Option[B]

    Definition Classes
    TreeNode

  18. def collectLeaves(): Seq[LogicalPlan]

    Definition Classes
    TreeNode

  19. def computeStats(conf: SQLConf): Statistics

    Attributes
    protected
    Definition Classes
    LogicalPlan

  20. lazy val constraints: ExpressionSet

    Definition Classes
    QueryPlan

  21. lazy val containsChild: Set[TreeNode[_]]

    Definition Classes
    TreeNode

  22. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  23. final def expressions: Seq[Expression]

    Definition Classes
    QueryPlan

  24. def fastEquals(other: TreeNode[_]): Boolean

    Definition Classes
    TreeNode

  25. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  26. def find(f: (LogicalPlan) ⇒ Boolean): Option[LogicalPlan]

    Definition Classes
    TreeNode

  27. def flatMap[A](f: (LogicalPlan) ⇒ TraversableOnce[A]): Seq[A]

    Definition Classes
    TreeNode

  28. def foreach(f: (LogicalPlan) ⇒ Unit): Unit

    Definition Classes
    TreeNode

  29. def foreachUp(f: (LogicalPlan) ⇒ Unit): Unit

    Definition Classes
    TreeNode

  30. val functionName: FunctionIdentifier

  31. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder, verbose: Boolean, prefix: String, addSuffix: Boolean): StringBuilder

    Definition Classes
    TreeNode

  32. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  33. def getRelevantConstraints(constraints: Set[Expression]): Set[Expression]

    Attributes
    protected
    Definition Classes
    QueryPlan

  34. def hashCode(): Int

    Definition Classes
    TreeNode → AnyRef → Any

  35. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Attributes
    protected
    Definition Classes
    Logging

  36. def innerChildren: Seq[QueryPlan[_]]

    Attributes
    protected
    Definition Classes
    QueryPlan → TreeNode

  37. def inputSet: AttributeSet

    Definition Classes
    QueryPlan

  38. final def invalidateStatsCache(): Unit

    Definition Classes
    LogicalPlan

  39. val isExtended: Boolean

  40. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  41. def isStreaming: Boolean

    Definition Classes
    LogicalPlan

  42. def isTraceEnabled(): Boolean

    Attributes
    protected
    Definition Classes
    Logging

  43. def jsonFields: List[(String, JValue)]

    Attributes
    protected
    Definition Classes
    TreeNode

  44. def log: Logger

    Attributes
    protected
    Definition Classes
    Logging

  45. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging

  46. def logDebug(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging

  47. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging

  48. def logError(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging

  49. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging

  50. def logInfo(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging

  51. def logName: String

    Attributes
    protected
    Definition Classes
    Logging

  52. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging

  53. def logTrace(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging

  54. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging

  55. def logWarning(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging

  56. def makeCopy(newArgs: Array[AnyRef]): LogicalPlan

    Definition Classes
    TreeNode

  57. def map[A](f: (LogicalPlan) ⇒ A): Seq[A]

    Definition Classes
    TreeNode

  58. def mapChildren(f: (LogicalPlan) ⇒ LogicalPlan): LogicalPlan

    Definition Classes
    TreeNode

  59. def mapExpressions(f: (Expression) ⇒ Expression): DescribeFunctionCommand.this.type

    Definition Classes
    QueryPlan

  60. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]

    Attributes
    protected
    Definition Classes
    TreeNode

  61. def maxRows: Option[Long]

    Definition Classes
    LogicalPlan

  62. def missingInput: AttributeSet

    Definition Classes
    QueryPlan

  63. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  64. def nodeName: String

    Definition Classes
    TreeNode

  65. final def notify(): Unit

    Definition Classes
    AnyRef

  66. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  67. def numberedTreeString: String

    Definition Classes
    TreeNode

  68. val origin: Origin

    Definition Classes
    TreeNode

  69. def otherCopyArgs: Seq[AnyRef]

    Attributes
    protected
    Definition Classes
    TreeNode

  70. val output: Seq[Attribute]

    Definition Classes
    DescribeFunctionCommand → Command → QueryPlan

  71. def outputSet: AttributeSet

    Definition Classes
    QueryPlan

  72. def p(number: Int): LogicalPlan

    Definition Classes
    TreeNode

  73. def preCanonicalized: LogicalPlan

    Attributes
    protected
    Definition Classes
    QueryPlan

  74. def prettyJson: String

    Definition Classes
    TreeNode

  75. def printSchema(): Unit

    Definition Classes
    QueryPlan

  76. def producedAttributes: AttributeSet

    Definition Classes
    LeafNode → QueryPlan

  77. def references: AttributeSet

    Definition Classes
    QueryPlan

  78. def refresh(): Unit

    Definition Classes
    LogicalPlan

  79. def resolve(nameParts: Seq[String], input: Seq[Attribute], resolver: (String, String) ⇒ Boolean): Option[NamedExpression]

    Attributes
    protected
    Definition Classes
    LogicalPlan

  80. def resolve(nameParts: Seq[String], resolver: (String, String) ⇒ Boolean): Option[NamedExpression]

    Definition Classes
    LogicalPlan

  81. def resolve(schema: StructType, resolver: (String, String) ⇒ Boolean): Seq[Attribute]

    Definition Classes
    LogicalPlan

  82. def resolveChildren(nameParts: Seq[String], resolver: (String, String) ⇒ Boolean): Option[NamedExpression]

    Definition Classes
    LogicalPlan

  83. def resolveExpressions(r: PartialFunction[Expression, Expression]): LogicalPlan

    Definition Classes
    LogicalPlan

  84. def resolveOperators(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    Definition Classes
    LogicalPlan

  85. def resolveQuoted(name: String, resolver: (String, String) ⇒ Boolean): Option[NamedExpression]

    Definition Classes
    LogicalPlan

  86. lazy val resolved: Boolean

    Definition Classes
    LogicalPlan

  87. def run(sparkSession: SparkSession): Seq[Row]

    Definition Classes
    DescribeFunctionCommand → RunnableCommand

  88. final def sameResult(other: LogicalPlan): Boolean

    Definition Classes
    QueryPlan

  89. lazy val schema: StructType

    Definition Classes
    QueryPlan

  90. def schemaString: String

    Definition Classes
    QueryPlan

  91. final def semanticHash(): Int

    Definition Classes
    QueryPlan

  92. def simpleString: String

    Definition Classes
    QueryPlan → TreeNode

  93. def statePrefix: String

    Attributes
    protected
    Definition Classes
    LogicalPlan → QueryPlan

  94. final def stats(conf: SQLConf): Statistics

    Definition Classes
    LogicalPlan

  95. def stringArgs: Iterator[Any]

    Attributes
    protected
    Definition Classes
    TreeNode

  96. def subqueries: Seq[LogicalPlan]

    Definition Classes
    QueryPlan

  97. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  98. def toJSON: String

    Definition Classes
    TreeNode

  99. def toString(): String

    Definition Classes
    TreeNode → AnyRef → Any

  100. def transform(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    Definition Classes
    TreeNode

  101. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): DescribeFunctionCommand.this.type

    Definition Classes
    QueryPlan

  102. def transformDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    Definition Classes
    TreeNode

  103. def transformExpressions(rule: PartialFunction[Expression, Expression]): DescribeFunctionCommand.this.type

    Definition Classes
    QueryPlan

  104. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): DescribeFunctionCommand.this.type

    Definition Classes
    QueryPlan

  105. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): DescribeFunctionCommand.this.type

    Definition Classes
    QueryPlan

  106. def transformUp(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    Definition Classes
    TreeNode

  107. def treeString(verbose: Boolean, addSuffix: Boolean): String

    Definition Classes
    TreeNode

  108. def treeString: String

    Definition Classes
    TreeNode

  109. def validConstraints: Set[Expression]

    Attributes
    protected
    Definition Classes
    QueryPlan

  110. def verboseString: String

    Definition Classes
    QueryPlan → TreeNode

  111. def verboseStringWithSuffix: String

    Definition Classes
    LogicalPlan → TreeNode

  112. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  113. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  114. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  115. def withNewChildren(newChildren: Seq[LogicalPlan]): LogicalPlan

    Definition Classes
    TreeNode

Inherited from Serializable

Inherited from Serializable

Inherited from RunnableCommand

Inherited from Command

Inherited from LeafNode

Inherited from LogicalPlan

Inherited from Logging

Inherited from QueryPlan[LogicalPlan]

Inherited from TreeNode[LogicalPlan]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped