org.apache.spark.sql.sources

Class BaseRelation

java.lang.Object

org.apache.spark.sql.sources.BaseRelation

Direct Known Subclasses:

HadoopFsRelation

public abstract class BaseRelation
extends java.lang.Object

::DeveloperApi:: Represents a collection of tuples with a known schema. Classes that extend BaseRelation must be able to produce the schema of their data in the form of a StructType. Concrete implementation should inherit from one of the descendant Scan classes, which define various abstract methods for execution.

BaseRelations must also define an equality function that only returns true when the two instances will return the same data. This equality function is used when determining when it is safe to substitute cached results for a given relation.

Since:

1.3.0

Constructor Summary

Constructors

Constructor and Description
BaseRelation()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	needConversion() Whether does it need to convert the objects in Row to internal representation, for example: java.lang.String -> UTF8String java.lang.Decimal -> Decimal
abstract StructType	schema()
long	sizeInBytes() Returns an estimated size of this relation in bytes.
abstract SQLContext	sqlContext()
Filter[]	unhandledFilters(Filter[] filters) Returns the list of Filters that this datasource may not be able to handle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseRelation

public BaseRelation()

Method Detail

sqlContext

public abstract SQLContext sqlContext()

schema

public abstract StructType schema()

sizeInBytes

public long sizeInBytes()

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.

Note that 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).

Returns:

(undocumented)

Since:

1.3.0

needConversion

public boolean needConversion()

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

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

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

Returns:

(undocumented)

Since:

1.4.0

unhandledFilters

public Filter[] unhandledFilters(Filter[] filters)

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.

Parameters:

filters - (undocumented)

Returns:

(undocumented)

Since:

1.6.0