Package org.apache.flink.table.types.logical

Class DayTimeIntervalType

  • All Implemented Interfaces:
    Serializable
    @PublicEvolving
public final class DayTimeIntervalType
extends LogicalType
    Logical type for a group of day-time interval types. The type must be parameterized to one of the following resolutions with up to nanosecond precision: interval of days, interval of days to hours, interval of days to minutes, interval of days to seconds, interval of hours, interval of hours to minutes, interval of hours to seconds, interval of minutes, interval of minutes to seconds, or interval of seconds.

    An interval of day-time consists of +days hours:months:seconds.fractional with values ranging from -999999 23:59:59.999999999 to +999999 23:59:59.999999999. The value representation is the same for all types of resolutions. For example, an interval of seconds of 70 is always represented in an interval-of-days-to-seconds format (with default precisions): +00 00:01:10.000000.

    The serialized string representation is INTERVAL DAY(p1), INTERVAL DAY(p1) TO HOUR, INTERVAL DAY(p1) TO MINUTE, INTERVAL DAY(p1) TO SECOND(p2), INTERVAL HOUR, INTERVAL HOUR TO MINUTE, INTERVAL HOUR TO SECOND(p2), INTERVAL MINUTE, INTERVAL MINUTE TO SECOND(p2), or INTERVAL SECOND(p2) where p1 is the number of digits of days (=day precision) and p2 is the number of digits of fractional seconds (=fractional precision). p1 must have a value between 1 and 6 (both inclusive). p2 must have a value between 0 and 9 (both inclusive). If no p1 is specified, it is equal to 2 by default. If no p2 is specified, it is equal to 6 by default.

    A conversion from and to long describes the number of milliseconds.

    See Also:
    YearMonthIntervalType, Serialized Form

    • Method Detail

      • getDayPrecision

        public int getDayPrecision()

      • getFractionalPrecision

        public int getFractionalPrecision()

      • copy

        public LogicalType copy​(boolean isNullable)
        Description copied from class: LogicalType
        Returns a deep copy of this type with possibly different nullability.
        Specified by:
        copy in class LogicalType
        Parameters:
        isNullable - the intended nullability of the copied type
        Returns:
        a deep copy

      • asSerializableString

        public String asSerializableString()
        Description copied from class: LogicalType
        Returns a string that fully serializes this instance. The serialized string can be used for transmitting or persisting a type.

        See LogicalTypeParser for the reverse operation.

        Specified by:
        asSerializableString in class LogicalType
        Returns:
        detailed string for transmission or persistence

      • supportsInputConversion

        public boolean supportsInputConversion​(Class<?> clazz)
        Description copied from class: LogicalType
        Returns whether an instance of the given class can be represented as a value of this logical type when entering the table ecosystem. This method helps for the interoperability between JVM-based languages and the relational type system.

        A supported conversion directly maps an input class to a logical type without loss of precision or type widening.

        For example, java.lang.Long or long can be used as input for BIGINT independent of the set nullability.

        Specified by:
        supportsInputConversion in class LogicalType
        Parameters:
        clazz - input class to be converted into this logical type
        Returns:
        flag that indicates if instances of this class can be used as input into the table ecosystem
        See Also:
        LogicalType.getDefaultConversion()

      • supportsOutputConversion

        public boolean supportsOutputConversion​(Class<?> clazz)
        Description copied from class: LogicalType
        Returns whether a value of this logical type can be represented as an instance of the given class when leaving the table ecosystem. This method helps for the interoperability between JVM-based languages and the relational type system.

        A supported conversion directly maps a logical type to an output class without loss of precision or type widening.

        For example, java.lang.Long or long can be used as output for BIGINT if the type is not nullable. If the type is nullable, only java.lang.Long can represent this.

        Specified by:
        supportsOutputConversion in class LogicalType
        Parameters:
        clazz - output class to be converted from this logical type
        Returns:
        flag that indicates if instances of this class can be used as output from the table ecosystem
        See Also:
        LogicalType.getDefaultConversion()