Packages

c

org.apache.spark.sql.execution.joins

BroadcastHashJoinExec

case class BroadcastHashJoinExec(leftKeys: Seq[Expression], rightKeys: Seq[Expression], joinType: JoinType, buildSide: BuildSide, condition: Option[Expression], left: SparkPlan, right: SparkPlan, isNullAwareAntiJoin: Boolean = false) extends SparkPlan with HashJoin with Product with Serializable

Performs an inner hash join of two child relations. When the output RDD of this operator is being constructed, a Spark job is asynchronously started to calculate the values for the broadcast relation. This data is then placed in a Spark broadcast variable. The streamed relation is not shuffled.

Linear Supertypes
HashJoin, JoinCodegenSupport, BaseJoinExec, BinaryExecNode, BinaryLike[SparkPlan], CodegenSupport, SparkPlan, Serializable, Logging, QueryPlan[SparkPlan], SQLConfHelper, TreeNode[SparkPlan], WithOrigin, TreePatternBits, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BroadcastHashJoinExec
  2. HashJoin
  3. JoinCodegenSupport
  4. BaseJoinExec
  5. BinaryExecNode
  6. BinaryLike
  7. CodegenSupport
  8. SparkPlan
  9. Serializable
  10. Logging
  11. QueryPlan
  12. SQLConfHelper
  13. TreeNode
  14. WithOrigin
  15. TreePatternBits
  16. Product
  17. Equals
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BroadcastHashJoinExec(leftKeys: Seq[Expression], rightKeys: Seq[Expression], joinType: JoinType, buildSide: BuildSide, condition: Option[Expression], left: SparkPlan, right: SparkPlan, isNullAwareAntiJoin: Boolean = false)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. lazy val allAttributes: AttributeSeq
    Definition Classes
    QueryPlan
  5. def apply(number: Int): TreeNode[_]
    Definition Classes
    TreeNode
  6. def argString(maxFields: Int): String
    Definition Classes
    TreeNode
  7. def asCode: String
    Definition Classes
    TreeNode
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. lazy val boundCondition: (InternalRow) => Boolean
    Attributes
    protected[this]
    Definition Classes
    HashJoin
    Annotations
    @transient()
  10. lazy val buildBoundKeys: Seq[Expression]
    Attributes
    protected
    Definition Classes
    HashJoin
    Annotations
    @transient()
  11. lazy val buildKeys: Seq[Expression]
    Attributes
    protected
    Definition Classes
    HashJoin
  12. lazy val buildOutput: Seq[Attribute]
    Attributes
    protected
    Definition Classes
    HashJoin
    Annotations
    @transient()
  13. lazy val buildPlan: SparkPlan
    Attributes
    protected
    Definition Classes
    HashJoin
  14. val buildSide: BuildSide
    Definition Classes
    BroadcastHashJoinExec → HashJoin
  15. def buildSideKeyGenerator(): UnsafeProjection
    Attributes
    protected
    Definition Classes
    HashJoin
  16. def canCheckLimitNotReached: Boolean

    Check if the node is supposed to produce limit not reached checks.

    Check if the node is supposed to produce limit not reached checks.

    Attributes
    protected
    Definition Classes
    CodegenSupport
  17. final lazy val canonicalized: SparkPlan
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  18. final lazy val children: Seq[SparkPlan]
    Definition Classes
    BinaryLike
    Annotations
    @transient()
  19. def cleanupResources(): Unit

    Cleans up the resources used by the physical operator (if any).

    Cleans up the resources used by the physical operator (if any). In general, all the resources should be cleaned up when the task finishes but operators like SortMergeJoinExec and LimitExec may want eager cleanup to free up tight resources (e.g., memory).

    Attributes
    protected[sql]
    Definition Classes
    SparkPlan
  20. def clone(): SparkPlan
    Definition Classes
    TreeNode → AnyRef
  21. def codegenAnti(ctx: CodegenContext, input: Seq[ExprCode]): String

    Generates the code for anti join.

    Generates the code for anti join. Handles NULL-aware anti join (NAAJ) separately here.

    Attributes
    protected
    Definition Classes
    BroadcastHashJoinExec → HashJoin
  22. def codegenExistence(ctx: CodegenContext, input: Seq[ExprCode]): String

    Generates the code for existence join.

    Generates the code for existence join.

    Attributes
    protected
    Definition Classes
    HashJoin
  23. def codegenInner(ctx: CodegenContext, input: Seq[ExprCode]): String

    Generates the code for Inner join.

    Generates the code for Inner join.

    Attributes
    protected
    Definition Classes
    HashJoin
  24. def codegenOuter(ctx: CodegenContext, input: Seq[ExprCode]): String

    Generates the code for left or right outer join.

    Generates the code for left or right outer join.

    Attributes
    protected
    Definition Classes
    HashJoin
  25. def codegenSemi(ctx: CodegenContext, input: Seq[ExprCode]): String

    Generates the code for left semi join.

    Generates the code for left semi join.

    Attributes
    protected
    Definition Classes
    HashJoin
  26. def collect[B](pf: PartialFunction[SparkPlan, B]): Seq[B]
    Definition Classes
    TreeNode
  27. def collectFirst[B](pf: PartialFunction[SparkPlan, B]): Option[B]
    Definition Classes
    TreeNode
  28. def collectLeaves(): Seq[SparkPlan]
    Definition Classes
    TreeNode
  29. def collectWithSubqueries[B](f: PartialFunction[SparkPlan, B]): Seq[B]
    Definition Classes
    QueryPlan
  30. val condition: Option[Expression]
    Definition Classes
    BroadcastHashJoinExec → BaseJoinExec
  31. def conf: SQLConf
    Definition Classes
    SparkPlan → SQLConfHelper
  32. final def consume(ctx: CodegenContext, outputVars: Seq[ExprCode], row: String = null): String

    Consume the generated columns or row from current SparkPlan, call its parent's doConsume().

    Consume the generated columns or row from current SparkPlan, call its parent's doConsume().

    Note that outputVars and row can't both be null.

    Definition Classes
    CodegenSupport
  33. final def containsAllPatterns(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  34. final def containsAnyPattern(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  35. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  36. final def containsPattern(t: TreePattern): Boolean
    Definition Classes
    TreePatternBits
    Annotations
    @inline()
  37. def copyTagsFrom(other: SparkPlan): Unit
    Definition Classes
    TreeNode
  38. def createResultProjection(): (InternalRow) => InternalRow
    Attributes
    protected
    Definition Classes
    HashJoin
  39. lazy val deterministic: Boolean
    Definition Classes
    QueryPlan
  40. def doCanonicalize(): SparkPlan
    Attributes
    protected
    Definition Classes
    QueryPlan
  41. def doConsume(ctx: CodegenContext, input: Seq[ExprCode], row: ExprCode): String

    Generate the Java source code to process the rows from child SparkPlan.

    Generate the Java source code to process the rows from child SparkPlan. This should only be called from consume.

    This should be override by subclass to support codegen.

    Note: The operator should not assume the existence of an outer processing loop, which it can jump from with "continue;"!

    For example, filter could generate this: # code to evaluate the predicate expression, result is isNull1 and value2 if (!isNull1 && value2) { # call consume(), which will call parent.doConsume() }

    Note: A plan can either consume the rows as UnsafeRow (row), or a list of variables (input). When consuming as a listing of variables, the code to produce the input is already generated and CodegenContext.currentVars is already set. When consuming as UnsafeRow, implementations need to put row.code in the generated code and set CodegenContext.INPUT_ROW manually. Some plans may need more tweaks as they have different inputs(join build side, aggregate buffer, etc.), or other special cases.

    Definition Classes
    HashJoin → CodegenSupport
  42. def doExecute(): RDD[InternalRow]

    Produces the result of the query as an RDD[InternalRow]

    Produces the result of the query as an RDD[InternalRow]

    Overridden by concrete implementations of SparkPlan.

    Attributes
    protected
    Definition Classes
    BroadcastHashJoinExec → SparkPlan
  43. def doExecuteBroadcast[T](): Broadcast[T]

    Produces the result of the query as a broadcast variable.

    Produces the result of the query as a broadcast variable.

    Overridden by concrete implementations of SparkPlan.

    Attributes
    protected[sql]
    Definition Classes
    SparkPlan
  44. def doExecuteColumnar(): RDD[ColumnarBatch]

    Produces the result of the query as an RDD[ColumnarBatch] if supportsColumnar returns true.

    Produces the result of the query as an RDD[ColumnarBatch] if supportsColumnar returns true. By convention the executor that creates a ColumnarBatch is responsible for closing it when it is no longer needed. This allows input formats to be able to reuse batches if needed.

    Attributes
    protected
    Definition Classes
    SparkPlan
  45. def doExecuteWrite(writeFilesSpec: WriteFilesSpec): RDD[WriterCommitMessage]

    Produces the result of the writes as an RDD[WriterCommitMessage]

    Produces the result of the writes as an RDD[WriterCommitMessage]

    Overridden by concrete implementations of SparkPlan.

    Attributes
    protected
    Definition Classes
    SparkPlan
  46. def doPrepare(): Unit

    Overridden by concrete implementations of SparkPlan.

    Overridden by concrete implementations of SparkPlan. It is guaranteed to run before any execute of SparkPlan. This is helpful if we want to set up some state before executing the query, e.g., BroadcastHashJoin uses it to broadcast asynchronously.

    Attributes
    protected
    Definition Classes
    SparkPlan
    Note

    prepare method has already walked down the tree, so the implementation doesn't have to call children's prepare methods. This will only be called once, protected by this.

  47. def doProduce(ctx: CodegenContext): String

    Generate the Java source code to process, should be overridden by subclass to support codegen.

    Generate the Java source code to process, should be overridden by subclass to support codegen.

    doProduce() usually generate the framework, for example, aggregation could generate this:

    if (!initialized) { # create a hash map, then build the aggregation hash map # call child.produce() initialized = true; } while (hashmap.hasNext()) { row = hashmap.next(); # build the aggregation results # create variables for results # call consume(), which will call parent.doConsume() if (shouldStop()) return; }

    Definition Classes
    HashJoin → CodegenSupport
  48. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49. def evaluateNondeterministicVariables(attributes: Seq[Attribute], variables: Seq[ExprCode], expressions: Seq[NamedExpression]): String

    Returns source code to evaluate the variables for non-deterministic expressions, and clear the code of evaluated variables, to prevent them to be evaluated twice.

    Returns source code to evaluate the variables for non-deterministic expressions, and clear the code of evaluated variables, to prevent them to be evaluated twice.

    Attributes
    protected
    Definition Classes
    CodegenSupport
  50. def evaluateRequiredVariables(attributes: Seq[Attribute], variables: Seq[ExprCode], required: AttributeSet): String

    Returns source code to evaluate the variables for required attributes, and clear the code of evaluated variables, to prevent them to be evaluated twice.

    Returns source code to evaluate the variables for required attributes, and clear the code of evaluated variables, to prevent them to be evaluated twice.

    Attributes
    protected
    Definition Classes
    CodegenSupport
  51. def evaluateVariables(variables: Seq[ExprCode]): String

    Returns source code to evaluate all the variables, and clear the code of them, to prevent them to be evaluated twice.

    Returns source code to evaluate all the variables, and clear the code of them, to prevent them to be evaluated twice.

    Attributes
    protected
    Definition Classes
    CodegenSupport
  52. final def execute(): RDD[InternalRow]

    Returns the result of this query as an RDD[InternalRow] by delegating to doExecute after preparations.

    Returns the result of this query as an RDD[InternalRow] by delegating to doExecute after preparations.

    Concrete implementations of SparkPlan should override doExecute.

    Definition Classes
    SparkPlan
  53. final def executeBroadcast[T](): Broadcast[T]

    Returns the result of this query as a broadcast variable by delegating to doExecuteBroadcast after preparations.

    Returns the result of this query as a broadcast variable by delegating to doExecuteBroadcast after preparations.

    Concrete implementations of SparkPlan should override doExecuteBroadcast.

    Definition Classes
    SparkPlan
  54. def executeCollect(): Array[InternalRow]

    Runs this query returning the result as an array.

    Runs this query returning the result as an array.

    Definition Classes
    SparkPlan
  55. def executeCollectPublic(): Array[Row]

    Runs this query returning the result as an array, using external Row format.

    Runs this query returning the result as an array, using external Row format.

    Definition Classes
    SparkPlan
  56. final def executeColumnar(): RDD[ColumnarBatch]

    Returns the result of this query as an RDD[ColumnarBatch] by delegating to doColumnarExecute after preparations.

    Returns the result of this query as an RDD[ColumnarBatch] by delegating to doColumnarExecute after preparations.

    Concrete implementations of SparkPlan should override doColumnarExecute if supportsColumnar returns true.

    Definition Classes
    SparkPlan
  57. final def executeQuery[T](query: => T): T

    Executes a query after preparing the query and adding query plan information to created RDDs for visualization.

    Executes a query after preparing the query and adding query plan information to created RDDs for visualization.

    Attributes
    protected
    Definition Classes
    SparkPlan
  58. def executeTail(n: Int): Array[InternalRow]

    Runs this query returning the last n rows as an array.

    Runs this query returning the last n rows as an array.

    This is modeled after RDD.take but never runs any job locally on the driver.

    Definition Classes
    SparkPlan
  59. def executeTake(n: Int): Array[InternalRow]

    Runs this query returning the first n rows as an array.

    Runs this query returning the first n rows as an array.

    This is modeled after RDD.take but never runs any job locally on the driver.

    Definition Classes
    SparkPlan
  60. def executeToIterator(): Iterator[InternalRow]

    Runs this query returning the result as an iterator of InternalRow.

    Runs this query returning the result as an iterator of InternalRow.

    Definition Classes
    SparkPlan
    Note

    Triggers multiple jobs (one for each partition).

  61. def executeWrite(writeFilesSpec: WriteFilesSpec): RDD[WriterCommitMessage]

    Returns the result of writes as an RDD[WriterCommitMessage] variable by delegating to doExecuteWrite after preparations.

    Returns the result of writes as an RDD[WriterCommitMessage] variable by delegating to doExecuteWrite after preparations.

    Concrete implementations of SparkPlan should override doExecuteWrite.

    Definition Classes
    SparkPlan
  62. def exists(f: (SparkPlan) => Boolean): Boolean
    Definition Classes
    TreeNode
  63. final def expressions: Seq[Expression]
    Definition Classes
    QueryPlan
  64. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  65. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  66. def find(f: (SparkPlan) => Boolean): Option[SparkPlan]
    Definition Classes
    TreeNode
  67. def flatMap[A](f: (SparkPlan) => TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  68. def foreach(f: (SparkPlan) => Unit): Unit
    Definition Classes
    TreeNode
  69. def foreachUp(f: (SparkPlan) => Unit): Unit
    Definition Classes
    TreeNode
  70. def formattedNodeName: String
    Attributes
    protected
    Definition Classes
    QueryPlan
  71. def genOneSideJoinVars(ctx: CodegenContext, row: String, plan: SparkPlan, setDefaultValue: Boolean): Seq[ExprCode]

    Generates the code for variables of one child side of join.

    Generates the code for variables of one child side of join.

    Attributes
    protected
    Definition Classes
    JoinCodegenSupport
  72. def genStreamSideJoinKey(ctx: CodegenContext, input: Seq[ExprCode]): (ExprCode, String)

    Returns the code for generating join key for stream side, and expression of whether the key has any null in it or not.

    Returns the code for generating join key for stream side, and expression of whether the key has any null in it or not.

    Attributes
    protected
    Definition Classes
    HashJoin
  73. def generateTreeString(depth: Int, lastChildren: ArrayList[Boolean], append: (String) => Unit, verbose: Boolean, prefix: String, addSuffix: Boolean, maxFields: Int, printNodeId: Boolean, indent: Int): Unit
    Definition Classes
    TreeNode
  74. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  75. def getDefaultTreePatternBits: BitSet
    Attributes
    protected
    Definition Classes
    TreeNode
  76. def getJoinCondition(ctx: CodegenContext, streamVars: Seq[ExprCode], streamPlan: SparkPlan, buildPlan: SparkPlan, buildRow: Option[String] = None): (String, String, Seq[ExprCode])

    Generate the (non-equi) condition used to filter joined rows.

    Generate the (non-equi) condition used to filter joined rows. This is used in Inner, Left Semi, Left Anti and Full Outer joins.

    returns

    Tuple of variable name for row of build side, generated code for condition, and generated code for variables of build side.

    Attributes
    protected
    Definition Classes
    JoinCodegenSupport
  77. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  78. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  79. val id: Int
    Definition Classes
    SparkPlan
  80. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  81. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. def innerChildren: Seq[QueryPlan[_]]
    Definition Classes
    QueryPlan → TreeNode
  83. def inputRDDs(): Seq[RDD[InternalRow]]

    Returns all the RDDs of InternalRow which generates the input rows.

    Returns all the RDDs of InternalRow which generates the input rows.

    Definition Classes
    BroadcastHashJoinExec → CodegenSupport
    Note

    Right now we support up to two RDDs

  84. def inputSet: AttributeSet
    Definition Classes
    QueryPlan
  85. def isCanonicalizedPlan: Boolean
    Attributes
    protected
    Definition Classes
    QueryPlan
  86. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  87. val isNullAwareAntiJoin: Boolean
  88. def isRuleIneffective(ruleId: RuleId): Boolean
    Attributes
    protected
    Definition Classes
    TreeNode
  89. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  90. def join(streamedIter: Iterator[InternalRow], hashed: HashedRelation, numOutputRows: SQLMetric): Iterator[InternalRow]
    Attributes
    protected
    Definition Classes
    HashJoin
  91. val joinType: JoinType
    Definition Classes
    BroadcastHashJoinExec → BaseJoinExec
  92. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  93. val left: SparkPlan
    Definition Classes
    BroadcastHashJoinExec → BinaryLike
  94. val leftKeys: Seq[Expression]
    Definition Classes
    BroadcastHashJoinExec → BaseJoinExec
  95. final def legacyWithNewChildren(newChildren: Seq[SparkPlan]): SparkPlan
    Attributes
    protected
    Definition Classes
    TreeNode
  96. def limitNotReachedChecks: Seq[String]

    A sequence of checks which evaluate to true if the downstream Limit operators have not received enough records and reached the limit.

    A sequence of checks which evaluate to true if the downstream Limit operators have not received enough records and reached the limit. If current node is a data producing node, it can leverage this information to stop producing data and complete the data flow earlier. Common data producing nodes are leaf nodes like Range and Scan, and blocking nodes like Sort and Aggregate. These checks should be put into the loop condition of the data producing loop.

    Definition Classes
    CodegenSupport
  97. final def limitNotReachedCond: String

    A helper method to generate the data producing loop condition according to the limit-not-reached checks.

    A helper method to generate the data producing loop condition according to the limit-not-reached checks.

    Definition Classes
    CodegenSupport
  98. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  99. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  100. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  101. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  102. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  103. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  104. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  105. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  106. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  107. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  108. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  109. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  110. def logicalLink: Option[LogicalPlan]

    returns

    The logical plan this plan is linked to.

    Definition Classes
    SparkPlan
  111. def longMetric(name: String): SQLMetric

    returns

    SQLMetric for the name.

    Definition Classes
    SparkPlan
  112. def makeCopy(newArgs: Array[AnyRef]): SparkPlan

    Overridden make copy also propagates sqlContext to copied plan.

    Overridden make copy also propagates sqlContext to copied plan.

    Definition Classes
    SparkPlan → TreeNode
  113. def map[A](f: (SparkPlan) => A): Seq[A]
    Definition Classes
    TreeNode
  114. final def mapChildren(f: (SparkPlan) => SparkPlan): SparkPlan
    Definition Classes
    BinaryLike
  115. def mapExpressions(f: (Expression) => Expression): BroadcastHashJoinExec.this.type
    Definition Classes
    QueryPlan
  116. def mapProductIterator[B](f: (Any) => B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  117. def markRuleAsIneffective(ruleId: RuleId): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  118. def metricTerm(ctx: CodegenContext, name: String): String

    Creates a metric using the specified name.

    Creates a metric using the specified name.

    returns

    name of the variable representing the metric

    Definition Classes
    CodegenSupport
  119. lazy val metrics: Map[String, SQLMetric]

    returns

    All metrics containing metrics of this SparkPlan.

    Definition Classes
    BroadcastHashJoinExec → SparkPlan
  120. final def missingInput: AttributeSet
    Definition Classes
    QueryPlan
  121. def multiTransformDown(rule: PartialFunction[SparkPlan, Seq[SparkPlan]]): Stream[SparkPlan]
    Definition Classes
    TreeNode
  122. def multiTransformDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[SparkPlan, Seq[SparkPlan]]): Stream[SparkPlan]
    Definition Classes
    TreeNode
  123. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  124. def needCopyResult: Boolean

    Whether or not the result rows of this operator should be copied before putting into a buffer.

    Whether or not the result rows of this operator should be copied before putting into a buffer.

    If any operator inside WholeStageCodegen generate multiple rows from a single row (for example, Join), this should be true.

    If an operator starts a new pipeline, this should be false.

    Definition Classes
    BroadcastHashJoinExec → CodegenSupport
  125. def needStopCheck: Boolean

    Whether or not the children of this operator should generate a stop check when consuming input rows.

    Whether or not the children of this operator should generate a stop check when consuming input rows. This is used to suppress shouldStop() in a loop of WholeStageCodegen.

    This should be false if an operator starts a new pipeline, which means it consumes all rows produced by children but doesn't output row to buffer by calling append(), so the children don't require shouldStop() in the loop of producing rows.

    Definition Classes
    CodegenSupport
  126. def nodeName: String
    Definition Classes
    TreeNode
  127. val nodePatterns: Seq[TreePattern]
    Attributes
    protected
    Definition Classes
    TreeNode
  128. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  129. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  130. def numberedTreeString: String
    Definition Classes
    TreeNode
  131. val origin: Origin
    Definition Classes
    TreeNode → WithOrigin
  132. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  133. def output: Seq[Attribute]
    Definition Classes
    HashJoin → QueryPlan
  134. def outputOrdering: Seq[SortOrder]
    Definition Classes
    HashJoin → QueryPlan
  135. lazy val outputPartitioning: Partitioning

    Specifies how data is partitioned across different nodes in the cluster.

    Specifies how data is partitioned across different nodes in the cluster. Note this method may fail if it is invoked before EnsureRequirements is applied since PartitioningCollection requires all its partitionings to have the same number of partitions.

    Definition Classes
    BroadcastHashJoinExec → HashJoin → SparkPlan
  136. lazy val outputSet: AttributeSet
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  137. def p(number: Int): SparkPlan
    Definition Classes
    TreeNode
  138. val parent: CodegenSupport

    Which SparkPlan is calling produce() of this one.

    Which SparkPlan is calling produce() of this one. It's itself for the first SparkPlan.

    Attributes
    protected
    Definition Classes
    CodegenSupport
  139. final def prepare(): Unit

    Prepares this SparkPlan for execution.

    Prepares this SparkPlan for execution. It's idempotent.

    Definition Classes
    SparkPlan
  140. def prepareRelation(ctx: CodegenContext): HashedRelationInfo
    Attributes
    protected
    Definition Classes
    BroadcastHashJoinExec → HashJoin
  141. def prepareSubqueries(): Unit

    Finds scalar subquery expressions in this plan node and starts evaluating them.

    Finds scalar subquery expressions in this plan node and starts evaluating them.

    Attributes
    protected
    Definition Classes
    SparkPlan
  142. def prettyJson: String
    Definition Classes
    TreeNode
  143. def printSchema(): Unit
    Definition Classes
    QueryPlan
  144. final def produce(ctx: CodegenContext, parent: CodegenSupport): String

    Returns Java source code to process the rows from input RDD.

    Returns Java source code to process the rows from input RDD.

    Definition Classes
    CodegenSupport
  145. def producedAttributes: AttributeSet
    Definition Classes
    QueryPlan
  146. def productElementNames: Iterator[String]
    Definition Classes
    Product
  147. lazy val references: AttributeSet
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  148. def requiredChildDistribution: Seq[Distribution]

    Specifies the data distribution requirements of all the children for this operator.

    Specifies the data distribution requirements of all the children for this operator. By default it's UnspecifiedDistribution for each child, which means each child can have any distribution.

    If an operator overwrites this method, and specifies distribution requirements(excluding UnspecifiedDistribution and BroadcastDistribution) for more than one child, Spark guarantees that the outputs of these children will have same number of partitions, so that the operator can safely zip partitions of these children's result RDDs. Some operators can leverage this guarantee to satisfy some interesting requirement, e.g., non-broadcast joins can specify HashClusteredDistribution(a,b) for its left child, and specify HashClusteredDistribution(c,d) for its right child, then it's guaranteed that left and right child are co-partitioned by a,b/c,d, which means tuples of same value are in the partitions of same index, e.g., (a=1,b=2) and (c=1,d=2) are both in the second partition of left and right child.

    Definition Classes
    BroadcastHashJoinExec → SparkPlan
  149. def requiredChildOrdering: Seq[Seq[SortOrder]]

    Specifies sort order for each partition requirements on the input data for this operator.

    Specifies sort order for each partition requirements on the input data for this operator.

    Definition Classes
    SparkPlan
  150. def resetMetrics(): Unit

    Resets all the metrics.

    Resets all the metrics.

    Definition Classes
    SparkPlan
  151. def rewriteAttrs(attrMap: AttributeMap[Attribute]): SparkPlan
    Definition Classes
    QueryPlan
  152. val right: SparkPlan
    Definition Classes
    BroadcastHashJoinExec → BinaryLike
  153. val rightKeys: Seq[Expression]
    Definition Classes
    BroadcastHashJoinExec → BaseJoinExec
  154. final def sameResult(other: SparkPlan): Boolean
    Definition Classes
    QueryPlan
  155. lazy val schema: StructType
    Definition Classes
    QueryPlan
  156. def schemaString: String
    Definition Classes
    QueryPlan
  157. final def semanticHash(): Int
    Definition Classes
    QueryPlan
  158. final val session: SparkSession
    Definition Classes
    SparkPlan
  159. def setLogicalLink(logicalPlan: LogicalPlan): Unit

    Set logical plan link recursively if unset.

    Set logical plan link recursively if unset.

    Definition Classes
    SparkPlan
  160. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  161. def shouldStopCheckCode: String

    Helper default should stop check code.

    Helper default should stop check code.

    Definition Classes
    CodegenSupport
  162. def simpleString(maxFields: Int): String
    Definition Classes
    QueryPlan → TreeNode
  163. def simpleStringWithNodeId(): String
    Definition Classes
    HashJoin → BaseJoinExec → QueryPlan → TreeNode
  164. def sparkContext: SparkContext
    Attributes
    protected
    Definition Classes
    SparkPlan
  165. def statePrefix: String
    Attributes
    protected
    Definition Classes
    QueryPlan
  166. def streamSideKeyGenerator(): UnsafeProjection
    Attributes
    protected
    Definition Classes
    HashJoin
  167. lazy val streamedBoundKeys: Seq[Expression]
    Attributes
    protected
    Definition Classes
    HashJoin
    Annotations
    @transient()
  168. lazy val streamedKeys: Seq[Expression]
    Attributes
    protected
    Definition Classes
    HashJoin
  169. lazy val streamedOutput: Seq[Attribute]
    Attributes
    protected
    Definition Classes
    HashJoin
    Annotations
    @transient()
  170. lazy val streamedPlan: SparkPlan
    Attributes
    protected
    Definition Classes
    HashJoin
  171. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  172. lazy val subqueries: Seq[SparkPlan]
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  173. def subqueriesAll: Seq[SparkPlan]
    Definition Classes
    QueryPlan
  174. def supportCodegen: Boolean

    Whether this SparkPlan supports whole stage codegen or not.

    Whether this SparkPlan supports whole stage codegen or not.

    Definition Classes
    CodegenSupport
  175. def supportsColumnar: Boolean

    Return true if this stage of the plan supports columnar execution.

    Return true if this stage of the plan supports columnar execution. A plan can also support row-based execution (see supportsRowBased). Spark will decide which execution to be called during query planning.

    Definition Classes
    SparkPlan
  176. def supportsRowBased: Boolean

    Return true if this stage of the plan supports row-based execution.

    Return true if this stage of the plan supports row-based execution. A plan can also support columnar execution (see supportsColumnar). Spark will decide which execution to be called during query planning.

    Definition Classes
    SparkPlan
  177. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  178. def toJSON: String
    Definition Classes
    TreeNode
  179. def toRowBased: SparkPlan

    Converts the output of this plan to row-based if it is columnar plan.

    Converts the output of this plan to row-based if it is columnar plan.

    Definition Classes
    SparkPlan
  180. def toString(): String
    Definition Classes
    TreeNode → AnyRef → Any
  181. def transform(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  182. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): BroadcastHashJoinExec.this.type
    Definition Classes
    QueryPlan
  183. def transformAllExpressionsWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): BroadcastHashJoinExec.this.type
    Definition Classes
    QueryPlan
  184. def transformAllExpressionsWithSubqueries(rule: PartialFunction[Expression, Expression]): BroadcastHashJoinExec.this.type
    Definition Classes
    QueryPlan
  185. def transformDown(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  186. def transformDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  187. def transformDownWithSubqueries(f: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    QueryPlan
  188. def transformDownWithSubqueriesAndPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(f: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    QueryPlan
  189. def transformExpressions(rule: PartialFunction[Expression, Expression]): BroadcastHashJoinExec.this.type
    Definition Classes
    QueryPlan
  190. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): BroadcastHashJoinExec.this.type
    Definition Classes
    QueryPlan
  191. def transformExpressionsDownWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): BroadcastHashJoinExec.this.type
    Definition Classes
    QueryPlan
  192. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): BroadcastHashJoinExec.this.type
    Definition Classes
    QueryPlan
  193. def transformExpressionsUpWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): BroadcastHashJoinExec.this.type
    Definition Classes
    QueryPlan
  194. def transformExpressionsWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): BroadcastHashJoinExec.this.type
    Definition Classes
    QueryPlan
  195. def transformUp(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  196. def transformUpWithBeforeAndAfterRuleOnChildren(cond: (SparkPlan) => Boolean, ruleId: RuleId)(rule: PartialFunction[(SparkPlan, SparkPlan), SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  197. def transformUpWithNewOutput(rule: PartialFunction[SparkPlan, (SparkPlan, Seq[(Attribute, Attribute)])], skipCond: (SparkPlan) => Boolean, canGetOutput: (SparkPlan) => Boolean): SparkPlan
    Definition Classes
    QueryPlan
  198. def transformUpWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  199. def transformUpWithSubqueries(f: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    QueryPlan
  200. def transformWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId)(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  201. def transformWithSubqueries(f: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    QueryPlan
  202. lazy val treePatternBits: BitSet
    Definition Classes
    QueryPlan → TreeNode → TreePatternBits
  203. def treeString(append: (String) => Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  204. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  205. final def treeString: String
    Definition Classes
    TreeNode
  206. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  207. def updateOuterReferencesInSubquery(plan: SparkPlan, attrMap: AttributeMap[Attribute]): SparkPlan
    Attributes
    protected
    Definition Classes
    QueryPlan
  208. def usedInputs: AttributeSet

    The subset of inputSet those should be evaluated before this plan.

    The subset of inputSet those should be evaluated before this plan.

    We will use this to insert some code to access those columns that are actually used by current plan before calling doConsume().

    Definition Classes
    CodegenSupport
  209. def vectorTypes: Option[Seq[String]]

    The exact java types of the columns that are output in columnar processing mode.

    The exact java types of the columns that are output in columnar processing mode. This is a performance optimization for code generation and is optional.

    Definition Classes
    SparkPlan
  210. def verboseString(maxFields: Int): String
    Definition Classes
    QueryPlan → TreeNode
  211. def verboseStringWithOperatorId(): String
    Definition Classes
    BaseJoinExec → BinaryExecNode → QueryPlan
  212. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  213. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  214. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  215. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  216. def waitForSubqueries(): Unit

    Blocks the thread until all subqueries finish evaluation and update the results.

    Blocks the thread until all subqueries finish evaluation and update the results.

    Attributes
    protected
    Definition Classes
    SparkPlan
  217. final def withNewChildren(newChildren: Seq[SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  218. def withNewChildrenInternal(newLeft: SparkPlan, newRight: SparkPlan): BroadcastHashJoinExec
    Attributes
    protected
    Definition Classes
    BroadcastHashJoinExec → BinaryLike
  219. final def withNewChildrenInternal(newChildren: IndexedSeq[SparkPlan]): SparkPlan
    Definition Classes
    BinaryLike

Inherited from HashJoin

Inherited from JoinCodegenSupport

Inherited from BaseJoinExec

Inherited from BinaryExecNode

Inherited from BinaryLike[SparkPlan]

Inherited from CodegenSupport

Inherited from SparkPlan

Inherited from Serializable

Inherited from Logging

Inherited from QueryPlan[SparkPlan]

Inherited from SQLConfHelper

Inherited from TreeNode[SparkPlan]

Inherited from WithOrigin

Inherited from TreePatternBits

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped