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

Class BinaryType

  • All Implemented Interfaces:
    Serializable
    @PublicEvolving
public final class BinaryType
extends LogicalType
    Logical type of a fixed-length binary string (=a sequence of bytes).

    The serialized string representation is BINARY(n) where n is the number of bytes. n must have a value between 1 and Integer.MAX_VALUE (both inclusive). If no length is specified, n is equal to 1.

    For expressing a zero-length binary string literal, this type does also support n to be 0. However, this is not exposed through the API.

    See Also:
    Serialized Form

    • Constructor Detail

      • BinaryType

        public BinaryType​(boolean isNullable,
                  int length)

      • BinaryType

        public BinaryType​(int length)

      • BinaryType

        public BinaryType()

    • Method Detail

      • ofEmptyLiteral

        public static BinaryType ofEmptyLiteral()
        The SQL standard defines that character string literals are allowed to be zero-length strings (i.e., to contain no characters) even though it is not permitted to declare a type that is zero. For consistent behavior, the same logic applies to binary strings.

        This method enables this special kind of binary string.

        Zero-length binary strings have no serializable string representation.

      • getLength

        public int getLength()

      • 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

      • asSummaryString

        public String asSummaryString()
        Description copied from class: LogicalType
        Returns a string that summarizes this type for printing to a console. An implementation might shorten long names or skips very specific properties.

        Use LogicalType.asSerializableString() for a type string that fully serializes this instance.

        Overrides:
        asSummaryString in class LogicalType
        Returns:
        summary string of this type for debugging purposes

      • 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()