DataFrameReader

java.lang.Object
- org.apache.spark.sql.DataFrameReader

All Implemented Interfaces:

Logging
```
public class DataFrameReader
extends java.lang.Object
implements Logging
```
:: Experimental :: Interface used to load a DataFrame from external storage systems (e.g. file systems, key-value stores, etc). Use SQLContext.read to access this.

Since:

1.4.0

Method Summary

Methods
Modifier and Type	Method and Description
`DataFrameReader`	`format(java.lang.String source)` Specifies the input data source format.
`DataFrame`	`jdbc(java.lang.String url, java.lang.String table, java.util.Properties properties)` Construct a `DataFrame` representing the database table accessible via JDBC URL url named table and connection properties.
`DataFrame`	`jdbc(java.lang.String url, java.lang.String table, java.lang.String[] predicates, java.util.Properties connectionProperties)` Construct a `DataFrame` representing the database table accessible via JDBC URL url named table using connection properties.
`DataFrame`	`jdbc(java.lang.String url, java.lang.String table, java.lang.String columnName, long lowerBound, long upperBound, int numPartitions, java.util.Properties connectionProperties)` Construct a `DataFrame` representing the database table accessible via JDBC URL url named table.
`DataFrame`	`json(JavaRDD<java.lang.String> jsonRDD)` Loads an `JavaRDD[String]` storing JSON objects (one object per record) and returns the result as a `DataFrame`.
`DataFrame`	`json(RDD<java.lang.String> jsonRDD)` Loads an `RDD[String]` storing JSON objects (one object per record) and returns the result as a `DataFrame`.
`DataFrame`	`json(scala.collection.Seq<java.lang.String> paths)` Loads a JSON file (one object per line) and returns the result as a `DataFrame`.
`DataFrame`	`json(java.lang.String path)` Loads a JSON file (one object per line) and returns the result as a `DataFrame`.
`DataFrame`	`load()` Loads input in as a `DataFrame`, for data sources that don't require a path (e.g.
`DataFrame`	`load(scala.collection.Seq<java.lang.String> paths)` Loads input in as a `DataFrame`, for data sources that support multiple paths.
`DataFrame`	`load(java.lang.String... paths)` Loads input in as a `DataFrame`, for data sources that support multiple paths.
`DataFrame`	`load(java.lang.String path)` Loads input in as a `DataFrame`, for data sources that require a path (e.g.
`DataFrameReader`	`option(java.lang.String key, java.lang.String value)` Adds an input option for the underlying data source.
`DataFrameReader`	`options(scala.collection.Map<java.lang.String,java.lang.String> options)` (Scala-specific) Adds input options for the underlying data source.
`DataFrameReader`	`options(java.util.Map<java.lang.String,java.lang.String> options)` Adds input options for the underlying data source.
`DataFrame`	`orc(java.lang.String path)` Loads an ORC file and returns the result as a `DataFrame`.
`DataFrame`	`parquet(scala.collection.Seq<java.lang.String> paths)` Loads a Parquet file, returning the result as a `DataFrame`.
`DataFrame`	`parquet(java.lang.String... paths)` Loads a Parquet file, returning the result as a `DataFrame`.
`DataFrameReader`	`schema(StructType schema)` Specifies the input schema.
`DataFrame`	`table(java.lang.String tableName)` Returns the specified table as a `DataFrame`.
`DataFrame`	`text(scala.collection.Seq<java.lang.String> paths)` Loads a text file and returns a `DataFrame` with a single string column named "value".
`DataFrame`	`text(java.lang.String... paths)` Loads a text file and returns a `DataFrame` with a single string column named "value".

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.spark.Logging
initializeIfNecessary, initializeLogging, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

- Method Detail
  - load
```
public DataFrame load(java.lang.String... paths)
```
    Loads input in as a DataFrame, for data sources that support multiple paths. Only works if the source is a HadoopFsRelationProvider.
    
    Parameters:
    paths - (undocumented)
    
    Returns:
    (undocumented)
    Since:
    
    1.6.0
  - parquet
```
public DataFrame parquet(java.lang.String... paths)
```
    Loads a Parquet file, returning the result as a DataFrame. This function returns an empty DataFrame if no paths are passed in.
    
    Parameters:
    paths - (undocumented)
    
    Returns:
    (undocumented)
    Since:
    
    1.4.0
  - text
```
public DataFrame text(java.lang.String... paths)
```
    Loads a text file and returns a DataFrame with a single string column named "value". Each line in the text file is a new row in the resulting DataFrame. For example:
```
   // Scala:
   sqlContext.read.text("/path/to/spark/README.md")

   // Java:
   sqlContext.read().text("/path/to/spark/README.md")
 
```
    Parameters:
    paths - input path
    
    Returns:
    (undocumented)
    Since:
    
    1.6.0
  - format
```
public DataFrameReader format(java.lang.String source)
```
    Specifies the input data source format.
    
    Parameters:
    source - (undocumented)
    
    Returns:
    (undocumented)
    Since:
    
    1.4.0
  - schema
```
public DataFrameReader schema(StructType schema)
```
    Specifies the input schema. Some data sources (e.g. JSON) can infer the input schema automatically from data. By specifying the schema here, the underlying data source can skip the schema inference step, and thus speed up data loading.
    
    Parameters:
    schema - (undocumented)
    
    Returns:
    (undocumented)
    Since:
    
    1.4.0
  - option
```
public DataFrameReader option(java.lang.String key,
                     java.lang.String value)
```
    Adds an input option for the underlying data source.
    
    Parameters:
    key - (undocumented)
    value - (undocumented)
    
    Returns:
    (undocumented)
    Since:
    
    1.4.0
  - options
```
public DataFrameReader options(scala.collection.Map<java.lang.String,java.lang.String> options)
```
    (Scala-specific) Adds input options for the underlying data source.
    
    Parameters:
    options - (undocumented)
    
    Returns:
    (undocumented)
    Since:
    
    1.4.0
  - options
```
public DataFrameReader options(java.util.Map<java.lang.String,java.lang.String> options)
```
    Adds input options for the underlying data source.
    
    Parameters:
    options - (undocumented)
    
    Returns:
    (undocumented)
    Since:
    
    1.4.0
  - load
```
public DataFrame load(java.lang.String path)
```
    Loads input in as a DataFrame, for data sources that require a path (e.g. data backed by a local or distributed file system).
    
    Parameters:
    path - (undocumented)
    
    Returns:
    (undocumented)
    Since:
    
    1.4.0
  - load
```
public DataFrame load()
```
    Loads input in as a DataFrame, for data sources that don't require a path (e.g. external key-value stores).
    
    Returns:
    (undocumented)
    Since:
    
    1.4.0
  - load
```
public DataFrame load(scala.collection.Seq<java.lang.String> paths)
```
    Loads input in as a DataFrame, for data sources that support multiple paths. Only works if the source is a HadoopFsRelationProvider.
    
    Parameters:
    paths - (undocumented)
    
    Returns:
    (undocumented)
    Since:
    
    1.6.0
  - jdbc
```
public DataFrame jdbc(java.lang.String url,
             java.lang.String table,
             java.util.Properties properties)
```
    Construct a DataFrame representing the database table accessible via JDBC URL url named table and connection properties.
    
    Parameters:
    url - (undocumented)
    table - (undocumented)
    properties - (undocumented)
    
    Returns:
    (undocumented)
    Since:
    
    1.4.0
  - jdbc
```
public DataFrame jdbc(java.lang.String url,
             java.lang.String table,
             java.lang.String columnName,
             long lowerBound,
             long upperBound,
             int numPartitions,
             java.util.Properties connectionProperties)
```
    Construct a DataFrame representing the database table accessible via JDBC URL url named table. Partitions of the table will be retrieved in parallel based on the parameters passed to this function.
    Don't create too many partitions in parallel on a large cluster; otherwise Spark might crash your external database systems.
    
    Parameters:
    url - JDBC database url of the form jdbc:subprotocol:subname
    table - Name of the table in the external database.
    columnName - the name of a column of integral type that will be used for partitioning.
    lowerBound - the minimum value of columnName used to decide partition stride
    upperBound - the maximum value of columnName used to decide partition stride
    numPartitions - the number of partitions. the range minValue-maxValue will be split evenly into this many partitions
    connectionProperties - JDBC database connection arguments, a list of arbitrary string tag/value. Normally at least a "user" and "password" property should be included.
    
    Returns:
    (undocumented)
    Since:
    
    1.4.0
  - jdbc
```
public DataFrame jdbc(java.lang.String url,
             java.lang.String table,
             java.lang.String[] predicates,
             java.util.Properties connectionProperties)
```
    Construct a DataFrame representing the database table accessible via JDBC URL url named table using connection properties. The predicates parameter gives a list expressions suitable for inclusion in WHERE clauses; each one defines one partition of the DataFrame.
    Don't create too many partitions in parallel on a large cluster; otherwise Spark might crash your external database systems.
    
    Parameters:
    url - JDBC database url of the form jdbc:subprotocol:subname
    table - Name of the table in the external database.
    predicates - Condition in the where clause for each partition.
    connectionProperties - JDBC database connection arguments, a list of arbitrary string tag/value. Normally at least a "user" and "password" property should be included.
    
    Returns:
    (undocumented)
    Since:
    
    1.4.0
  - json
```
public DataFrame json(java.lang.String path)
```
    Loads a JSON file (one object per line) and returns the result as a DataFrame.
    This function goes through the input once to determine the input schema. If you know the schema in advance, use the version that specifies the schema to avoid the extra scan.
    You can set the following JSON-specific options to deal with non-standard JSON files:
  - primitivesAsString (default false): infers all primitive values as a string type
  - allowComments (default false): ignores Java/C++ style comment in JSON records
  - allowUnquotedFieldNames (default false): allows unquoted JSON field names
  - allowSingleQuotes (default true): allows single quotes in addition to double quotes
  - allowNumericLeadingZeros (default false): allows leading zeros in numbers (e.g. 00012)

Parameters:: path - (undocumented)
Returns:: (undocumented)
Since:: 1.4.0

json
```
public DataFrame json(scala.collection.Seq<java.lang.String> paths)
```
Loads a JSON file (one object per line) and returns the result as a DataFrame.
This function goes through the input once to determine the input schema. If you know the schema in advance, use the version that specifies the schema to avoid the extra scan.
You can set the following JSON-specific options to deal with non-standard JSON files:
primitivesAsString (default false): infers all primitive values as a string type
allowComments (default false): ignores Java/C++ style comment in JSON records
allowUnquotedFieldNames (default false): allows unquoted JSON field names
allowSingleQuotes (default true): allows single quotes in addition to double quotes
allowNumericLeadingZeros (default false): allows leading zeros in numbers (e.g. 00012)

Class DataFrameReader

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.spark.Logging

Method Detail

load

parquet

text

format

schema

option

options

options

load

load

load

jdbc

jdbc

jdbc

json

json

json

json

parquet

orc

table

text