Class

com.nvidia.spark.rapids

GpuHashAggregateMeta

Related Doc: package rapids

Permalink

class GpuHashAggregateMeta extends SparkPlanMeta[HashAggregateExec]

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GpuHashAggregateMeta
  2. SparkPlanMeta
  3. RapidsMeta
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GpuHashAggregateMeta(agg: HashAggregateExec, conf: RapidsConf, parent: Option[RapidsMeta[_, _]], rule: DataFromReplacementRule)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def addConvertedDataType(expression: Expression, typeMeta: DataTypeMeta): Unit

    Permalink

    Call this method to record information about type conversions via DataTypeMeta.

    Call this method to record information about type conversions via DataTypeMeta.

    Definition Classes
    RapidsMeta
  5. val agg: HashAggregateExec

    Permalink
  6. val aggregateAttributes: Seq[BaseExprMeta[_]]

    Permalink
  7. val aggregateExpressions: Seq[BaseExprMeta[_]]

    Permalink
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. val availableRuntimeDataTransition: Boolean

    Permalink

    Whether there exists runtime data transition for the wrapped plan, if true, the overriding of output attributes will always work even when the wrapped plan can't be replaced by GPU overrides.

    Whether there exists runtime data transition for the wrapped plan, if true, the overriding of output attributes will always work even when the wrapped plan can't be replaced by GPU overrides.

    Definition Classes
    SparkPlanMeta
  10. def canDataWriteCmdsBeReplaced: Boolean

    Permalink

    Returns true iff all of the data writing commands can be replaced.

    Returns true iff all of the data writing commands can be replaced.

    Definition Classes
    RapidsMeta
  11. def canExprTreeBeReplaced: Boolean

    Permalink

    Returns true iff all of the expressions and their children could be replaced.

    Returns true iff all of the expressions and their children could be replaced.

    Definition Classes
    RapidsMeta
  12. def canPartsBeReplaced: Boolean

    Permalink

    Returns true iff all of the partitioning can be replaced.

    Returns true iff all of the partitioning can be replaced.

    Definition Classes
    RapidsMeta
  13. final def canThisBeReplaced: Boolean

    Permalink

    Returns true iff this could be replaced.

    Returns true iff this could be replaced.

    Definition Classes
    RapidsMeta
  14. var cannotBeReplacedReasons: Option[Set[String]]

    Permalink
    Attributes
    protected
    Definition Classes
    RapidsMeta
  15. var cannotRunOnGpuBecauseOfCost: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RapidsMeta
  16. var cannotRunOnGpuBecauseOfSparkPlan: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RapidsMeta
  17. def checkExistingTags(): Unit

    Permalink

    When AQE is enabled and we are planning a new query stage, we need to look at meta-data previously stored on the spark plan to determine whether this operator can run on GPU

    When AQE is enabled and we are planning a new query stage, we need to look at meta-data previously stored on the spark plan to determine whether this operator can run on GPU

    Definition Classes
    SparkPlanMeta
  18. def checkTimeZoneId(timeZoneId: Option[String]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    RapidsMeta
  19. val childDataWriteCmds: Seq[DataWritingCommandMeta[_]]

    Permalink

    The wrapped data writing commands that should be examined

    The wrapped data writing commands that should be examined

    Definition Classes
    SparkPlanMetaRapidsMeta
  20. val childExprs: Seq[BaseExprMeta[_]]

    Permalink

    The wrapped expressions that should be examined

    The wrapped expressions that should be examined

    Definition Classes
    GpuHashAggregateMetaSparkPlanMetaRapidsMeta
  21. val childParts: Seq[PartMeta[_]]

    Permalink

    The wrapped partitioning that should be examined

    The wrapped partitioning that should be examined

    Definition Classes
    SparkPlanMetaRapidsMeta
  22. val childPlans: Seq[SparkPlanMeta[SparkPlan]]

    Permalink

    The wrapped plans that should be examined

    The wrapped plans that should be examined

    Definition Classes
    SparkPlanMetaRapidsMeta
  23. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. val conf: RapidsConf

    Permalink

    the config

    the config

    Definition Classes
    RapidsMeta
  25. def confKey: String

    Permalink
    Definition Classes
    RapidsMeta
  26. final def convertIfNeeded(): SparkPlan

    Permalink

    If this is enabled to be converted to a GPU version convert it and return the result, else do what is needed to possibly convert the rest of the plan.

    If this is enabled to be converted to a GPU version convert it and return the result, else do what is needed to possibly convert the rest of the plan.

    Definition Classes
    SparkPlanMeta
  27. def convertToCpu(): SparkPlan

    Permalink

    Keep this on the CPU, but possibly convert its children under it to run on the GPU if enabled.

    Keep this on the CPU, but possibly convert its children under it to run on the GPU if enabled. By default this just returns what is wrapped by this. For some types of operators/stages, like SparkPlan, each part of the query can be converted independent of other parts. As such in a subclass this should be overridden to do the correct thing.

    Definition Classes
    SparkPlanMetaRapidsMeta
  28. final def costPreventsRunningOnGpu(): Unit

    Permalink
    Definition Classes
    RapidsMeta
  29. var cpuCost: Double

    Permalink
    Definition Classes
    SparkPlanMeta
  30. final val disabledMsg: Option[String]

    Permalink
    Definition Classes
    RapidsMeta
  31. final def entirePlanExcludedReasons: Seq[String]

    Permalink

    Returns the list of reasons the entire plan can't be replaced.

    Returns the list of reasons the entire plan can't be replaced. An empty set means the entire plan is ok to be replaced, do the normal checking per exec and children.

    Definition Classes
    RapidsMeta
  32. final def entirePlanWillNotWork(because: String): Unit

    Permalink

    Call this if there is a condition found that the entire plan is not allowed to run on the GPU.

    Call this if there is a condition found that the entire plan is not allowed to run on the GPU.

    Definition Classes
    RapidsMeta
  33. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  35. var estimatedOutputRows: Option[BigInt]

    Permalink
    Definition Classes
    SparkPlanMeta
  36. def explain(all: Boolean): String

    Permalink
    Definition Classes
    RapidsMeta
  37. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  38. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  39. def getReasonsNotToReplaceEntirePlan: Seq[String]

    Permalink
    Definition Classes
    SparkPlanMeta
  40. var gpuCost: Double

    Permalink
    Definition Classes
    SparkPlanMeta
  41. val groupingExpressions: Seq[BaseExprMeta[_]]

    Permalink
  42. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  43. final val incompatDoc: Option[String]

    Permalink
    Definition Classes
    RapidsMeta
  44. def indent(append: StringBuilder, depth: Int): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    RapidsMeta
  45. def initReasons(): Unit

    Permalink
    Definition Classes
    RapidsMeta
  46. final def inputFilePreventsRunningOnGpu(): Unit

    Permalink
    Definition Classes
    RapidsMeta
  47. def isDisabledByDefault: Boolean

    Permalink
    Definition Classes
    RapidsMeta
  48. def isIncompat: Boolean

    Permalink
    Definition Classes
    RapidsMeta
  49. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  50. final def mustBeReplaced(because: String): Unit

    Permalink
    Definition Classes
    RapidsMeta
  51. final def mustThisBeReplaced: Boolean

    Permalink

    Returns true iff this must be replaced because its children have already been replaced and this needs to also be replaced for compatibility.

    Returns true iff this must be replaced because its children have already been replaced and this needs to also be replaced for compatibility.

    Definition Classes
    RapidsMeta
  52. def namedChildExprs: Map[String, Seq[BaseExprMeta[_]]]

    Permalink
    Definition Classes
    SparkPlanMeta
  53. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  54. def noReplacementPossibleMessage(reasons: String): String

    Permalink
    Definition Classes
    RapidsMeta
  55. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  56. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  57. final val operationName: String

    Permalink
    Definition Classes
    RapidsMeta
  58. def outputAttributes: Seq[Attribute]

    Permalink

    Gets output attributes of current SparkPlanMeta, which is supposed to be called during type checking for the current plan.

    Gets output attributes of current SparkPlanMeta, which is supposed to be called during type checking for the current plan.

    By default, it simply returns the output of wrapped plan. For specific plans, they can override outputTypeMetas to apply custom conversions on the output of wrapped plan. For plans which just pass through the schema of childPlan, they can set useOutputAttributesOfChild to true, in order to propagate the custom conversions of childPlan if they exist.

    Definition Classes
    SparkPlanMeta
  59. lazy val outputTypeMetas: Option[Seq[DataTypeMeta]]

    Permalink

    Overrides this method to implement custom conversions for specific plans.

    Overrides this method to implement custom conversions for specific plans.

    Attributes
    protected
    Definition Classes
    SparkPlanMeta
  60. val parent: Option[RapidsMeta[_, _]]

    Permalink

    the parent of this node, if there is one.

    the parent of this node, if there is one.

    Definition Classes
    RapidsMeta
  61. def print(strBuilder: StringBuilder, depth: Int, all: Boolean): Unit

    Permalink

    Create a string representation of this in append.

    Create a string representation of this in append.

    strBuilder

    where to place the string representation.

    depth

    how far down the tree this is.

    all

    should all the data be printed or just what does not work on the GPU?

    Attributes
    protected
    Definition Classes
    RapidsMeta
  62. val printWrapped: Boolean

    Permalink

    When converting this to a string should we include the string representation of what this wraps too? This is off by default.

    When converting this to a string should we include the string representation of what this wraps too? This is off by default.

    Attributes
    protected
    Definition Classes
    RapidsMeta
  63. final def recursiveCostPreventsRunningOnGpu(): Unit

    Permalink

    Recursively force a section of the plan back onto CPU, stopping once a plan is reached that is already on CPU.

    Recursively force a section of the plan back onto CPU, stopping once a plan is reached that is already on CPU.

    Definition Classes
    RapidsMeta
  64. final def recursiveSparkPlanPreventsRunningOnGpu(): Unit

    Permalink
    Definition Classes
    RapidsMeta
  65. final def recursiveSparkPlanRemoved(): Unit

    Permalink
    Definition Classes
    RapidsMeta
  66. def replaceMessage: String

    Permalink
    Definition Classes
    RapidsMeta
  67. def requireAstForGpuOn(exprMeta: BaseExprMeta[_]): Unit

    Permalink
    Definition Classes
    SparkPlanMeta
  68. val resultExpressions: Seq[BaseExprMeta[_]]

    Permalink
  69. def runAfterTagRules(): Unit

    Permalink

    Run rules that happen for the entire tree after it has been tagged initially.

    Run rules that happen for the entire tree after it has been tagged initially.

    Definition Classes
    SparkPlanMeta
  70. final def shouldBeRemoved(because: String): Unit

    Permalink
    Definition Classes
    RapidsMeta
  71. final def shouldThisBeRemoved: Boolean

    Permalink

    Returns true if this node should be removed.

    Returns true if this node should be removed.

    Definition Classes
    RapidsMeta
  72. def suppressWillWorkOnGpuInfo: Boolean

    Permalink
    Definition Classes
    RapidsMeta
  73. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  74. def tagForExplain(): Unit

    Permalink
    Definition Classes
    SparkPlanMeta
  75. final def tagForGpu(): Unit

    Permalink

    Tag all of the children to see if they are GPU compatible first.

    Tag all of the children to see if they are GPU compatible first. Do basic common verification for the operators, and then call tagSelfForGpu

    Definition Classes
    RapidsMeta
  76. def tagPlanForGpu(): Unit

    Permalink

    Called to verify that this plan will work on the GPU.

    Called to verify that this plan will work on the GPU. Generic checks will have already been done. In general this method should only tag this operator as bad. If it needs to tag one of its children please take special care to update the comment inside tagSelfForGpu so we don't end up with something that could be cyclical.

    Definition Classes
    GpuHashAggregateMetaSparkPlanMeta
  77. final def tagSelfForGpu(): Unit

    Permalink

    Do any extra checks and tag yourself if you are compatible or not.

    Do any extra checks and tag yourself if you are compatible or not. Be aware that this may already have been marked as incompatible for a number of reasons.

    All of your children should have already been tagged so if there are situations where you may need to disqualify your children for various reasons you may do it here too.

    Definition Classes
    SparkPlanMetaRapidsMeta
  78. def toString(): String

    Permalink
    Definition Classes
    RapidsMeta → AnyRef → Any
  79. val useOutputAttributesOfChild: Boolean

    Permalink

    Whether to pass through the outputAttributes of childPlan's meta, only for UnaryPlan

    Whether to pass through the outputAttributes of childPlan's meta, only for UnaryPlan

    Attributes
    protected
    Definition Classes
    SparkPlanMeta
  80. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. final def willNotWorkOnGpu(because: String): Unit

    Permalink

    Call this to indicate that this should not be replaced with a GPU enabled version

    Call this to indicate that this should not be replaced with a GPU enabled version

    because

    why it should not be replaced.

    Definition Classes
    RapidsMeta
  84. val wrapped: HashAggregateExec

    Permalink

    what we are wrapping

    what we are wrapping

    Definition Classes
    RapidsMeta

Inherited from AnyRef

Inherited from Any

Ungrouped