Package io.debezium.spi.converter

Interface RelationalColumn

All Superinterfaces:
ConvertedField
@Incubating public interface RelationalColumn extends ConvertedField
A definition of a converted relational column.
Author:
Randall Hauch

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    charsetName()
    Get the character set associated with the column.
    Object
    defaultValue()
    Get the default value of the column
    boolean
    hasDefaultValue()
    Determine whether this column's has a default value
    boolean
    isOptional()
    Determine whether this column is optional.
    int
    jdbcType()
    Get the JDBC type for this column
    OptionalInt
    length()
    Get the maximum length of this column's values.
    int
    nativeType()
    Get the database native type for this column
    OptionalInt
    scale()
    Get the scale of the column.
    String
    typeExpression()
    Get the database-specific complete expression defining the column's data type, including dimensions, length, precision, character sets, constraints, etc.
    String
    typeName()
    Get the database-specific name of the column's data type.

    Methods inherited from interface io.debezium.spi.converter.ConvertedField

    dataCollection, name

  • Method Details

    • jdbcType

      int jdbcType()
      Get the JDBC type for this column
      Returns:
      the type constant

    • nativeType

      int nativeType()
      Get the database native type for this column
      Returns:
      a type constant for the specific database

    • typeName

      String typeName()
      Get the database-specific name of the column's data type.
      Returns:
      the name of the type

    • typeExpression

      String typeExpression()
      Get the database-specific complete expression defining the column's data type, including dimensions, length, precision, character sets, constraints, etc.
      Returns:
      the complete type expression

    • length

      OptionalInt length()
      Get the maximum length of this column's values. For numeric columns, this represents the precision.
      Returns:
      the length of the column

    • scale

      OptionalInt scale()
      Get the scale of the column.
      Returns:
      the scale if it applies to this type

    • isOptional

      boolean isOptional()
      Determine whether this column is optional.
      Returns:
      true if it is optional, or false otherwise

    • defaultValue

      Object defaultValue()
      Get the default value of the column
      Returns:
      the default value

    • hasDefaultValue

      boolean hasDefaultValue()
      Determine whether this column's has a default value
      Returns:
      true if the default value was provided, or false otherwise

    • charsetName

      default String charsetName()
      Get the character set associated with the column.
      Returns:
      the character set name