Packages

c

org.apache.spark.sql.columnar

SimpleMetricsCachedBatchSerializer

abstract class SimpleMetricsCachedBatchSerializer extends CachedBatchSerializer with Logging

Provides basic filtering for CachedBatchSerializer implementations. The requirement to extend this is that all of the batches produced by your serializer are instances of SimpleMetricsCachedBatch. This does not calculate the metrics needed to be stored in the batches. That is up to each implementation. The metrics required are really just min and max values and those are optional especially for complex types. Because those metrics are simple and it is likely that compression will also be done on the data we thought it best to let each implementation decide on the most efficient way to calculate the metrics, possibly combining them with compression passes that might also be done across the data.

Annotations
@DeveloperApi() @Since( "3.1.0" )
Source
CachedBatchSerializer.scala
Linear Supertypes
Logging, CachedBatchSerializer, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SimpleMetricsCachedBatchSerializer
  2. Logging
  3. CachedBatchSerializer
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SimpleMetricsCachedBatchSerializer()

Abstract Value Members

  1. abstract def convertCachedBatchToColumnarBatch(input: RDD[CachedBatch], cacheAttributes: Seq[Attribute], selectedAttributes: Seq[Attribute], conf: SQLConf): RDD[ColumnarBatch]

    Convert the cached data into a ColumnarBatch.

    Convert the cached data into a ColumnarBatch. This currently is only used if supportsColumnarOutput() returns true for the associated schema, but there are other checks that can force row based output. One of the main advantages of doing columnar output over row based output is that the code generation is more standard and can be combined with code generation for downstream operations.

    input

    the cached batches that should be converted.

    cacheAttributes

    the attributes of the data in the batch.

    selectedAttributes

    the fields that should be loaded from the data and the order they should appear in the output batch.

    conf

    the configuration for the job.

    returns

    an RDD of the input cached batches transformed into the ColumnarBatch format.

    Definition Classes
    CachedBatchSerializer
  2. abstract def convertCachedBatchToInternalRow(input: RDD[CachedBatch], cacheAttributes: Seq[Attribute], selectedAttributes: Seq[Attribute], conf: SQLConf): RDD[InternalRow]

    Convert the cached batch into InternalRows.

    Convert the cached batch into InternalRows. If you want this to be performant, code generation is advised.

    input

    the cached batches that should be converted.

    cacheAttributes

    the attributes of the data in the batch.

    selectedAttributes

    the field that should be loaded from the data and the order they should appear in the output rows.

    conf

    the configuration for the job.

    returns

    RDD of the rows that were stored in the cached batches.

    Definition Classes
    CachedBatchSerializer
  3. abstract def convertColumnarBatchToCachedBatch(input: RDD[ColumnarBatch], schema: Seq[Attribute], storageLevel: StorageLevel, conf: SQLConf): RDD[CachedBatch]

    Convert an RDD[ColumnarBatch] into an RDD[CachedBatch] in preparation for caching the data.

    Convert an RDD[ColumnarBatch] into an RDD[CachedBatch] in preparation for caching the data. This will only be called if supportsColumnarInput() returned true for the given schema and the plan up to this point would could produce columnar output without modifying it.

    input

    the input RDD to be converted.

    schema

    the schema of the data being stored.

    storageLevel

    where the data will be stored.

    conf

    the config for the query.

    returns

    The data converted into a format more suitable for caching.

    Definition Classes
    CachedBatchSerializer
  4. abstract def convertInternalRowToCachedBatch(input: RDD[InternalRow], schema: Seq[Attribute], storageLevel: StorageLevel, conf: SQLConf): RDD[CachedBatch]

    Convert an RDD[InternalRow] into an RDD[CachedBatch] in preparation for caching the data.

    Convert an RDD[InternalRow] into an RDD[CachedBatch] in preparation for caching the data.

    input

    the input RDD to be converted.

    schema

    the schema of the data being stored.

    storageLevel

    where the data will be stored.

    conf

    the config for the query.

    returns

    The data converted into a format more suitable for caching.

    Definition Classes
    CachedBatchSerializer
  5. abstract def supportsColumnarInput(schema: Seq[Attribute]): Boolean

    Can convertColumnarBatchToCachedBatch() be called instead of convertInternalRowToCachedBatch() for this given schema? True if it can and false if it cannot.

    Can convertColumnarBatchToCachedBatch() be called instead of convertInternalRowToCachedBatch() for this given schema? True if it can and false if it cannot. Columnar input is only supported if the plan could produce columnar output. Currently this is mostly supported by input formats like parquet and orc, but more operations are likely to be supported soon.

    schema

    the schema of the data being stored.

    returns

    True if columnar input can be supported, else false.

    Definition Classes
    CachedBatchSerializer
  6. abstract def supportsColumnarOutput(schema: StructType): Boolean

    Can convertCachedBatchToColumnarBatch() be called instead of convertCachedBatchToInternalRow() for this given schema? True if it can and false if it cannot.

    Can convertCachedBatchToColumnarBatch() be called instead of convertCachedBatchToInternalRow() for this given schema? True if it can and false if it cannot. Columnar output is typically preferred because it is more efficient. Note that convertCachedBatchToInternalRow() must always be supported as there are other checks that can force row based output.

    schema

    the schema of the data being checked.

    returns

    true if columnar output should be used for this schema, else false.

    Definition Classes
    CachedBatchSerializer

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 buildFilter(predicates: Seq[Expression], cachedAttributes: Seq[Attribute]): (Int, Iterator[CachedBatch]) ⇒ Iterator[CachedBatch]

    Builds a function that can be used to filter batches prior to being decompressed.

    Builds a function that can be used to filter batches prior to being decompressed. In most cases extending SimpleMetricsCachedBatchSerializer will provide the filter logic necessary. You will need to provide metrics for this to work. SimpleMetricsCachedBatch provides the APIs to hold those metrics and explains the metrics used, really just min and max. Note that this is intended to skip batches that are not needed, and the actual filtering of individual rows is handled later.

    predicates

    the set of expressions to use for filtering.

    cachedAttributes

    the schema/attributes of the data that is cached. This can be helpful if you don't store it with the data.

    returns

    a function that takes the partition id and the iterator of batches in the partition. It returns an iterator of batches that should be decompressed.

    Definition Classes
    SimpleMetricsCachedBatchSerializer → CachedBatchSerializer
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  12. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  15. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  16. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  17. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  18. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  19. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  20. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  21. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  22. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  23. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def vectorTypes(attributes: Seq[Attribute], conf: SQLConf): Option[Seq[String]]

    The exact java types of the columns that are output in columnar processing mode.

    The exact java types of the columns that are output in columnar processing mode. This is a performance optimization for code generation and is optional.

    attributes

    the attributes to be output.

    conf

    the config for the query that will read the data.

    Definition Classes
    CachedBatchSerializer
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from Logging

Inherited from CachedBatchSerializer

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped