t

org.apache.spark.sql.hive.rapids

GpuRowBasedHiveUDFBase

trait GpuRowBasedHiveUDFBase extends Expression with GpuRowBasedUserDefinedFunction with HiveInspectorsShim

Common implementation across row-based Hive UDFs

Linear Supertypes
HiveInspectorsShim, HiveInspectors, GpuRowBasedUserDefinedFunction, Logging, Serializable, Serializable, UserDefinedExpression, ShimExpression, GpuExpression, Expression, TreeNode[Expression], TreePatternBits, Product, Equals, AnyRef, Any
Known Subclasses
GpuRowBasedHiveGenericUDF, GpuRowBasedHiveSimpleUDF
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GpuRowBasedHiveUDFBase
  2. HiveInspectorsShim
  3. HiveInspectors
  4. GpuRowBasedUserDefinedFunction
  5. Logging
  6. Serializable
  7. Serializable
  8. UserDefinedExpression
  9. ShimExpression
  10. GpuExpression
  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

Type Members

  1. implicit class typeInfoConversions extends AnyRef
    Definition Classes
    HiveInspectors

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def children: Seq[Expression]
    Definition Classes
    TreeNode
  3. abstract def dataType: DataType
    Definition Classes
    Expression
  4. abstract def evaluateRow(childrenRow: InternalRow): Any

    The row based function of the UDF.

    The row based function of the UDF.

    Attributes
    protected
    Definition Classes
    GpuRowBasedUserDefinedFunction
  5. abstract val funcWrapper: HiveFunctionWrapper
  6. abstract val function: AnyRef
    Annotations
    @transient()
  7. abstract val name: String

    name of the UDF function

    name of the UDF function

    Definition Classes
    GpuRowBasedUserDefinedFunction → UserDefinedExpression
  8. abstract def productArity: Int
    Definition Classes
    Product
  9. abstract def productElement(n: Int): Any
    Definition Classes
    Product

Concrete 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
    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
    Annotations
    @transient()
  13. def childrenResolved: Boolean
    Definition Classes
    Expression
  14. def clone(): Expression
    Definition Classes
    TreeNode → AnyRef
  15. def collect[B](pf: PartialFunction[Expression, B]): Seq[B]
    Definition Classes
    TreeNode
  16. def collectFirst[B](pf: PartialFunction[Expression, B]): Option[B]
    Definition Classes
    TreeNode
  17. def collectLeaves(): Seq[Expression]
    Definition Classes
    TreeNode
  18. 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
  19. 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
  20. final def containsAllPatterns(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  21. final def containsAnyPattern(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  22. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  23. final def containsPattern(t: TreePattern): Boolean
    Definition Classes
    TreePatternBits
    Annotations
    @inline()
  24. 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
  25. def copyTagsFrom(other: Expression): Unit
    Definition Classes
    TreeNode
  26. lazy val deterministic: Boolean
    Definition Classes
    GpuRowBasedUserDefinedFunction → Expression
  27. 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
  28. 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
  29. final def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode
    Definition Classes
    GpuExpression → Expression
  30. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  32. final def eval(input: InternalRow = null): Any
    Definition Classes
    GpuExpression → Expression
  33. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  34. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. def find(f: (Expression) ⇒ Boolean): Option[Expression]
    Definition Classes
    TreeNode
  36. def flatArguments: Iterator[Any]
    Attributes
    protected
    Definition Classes
    Expression
  37. def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  38. def foldable: Boolean
    Definition Classes
    Expression
  39. def foreach(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  40. def foreachUp(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  41. def genCode(ctx: CodegenContext): ExprCode
    Definition Classes
    Expression
  42. 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
  43. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. def getDefaultTreePatternBits: BitSet
    Attributes
    protected
    Definition Classes
    TreeNode
  45. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  46. def gpuToInspector(expr: Expression): ObjectInspector

    Create an object inspector from a GPU expression.

    Create an object inspector from a GPU expression.

    Attributes
    protected
  47. 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
  48. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  49. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  50. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def innerChildren: Seq[TreeNode[_]]
    Definition Classes
    TreeNode
  52. def inspectorToDataType(inspector: ObjectInspector): DataType
    Definition Classes
    HiveInspectors
  53. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  54. def isRuleIneffective(ruleId: RuleId): Boolean
    Attributes
    protected
    Definition Classes
    TreeNode
  55. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  56. def javaTypeToDataType(clz: Type): DataType
    Definition Classes
    HiveInspectors
  57. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  58. final def legacyWithNewChildren(newChildren: Seq[Expression]): Expression
    Attributes
    protected
    Definition Classes
    TreeNode
  59. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  60. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  67. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def makeCopy(newArgs: Array[AnyRef]): Expression
    Definition Classes
    TreeNode
  72. def map[A](f: (Expression) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  73. def mapChildren(f: (Expression) ⇒ Expression): Expression
    Definition Classes
    TreeNode
  74. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  75. def markRuleAsIneffective(ruleId: RuleId): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  76. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  77. def nodeName: String
    Definition Classes
    TreeNode
  78. val nodePatterns: Seq[TreePattern]
    Attributes
    protected
    Definition Classes
    TreeNode
  79. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  80. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  81. def nullable: Boolean
    Definition Classes
    GpuRowBasedHiveUDFBase → Expression
  82. def numberedTreeString: String
    Definition Classes
    TreeNode
  83. val origin: Origin
    Definition Classes
    TreeNode
  84. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  85. def p(number: Int): Expression
    Definition Classes
    TreeNode
  86. def prettyJson: String
    Definition Classes
    TreeNode
  87. def prettyName: String
    Definition Classes
    GpuRowBasedHiveUDFBase → Expression
  88. def productIterator: Iterator[Any]
    Definition Classes
    Product
  89. def productPrefix: String
    Definition Classes
    Product
  90. def references: AttributeSet
    Definition Classes
    Expression
  91. lazy val resolved: Boolean
    Definition Classes
    Expression
  92. 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
  93. 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
  94. final def semanticEquals(other: Expression): Boolean
    Definition Classes
    Expression
  95. def semanticHash(): Int
    Definition Classes
    Expression
  96. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  97. def simpleString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  98. def simpleStringWithNodeId(): String
    Definition Classes
    Expression → TreeNode
  99. def sql: String
    Definition Classes
    Expression
  100. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  101. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  102. def toInspector(expr: Expression): ObjectInspector
    Definition Classes
    HiveInspectors
  103. def toInspector(dataType: DataType): ObjectInspector
    Definition Classes
    HiveInspectors
  104. def toJSON: String
    Definition Classes
    TreeNode
  105. def toString(): String
    Definition Classes
    GpuRowBasedHiveUDFBase → Expression → TreeNode → AnyRef → Any
  106. def transform(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  107. def transformDown(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  108. def transformDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  109. def transformUp(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  110. def transformUpWithBeforeAndAfterRuleOnChildren(cond: (Expression) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[(Expression, Expression), Expression]): Expression
    Definition Classes
    TreeNode
  111. def transformUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  112. def transformWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  113. lazy val treePatternBits: BitSet
    Definition Classes
    TreeNode → TreePatternBits
  114. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  115. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  116. final def treeString: String
    Definition Classes
    TreeNode
  117. val udfDeterministic: Boolean

    True if the UDF is deterministic

    True if the UDF is deterministic

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

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