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

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

  21. 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.

  22. 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 ""

  23. val enableDateTimeParsingFallback: Option[Boolean]
  24. 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.

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

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

    A string between two consecutive JSON records.

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

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

  77. val multiLine: Boolean
  78. val nanValue: String
  79. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  80. def needHeaderForSingleVariantColumn: Boolean
  81. val negativeInf: String
  82. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  83. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  84. val nullValue: String
  85. val parameters: CaseInsensitiveMap[String]
  86. val parseMode: ParseMode
  87. val positiveInf: String
  88. 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

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

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

  100. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  101. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  102. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  103. def withLogContext(context: Map[String, String])(body: => Unit): Unit
    Attributes
    protected
    Definition Classes
    Logging
  104. 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