Packages

c

com.nvidia.spark.rapids

RequireSingleBatchWithFilter

case class RequireSingleBatchWithFilter(filterExpression: GpuExpression) extends CoalesceSizeGoal with RequireSingleBatchLike with Product with Serializable

This is exactly the same as RequireSingleBatch except that if the batch would fail to coalesce because it reaches cuDF row-count limits, the coalesce code is free to null filter given the filter expression in filterExpression.

Note

This is an ugly hack because ideally these rows are never read from the input source given that we normally push down IsNotNull in Spark. This should be removed when we can handle this in a proper way, likely at the logical plan optimization level. More details here: https://issues.apache.org/jira/browse/SPARK-39131

Linear Supertypes
Serializable, Serializable, RequireSingleBatchLike, CoalesceSizeGoal, CoalesceGoal, ShimExpression, GpuUnevaluable, GpuExpression, Arm, Expression, TreeNode[Expression], TreePatternBits, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RequireSingleBatchWithFilter
  2. Serializable
  3. Serializable
  4. RequireSingleBatchLike
  5. CoalesceSizeGoal
  6. CoalesceGoal
  7. ShimExpression
  8. GpuUnevaluable
  9. GpuExpression
  10. Arm
  11. Expression
  12. TreeNode
  13. TreePatternBits
  14. Product
  15. Equals
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RequireSingleBatchWithFilter(filterExpression: GpuExpression)

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. def apply(number: Int): TreeNode[_]
    Definition Classes
    TreeNode
  5. def argString(maxFields: Int): String
    Definition Classes
    TreeNode
  6. def asCode: String
    Definition Classes
    TreeNode
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. lazy val canonicalized: Expression
    Definition Classes
    GpuExpression → Expression
  9. def checkInputDataTypes(): TypeCheckResult
    Definition Classes
    Expression
  10. def children: Seq[Expression]
    Definition Classes
    CoalesceGoal → TreeNode
  11. def childrenResolved: Boolean
    Definition Classes
    Expression
  12. def clone(): Expression
    Definition Classes
    TreeNode → AnyRef
  13. def closeOnExcept[T <: AutoCloseable, V](r: Option[T])(block: (Option[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  14. def closeOnExcept[T <: AutoCloseable, V](r: ArrayBuffer[T])(block: (ArrayBuffer[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  15. def closeOnExcept[T <: AutoCloseable, V](r: Array[T])(block: (Array[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  16. def closeOnExcept[T <: AutoCloseable, V](r: Seq[T])(block: (Seq[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  17. def closeOnExcept[T <: AutoCloseable, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block, closing the resource only if an exception occurs

    Executes the provided code block, closing the resource only if an exception occurs

    Definition Classes
    Arm
  18. def collect[B](pf: PartialFunction[Expression, B]): Seq[B]
    Definition Classes
    TreeNode
  19. def collectFirst[B](pf: PartialFunction[Expression, B]): Option[B]
    Definition Classes
    TreeNode
  20. def collectLeaves(): Seq[Expression]
    Definition Classes
    TreeNode
  21. final def columnarEval(batch: ColumnarBatch): Any

    Returns the result of evaluating this expression on the entire ColumnarBatch.

    Returns the result of evaluating this expression on the entire ColumnarBatch. The result of calling this may be a single GpuColumnVector or a scalar value. Scalar values typically happen if they are a part of the expression i.e. col("a") + 100. In this case the 100 is a literal that Add would have to be able to handle.

    By convention any GpuColumnVector returned by columnarEval is owned by the caller and will need to be closed by them. This can happen by putting it into a ColumnarBatch and closing the batch or by closing the vector directly if it is a temporary value.

    Definition Classes
    GpuUnevaluableGpuExpression
  22. final def containsAllPatterns(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  23. final def containsAnyPattern(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  24. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  25. final def containsPattern(t: TreePattern): Boolean
    Definition Classes
    TreePatternBits
    Annotations
    @inline()
  26. def convertToAst(numFirstTableColumns: Int): AstExpression

    Build an equivalent representation of this expression in a cudf AST.

    Build an equivalent representation of this expression in a cudf AST.

    numFirstTableColumns

    number of columns in the leftmost input table. Spark places the columns of all inputs in a single sequence, while cudf AST uses an explicit table reference to make column indices unique. This parameter helps translate input column references from Spark's single sequence into cudf's separate sequences.

    returns

    top node of the equivalent AST

    Definition Classes
    GpuExpression
  27. def copyTagsFrom(other: Expression): Unit
    Definition Classes
    TreeNode
  28. def dataType: DataType
    Definition Classes
    CoalesceGoal → Expression
  29. lazy val deterministic: Boolean
    Definition Classes
    Expression
  30. def disableCoalesceUntilInput(): Boolean

    Override this if your expression cannot allow combining of data from multiple files into a single batch before it operates on them.

    Override this if your expression cannot allow combining of data from multiple files into a single batch before it operates on them. These are for things like getting the input file name. Which for spark is stored in a thread local variable which means we have to jump through some hoops to make this work.

    Definition Classes
    GpuExpression
  31. final def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode
    Definition Classes
    GpuExpression → Expression
  32. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def eval(input: InternalRow = null): Any
    Definition Classes
    GpuExpression → Expression
  34. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  35. val filterExpression: GpuExpression
  36. def find(f: (Expression) ⇒ Boolean): Option[Expression]
    Definition Classes
    TreeNode
  37. def flatArguments: Iterator[Any]
    Attributes
    protected
    Definition Classes
    Expression
  38. def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  39. def foldable: Boolean
    Definition Classes
    Expression
  40. def foreach(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  41. def foreachUp(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  42. def freeOnExcept[T <: RapidsBuffer, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block, freeing the RapidsBuffer only if an exception occurs

    Executes the provided code block, freeing the RapidsBuffer only if an exception occurs

    Definition Classes
    Arm
  43. def genCode(ctx: CodegenContext): ExprCode
    Definition Classes
    Expression
  44. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], append: (String) ⇒ Unit, verbose: Boolean, prefix: String, addSuffix: Boolean, maxFields: Int, printNodeId: Boolean, indent: Int): Unit
    Definition Classes
    TreeNode
  45. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  46. def getDefaultTreePatternBits: BitSet
    Attributes
    protected
    Definition Classes
    TreeNode
  47. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  48. def hasSideEffects: Boolean

    Could evaluating this expression cause side-effects, such as throwing an exception?

    Could evaluating this expression cause side-effects, such as throwing an exception?

    Definition Classes
    GpuExpression
  49. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  50. def innerChildren: Seq[TreeNode[_]]
    Definition Classes
    TreeNode
  51. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  52. def isRuleIneffective(ruleId: RuleId): Boolean
    Attributes
    protected
    Definition Classes
    TreeNode
  53. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  54. final def legacyWithNewChildren(newChildren: Seq[Expression]): Expression
    Attributes
    protected
    Definition Classes
    TreeNode
  55. def makeCopy(newArgs: Array[AnyRef]): Expression
    Definition Classes
    TreeNode
  56. def map[A](f: (Expression) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  57. def mapChildren(f: (Expression) ⇒ Expression): Expression
    Definition Classes
    TreeNode
  58. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  59. def markRuleAsIneffective(ruleId: RuleId): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  60. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  61. def nodeName: String
    Definition Classes
    TreeNode
  62. val nodePatterns: Seq[TreePattern]
    Attributes
    protected
    Definition Classes
    TreeNode
  63. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  64. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  65. def nullable: Boolean
    Definition Classes
    CoalesceGoal → Expression
  66. def numberedTreeString: String
    Definition Classes
    TreeNode
  67. val origin: Origin
    Definition Classes
    TreeNode
  68. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  69. def p(number: Int): Expression
    Definition Classes
    TreeNode
  70. def prettyJson: String
    Definition Classes
    TreeNode
  71. def prettyName: String
    Definition Classes
    Expression
  72. def references: AttributeSet
    Definition Classes
    Expression
  73. lazy val resolved: Boolean
    Definition Classes
    Expression
  74. final def semanticEquals(other: Expression): Boolean
    Definition Classes
    Expression
  75. def semanticHash(): Int
    Definition Classes
    Expression
  76. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  77. def simpleString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  78. def simpleStringWithNodeId(): String
    Definition Classes
    Expression → TreeNode
  79. def sql: String
    Definition Classes
    Expression
  80. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  81. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  82. val targetSizeBytes: Long
  83. def toJSON: String
    Definition Classes
    TreeNode
  84. def toString(): String

    Override toString to improve readability of Spark explain output

    Override toString to improve readability of Spark explain output

    Definition Classes
    RequireSingleBatchWithFilter → Expression → TreeNode → AnyRef → Any
  85. def transform(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  86. def transformDown(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  87. def transformDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  88. def transformUp(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  89. def transformUpWithBeforeAndAfterRuleOnChildren(cond: (Expression) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[(Expression, Expression), Expression]): Expression
    Definition Classes
    TreeNode
  90. def transformUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  91. def transformWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  92. lazy val treePatternBits: BitSet
    Definition Classes
    TreeNode → TreePatternBits
  93. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  94. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  95. final def treeString: String
    Definition Classes
    TreeNode
  96. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  97. final def verboseString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  98. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  99. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  100. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  101. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  102. final def withNewChildren(newChildren: Seq[Expression]): Expression
    Definition Classes
    TreeNode
  103. def withNewChildrenInternal(newChildren: IndexedSeq[Expression]): Expression
    Definition Classes
    ShimExpression → TreeNode
  104. def withResource[T <: AutoCloseable, V](h: CloseableHolder[T])(block: (CloseableHolder[T]) ⇒ V): V

    Executes the provided code block and then closes the resource

    Executes the provided code block and then closes the resource

    Definition Classes
    Arm
  105. def withResource[T <: AutoCloseable, V](r: ArrayBuffer[T])(block: (ArrayBuffer[T]) ⇒ V): V

    Executes the provided code block and then closes the array buffer of resources

    Executes the provided code block and then closes the array buffer of resources

    Definition Classes
    Arm
  106. def withResource[T <: AutoCloseable, V](r: Array[T])(block: (Array[T]) ⇒ V): V

    Executes the provided code block and then closes the array of resources

    Executes the provided code block and then closes the array of resources

    Definition Classes
    Arm
  107. def withResource[T <: AutoCloseable, V](r: Seq[T])(block: (Seq[T]) ⇒ V): V

    Executes the provided code block and then closes the sequence of resources

    Executes the provided code block and then closes the sequence of resources

    Definition Classes
    Arm
  108. def withResource[T <: AutoCloseable, V](r: Option[T])(block: (Option[T]) ⇒ V): V

    Executes the provided code block and then closes the Option[resource]

    Executes the provided code block and then closes the Option[resource]

    Definition Classes
    Arm
  109. def withResource[T <: AutoCloseable, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block and then closes the resource

    Executes the provided code block and then closes the resource

    Definition Classes
    Arm
  110. def withResourceIfAllowed[T, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block and then closes the value if it is AutoCloseable

    Executes the provided code block and then closes the value if it is AutoCloseable

    Definition Classes
    Arm

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from RequireSingleBatchLike

Inherited from CoalesceSizeGoal

Inherited from CoalesceGoal

Inherited from ShimExpression

Inherited from GpuUnevaluable

Inherited from GpuExpression

Inherited from Arm

Inherited from Expression

Inherited from TreeNode[Expression]

Inherited from TreePatternBits

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped