Packages

c

org.apache.spark.sql.rapids

GpuMultiFileCloudAvroPartitionReader

class GpuMultiFileCloudAvroPartitionReader extends MultiFileCloudPartitionReaderBase with MultiFileReaderFunctions with GpuAvroReaderBase

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

When reading a file, it

  • seeks to the start position of the first block located in this partition.
  • next, parses the meta and sync, rewrites the meta and sync, and copies the data to a batch buffer per block, until reaching the last one of the current partition.
  • sends batches to GPU at last.
Linear Supertypes
GpuAvroReaderBase, MultiFileReaderFunctions, MultiFileCloudPartitionReaderBase, FilePartitionReaderBase, Arm, ScanWithMetrics, Logging, PartitionReader[ColumnarBatch], Closeable, AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GpuMultiFileCloudAvroPartitionReader
  2. GpuAvroReaderBase
  3. MultiFileReaderFunctions
  4. MultiFileCloudPartitionReaderBase
  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 GpuMultiFileCloudAvroPartitionReader(conf: Configuration, files: Array[PartitionedFile], numThreads: Int, maxNumFileProcessed: Int, filters: Array[Filter], execMetrics: Map[String, GpuMetric], ignoreCorruptFiles: Boolean, ignoreMissingFiles: Boolean, debugDumpPrefix: Option[String], readDataSchema: StructType, partitionSchema: StructType, maxReadBatchSizeRows: Integer, maxReadBatchSizeBytes: Long)

    conf

    the Hadoop configuration

    files

    the partitioned files to read

    numThreads

    the size of the threadpool

    maxNumFileProcessed

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

    filters

    filters passed into the filterHandler

    execMetrics

    the metrics

    ignoreCorruptFiles

    Whether to ignore corrupt files

    ignoreMissingFiles

    Whether to ignore missing files

    debugDumpPrefix

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

    readDataSchema

    the Spark schema describing what will be read

    partitionSchema

    Schema of partitions.

    maxReadBatchSizeRows

    soft limit on the maximum number of rows to be read per batch

    maxReadBatchSizeBytes

    soft limit on the maximum number of bytes to be read per batch

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. val cacheBufferSize: Int
    Definition Classes
    GpuAvroReaderBase
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. def close(): Unit
    Definition Classes
    MultiFileCloudPartitionReaderBase → FilePartitionReaderBase → 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. val conf: Configuration
    Definition Classes
    GpuMultiFileCloudAvroPartitionReader → GpuAvroReaderBase
  16. final def copyBlocksData(blocks: Seq[BlockInfo], in: FSDataInputStream, out: OutputStream, sync: Option[Array[Byte]] = None): Seq[BlockInfo]

    Copy the data specified by the blocks from in to out

    Copy the data specified by the blocks from in to out

    Attributes
    protected
    Definition Classes
    GpuAvroReaderBase
  17. var currentFileHostBuffers: Option[HostMemoryBuffersWithMetaDataBase]
    Attributes
    protected
    Definition Classes
    MultiFileCloudPartitionReaderBase
  18. def currentMetricsValues(): Array[CustomTaskMetric]
    Definition Classes
    PartitionReader
  19. val debugDumpPrefix: Option[String]
    Definition Classes
    GpuMultiFileCloudAvroPartitionReader → GpuAvroReaderBase
  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. final def estimateOutputSize(blocks: Seq[BlockInfo], headerSize: Long): Long

    Estimate the total size from the given blocks and header

    Estimate the total size from the given blocks and header

    Attributes
    protected
    Definition Classes
    GpuAvroReaderBase
  24. def fileSystemBytesRead(): Long
    Attributes
    protected
    Definition Classes
    MultiFileReaderFunctions
    Annotations
    @nowarn()
  25. 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
  26. def get(): ColumnarBatch
    Definition Classes
    FilePartitionReaderBase → PartitionReader
  27. def getBatchRunner(tc: TaskContext, file: PartitionedFile, config: 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

    tc

    task context to use

    file

    file to be read

    filters

    push down filters

    returns

    Callable[HostMemoryBuffersWithMetaDataBase]

    Definition Classes
    GpuMultiFileCloudAvroPartitionReader → MultiFileCloudPartitionReaderBase
  28. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final 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
    GpuMultiFileCloudAvroPartitionReader → MultiFileCloudPartitionReaderBase
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  32. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  33. var isDone: Boolean
    Attributes
    protected
    Definition Classes
    FilePartitionReaderBase
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  36. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  37. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  38. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  39. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  40. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  41. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  42. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  43. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  44. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  46. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  47. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  48. var maxDeviceMemory: Long
    Attributes
    protected
    Definition Classes
    FilePartitionReaderBase
  49. val metrics: Map[String, GpuMetric]
    Definition Classes
    ScanWithMetrics
  50. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  51. def next(): Boolean
    Definition Classes
    MultiFileCloudPartitionReaderBase → PartitionReader
  52. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  53. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  54. final def populateCurrentBlockChunk(blockIter: BufferedIterator[BlockInfo], maxReadBatchSizeRows: Int, maxReadBatchSizeBytes: Long): Seq[BlockInfo]

    Get the block chunk according to the max batch size and max rows.

    Get the block chunk according to the max batch size and max rows.

    blockIter

    blocks to be evaluated

    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

    Attributes
    protected
    Definition Classes
    GpuAvroReaderBase
  55. 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
    GpuMultiFileCloudAvroPartitionReader → MultiFileCloudPartitionReaderBase
  56. val readDataSchema: StructType
    Definition Classes
    GpuMultiFileCloudAvroPartitionReader → GpuAvroReaderBase
  57. final def readPartFile(partFilePath: Path, blocks: Seq[BlockInfo], headerSize: Long, conf: Configuration): (HostMemoryBuffer, Long)

    Read a split into a host buffer, preparing for sending to GPU

    Read a split into a host buffer, preparing for sending to GPU

    Attributes
    protected
    Definition Classes
    GpuAvroReaderBase
  58. final def sendToGpu(hostBuf: HostMemoryBuffer, bufSize: Long, splits: Array[PartitionedFile]): Option[ColumnarBatch]

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

    Send a host buffer to GPU for 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
    GpuAvroReaderBase
  59. final def sendToGpuUnchecked(hostBuf: HostMemoryBuffer, bufSize: Long, splits: Array[PartitionedFile]): Table

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

    Read the host data to GPU for 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
    GpuAvroReaderBase
  60. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  61. def toString(): String
    Definition Classes
    AnyRef → Any
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. 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
  66. 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
  67. 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
  68. 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
  69. 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
  70. 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
  71. 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

Deprecated Value Members

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

Inherited from GpuAvroReaderBase

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