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

Class DecimalType

java.lang.Object
org.apache.flink.table.types.logical.LogicalType
org.apache.flink.table.types.logical.DecimalType
All Implemented Interfaces:
Serializable
@PublicEvolving public final class DecimalType extends LogicalType
Logical type of a decimal number with fixed precision and scale.

The serialized string representation is DECIMAL(p, s) where p is the number of digits in a number (=precision) and s is the number of digits to the right of the decimal point in a number (=scale). p must have a value between 1 and 38 (both inclusive). s must have a value between 0 and p (both inclusive). The default value for p is 10. The default value for s is 0. NUMERIC(p, s) and DEC(p, s) are synonyms for this type.

See Also:

  • Field Details

  • Constructor Details

    • DecimalType

      public DecimalType(boolean isNullable, int precision, int scale)

    • DecimalType

      public DecimalType(int precision, int scale)

    • DecimalType

      public DecimalType(int precision)

    • DecimalType

      public DecimalType()

  • Method Details

    • getPrecision

      public int getPrecision()

    • getScale

      public int getScale()

    • 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:

    • 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:

    • getDefaultConversion

      public Class<?> getDefaultConversion()
      Description copied from class: LogicalType
      Returns the default conversion class. A value of this logical type is expected to be an instance of the given class when entering or is represented as an instance of the given class when leaving the table ecosystem if no other conversion has been specified.

      For example, java.lang.Long is the default input and output for BIGINT.

      Specified by:
      getDefaultConversion in class LogicalType
      Returns:
      default class to represent values of this logical type
      See Also:

    • getChildren

      public List<LogicalType> getChildren()
      Specified by:
      getChildren in class LogicalType

    • accept

      public <R> R accept(LogicalTypeVisitor<R> visitor)
      Specified by:
      accept in class LogicalType

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class LogicalType

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class LogicalType