Packages

class OrcFileFormat extends FileFormat with DataSourceRegister with Serializable

New ORC File Format based on Apache ORC.

Linear Supertypes
Serializable, DataSourceRegister, FileFormat, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OrcFileFormat
  2. Serializable
  3. DataSourceRegister
  4. FileFormat
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OrcFileFormat()

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 buildReader(sparkSession: SparkSession, dataSchema: StructType, partitionSchema: StructType, requiredSchema: StructType, filters: Seq[Filter], options: Map[String, String], hadoopConf: Configuration): (PartitionedFile) ⇒ Iterator[InternalRow]

    Returns a function that can be used to read a single file in as an Iterator of InternalRow.

    Returns a function that can be used to read a single file in as an Iterator of InternalRow.

    dataSchema

    The global data schema. It can be either specified by the user, or reconciled/merged from all underlying data files. If any partition columns are contained in the files, they are preserved in this schema.

    partitionSchema

    The schema of the partition column row that will be present in each PartitionedFile. These columns should be appended to the rows that are produced by the iterator.

    requiredSchema

    The schema of the data that should be output for each row. This may be a subset of the columns that are present in the file if column pruning has occurred.

    filters

    A set of filters than can optionally be used to reduce the number of rows output

    options

    A set of string -> string configuration options.

    Attributes
    protected
    Definition Classes
    FileFormat
  6. def buildReaderWithPartitionValues(sparkSession: SparkSession, dataSchema: StructType, partitionSchema: StructType, requiredSchema: StructType, filters: Seq[Filter], options: Map[String, String], hadoopConf: Configuration): (PartitionedFile) ⇒ Iterator[InternalRow]

    Build the reader.

    Build the reader.

    Definition Classes
    OrcFileFormat → FileFormat
    Note

    It is required to pass FileFormat.OPTION_RETURNING_BATCH in options, to indicate whether the reader should return row or columnar output. If the caller can handle both, pass FileFormat.OPTION_RETURNING_BATCH -> supportBatch(sparkSession, StructType(requiredSchema.fields ++ partitionSchema.fields)) as the option. It should be set to "true" only if this reader can support it.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(other: Any): Boolean
    Definition Classes
    OrcFileFormat → AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    OrcFileFormat → AnyRef → Any
  13. def inferSchema(sparkSession: SparkSession, options: Map[String, String], files: Seq[FileStatus]): Option[StructType]

    When possible, this method should return the schema of the given files.

    When possible, this method should return the schema of the given files. When the format does not support inference, or no valid files are given should return None. In these cases Spark will require that user specify the schema manually.

    Definition Classes
    OrcFileFormat → FileFormat
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def isSplitable(sparkSession: SparkSession, options: Map[String, String], path: Path): Boolean

    Returns whether a file with path could be split or not.

    Returns whether a file with path could be split or not.

    Definition Classes
    OrcFileFormat → FileFormat
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def prepareWrite(sparkSession: SparkSession, job: Job, options: Map[String, String], dataSchema: StructType): OutputWriterFactory

    Prepares a write job and returns an OutputWriterFactory.

    Prepares a write job and returns an OutputWriterFactory. Client side job preparation can be put here. For example, user defined output committer can be configured here by setting the output committer class in the conf of spark.sql.sources.outputCommitterClass.

    Definition Classes
    OrcFileFormat → FileFormat
  20. def shortName(): String

    The string that represents the format that this data source provider uses.

    The string that represents the format that this data source provider uses. This is overridden by children to provide a nice alias for the data source. For example:

    override def shortName(): String = "parquet"
    Definition Classes
    OrcFileFormat → DataSourceRegister
    Since

    1.5.0

  21. def supportBatch(sparkSession: SparkSession, schema: StructType): Boolean

    Returns whether this format supports returning columnar batch or not.

    Returns whether this format supports returning columnar batch or not. If columnar batch output is requested, users shall supply FileFormat.OPTION_RETURNING_BATCH -> true in relation options when calling buildReaderWithPartitionValues. This should only be passed as true if it can actually be supported. For ParquetFileFormat and OrcFileFormat, passing this option is required.

    TODO: we should just have different traits for the different formats.

    Definition Classes
    OrcFileFormat → FileFormat
  22. def supportDataType(dataType: DataType): Boolean

    Returns whether this format supports the given DataType in read/write path.

    Returns whether this format supports the given DataType in read/write path. By default all data types are supported.

    Definition Classes
    OrcFileFormat → FileFormat
  23. def supportFieldName(name: String): Boolean

    Returns whether this format supports the given filed name in read/write path.

    Returns whether this format supports the given filed name in read/write path. By default all field name is supported.

    Definition Classes
    FileFormat
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    OrcFileFormat → AnyRef → Any
  26. def vectorTypes(requiredSchema: StructType, partitionSchema: StructType, sqlConf: SQLConf): Option[Seq[String]]

    Returns concrete column vector class names for each column to be used in a columnar batch if this format supports returning columnar batch.

    Returns concrete column vector class names for each column to be used in a columnar batch if this format supports returning columnar batch.

    Definition Classes
    FileFormat
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from DataSourceRegister

Inherited from FileFormat

Inherited from AnyRef

Inherited from Any

Ungrouped