c

org.apache.spark.sql.hive.rapids

GpuRowBasedHiveSimpleUDF

case class GpuRowBasedHiveSimpleUDF(name: String, funcWrapper: HiveFunctionWrapper, children: Seq[Expression]) extends Expression with GpuRowBasedHiveUDFBase with Product with Serializable

Row-based version of Spark's HiveSimpleUDF running in a GPU operation

Linear Supertypes
GpuRowBasedHiveUDFBase, HiveInspectorsShim, HiveInspectors, GpuRowBasedUserDefinedFunction, Logging, Serializable, Serializable, UserDefinedExpression, ShimExpression, GpuExpression, Expression, TreeNode[Expression], TreePatternBits, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GpuRowBasedHiveSimpleUDF
  2. GpuRowBasedHiveUDFBase
  3. HiveInspectorsShim
  4. HiveInspectors
  5. GpuRowBasedUserDefinedFunction
  6. Logging
  7. Serializable
  8. Serializable
  9. UserDefinedExpression
  10. ShimExpression
  11. GpuExpression
  12. Expression
  13. TreeNode
  14. TreePatternBits
  15. Product
  16. Equals
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GpuRowBasedHiveSimpleUDF(name: String, funcWrapper: HiveFunctionWrapper, children: Seq[Expression])

