Packages

class CSVOptions extends FileSourceOptions with Logging

Linear Supertypes
Logging, FileSourceOptions, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CSVOptions
  2. Logging
  3. FileSourceOptions
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CSVOptions(parameters: Map[String, String], columnPruning: Boolean, defaultTimeZoneId: String, defaultColumnNameOfCorruptRecord: String)
  2. new CSVOptions(parameters: Map[String, String], columnPruning: Boolean, defaultTimeZoneId: String)
  3. new CSVOptions(parameters: CaseInsensitiveMap[String], columnPruning: Boolean, defaultTimeZoneId: String, defaultColumnNameOfCorruptRecord: String)

Type Members

  1. implicit class LogStringContext extends AnyRef
    Definition Classes
    Logging

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 asParserSettings: CsvParserSettings
  6. def asWriterSettings: CsvWriterSettings
  7. val charToEscapeQuoteEscaping: Option[Char]
  8. val charset: String
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  10. val columnNameOfCorruptRecord: String
  11. val columnPruning: Boolean
  12. val comment: Char
  13. def commonTimestampFormat: String
    Attributes
    protected
    Definition Classes
    FileSourceOptions
  14. val compressionCodec: Option[String]
  15. val dateFormatInRead: Option[String]
  16. val dateFormatInWrite: String
  17. val dateFormatOption: Option[String]
  18. val delimiter: String
  19. val emptyValue: Option[String]

    String representation of an empty value in read and in write.

  20. val emptyValueInRead: String

    The string is returned when CSV reader doesn't have any characters for input value, or an empty quoted string "".

    The string is returned when CSV reader doesn't have any characters for input value, or an empty quoted string "". Default value is empty string.

  21. val emptyValueInWrite: String

    The value is used instead of an empty string in write.

    The value is used instead of an empty string in write. Default value is ""

  22. val enableDateTimeParsingFallback: Option[Boolean]
  23. val enforceSchema: Boolean

    Forcibly apply the specified or inferred schema to datasource files.

    Forcibly apply the specified or inferred schema to datasource files. If the option is enabled, headers of CSV files will be ignored.

  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  26. val escape: Char
  27. val escapeQuotes: Boolean
  28. val extension: String
  29. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  31. val headerFlag: Boolean
  32. val ignoreCorruptFiles: Boolean
    Definition Classes
    FileSourceOptions
  33. val ignoreLeadingWhiteSpaceFlagInWrite: Boolean
  34. val ignoreLeadingWhiteSpaceInRead: Boolean
  35. val ignoreMissingFiles: Boolean
    Definition Classes
    FileSourceOptions
  36. val ignoreTrailingWhiteSpaceFlagInWrite: Boolean
  37. val ignoreTrailingWhiteSpaceInRead: Boolean
  38. val inferSchemaFlag: Boolean
  39. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  40. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  41. val inputBufferSize: Option[Int]
  42. def isColumnPruningEnabled(schema: StructType): Boolean

    Returns true if column pruning is enabled and there are no existence column default values in the schema.

    Returns true if column pruning is enabled and there are no existence column default values in the schema.

    The column pruning feature can be enabled either via the CSV option columnPruning or in non-multiline mode via initialization of CSV options by the SQL config: spark.sql.csv.parser.columnPruning.enabled. The feature is disabled in the multiLine mode because of the issue: https://github.com/uniVocity/univocity-parsers/issues/529

    We disable column pruning when there are any column defaults, instead preferring to reach in each row and then post-process it to substitute the default values after.

  43. val isCommentSet: Boolean
  44. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  45. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  46. val lineSeparator: Option[String]

    A string between two consecutive JSON records.

  47. val lineSeparatorInRead: Option[Array[Byte]]
  48. val lineSeparatorInWrite: Option[String]
  49. val locale: Locale
  50. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  51. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logDebug(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logDebug(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logError(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def logError(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logInfo(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logInfo(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  64. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logTrace(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logTrace(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logWarning(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logWarning(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. val maxCharsPerColumn: Int
  73. val maxColumns: Int
  74. val maxErrorContentLength: Int

    The max error content length in CSV parser/writer exception message.

  75. val multiLine: Boolean
  76. val nanValue: String
  77. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  78. val negativeInf: String
  79. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  80. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  81. val nullValue: String
  82. val parameters: CaseInsensitiveMap[String]
  83. val parseMode: ParseMode
  84. val positiveInf: String
  85. val preferDate: Boolean

    Infer columns with all valid date entries as date type (otherwise inferred as string or timestamp type) if schema inference is enabled.

    Infer columns with all valid date entries as date type (otherwise inferred as string or timestamp type) if schema inference is enabled.

    Enabled by default.

    Not compatible with legacyTimeParserPolicy == LEGACY since legacy date parser will accept extra trailing characters. Thus, disabled when legacyTimeParserPolicy == LEGACY

  86. val quote: Char
  87. val quoteAll: Boolean
  88. val samplingRatio: Double
  89. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  90. val timestampFormatInRead: Option[String]
  91. val timestampFormatInWrite: String
  92. val timestampNTZFormatInRead: Option[String]
  93. val timestampNTZFormatInWrite: String
  94. def toString(): String
    Definition Classes
    AnyRef → Any
  95. val unescapedQuoteHandling: UnescapedQuoteHandling

    The handling method to be used when unescaped quotes are found in the input.

  96. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  97. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  98. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  99. def withLogContext(context: Map[String, String])(body: => Unit): Unit
    Attributes
    protected
    Definition Classes
    Logging
  100. val zoneId: ZoneId

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Logging

Inherited from FileSourceOptions

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped