Packages

trait JoinGatherer extends LazySpillable

Generic trait for all join gather instances. A JoinGatherer takes the gather maps that are the result of a cudf join call along with the data batches that need to be gathered and allow someone to materialize the join in batches. It also provides APIs to help decide on how many rows to gather.

This is a LazySpillable instance so the life cycle follows that too.

Linear Supertypes
LazySpillable, Retryable, AutoCloseable, AnyRef, Any
Known Subclasses
JoinGathererImpl, JoinGathererSameTable, MultiJoinGather
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JoinGatherer
  2. LazySpillable
  3. Retryable
  4. AutoCloseable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def allowSpilling(): Unit

    Indicate that we are done using the data for now and it can be spilled.

    Indicate that we are done using the data for now and it can be spilled.

    This method should not have issues with being called multiple times without the data being accessed.

    Definition Classes
    LazySpillable
  2. abstract def checkpoint(): Unit
    Definition Classes
    Retryable
  3. abstract def close(): Unit
    Definition Classes
    AutoCloseable
    Annotations
    @throws( classOf[java.lang.Exception] )
  4. abstract def gatherNext(n: Int): ColumnarBatch

    Gather the next n rows from the join gather maps.

    Gather the next n rows from the join gather maps.

    n

    how many rows to gather

    returns

    the gathered data as a ColumnarBatch

  5. abstract def getBitSizeMap(n: Int): ColumnView

    Get the bit count size map for the next n rows to be gathered.

    Get the bit count size map for the next n rows to be gathered. It returns a column of INT64 values. One for each of the next n rows requested. This is a bit count to deal with validity bits, etc. This is an INT64 to allow a prefix sum (running total) to be done on it without overflowing so we can compute an accurate cuttoff point for a batch size limit.

  6. abstract def getFixedWidthBitSize: Option[Int]

    If the data is all fixed width return the size of each row, otherwise return None.

  7. abstract def isDone: Boolean

    Is all of the data gathered so far.

  8. abstract def numRowsLeft: Long

    Number of rows left to gather

  9. abstract def realCheapPerRowSizeEstimate: Double

    A really fast and dirty way to estimate the size of each row in the join output measured as in bytes.

  10. abstract def restore(): Unit
    Definition Classes
    Retryable

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def gatherRowEstimate(targetSize: Long): Int

    Do a complete/expensive job to get the number of rows that can be gathered to get close to the targetSize for the final output.

    Do a complete/expensive job to get the number of rows that can be gathered to get close to the targetSize for the final output.

    targetSize

    The target size in bytes for the final output batch.

  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from LazySpillable

Inherited from Retryable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped