Packages

c

org.apache.spark.sql.catalyst.util

DefaultTimestampFormatter

class DefaultTimestampFormatter extends Iso8601TimestampFormatter

The formatter for timestamps which doesn't require users to specify a pattern. While formatting, it uses the default pattern TimestampFormatter.defaultPattern(). In parsing, it follows the CAST logic in conversion of strings to Catalyst's TimestampType.

Linear Supertypes
Iso8601TimestampFormatter, DateTimeFormatterHelper, TimestampFormatter, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultTimestampFormatter
  2. Iso8601TimestampFormatter
  3. DateTimeFormatterHelper
  4. TimestampFormatter
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DefaultTimestampFormatter(zoneId: ZoneId, locale: Locale, legacyFormat: LegacyDateFormat = LENIENT_SIMPLE_DATE_FORMAT, isParsing: Boolean)

    zoneId

    The time zone ID in which timestamps should be formatted or parsed.

    locale

    The locale overrides the system locale and is used in formatting.

    legacyFormat

    Defines the formatter used for legacy timestamps.

    isParsing

    Whether the formatter is used for parsing (true) or for formatting (false).

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 checkFormattedDiff[T <: Date](d: T, legacyFormatFunc: (T) ⇒ String): PartialFunction[Throwable, String]
    Attributes
    protected
    Definition Classes
    DateTimeFormatterHelper
  6. def checkInvalidPattern(pattern: String): PartialFunction[Throwable, Nothing]
    Attributes
    protected
    Definition Classes
    DateTimeFormatterHelper
  7. def checkLegacyFormatter(pattern: String, tryLegacyFormatter: ⇒ Unit): PartialFunction[Throwable, DateTimeFormatter]

    When the new DateTimeFormatter failed to initialize because of invalid datetime pattern, it will throw IllegalArgumentException.

    When the new DateTimeFormatter failed to initialize because of invalid datetime pattern, it will throw IllegalArgumentException. If the pattern can be recognized by the legacy formatter it will raise SparkUpgradeException to tell users to restore the previous behavior via LEGACY policy or follow our guide to correct their pattern. Otherwise, the original IllegalArgumentException will be thrown.

    pattern

    the date time pattern

    tryLegacyFormatter

    a func to capture exception, identically which forces a legacy datetime formatter to be initialized

    Attributes
    protected
    Definition Classes
    DateTimeFormatterHelper
  8. def checkParsedDiff[T](s: String, legacyParseFunc: (String) ⇒ T): PartialFunction[Throwable, T]
    Attributes
    protected
    Definition Classes
    DateTimeFormatterHelper
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def format(localDateTime: LocalDateTime): String
    Definition Classes
    Iso8601TimestampFormatter → TimestampFormatter
  13. def format(ts: Timestamp): String
    Definition Classes
    Iso8601TimestampFormatter → TimestampFormatter
  14. def format(us: Long): String
    Definition Classes
    Iso8601TimestampFormatter → TimestampFormatter
  15. def format(instant: Instant): String
    Definition Classes
    Iso8601TimestampFormatter → TimestampFormatter
  16. lazy val formatter: DateTimeFormatter
    Attributes
    protected
    Definition Classes
    Iso8601TimestampFormatter
    Annotations
    @transient()
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def getOrCreateFormatter(pattern: String, locale: Locale, isParsing: Boolean): DateTimeFormatter
    Attributes
    protected
    Definition Classes
    DateTimeFormatterHelper
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. lazy val legacyFormatter: TimestampFormatter
    Attributes
    protected
    Definition Classes
    Iso8601TimestampFormatter
    Annotations
    @transient()
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def parse(s: String): Long

    Parses a timestamp in a string and converts it to microseconds.

    Parses a timestamp in a string and converts it to microseconds.

    s

    - string with timestamp to parse

    returns

    microseconds since epoch.

    Definition Classes
    DefaultTimestampFormatter → Iso8601TimestampFormatter → TimestampFormatter
    Exceptions thrown

    DateTimeException unable to obtain local date or time

    DateTimeParseException can be thrown by new parser

    ParseException can be thrown by legacy parser

  26. def parseOptional(s: String): Option[Long]

    Parses a timestamp in a string and converts it to an optional number of microseconds.

    Parses a timestamp in a string and converts it to an optional number of microseconds.

    s

    - string with timestamp to parse

    returns

    An optional number of microseconds since epoch. The result is None on invalid input.

    Definition Classes
    DefaultTimestampFormatter → TimestampFormatter
    Exceptions thrown

    DateTimeException unable to obtain local date or time

    DateTimeParseException can be thrown by new parser

    ParseException can be thrown by legacy parser

  27. def parseWithoutTimeZone(s: String, allowTimeZone: Boolean): Long

    Parses a timestamp in a string and converts it to microseconds since Unix Epoch in local time.

    Parses a timestamp in a string and converts it to microseconds since Unix Epoch in local time.

    s

    - string with timestamp to parse

    allowTimeZone

    - indicates strict parsing of timezone

    returns

    microseconds since epoch.

    Definition Classes
    DefaultTimestampFormatter → Iso8601TimestampFormatter → TimestampFormatter
    Exceptions thrown

    DateTimeException unable to obtain local date or time

    DateTimeParseException can be thrown by new parser

    IllegalStateException The formatter for timestamp without time zone should always implement this method. The exception should never be hit.

    ParseException can be thrown by legacy parser

  28. final def parseWithoutTimeZone(s: String): Long

    Parses a timestamp in a string and converts it to microseconds since Unix Epoch in local time.

    Parses a timestamp in a string and converts it to microseconds since Unix Epoch in local time. Zone-id and zone-offset components are ignored.

    Definition Classes
    TimestampFormatter
    Annotations
    @throws( classOf[ParseException] ) @throws( classOf[DateTimeParseException] ) @throws( classOf[DateTimeException] ) @throws( classOf[IllegalStateException] )
  29. def parseWithoutTimeZoneOptional(s: String, allowTimeZone: Boolean): Option[Long]

    Parses a timestamp in a string and converts it to an optional number of microseconds since Unix Epoch in local time.

    Parses a timestamp in a string and converts it to an optional number of microseconds since Unix Epoch in local time.

    s

    - string with timestamp to parse

    allowTimeZone

    - indicates strict parsing of timezone

    returns

    An optional number of microseconds since epoch. The result is None on invalid input.

    Definition Classes
    DefaultTimestampFormatter → TimestampFormatter
    Exceptions thrown

    DateTimeException unable to obtain local date or time

    DateTimeParseException can be thrown by new parser

    IllegalStateException The formatter for timestamp without time zone should always implement this method. The exception should never be hit.

    ParseException can be thrown by legacy parser

  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toLocalDate(accessor: TemporalAccessor): LocalDate
    Attributes
    protected
    Definition Classes
    DateTimeFormatterHelper
  32. def toLocalTime(accessor: TemporalAccessor): LocalTime
    Attributes
    protected
    Definition Classes
    DateTimeFormatterHelper
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. def toZonedDateTime(accessor: TemporalAccessor, zoneId: ZoneId): ZonedDateTime
    Attributes
    protected
    Definition Classes
    DateTimeFormatterHelper
  35. def validatePatternString(checkLegacy: Boolean): Unit

    Validates the pattern string.

    Validates the pattern string.

    checkLegacy

    if true and the pattern is invalid, check whether the pattern is valid for legacy formatters and show hints for using legacy formatter. Otherwise, simply check the pattern string.

    Definition Classes
    Iso8601TimestampFormatter → TimestampFormatter
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from Iso8601TimestampFormatter

Inherited from DateTimeFormatterHelper

Inherited from TimestampFormatter

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped