org.apache.spark.sql.catalyst.plans

QueryPlan

abstract class QueryPlan[PlanType <: TreeNode[PlanType]] extends TreeNode[PlanType]

Self Type
QueryPlan[PlanType] with PlanType
Linear Supertypes
TreeNode[PlanType], Product, Equals, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. QueryPlan
  2. TreeNode
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new QueryPlan()

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean

    Definition Classes
    Equals
  2. abstract def children: Seq[PlanType]

    Returns a Seq of the children of this node.

    Returns a Seq of the children of this node. Children should not change. Immutability required for containsChild optimization

    Definition Classes
    TreeNode
  3. abstract def output: Seq[Attribute]

  4. abstract def productArity: Int

    Definition Classes
    Product
  5. abstract def productElement(n: Int): Any

    Definition Classes
    Product

Concrete 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. def apply(number: Int): PlanType

    Returns the tree node at the specified number.

    Returns the tree node at the specified number. Numbers for each node can be found in the numberedTreeString.

    Definition Classes
    TreeNode
  7. def argString: String

    Returns a string representing the arguments to this node, minus any children

    Returns a string representing the arguments to this node, minus any children

    Definition Classes
    TreeNode
  8. def asCode: String

    Returns a 'scala code' representation of this TreeNode and its children.

    Returns a 'scala code' representation of this TreeNode and its children. Intended for use when debugging where the prettier toString function is obfuscating the actual structure. In the case of 'pure' TreeNodes that only contain primitives and other TreeNodes, the result can be pasted in the REPL to build an equivalent Tree.

    Definition Classes
    TreeNode
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def collect[B](pf: PartialFunction[PlanType, B]): Seq[B]

    Returns a Seq containing the result of applying a partial function to all elements in this tree on which the function is defined.

    Returns a Seq containing the result of applying a partial function to all elements in this tree on which the function is defined.

    Definition Classes
    TreeNode
  12. def collectFirst[B](pf: PartialFunction[PlanType, B]): Option[B]

    Finds and returns the first TreeNode of the tree for which the given partial function is defined (pre-order), and applies the partial function to it.

    Finds and returns the first TreeNode of the tree for which the given partial function is defined (pre-order), and applies the partial function to it.

    Definition Classes
    TreeNode
  13. lazy val containsChild: Set[TreeNode[_]]

    Definition Classes
    TreeNode
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def expressions: Seq[Expression]

    Returns all of the expressions present in this query plan operator.

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

    Faster version of equality which short-circuits when two treeNodes are the same instance.

    Faster version of equality which short-circuits when two treeNodes are the same instance. We don't just override Object.equals, as doing so prevents the scala compiler from generating case class equals methods

    Definition Classes
    TreeNode
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def find(f: (PlanType) ⇒ Boolean): Option[PlanType]

    Find the first TreeNode that satisfies the condition specified by f.

    Find the first TreeNode that satisfies the condition specified by f. The condition is recursively applied to this node and all of its children (pre-order).

    Definition Classes
    TreeNode
  20. def flatMap[A](f: (PlanType) ⇒ TraversableOnce[A]): Seq[A]

    Returns a Seq by applying a function to all nodes in this tree and using the elements of the resulting collections.

    Returns a Seq by applying a function to all nodes in this tree and using the elements of the resulting collections.

    Definition Classes
    TreeNode
  21. def foreach(f: (PlanType) ⇒ Unit): Unit

    Runs the given function on this node and then recursively on children.

    Runs the given function on this node and then recursively on children.

    f

    the function to be applied to each node in the tree.

    Definition Classes
    TreeNode
  22. def foreachUp(f: (PlanType) ⇒ Unit): Unit

    Runs the given function recursively on children then on this node.

    Runs the given function recursively on children then on this node.

    f

    the function to be applied to each node in the tree.

    Definition Classes
    TreeNode
  23. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder): StringBuilder

    Appends the string represent of this node and its children to the given StringBuilder.

    Appends the string represent of this node and its children to the given StringBuilder.

    The i-th element in lastChildren indicates whether the ancestor of the current node at depth i + 1 is the last child of its own parent node. The depth of the root node is 0, and lastChildren for the root node should be empty.

    Attributes
    protected
    Definition Classes
    TreeNode
  24. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  25. def getNodeNumbered(number: MutableInt): PlanType

    Attributes
    protected
    Definition Classes
    TreeNode
  26. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  27. def inputSet: AttributeSet

    The set of all attributes that are input to this operator by its children.

  28. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  29. def jsonFields: List[(String, JValue)]

    Attributes
    protected
    Definition Classes
    TreeNode
  30. def makeCopy(newArgs: Array[AnyRef]): PlanType

    Creates a copy of this type of tree node after a transformation.

    Creates a copy of this type of tree node after a transformation. Must be overridden by child classes that have constructor arguments that are not present in the productIterator.

    newArgs

    the new product arguments.

    Definition Classes
    TreeNode
  31. def map[A](f: (PlanType) ⇒ A): Seq[A]

    Returns a Seq containing the result of applying the given function to each node in this tree in a preorder traversal.

    Returns a Seq containing the result of applying the given function to each node in this tree in a preorder traversal.

    f

    the function to be applied.

    Definition Classes
    TreeNode
  32. def mapChildren(f: (PlanType) ⇒ PlanType): PlanType

    Returns a copy of this node where f has been applied to all the nodes children.

    Returns a copy of this node where f has been applied to all the nodes children.

    Definition Classes
    TreeNode
  33. def missingInput: AttributeSet

    Attributes that are referenced by expressions but not provided by this nodes children.

    Attributes that are referenced by expressions but not provided by this nodes children. Subclasses should override this method if they produce attributes internally as it is used by assertions designed to prevent the construction of invalid plans.

    Note that virtual columns should be excluded. Currently, we only support the grouping ID virtual column.

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

    Definition Classes
    AnyRef
  35. def nodeName: String

    Returns the name of this type of TreeNode.

    Returns the name of this type of TreeNode. Defaults to the class name.

    Definition Classes
    TreeNode
  36. final def notify(): Unit

    Definition Classes
    AnyRef
  37. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  38. def numberedTreeString: String

    Returns a string representation of the nodes in this tree, where each operator is numbered.

    Returns a string representation of the nodes in this tree, where each operator is numbered. The numbers can be used with apply to easily access specific subtrees.

    Definition Classes
    TreeNode
  39. val origin: Origin

    Definition Classes
    TreeNode
  40. def otherCopyArgs: Seq[AnyRef]

    Args to the constructor that should be copied, but not transformed.

    Args to the constructor that should be copied, but not transformed. These are appended to the transformed args automatically by makeCopy

    returns

    Attributes
    protected
    Definition Classes
    TreeNode
  41. def outputSet: AttributeSet

    Returns the set of attributes that are output by this node.

  42. def prettyJson: String

    Definition Classes
    TreeNode
  43. def printSchema(): Unit

    Prints out the schema in the tree format

  44. def productIterator: Iterator[Any]

    Definition Classes
    Product
  45. def productPrefix: String

    Definition Classes
    Product
  46. def references: AttributeSet

    All Attributes that appear in expressions from this operator.

    All Attributes that appear in expressions from this operator. Note that this set does not include attributes that are implicitly referenced by being passed through to the output tuple.

  47. lazy val schema: StructType

  48. def schemaString: String

    Returns the output schema in the tree format.

  49. def simpleString: String

    String representation of this node without any children

    String representation of this node without any children

    Definition Classes
    QueryPlanTreeNode
  50. def statePrefix: String

    A prefix string used when printing the plan.

    A prefix string used when printing the plan.

    We use "!" to indicate an invalid plan, and "'" to indicate an unresolved plan.

    Attributes
    protected
  51. def stringArgs: Iterator[Any]

    The arguments that should be included in the arg string.

    The arguments that should be included in the arg string. Defaults to the productIterator.

    Attributes
    protected
    Definition Classes
    TreeNode
  52. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  53. def toJSON: String

    Definition Classes
    TreeNode
  54. def toString(): String

    Definition Classes
    TreeNode → AnyRef → Any
  55. def transform(rule: PartialFunction[PlanType, PlanType]): PlanType

    Returns a copy of this node where rule has been recursively applied to the tree.

    Returns a copy of this node where rule has been recursively applied to the tree. When rule does not apply to a given node it is left unchanged. Users should not expect a specific directionality. If a specific directionality is needed, transformDown or transformUp should be used.

    rule

    the function use to transform this nodes children

    Definition Classes
    TreeNode
  56. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): QueryPlan.this

    Returns the result of running transformExpressions on this node and all its children.

  57. def transformChildren(rule: PartialFunction[PlanType, PlanType], nextOperation: (PlanType, PartialFunction[PlanType, PlanType]) ⇒ PlanType): PlanType

    Returns a copy of this node where rule has been recursively applied to all the children of this node.

    Returns a copy of this node where rule has been recursively applied to all the children of this node. When rule does not apply to a given node it is left unchanged.

    rule

    the function used to transform this nodes children

    Attributes
    protected
    Definition Classes
    TreeNode
  58. def transformDown(rule: PartialFunction[PlanType, PlanType]): PlanType

    Returns a copy of this node where rule has been recursively applied to it and all of its children (pre-order).

    Returns a copy of this node where rule has been recursively applied to it and all of its children (pre-order). When rule does not apply to a given node it is left unchanged.

    rule

    the function used to transform this nodes children

    Definition Classes
    TreeNode
  59. def transformExpressions(rule: PartialFunction[Expression, Expression]): QueryPlan.this

    Runs transform with rule on all expressions present in this query operator.

    Runs transform with rule on all expressions present in this query operator. Users should not expect a specific directionality. If a specific directionality is needed, transformExpressionsDown or transformExpressionsUp should be used.

    rule

    the rule to be applied to every expression in this operator.

  60. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): QueryPlan.this

    Runs transformDown with rule on all expressions present in this query operator.

    Runs transformDown with rule on all expressions present in this query operator.

    rule

    the rule to be applied to every expression in this operator.

  61. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): QueryPlan.this

    Runs transformUp with rule on all expressions present in this query operator.

    Runs transformUp with rule on all expressions present in this query operator.

    rule

    the rule to be applied to every expression in this operator.

    returns

  62. def transformUp(rule: PartialFunction[PlanType, PlanType]): PlanType

    Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order).

    Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order). When rule does not apply to a given node, it is left unchanged.

    rule

    the function use to transform this nodes children

    Definition Classes
    TreeNode
  63. def treeString: String

    Returns a string representation of the nodes in this tree

    Returns a string representation of the nodes in this tree

    Definition Classes
    TreeNode
  64. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  67. def withNewChildren(newChildren: Seq[PlanType]): PlanType

    Returns a copy of this node with the children replaced.

    Returns a copy of this node with the children replaced. TODO: Validate somewhere (in debug mode?) that children are ordered correctly.

    Definition Classes
    TreeNode

Inherited from TreeNode[PlanType]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped