ColumnDefinitionPacket (singlestore-jdbc-client 1.2.7 API)

java.lang.Object
- com.singlestore.jdbc.message.server.ColumnDefinitionPacket

All Implemented Interfaces:

com.singlestore.jdbc.client.Column, com.singlestore.jdbc.message.ServerMessage

Direct Known Subclasses:

BigDecimalColumn, BitColumn, DateColumn, DoubleColumn, FloatColumn, SignedBigIntColumn, SignedIntColumn, SignedMediumIntColumn, SignedSmallIntColumn, SignedTinyIntColumn, StringColumn, TimeColumn, TimestampColumn, UnsignedBigIntColumn, UnsignedIntColumn, UnsignedMediumIntColumn, UnsignedSmallIntColumn, UnsignedTinyIntColumn, VectorColumn
```
public class ColumnDefinitionPacket
extends Object
implements com.singlestore.jdbc.client.Column, com.singlestore.jdbc.message.ServerMessage
```
Column metadata definition

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`charset`
`protected long`	`columnLength`
`protected com.singlestore.jdbc.client.DataType`	`dataType`
`protected byte`	`decimals`
`protected String`	`extTypeFormat`
`protected String`	`extTypeName`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ColumnDefinitionPacket(ColumnDefinitionPacket prev, boolean useAliasAsName)`
	`ColumnDefinitionPacket(com.singlestore.jdbc.client.ReadableByteBuf buf, int charset, long columnLength, com.singlestore.jdbc.client.DataType dataType, byte decimals, int flags, int[] stringPos, String extTypeName, String extTypeFormat, boolean useAliasAsName)` Column definition constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getCatalog()` get column catalog
`String`	`getColumnAlias()` retrieve column alias if any
`long`	`getColumnLength()` column maximum length if known
`String`	`getColumnName()` retrieve column name if any
`byte`	`getDecimals()` get number of decimal
`int`	`getDisplaySize()` get display size
`String`	`getExtTypeFormat()` Get extended type format.
`String`	`getExtTypeName()` retrieve extended metadata name if any
`int`	`getFlags()` Retrieve metadata flag
`String`	`getSchema()` get column schema
`String`	`getTable()` retrieve table name if any
`String`	`getTableAlias()` retrieve table alias if any
`com.singlestore.jdbc.client.DataType`	`getType()` server data type
`boolean`	`hasDefault()` Column has a default value
`int`	`hashCode()`
`boolean`	`isAutoIncrement()` Column autoincrement
`boolean`	`isBinary()` indicate if column is of binary type.
`boolean`	`isPrimaryKey()` Is column a primary key
`boolean`	`isSigned()` Is column signed (for number only)

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - charset
```
protected final int charset
```
  - columnLength
```
protected final long columnLength
```
  - dataType
```
protected final com.singlestore.jdbc.client.DataType dataType
```
  - decimals
```
protected final byte decimals
```
  - extTypeName
```
protected final String extTypeName
```
  - extTypeFormat
```
protected final String extTypeFormat
```
- Constructor Detail
  - ColumnDefinitionPacket
```
public ColumnDefinitionPacket(com.singlestore.jdbc.client.ReadableByteBuf buf,
                              int charset,
                              long columnLength,
                              com.singlestore.jdbc.client.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 Detail
  - getCatalog
```
public String getCatalog()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    get column catalog
    
    Specified by:
    
    getCatalog in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    column catalog
  - getSchema
```
public String getSchema()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    get column schema
    
    Specified by:
    
    getSchema in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    column schema
  - getTableAlias
```
public String getTableAlias()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    retrieve table alias if any
    
    Specified by:
    
    getTableAlias in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    table alias
  - getTable
```
public String getTable()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    retrieve table name if any
    
    Specified by:
    
    getTable in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    table name
  - getColumnAlias
```
public String getColumnAlias()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    retrieve column alias if any
    
    Specified by:
    
    getColumnAlias in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    column alias
  - getColumnName
```
public String getColumnName()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    retrieve column name if any
    
    Specified by:
    
    getColumnName in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    column name
  - getColumnLength
```
public long getColumnLength()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    column maximum length if known
    
    Specified by:
    
    getColumnLength in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    column maximum length
  - getType
```
public com.singlestore.jdbc.client.DataType getType()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    server data type
    
    Specified by:
    
    getType in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    server data type
  - getDecimals
```
public byte getDecimals()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    get number of decimal
    
    Specified by:
    
    getDecimals in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    number of decimal
  - isSigned
```
public boolean isSigned()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    Is column signed (for number only)
    
    Specified by:
    
    isSigned in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    is signed
  - getDisplaySize
```
public int getDisplaySize()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    get display size
    
    Specified by:
    
    getDisplaySize in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    display sier
  - isPrimaryKey
```
public boolean isPrimaryKey()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    Is column a primary key
    
    Specified by:
    
    isPrimaryKey in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    is a primary key
  - isAutoIncrement
```
public boolean isAutoIncrement()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    Column autoincrement
    
    Specified by:
    
    isAutoIncrement in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    true if column auto-increment
  - hasDefault
```
public boolean hasDefault()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    Column has a default value
    
    Specified by:
    
    hasDefault in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    indicate if has a default value
  - isBinary
```
public boolean isBinary()
```
    Description copied from interface: com.singlestore.jdbc.client.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 com.singlestore.jdbc.client.Column
    
    Returns:
    
    is column type binary
  - getFlags
```
public int getFlags()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    Retrieve metadata flag
    
    Specified by:
    
    getFlags in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    metadata flag
  - getExtTypeName
```
public String getExtTypeName()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    retrieve extended metadata name if any
    
    Specified by:
    
    getExtTypeName in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    extended metadata name
  - getExtTypeFormat
```
public String getExtTypeFormat()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    Get extended type format.
    
    Specified by:
    
    getExtTypeFormat in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    extended type format
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ColumnDefinitionPacket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

charset

columnLength

dataType

decimals

extTypeName

extTypeFormat

Constructor Detail

ColumnDefinitionPacket

ColumnDefinitionPacket

Method Detail

getCatalog

getSchema

getTableAlias

getTable

getColumnAlias

getColumnName

getColumnLength

getType

getDecimals

isSigned

getDisplaySize

isPrimaryKey

isAutoIncrement

hasDefault

isBinary

getFlags

getExtTypeName

getExtTypeFormat

equals

hashCode