Packages

c

com.nvidia.spark.rapids

MultiFileCloudOrcPartitionReader

class MultiFileCloudOrcPartitionReader extends MultiFileCloudPartitionReaderBase with MultiFileReaderFunctions with OrcPartitionReaderBase

A PartitionReader that can read multiple ORC files in parallel. This is most efficient running in a cloud environment where the I/O of reading is slow.

Efficiently reading a ORC split on the GPU requires re-constructing the ORC file in memory that contains just the Stripes that are needed. This avoids sending unnecessary data to the GPU and saves GPU memory.

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

Instance Constructors

  1. new MultiFileCloudOrcPartitionReader(conf: Configuration, files: Array[PartitionedFile], dataSchema: StructType, readDataSchema: StructType, partitionSchema: StructType, maxReadBatchSizeRows: Integer, maxReadBatchSizeBytes: Long, numThreads: Int, maxNumFileProcessed: Int, debugDumpPrefix: String, filters: Array[Filter], filterHandler: GpuOrcFileFilterHandler, execMetrics: Map[String, GpuMetric])

    conf

    the Hadoop configuration

    files

    the partitioned files to read

    dataSchema

    schema of the data

    readDataSchema

    the Spark schema describing what will be read

    partitionSchema

    Schema of partitions.

    maxReadBatchSizeRows

    soft limit on the maximum number of rows the reader reads per batch

    maxReadBatchSizeBytes

    soft limit on the maximum number of bytes the reader reads per batch

    numThreads

    the size of the threadpool

    maxNumFileProcessed

    threshold to control the maximum file number to be submitted to threadpool

    debugDumpPrefix

    a path prefix to use for dumping the fabricated ORC data or null

    filters

    filters passed into the filterHandler

    filterHandler

    used to filter the ORC stripes

    execMetrics

    the metrics

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 addPartitionValues(batch: Option[ColumnarBatch], inPartitionValues: InternalRow, partitionSchema: StructType): Option[ColumnarBatch]
    Attributes
    protected
    Definition Classes
    MultiFileReaderFunctions
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. var batch: Option[ColumnarBatch]
    Attributes
    protected
    Definition Classes
    FilePartitionReaderBase
  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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def close(): Unit
    Definition Classes
    MultiFileCloudPartitionReaderBase → FilePartitionReaderBase → Closeable → AutoCloseable
  10. 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
  11. 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
  12. 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
  13. 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
  14. 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
  15. var currentFileHostBuffers: Option[HostMemoryBuffersWithMetaDataBase]
    Attributes
    protected
    Definition Classes
    MultiFileCloudPartitionReaderBase
  16. 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
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. def fileSystemBytesRead(): Long
    Attributes
    protected
    Definition Classes
    MultiFileReaderFunctions
  20. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. 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
  22. def get(): ColumnarBatch
    Definition Classes
    FilePartitionReaderBase → PartitionReader
  23. def getBatchRunner(file: PartitionedFile, conf: Configuration, filters: Array[Filter]): Callable[HostMemoryBuffersWithMetaDataBase]

    The sub-class must implement the real file reading logic in a Callable which will be running in a thread pool

    The sub-class must implement the real file reading logic in a Callable which will be running in a thread pool

    file

    file to be read

    conf

    the Configuration parameters

    filters

    push down filters

    returns

    Callable[HostMemoryBuffersWithMetaDataBase]

    Definition Classes
    MultiFileCloudOrcPartitionReader → MultiFileCloudPartitionReaderBase
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def getFileFormatShortName: String

    File format short name used for logging and other things to uniquely identity which file format is being used.

    File format short name used for logging and other things to uniquely identity which file format is being used.

    returns

    the file format short name

    Definition Classes
    MultiFileCloudOrcPartitionReader → MultiFileCloudPartitionReaderBase
  26. def getThreadPool(numThreads: Int): ThreadPoolExecutor

    Get ThreadPoolExecutor to run the Callable.

    Get ThreadPoolExecutor to run the Callable.

    The requirements: 1. Same ThreadPoolExecutor for cloud and coalescing for the same file format 2. Different file formats have different ThreadPoolExecutors

    numThreads

    max number of threads to create

    returns

    ThreadPoolExecutor

    Definition Classes
    MultiFileCloudOrcPartitionReader → MultiFileCloudPartitionReaderBase
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  29. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  30. var isDone: Boolean
    Attributes
    protected
    Definition Classes
    FilePartitionReaderBase
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  33. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  34. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  35. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  36. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  37. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  38. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  39. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  40. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  41. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  42. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  43. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  44. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. var maxDeviceMemory: Long
    Attributes
    protected
    Definition Classes
    FilePartitionReaderBase
  46. val metrics: Map[String, GpuMetric]
    Definition Classes
    ScanWithMetrics
  47. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. def next(): Boolean
    Definition Classes
    MultiFileCloudPartitionReaderBase → PartitionReader
  49. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  51. def populateCurrentBlockChunk(blockIterator: BufferedIterator[OrcOutputStripe], maxReadBatchSizeRows: Int, maxReadBatchSizeBytes: Long): Seq[OrcOutputStripe]
    Definition Classes
    OrcPartitionReaderBase
  52. def readBatch(fileBufsAndMeta: HostMemoryBuffersWithMetaDataBase): Option[ColumnarBatch]

    Decode HostMemoryBuffers in GPU

    Decode HostMemoryBuffers in GPU

    fileBufsAndMeta

    the file HostMemoryBuffer read from a PartitionedFile

    returns

    Option[ColumnarBatch] which has been decoded by GPU

    Definition Classes
    MultiFileCloudOrcPartitionReader → MultiFileCloudPartitionReaderBase
  53. val readDataSchema: StructType
    Definition Classes
    MultiFileCloudOrcPartitionReader → OrcPartitionReaderBase
  54. 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
  55. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  56. def toString(): String
    Definition Classes
    AnyRef → Any
  57. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  60. 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
  61. 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
  62. 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
  63. 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
  64. 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
  65. 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
  66. 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
  67. 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

Inherited from OrcPartitionReaderBase

Inherited from OrcCommonFunctions

Inherited from OrcCodecWritingHelper

Inherited from MultiFileReaderFunctions

Inherited from MultiFileCloudPartitionReaderBase

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