Type Members

  1. implicit class typeInfoConversions extends AnyRef
    Definition Classes
    HiveInspectors

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. lazy val argumentInspectors: Seq[ObjectInspector]
    Attributes
    protected
    Definition Classes
    GpuRowBasedHiveUDFBase
    Annotations
    @transient()
  7. def asCode: String
    Definition Classes
    TreeNode
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. lazy val canonicalized: Expression
    Definition Classes
    GpuExpression → Expression
  10. def checkInputDataTypes(): TypeCheckResult
    Definition Classes
    Expression
  11. final val checkNull: Boolean

    True if the UDF needs null check when converting input columns to rows

    True if the UDF needs null check when converting input columns to rows

    Definition Classes
    GpuRowBasedHiveUDFBase → GpuRowBasedUserDefinedFunction
  12. lazy val childRowAccessors: Array[(SpecializedGetters) ⇒ Any]
    Attributes
    protected
    Definition Classes
    GpuRowBasedHiveUDFBase
    Annotations
    @transient()
  13. val children: Seq[Expression]
    Definition Classes
    GpuRowBasedHiveSimpleUDF → TreeNode
  14. def childrenResolved: Boolean
    Definition Classes
    Expression
  15. def clone(): Expression
    Definition Classes
    TreeNode → AnyRef
  16. def collect[B](pf: PartialFunction[Expression, B]): Seq[B]
    Definition Classes
    TreeNode
  17. def collectFirst[B](pf: PartialFunction[Expression, B]): Option[B]
    Definition Classes
    TreeNode
  18. def collectLeaves(): Seq[Expression]
    Definition Classes
    TreeNode
  19. def columnarEval(batch: ColumnarBatch): GpuColumnVector

    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 is a GpuColumnVector.

    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
    GpuRowBasedUserDefinedFunction → GpuExpression
  20. def columnarEvalAny(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 AutoCloseable returned by columnarEvalAny is owned by the caller and will need to be closed by them.

    Definition Classes
    GpuExpression
  21. final def containsAllPatterns(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  22. final def containsAnyPattern(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  23. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  24. final def containsPattern(t: TreePattern): Boolean
    Definition Classes
    TreePatternBits
    Annotations
    @inline()
  25. 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
  26. def copyTagsFrom(other: Expression): Unit
    Definition Classes
    TreeNode
  27. lazy val dataType: DataType
    Definition Classes
    GpuRowBasedHiveSimpleUDF → Expression
  28. lazy val deterministic: Boolean
    Definition Classes
    GpuRowBasedUserDefinedFunction → Expression
  29. 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
  30. def disableTieredProjectCombine: Boolean

    If this returns true then tiered project will stop looking to combine expressions when this is seen.

    If this returns true then tiered project will stop looking to combine expressions when this is seen.

    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 evaluateRow(childrenRow: InternalRow): Any

    The row based function of the UDF.

    The row based function of the UDF.

    Attributes
    protected
    Definition Classes
    GpuRowBasedHiveSimpleUDF → GpuRowBasedUserDefinedFunction
  35. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  36. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def find(f: (Expression) ⇒ Boolean): Option[Expression]
    Definition Classes
    TreeNode
  38. def flatArguments: Iterator[Any]
    Attributes
    protected
    Definition Classes
    Expression
  39. def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  40. def foldable: Boolean
    Definition Classes
    GpuRowBasedHiveSimpleUDF → Expression
  41. def foreach(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  42. def foreachUp(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  43. val funcWrapper: HiveFunctionWrapper
    Definition Classes
    GpuRowBasedHiveSimpleUDF → GpuRowBasedHiveUDFBase
  44. lazy val function: UDF
    Definition Classes
    GpuRowBasedHiveSimpleUDF → GpuRowBasedHiveUDFBase
    Annotations
    @nowarn() @transient()
  45. def genCode(ctx: CodegenContext): ExprCode
    Definition Classes
    Expression
  46. 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
  47. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  48. def getDefaultTreePatternBits: BitSet
    Attributes
    protected
    Definition Classes
    TreeNode
  49. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  50. def gpuToInspector(expr: Expression): ObjectInspector

    Create an object inspector from a GPU expression.

    Create an object inspector from a GPU expression.

    Attributes
    protected
    Definition Classes
    GpuRowBasedHiveUDFBase
  51. 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
    GpuRowBasedUserDefinedFunction → GpuExpression
  52. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  53. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  54. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def innerChildren: Seq[TreeNode[_]]
    Definition Classes
    TreeNode
  56. def inspectorToDataType(inspector: ObjectInspector): DataType
    Definition Classes
    HiveInspectors
  57. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  58. def isRuleIneffective(ruleId: RuleId): Boolean
    Attributes
    protected
    Definition Classes
    TreeNode
  59. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  60. def javaTypeToDataType(clz: Type): DataType
    Definition Classes
    HiveInspectors
  61. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  62. final def legacyWithNewChildren(newChildren: Seq[Expression]): Expression
    Attributes
    protected
    Definition Classes
    TreeNode
  63. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  64. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  71. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def makeCopy(newArgs: Array[AnyRef]): Expression
    Definition Classes
    TreeNode
  76. def map[A](f: (Expression) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  77. def mapChildren(f: (Expression) ⇒ Expression): Expression
    Definition Classes
    TreeNode
  78. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  79. def markRuleAsIneffective(ruleId: RuleId): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  80. val name: String

    name of the UDF function

    name of the UDF function

    Definition Classes
    GpuRowBasedHiveSimpleUDF → GpuRowBasedUserDefinedFunction → UserDefinedExpression
  81. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  82. def nodeName: String
    Definition Classes
    TreeNode
  83. val nodePatterns: Seq[TreePattern]
    Attributes
    protected
    Definition Classes
    TreeNode
  84. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  85. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  86. def nullable: Boolean
    Definition Classes
    GpuRowBasedHiveUDFBase → Expression
  87. def numberedTreeString: String
    Definition Classes
    TreeNode
  88. val origin: Origin
    Definition Classes
    TreeNode
  89. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  90. def p(number: Int): Expression
    Definition Classes
    TreeNode
  91. def prettyJson: String
    Definition Classes
    TreeNode
  92. def prettyName: String
    Definition Classes
    GpuRowBasedHiveUDFBase → Expression
  93. def references: AttributeSet
    Definition Classes
    Expression
  94. lazy val resolved: Boolean
    Definition Classes
    Expression
  95. lazy val retryable: Boolean

    true means this expression can be used inside a retry block, otherwise false.

    true means this expression can be used inside a retry block, otherwise false. An expression is retryable when

    • it is deterministic, or
    • when being non-deterministic, it is a Retryable and its children are all retryable.
    Definition Classes
    GpuExpression
  96. val selfNonDeterministic: Boolean

    Whether an expression itself is non-deterministic when its "deterministic" is false, no matter whether it has any non-deterministic children.

    Whether an expression itself is non-deterministic when its "deterministic" is false, no matter whether it has any non-deterministic children. An expression is actually a tree, and deterministic being false means there is at least one tree node is non-deterministic, but we need to know the exact nodes which are non-deterministic to check if it implements the Retryable.

    Default to false because Spark checks only children by default in Expression. So it is non-deterministic iff it has non-deterministic children.

    NOTE When overriding "deterministic", this should be taken care of.

    Definition Classes
    GpuRowBasedUserDefinedFunction → GpuExpression
  97. final def semanticEquals(other: Expression): Boolean
    Definition Classes
    Expression
  98. def semanticHash(): Int
    Definition Classes
    Expression
  99. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  100. def simpleString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  101. def simpleStringWithNodeId(): String
    Definition Classes
    Expression → TreeNode
  102. def sql: String
    Definition Classes
    GpuRowBasedHiveSimpleUDF → Expression
  103. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  104. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  105. def toInspector(expr: Expression): ObjectInspector
    Definition Classes
    HiveInspectors
  106. def toInspector(dataType: DataType): ObjectInspector
    Definition Classes
    HiveInspectors
  107. def toJSON: String
    Definition Classes
    TreeNode
  108. def toString(): String
    Definition Classes
    GpuRowBasedHiveUDFBase → Expression → TreeNode → AnyRef → Any
  109. def transform(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  110. def transformDown(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  111. def transformDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  112. def transformUp(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  113. def transformUpWithBeforeAndAfterRuleOnChildren(cond: (Expression) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[(Expression, Expression), Expression]): Expression
    Definition Classes
    TreeNode
  114. def transformUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  115. def transformWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  116. lazy val treePatternBits: BitSet
    Definition Classes
    TreeNode → TreePatternBits
  117. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  118. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  119. final def treeString: String
    Definition Classes
    TreeNode
  120. val udfDeterministic: Boolean

    True if the UDF is deterministic

    True if the UDF is deterministic

    Definition Classes
    GpuRowBasedHiveUDFBase → GpuRowBasedUserDefinedFunction
  121. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  122. def unwrapperFor(field: StructField): (Any, InternalRow, Int) ⇒ Unit
    Definition Classes
    HiveInspectors
  123. def unwrapperFor(objectInspector: ObjectInspector): (Any) ⇒ Any
    Definition Classes
    HiveInspectors
  124. final def verboseString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  125. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  126. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  127. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  128. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  129. final def withNewChildren(newChildren: Seq[Expression]): Expression
    Definition Classes
    TreeNode
  130. def withNewChildrenInternal(newChildren: IndexedSeq[Expression]): Expression
    Definition Classes
    ShimExpression → TreeNode
  131. def wrap(row: Seq[Any], wrappers: Array[(Any) ⇒ Any], cache: Array[AnyRef], dataTypes: Array[DataType]): Array[AnyRef]
    Definition Classes
    HiveInspectors
  132. def wrap(row: InternalRow, wrappers: Array[(Any) ⇒ Any], cache: Array[AnyRef], dataTypes: Array[DataType]): Array[AnyRef]
    Definition Classes
    HiveInspectors
  133. def wrap(a: Any, oi: ObjectInspector, dataType: DataType): AnyRef
    Definition Classes
    HiveInspectors
  134. def wrapRow(row: Seq[Any], wrappers: Array[(Any) ⇒ Any], cache: Array[AnyRef], dataTypes: Array[DataType]): Array[AnyRef]
    Definition Classes
    HiveInspectorsShim
  135. def wrapperFor(oi: ObjectInspector, dataType: DataType): (Any) ⇒ Any
    Attributes
    protected
    Definition Classes
    HiveInspectors

Inherited from GpuRowBasedHiveUDFBase

Inherited from HiveInspectorsShim

Inherited from HiveInspectors

Inherited from GpuRowBasedUserDefinedFunction

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from UserDefinedExpression

Inherited from ShimExpression

Inherited from GpuExpression

Inherited from Expression

Inherited from TreeNode[Expression]

Inherited from TreePatternBits

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped