Packages

c

com.nvidia.spark.rapids

GpuOrcPartitionReader

class GpuOrcPartitionReader extends FilePartitionReaderBase with OrcPartitionReaderBase

A PartitionReader that reads an ORC file split on the GPU.

Efficiently reading an ORC split on the GPU requires rebuilding the ORC file in memory such that only relevant data is present in the memory file. This avoids sending unnecessary data to the GPU and saves GPU memory.

Linear Supertypes
OrcPartitionReaderBase, OrcCommonFunctions, OrcCodecWritingHelper, FilePartitionReaderBase, Arm, ScanWithMetrics, Logging, PartitionReader[ColumnarBatch], Closeable, AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GpuOrcPartitionReader
  2. OrcPartitionReaderBase
  3. OrcCommonFunctions
  4. OrcCodecWritingHelper
  5. FilePartitionReaderBase
  6. Arm
  7. ScanWithMetrics
  8. Logging
  9. PartitionReader
  10. Closeable
  11. AutoCloseable
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GpuOrcPartitionReader(conf: Configuration, partFile: PartitionedFile, ctx: OrcPartitionReaderContext, readDataSchema: StructType, debugDumpPrefix: Option[String], maxReadBatchSizeRows: Integer, maxReadBatchSizeBytes: Long, execMetrics: Map[String, GpuMetric], isCaseSensitive: Boolean)

    conf

    Hadoop configuration

    partFile

    file split to read

    ctx

    the context to provide some necessary information

    readDataSchema

    Spark schema of what will be read from the file

    debugDumpPrefix

    path prefix for dumping the memory file or null

    maxReadBatchSizeRows

    maximum number of rows to read in a batch

    maxReadBatchSizeBytes

    maximum number of bytes to read in a batch

    execMetrics

    metrics to update during read

    isCaseSensitive

    whether the name check should be case sensitive or not

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. var batch: Option[ColumnarBatch]
    Attributes
    protected
    Definition Classes
    FilePartitionReaderBase
  6. def buildReaderSchema(updatedSchema: TypeDescription, requestedMapping: Option[Array[Int]]): TypeDescription
    Attributes
    protected
    Definition Classes
    OrcCommonFunctions
  7. def buildReaderSchema(ctx: OrcPartitionReaderContext): TypeDescription

    Get the ORC schema corresponding to the file being constructed for the GPU

    Get the ORC schema corresponding to the file being constructed for the GPU

    Attributes
    protected
    Definition Classes
    OrcCommonFunctions
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. def close(): Unit
    Definition Classes
    GpuOrcPartitionReaderFilePartitionReaderBase → Closeable → AutoCloseable
  10. 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
  11. 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
  12. 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
  13. 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
  14. 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
  15. def copyStripeData(ctx: OrcPartitionReaderContext, out: WritableByteChannel, inputDataRanges: DiskRangeList): Unit

    Copy the stripe to the channel

    Copy the stripe to the channel

    Attributes
    protected
    Definition Classes
    OrcCommonFunctions
  16. def currentMetricsValues(): Array[CustomTaskMetric]
    Definition Classes
    PartitionReader
  17. val debugDumpPrefix: Option[String]
  18. final def decodeToBatch(hostBuf: HostMemoryBuffer, bufSize: Long, memFileSchema: TypeDescription, requestedMapping: Option[Array[Int]], isCaseSensitive: Boolean, splits: Array[PartitionedFile]): Option[ColumnarBatch]

    Send a host buffer to GPU for ORC decoding, and return it as a ColumnarBatch.

    Send a host buffer to GPU for ORC decoding, and return it as a ColumnarBatch. The input hostBuf will be closed after returning, please do not use it anymore. 'splits' is used only for debugging.

    Attributes
    protected
    Definition Classes
    OrcPartitionReaderBase
  19. def decodeToTable(hostBuf: HostMemoryBuffer, bufSize: Long, memFileSchema: TypeDescription, requestedMapping: Option[Array[Int]], isCaseSensitive: Boolean, splits: Array[PartitionedFile]): Table

    Read the host data to GPU for ORC decoding, and return it as a cuDF Table.

    Read the host data to GPU for ORC decoding, and return it as a cuDF Table. The input host buffer should contain valid data, otherwise the behavior is undefined. 'splits' is used only for debugging.

    Attributes
    protected
    Definition Classes
    OrcCommonFunctions
  20. def dumpDataToFile(hmb: HostMemoryBuffer, dataLength: Long, splits: Array[PartitionedFile], debugDumpPrefix: Option[String] = None, format: Option[String] = None): Unit

    Dump the data from HostMemoryBuffer to a file named by debugDumpPrefix + random + format

    Dump the data from HostMemoryBuffer to a file named by debugDumpPrefix + random + format

    hmb

    host data to be dumped

    dataLength

    data size

    splits

    PartitionedFile to be handled

    debugDumpPrefix

    file name prefix, if it is None, will not dump

    format

    file name suffix, if it is None, will not dump

    Attributes
    protected
    Definition Classes
    FilePartitionReaderBase
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. 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
  24. def get(): ColumnarBatch
    Definition Classes
    FilePartitionReaderBase → PartitionReader
  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  28. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. var isDone: Boolean
    Attributes
    protected
    Definition Classes
    FilePartitionReaderBase
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  32. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  33. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  34. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  35. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  36. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  37. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  38. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  39. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  40. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  41. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  42. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  43. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  44. var maxDeviceMemory: Long
    Attributes
    protected
    Definition Classes
    FilePartitionReaderBase
  45. val metrics: Map[String, GpuMetric]
    Definition Classes
    ScanWithMetrics
  46. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. def next(): Boolean
    Definition Classes
    GpuOrcPartitionReader → PartitionReader
  48. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  49. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  50. def populateCurrentBlockChunk(blockIterator: BufferedIterator[OrcOutputStripe], maxReadBatchSizeRows: Int, maxReadBatchSizeBytes: Long): Seq[OrcOutputStripe]
    Definition Classes
    OrcPartitionReaderBase
  51. val readDataSchema: StructType
  52. def readPartFile(ctx: OrcPartitionReaderContext, stripes: Seq[OrcOutputStripe]): (HostMemoryBuffer, Long)

    Read the stripes into HostMemoryBuffer.

    Read the stripes into HostMemoryBuffer.

    ctx

    the context to provide some necessary information

    stripes

    a sequence of Stripe to be read into HostMemeoryBuffer

    returns

    HostMemeoryBuffer and its data size

    Attributes
    protected
    Definition Classes
    OrcPartitionReaderBase
  53. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  54. def toString(): String
    Definition Classes
    AnyRef → Any
  55. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  57. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. def withCodecOutputStream[T](ctx: OrcPartitionReaderContext, out: HostMemoryOutputStream)(block: (WritableByteChannel, CodedOutputStream, OutStream) ⇒ T): T

    Executes the provided code block in the codec environment

    Executes the provided code block in the codec environment

    Definition Classes
    OrcCodecWritingHelper
  59. 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
  60. 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
  61. 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
  62. 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
  63. 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
  64. 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
  65. 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
  66. def writeOrcFileFooter(ctx: OrcPartitionReaderContext, fileFooterBuilder: Builder, rawOut: HostMemoryOutputStream, footerStartOffset: Long, numRows: Long, protoWriter: CodedOutputStream, codecStream: OutStream): Unit

    write the ORC file Footer and PostScript

    write the ORC file Footer and PostScript

    Attributes
    protected
    Definition Classes
    OrcCommonFunctions

Deprecated Value Members

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

Inherited from OrcPartitionReaderBase

Inherited from OrcCommonFunctions

Inherited from OrcCodecWritingHelper

Inherited from FilePartitionReaderBase

Inherited from Arm

Inherited from ScanWithMetrics

Inherited from Logging

Inherited from PartitionReader[ColumnarBatch]

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped