Package org.mariadb.jdbc.message.server

Class ColumnDefinitionPacket

java.lang.Object
org.mariadb.jdbc.message.server.ColumnDefinitionPacket
All Implemented Interfaces:
Column, ServerMessage
Direct Known Subclasses:
BigDecimalColumn, BitColumn, DateColumn, DoubleColumn, FloatColumn, SignedBigIntColumn, SignedIntColumn, SignedMediumIntColumn, SignedSmallIntColumn, SignedTinyIntColumn, StringColumn, TimeColumn, TimestampColumn, UnsignedBigIntColumn, UnsignedIntColumn, UnsignedMediumIntColumn, UnsignedSmallIntColumn, UnsignedTinyIntColumn, UuidColumn
public class ColumnDefinitionPacket extends Object implements Column, ServerMessage
Column metadata definition

  • Field Details

    • charset

      protected final int charset
      charset

    • columnLength

      protected final long columnLength
      column maximum length

    • dataType

      protected final DataType dataType
      data type @see Field type

    • decimals

      protected final byte decimals
      number of decimal

    • extTypeName

      protected final String extTypeName
      extended type name

    • extTypeFormat

      protected final String extTypeFormat
      extended type format

    • buf

      private final ReadableByteBuf buf

    • flags

      private final int flags
      See Also:

    • stringPos

      private final int[] stringPos
      string offset position in buffer

    • useAliasAsName

      private final boolean useAliasAsName
      configuration: use alias as name

  • Constructor Details

    • ColumnDefinitionPacket

      public ColumnDefinitionPacket(ReadableByteBuf buf, int charset, long columnLength, DataType dataType, byte decimals, int flags, int[] stringPos, String extTypeName, String extTypeFormat, boolean useAliasAsName)
      Column definition constructor
      Parameters:
      buf - buffer
      charset - charset
      columnLength - maxium column length
      dataType - data type
      decimals - decimal length
      flags - flags
      stringPos - string position indexes
      extTypeName - extended type name
      extTypeFormat - extended type format
      useAliasAsName - use alias as name

    • ColumnDefinitionPacket

      protected ColumnDefinitionPacket(ColumnDefinitionPacket prev, boolean useAliasAsName)

  • Method Details

    • getCatalog

      public String getCatalog()
      Description copied from interface: Column
      get column catalog
      Specified by:
      getCatalog in interface Column
      Returns:
      column catalog

    • getSchema

      public String getSchema()
      Description copied from interface: Column
      get column schema
      Specified by:
      getSchema in interface Column
      Returns:
      column schema

    • getTableAlias

      public String getTableAlias()
      Description copied from interface: Column
      retrieve table alias if any
      Specified by:
      getTableAlias in interface Column
      Returns:
      table alias

    • getTable

      public String getTable()
      Description copied from interface: Column
      retrieve table name if any
      Specified by:
      getTable in interface Column
      Returns:
      table name

    • getColumnAlias

      public String getColumnAlias()
      Description copied from interface: Column
      retrieve column alias if any
      Specified by:
      getColumnAlias in interface Column
      Returns:
      column alias

    • getColumnName

      public String getColumnName()
      Description copied from interface: Column
      retrieve column name if any
      Specified by:
      getColumnName in interface Column
      Returns:
      column name

    • getColumnLength

      public long getColumnLength()
      Description copied from interface: Column
      column maximum length if known
      Specified by:
      getColumnLength in interface Column
      Returns:
      column maximum length

    • getType

      public DataType getType()
      Description copied from interface: Column
      server data type
      Specified by:
      getType in interface Column
      Returns:
      server data type

    • getDecimals

      public byte getDecimals()
      Description copied from interface: Column
      get number of decimal
      Specified by:
      getDecimals in interface Column
      Returns:
      number of decimal

    • isSigned

      public boolean isSigned()
      Description copied from interface: Column
      Is column signed (for number only)
      Specified by:
      isSigned in interface Column
      Returns:
      is signed

    • getDisplaySize

      public int getDisplaySize()
      Description copied from interface: Column
      get display size
      Specified by:
      getDisplaySize in interface Column
      Returns:
      display sier

    • isPrimaryKey

      public boolean isPrimaryKey()
      Description copied from interface: Column
      Is column a primary key
      Specified by:
      isPrimaryKey in interface Column
      Returns:
      is a primary key

    • isAutoIncrement

      public boolean isAutoIncrement()
      Description copied from interface: Column
      Column autoincrement
      Specified by:
      isAutoIncrement in interface Column
      Returns:
      true if column auto-increment

    • hasDefault

      public boolean hasDefault()
      Description copied from interface: Column
      Column has a default value
      Specified by:
      hasDefault in interface Column
      Returns:
      indicate if has a default value

    • isBinary

      public boolean isBinary()
      Description copied from interface: Column
      indicate if column is of binary type. doesn't use flag BINARY filter, because char binary and varchar binary are not binary (handle like string), but have binary flag
      Specified by:
      isBinary in interface Column
      Returns:
      is column type binary

    • getFlags

      public int getFlags()
      Description copied from interface: Column
      Retrieve metadata flag
      Specified by:
      getFlags in interface Column
      Returns:
      metadata flag

    • getExtTypeName

      public String getExtTypeName()
      Description copied from interface: Column
      retrieve extended metadata name if any
      Specified by:
      getExtTypeName in interface Column
      Returns:
      extended metadata name

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object