Package com.here.platform.data.client.spark

Interface IndexDataFrameReader

All Superinterfaces:

LayerDataFrameReader

public interface IndexDataFrameReader
extends LayerDataFrameReader

LayerDataFrameReader to query data from an index layer.

Nested Class Summary

Nested classes/interfaces inherited from interface com.here.platform.data.client.spark.LayerDataFrameReader

LayerDataFrameReader.SparkSessionExt

Method Summary

Modifier and Type	Method	Description
IndexDataFrameReader	format(String source)	Specifies the format of the data stored in the layer.
IndexDataFrameReader	option(String key, boolean value)	Adds an input option for the underlying data source.
IndexDataFrameReader	option(String key, double value)	Adds an input option for the underlying data source.
IndexDataFrameReader	option(String key, long value)	Adds an input option for the underlying data source.
IndexDataFrameReader	option(String key, String value)	Adds an input option for the underlying data source.
IndexDataFrameReader	query(String query)	Specifies the query to use when querying the layer.
LayerDataFrameReader	queryMetadata(String query)	Specifies the query to use when querying the layer partitions metadata.
IndexDataFrameReader	schema(org.apache.spark.sql.types.StructType schema)	Specifies the schema of the data stored in the layer.

Methods inherited from interface com.here.platform.data.client.spark.LayerDataFrameReader

load, option

Method Details

format

IndexDataFrameReader format(String source)

Description copied from interface: LayerDataFrameReader

Specifies the format of the data stored in the layer.

Specified by:

format in interface LayerDataFrameReader

option

IndexDataFrameReader option(String key,
 double value)

Description copied from interface: LayerDataFrameReader

Adds an input option for the underlying data source.

Specified by:

option in interface LayerDataFrameReader

option

IndexDataFrameReader option(String key,
 long value)

Description copied from interface: LayerDataFrameReader

Adds an input option for the underlying data source.

Specified by:

option in interface LayerDataFrameReader

option

IndexDataFrameReader option(String key,
 boolean value)

Description copied from interface: LayerDataFrameReader

Adds an input option for the underlying data source.

Specified by:

option in interface LayerDataFrameReader

option

IndexDataFrameReader option(String key,
 String value)

Description copied from interface: LayerDataFrameReader

Adds an input option for the underlying data source.

Specified by:

option in interface LayerDataFrameReader

query

IndexDataFrameReader query(String query)

Description copied from interface: LayerDataFrameReader

Specifies the query to use when querying the layer.

Specified by:

query in interface LayerDataFrameReader

Parameters:

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

queryMetadata

LayerDataFrameReader queryMetadata(String query)

Description copied from interface: LayerDataFrameReader

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

Specified by:

queryMetadata in interface LayerDataFrameReader

Parameters:

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

schema

IndexDataFrameReader schema(org.apache.spark.sql.types.StructType schema)

Description copied from interface: LayerDataFrameReader

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.

Specified by:

schema in interface LayerDataFrameReader