DataFrameReader

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[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

6. def csv(paths: String*): DataFrame

   

   Loads a CSV file and returns the result as a DataFrame.

   Loads a CSV file and returns the result as a DataFrame.

   This function goes through the input once to determine the input schema. To avoid going through the entire data once, specify the schema explicitly using schema.

   You can set the following CSV-specific options to deal with CSV files:

   • sep (default ,): sets the single character as a separator for each field and value.
   • encoding (default UTF-8): decodes the CSV files by the given encoding type.
   • quote (default "): sets the single character used for escaping quoted values where the separator can be part of the value.
   • escape (default \): sets the single character used for escaping quotes inside an already quoted value.
   • comment (default empty string): sets the single character used for skipping lines beginning with this character. By default, it is disabled.
   • header (default false): uses the first line as names of columns.
   • ignoreLeadingWhiteSpace (default false): defines whether or not leading whitespaces from values being read should be skipped.
   • ignoreTrailingWhiteSpace (default false): defines whether or not trailing whitespaces from values being read should be skipped.
   • nullValue (default empty string): sets the string representation of a null value.
   • nanValue (default NaN): sets the string representation of a non-number" value.
   • positiveInf (default Inf): sets the string representation of a positive infinity value.
   • negativeInf (default -Inf): sets the string representation of a negative infinity value.
   • dateFormat (default null): sets the string that indicates a date format. Custom date formats follow the formats at java.text.SimpleDateFormat. This applies to both date type and timestamp type. By default, it is null which means trying to parse times and date by java.sql.Timestamp.valueOf() and java.sql.Date.valueOf().
   • maxColumns (default 20480): defines a hard limit of how many columns a record can have.
   • maxCharsPerColumn (default 1000000): defines the maximum number of characters allowed for any given value being read.
   • mode (default PERMISSIVE): allows a mode for dealing with corrupt records during parsing.
   • PERMISSIVE : sets other fields to null when it meets a corrupted record. When a schema is set by user, it sets null for extra fields.
   • DROPMALFORMED : ignores the whole corrupted records.
   • FAILFAST : throws an exception when it meets corrupted records.

   Annotations

   @varargs()

   Since

   2.0.0

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

   

   Definition Classes

   AnyRef

8. def equals(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

9. def finalize(): Unit

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( classOf[java.lang.Throwable] )

10. def format(source: String): DataFrameReader

    

    Specifies the input data source format.

    Specifies the input data source format.

    Since

    1.4.0

11. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

12. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

13. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

14. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

15. def isTraceEnabled(): Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

16. def jdbc(url: String, table: String, predicates: Array[String], connectionProperties: Properties): DataFrame

    

    Construct a DataFrame representing the database table accessible via JDBC URL url named table using connection properties.

    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.

    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.

    Since

    1.4.0

17. def jdbc(url: String, table: String, columnName: String, lowerBound: Long, upperBound: Long, numPartitions: Int, connectionProperties: Properties): DataFrame

    

    Construct a DataFrame representing the database table accessible via JDBC URL url named table.

    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.

    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. This, along with lowerBound (inclusive), upperBound (exclusive), form partition strides for generated WHERE clause expressions used to split the column columnName evenly.

    connectionProperties

    JDBC database connection arguments, a list of arbitrary string tag/value. Normally at least a "user" and "password" property should be included.

    Since

    1.4.0

18. def jdbc(url: String, table: String, properties: Properties): DataFrame

    

    Construct a DataFrame representing the database table accessible via JDBC URL url named table and connection properties.

    Construct a DataFrame representing the database table accessible via JDBC URL url named table and connection properties.

    Since

    1.4.0

19. def json(jsonRDD: RDD[String]): DataFrame

    

    Loads an RDD[String] storing JSON objects (one object per record) and returns the result as a DataFrame.

    Loads an RDD[String] storing JSON objects (one object per record) and returns the result as a DataFrame.

    Unless the schema is specified using schema function, this function goes through the input once to determine the input schema.

    jsonRDD

    input RDD with one JSON object per record

    Since

    1.4.0

20. def json(jsonRDD: JavaRDD[String]): DataFrame

    

    Loads an JavaRDD[String] storing JSON objects (one object per record) and returns the result as a DataFrame.

    Loads an JavaRDD[String] storing JSON objects (one object per record) and returns the result as a DataFrame.

    Unless the schema is specified using schema function, this function goes through the input once to determine the input schema.

    jsonRDD

    input RDD with one JSON object per record

    Since

    1.4.0

21. def json(paths: String*): DataFrame

    

    Loads a JSON file (one object per line) and returns the result as a DataFrame.

    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
    • prefersDecimal (default false): infers all floating-point values as a decimal type. If the values do not fit in decimal, then it infers them as doubles.
    • 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)
    • allowBackslashEscapingAnyCharacter (default false): allows accepting quoting of all character using backslash quoting mechanism
    • mode (default PERMISSIVE): allows a mode for dealing with corrupt records during parsing.
    • PERMISSIVE : sets other fields to null when it meets a corrupted record, and puts the malformed string into a new field configured by columnNameOfCorruptRecord. When a schema is set by user, it sets null for extra fields.
    • DROPMALFORMED : ignores the whole corrupted records.
    • FAILFAST : throws an exception when it meets corrupted records.
    • columnNameOfCorruptRecord (default _corrupt_record): allows renaming the new field having malformed string created by PERMISSIVE mode. This overrides spark.sql.columnNameOfCorruptRecord.

    Annotations

    @varargs()

    Since

    1.6.0

22. def load(paths: String*): DataFrame

    

    Loads input in as a DataFrame, for data sources that support multiple paths.

    Loads input in as a DataFrame, for data sources that support multiple paths. Only works if the source is a HadoopFsRelationProvider.

    Annotations

    @varargs()

    Since

    1.6.0

23. def load(path: String): DataFrame

    

    Loads input in as a DataFrame, for data sources that require a path (e.g.

    Loads input in as a DataFrame, for data sources that require a path (e.g. data backed by a local or distributed file system).

    Since

    1.4.0

24. def load(): DataFrame

    

    Loads input in as a DataFrame, for data sources that don't require a path (e.g.

    Loads input in as a DataFrame, for data sources that don't require a path (e.g. external key-value stores).

    Since

    1.4.0

25. def log: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

26. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

27. def logDebug(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

28. def logError(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

29. def logError(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

30. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

31. def logInfo(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

32. def logName: String

    

    Attributes

    protected

    Definition Classes

    Logging

33. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

34. def logTrace(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

35. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

36. def logWarning(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Definition Classes

    AnyRef

38. final def notify(): Unit

    

    Definition Classes

    AnyRef

39. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

40. def option(key: String, value: Double): DataFrameReader

    

    Adds an input option for the underlying data source.

    Adds an input option for the underlying data source.

    Since

    2.0.0

41. def option(key: String, value: Long): DataFrameReader

    

    Adds an input option for the underlying data source.

    Adds an input option for the underlying data source.

    Since

    2.0.0

42. def option(key: String, value: Boolean): DataFrameReader

    

    Adds an input option for the underlying data source.

    Adds an input option for the underlying data source.

    Since

    2.0.0

43. def option(key: String, value: String): DataFrameReader

    

    Adds an input option for the underlying data source.

    Adds an input option for the underlying data source.

    Since

    1.4.0

44. def options(options: Map[String, String]): DataFrameReader

    

    Adds input options for the underlying data source.

    Adds input options for the underlying data source.

    Since

    1.4.0

45. def options(options: Map[String, String]): DataFrameReader

    

    (Scala-specific) Adds input options for the underlying data source.

    (Scala-specific) Adds input options for the underlying data source.

    Since

    1.4.0

46. def orc(path: String): DataFrame

    

    Loads an ORC file and returns the result as a DataFrame.

    Loads an ORC file and returns the result as a DataFrame.

    path

    input path

    Since

    1.5.0

    Note

    Currently, this method can only be used together with HiveContext.

47. def parquet(paths: String*): DataFrame

    

    Loads a Parquet file, returning the result as a DataFrame.

    Loads a Parquet file, returning the result as a DataFrame. This function returns an empty DataFrame if no paths are passed in.

    Annotations

    @varargs()

    Since

    1.4.0

48. def schema(schema: StructType): DataFrameReader

    

    Specifies the input 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.

    Since

    1.4.0

49. def stream(path: String): DataFrame

    

    :: Experimental :: Loads input in as a DataFrame, for data streams that read from some path.

    :: Experimental :: Loads input in as a DataFrame, for data streams that read from some path.

    Annotations

    @Experimental()

    Since

    2.0.0

50. def stream(): DataFrame

    

    :: Experimental :: Loads input data stream in as a DataFrame, for data streams that don't require a path (e.g.

    :: Experimental :: Loads input data stream in as a DataFrame, for data streams that don't require a path (e.g. external key-value stores).

    Annotations

    @Experimental()

    Since

    2.0.0

51. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

52. def table(tableName: String): DataFrame

    

    Returns the specified table as a DataFrame.

    Returns the specified table as a DataFrame.

    Since

    1.4.0

53. def text(paths: String*): Dataset[String]

    

    Loads a text file and returns a Dataset of String.

    Loads a text file and returns a Dataset of String. The underlying schema of the Dataset contains a single string column named "value".

    Each line in the text file is a new row in the resulting Dataset. For example:

    // Scala:
    spark.read.text("/path/to/spark/README.md")
    
    // Java:
    spark.read().text("/path/to/spark/README.md")

    paths

    input path

    Annotations

    @varargs()

    Since

    2.0.0

54. def toString(): String

    

    Definition Classes

    AnyRef → Any

55. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

56. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

57. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )