org.apache.spark.sql.execution.datasources

HadoopFsRelation

case class HadoopFsRelation(location: FileIndex, partitionSchema: StructType, dataSchema: StructType, bucketSpec: Option[BucketSpec], fileFormat: FileFormat, options: Map[String, String])(sparkSession: SparkSession) extends BaseRelation with FileRelation with Product with Serializable

Acts as a container for all of the metadata required to read from a datasource. All discovery, resolution and merging logic for schemas and partitions has been removed.

location

A FileIndex that can enumerate the locations of all the files that comprise this relation.

partitionSchema

The schema of the columns (if any) that are used to partition the relation

dataSchema

The schema of any remaining columns. Note that if any partition columns are present in the actual data files as well, they are preserved.

bucketSpec

Describes the bucketing (hash-partitioning of the files by some column values).

fileFormat

A file format that can be used to read and write the data in files.

options

Configuration used when reading / writing data.

Linear Supertypes
Serializable, Serializable, Product, Equals, FileRelation, BaseRelation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HadoopFsRelation
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. FileRelation
  7. BaseRelation
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HadoopFsRelation(location: FileIndex, partitionSchema: StructType, dataSchema: StructType, bucketSpec: Option[BucketSpec], fileFormat: FileFormat, options: Map[String, String])(sparkSession: SparkSession)

    location

    A FileIndex that can enumerate the locations of all the files that comprise this relation.

    partitionSchema

    The schema of the columns (if any) that are used to partition the relation

    dataSchema

    The schema of any remaining columns. Note that if any partition columns are present in the actual data files as well, they are preserved.

    bucketSpec

    Describes the bucketing (hash-partitioning of the files by some column values).

    fileFormat

    A file format that can be used to read and write the data in files.

    options

    Configuration used when reading / writing data.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. val bucketSpec: Option[BucketSpec]

    Describes the bucketing (hash-partitioning of the files by some column values).

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val dataSchema: StructType

    The schema of any remaining columns.

    The schema of any remaining columns. Note that if any partition columns are present in the actual data files as well, they are preserved.

  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. val fileFormat: FileFormat

    A file format that can be used to read and write the data in files.

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  14. def inputFiles: Array[String]

    Returns the list of files that will be read when scanning this relation.

    Returns the list of files that will be read when scanning this relation.

    Definition Classes
    HadoopFsRelationFileRelation
  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  16. val location: FileIndex

    A FileIndex that can enumerate the locations of all the files that comprise this relation.

  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. def needConversion: Boolean

    Whether does it need to convert the objects in Row to internal representation, for example: java.

    Whether does it need to convert the objects in Row to internal representation, for example: java.lang.String to UTF8String java.lang.Decimal to Decimal

    If needConversion is false, buildScan() should return an RDD of InternalRow

    Definition Classes
    BaseRelation
    Since

    1.4.0

    Note

    The internal representation is not stable across releases and thus data sources outside of Spark SQL should leave this as true.

  19. final def notify(): Unit

    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  21. val options: Map[String, String]

    Configuration used when reading / writing data.

  22. val overlappedPartCols: Map[String, StructField]

  23. val partitionSchema: StructType

    The schema of the columns (if any) that are used to partition the relation

  24. def partitionSchemaOption: Option[StructType]

  25. val schema: StructType

    Definition Classes
    HadoopFsRelationBaseRelation
  26. def sizeInBytes: Long

    Returns an estimated size of this relation in bytes.

    Returns an estimated size of this relation in bytes. This information is used by the planner to decide when it is safe to broadcast a relation and can be overridden by sources that know the size ahead of time. By default, the system will assume that tables are too large to broadcast. This method will be called multiple times during query planning and thus should not perform expensive operations for each invocation.

    Definition Classes
    HadoopFsRelationBaseRelation
    Since

    1.3.0

    Note

    It is always better to overestimate size than underestimate, because underestimation could lead to execution plans that are suboptimal (i.e. broadcasting a very large table).

  27. val sparkSession: SparkSession

  28. def sqlContext: SQLContext

    Definition Classes
    HadoopFsRelationBaseRelation
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  30. def toString(): String

    Definition Classes
    HadoopFsRelation → AnyRef → Any
  31. def unhandledFilters(filters: Array[Filter]): Array[Filter]

    Returns the list of Filters that this datasource may not be able to handle.

    Returns the list of Filters that this datasource may not be able to handle. These returned Filters will be evaluated by Spark SQL after data is output by a scan. By default, this function will return all filters, as it is always safe to double evaluate a Filter. However, specific implementations can override this function to avoid double filtering when they are capable of processing a filter internally.

    Definition Classes
    BaseRelation
    Since

    1.6.0

  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from FileRelation

Inherited from BaseRelation

Inherited from AnyRef

Inherited from Any

Ungrouped