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
Column metadata definition
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ReadableByteBuf
protected final int
charsetprotected final long
column maximum lengthprotected final DataType
data type @see Field typeprotected final byte
number of decimalprotected final String
extended type formatprotected final String
extended type nameprivate final int
private final int[]
string offset position in bufferprivate final boolean
configuration: use alias as name -
Constructor Summary
ConstructorsModifierConstructorDescriptionColumnDefinitionPacket
(ReadableByteBuf buf, int charset, long columnLength, DataType dataType, byte decimals, int flags, int[] stringPos, String extTypeName, String extTypeFormat, boolean useAliasAsName) Column definition constructorprotected
ColumnDefinitionPacket
(ColumnDefinitionPacket prev, boolean useAliasAsName) -
Method Summary
Modifier and TypeMethodDescriptionboolean
get column catalogretrieve column alias if anylong
column maximum length if knownretrieve column name if anybyte
get number of decimalint
get display sizeretrieve extended metadata name if anyint
getFlags()
Retrieve metadata flagget column schemagetTable()
retrieve table name if anyretrieve table alias if anygetType()
server data typeboolean
Column has a default valueint
hashCode()
boolean
Column autoincrementboolean
isBinary()
indicate if column is of binary type.boolean
Is column a primary keyboolean
isSigned()
Is column signed (for number only)
-
Field Details
-
charset
protected final int charsetcharset -
columnLength
protected final long columnLengthcolumn maximum length -
dataType
data type @see Field type -
decimals
protected final byte decimalsnumber of decimal -
extTypeName
extended type name -
extTypeFormat
extended type format -
buf
-
flags
private final int flags- See Also:
-
stringPos
private final int[] stringPosstring offset position in buffer -
useAliasAsName
private final boolean useAliasAsNameconfiguration: 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
- buffercharset
- charsetcolumnLength
- maxium column lengthdataType
- data typedecimals
- decimal lengthflags
- flagsstringPos
- string position indexesextTypeName
- extended type nameextTypeFormat
- extended type formatuseAliasAsName
- use alias as name
-
ColumnDefinitionPacket
-
-
Method Details
-
getCatalog
Description copied from interface:Column
get column catalog- Specified by:
getCatalog
in interfaceColumn
- Returns:
- column catalog
-
getSchema
Description copied from interface:Column
get column schema -
getTableAlias
Description copied from interface:Column
retrieve table alias if any- Specified by:
getTableAlias
in interfaceColumn
- Returns:
- table alias
-
getTable
Description copied from interface:Column
retrieve table name if any -
getColumnAlias
Description copied from interface:Column
retrieve column alias if any- Specified by:
getColumnAlias
in interfaceColumn
- Returns:
- column alias
-
getColumnName
Description copied from interface:Column
retrieve column name if any- Specified by:
getColumnName
in interfaceColumn
- Returns:
- column name
-
getColumnLength
public long getColumnLength()Description copied from interface:Column
column maximum length if known- Specified by:
getColumnLength
in interfaceColumn
- Returns:
- column maximum length
-
getType
Description copied from interface:Column
server data type -
getDecimals
public byte getDecimals()Description copied from interface:Column
get number of decimal- Specified by:
getDecimals
in interfaceColumn
- Returns:
- number of decimal
-
isSigned
public boolean isSigned()Description copied from interface:Column
Is column signed (for number only) -
getDisplaySize
public int getDisplaySize()Description copied from interface:Column
get display size- Specified by:
getDisplaySize
in interfaceColumn
- Returns:
- display sier
-
isPrimaryKey
public boolean isPrimaryKey()Description copied from interface:Column
Is column a primary key- Specified by:
isPrimaryKey
in interfaceColumn
- Returns:
- is a primary key
-
isAutoIncrement
public boolean isAutoIncrement()Description copied from interface:Column
Column autoincrement- Specified by:
isAutoIncrement
in interfaceColumn
- Returns:
- true if column auto-increment
-
hasDefault
public boolean hasDefault()Description copied from interface:Column
Column has a default value- Specified by:
hasDefault
in interfaceColumn
- 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 -
getFlags
public int getFlags()Description copied from interface:Column
Retrieve metadata flag -
getExtTypeName
Description copied from interface:Column
retrieve extended metadata name if any- Specified by:
getExtTypeName
in interfaceColumn
- Returns:
- extended metadata name
-
equals
-
hashCode
public int hashCode()
-