t

com.here.platform.data.client.spark

IndexDataFrameReader

trait IndexDataFrameReader extends LayerDataFrameReader

LayerDataFrameReader to query data from an index layer.

Linear Supertypes
LayerDataFrameReader, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IndexDataFrameReader
  2. LayerDataFrameReader
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def format(source: String): IndexDataFrameReader

    Specifies the format of the data stored in the layer.

    Specifies the format of the data stored in the layer.

    Definition Classes
    IndexDataFrameReader → LayerDataFrameReader
  2. abstract def load(): DataFrame

    Retrieve the data in the user defined format (see format) which satisfies the provided query (see query).

    Retrieve the data in the user defined format (see format) which satisfies the provided query (see query).

    If no format is set, the load method infers the input data source format from the layer content type. For example, if the layer content type is application/x-parquet, the load method will specify the parquet data source format.

    If no format is set and the load method cannot infer the input data source format from the layer content type, the load method will use the default format defined in the spark.sql.sources.default Spark property, whose default value is parquet.

    returns

    DataFrame with the data, note the structure of the data DataFrame will depend on the format (see format) or optional user provided schema

    Definition Classes
    LayerDataFrameReader
    Exceptions thrown

    com.here.platform.data.client.DataClientNonRetriableException in case of non-retriable error

    com.here.platform.data.client.DataClientRetriableException in case of retriable error

  3. abstract def option(key: String, value: String): IndexDataFrameReader

    Adds an input option for the underlying data source.

    Adds an input option for the underlying data source.

    Definition Classes
    IndexDataFrameReader → LayerDataFrameReader
  4. abstract def option(key: String, value: Boolean): IndexDataFrameReader

    Adds an input option for the underlying data source.

    Adds an input option for the underlying data source.

    Definition Classes
    IndexDataFrameReader → LayerDataFrameReader
  5. abstract def option(key: String, value: Long): IndexDataFrameReader

    Adds an input option for the underlying data source.

    Adds an input option for the underlying data source.

    Definition Classes
    IndexDataFrameReader → LayerDataFrameReader
  6. abstract def option(key: String, value: Double): IndexDataFrameReader

    Adds an input option for the underlying data source.

    Adds an input option for the underlying data source.

    Definition Classes
    IndexDataFrameReader → LayerDataFrameReader
  7. abstract def option(key: String, value: Enum[_]): LayerDataFrameReader

    Adds an input option for the underlying data source.

    Adds an input option for the underlying data source.

    Definition Classes
    LayerDataFrameReader
  8. abstract def query(query: String): IndexDataFrameReader

    Specifies the query to use when querying the layer.

    Specifies the query to use when querying the layer.

    query

    Query string to retrieve layer data. Format of query should follow RSQL. See https://github.com/jirutka/rsql-parser

    Definition Classes
    IndexDataFrameReader → LayerDataFrameReader
  9. abstract def queryMetadata(query: String): LayerDataFrameReader

    Specifies the query to use when querying the layer partitions metadata.

    Specifies the query to use when querying the layer partitions metadata.

    query

    Query string to retrieve layer partitions metadata. Format of query should follow RSQL. See https://github.com/jirutka/rsql-parser

    Definition Classes
    IndexDataFrameReader → LayerDataFrameReader
  10. abstract def schema(schema: StructType): IndexDataFrameReader

    Specifies the schema of the data stored in the layer.

    Specifies the schema of the data stored in the layer. Some data formats such as Apache Avro can infer the schema automatically from the data. By specifying the schema here, the underlying data source can skip the schema inference step, and thus speed up data loading.

    Definition Classes
    IndexDataFrameReader → LayerDataFrameReader

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from LayerDataFrameReader

Inherited from AnyRef

Inherited from Any

Ungrouped