ColumnDefinitionPacket (singlestore-jdbc-client 1.2.0-beta0 API)

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

All Implemented Interfaces:: com.singlestore.jdbc.client.Column, com.singlestore.jdbc.message.ServerMessage

public class ColumnDefinitionPacket
extends Object
implements com.singlestore.jdbc.client.Column, com.singlestore.jdbc.message.ServerMessage

Column metadata definition

Constructor Summary

Constructors
Constructor and Description
`ColumnDefinitionPacket(com.singlestore.jdbc.client.ReadableByteBuf buf, boolean extendedInfo)` Generate object from mysql packet

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ColumnDefinitionPacket`	`create(String name, com.singlestore.jdbc.client.DataType type, int flags)` Generate column definition from name
`boolean`	`equals(Object o)`
`String`	`getColumnAlias()` retrieve column alias if any
`String`	`getColumnName()` retrieve column name if any
`int`	`getColumnType(Configuration conf)` return column type from column server type
`byte`	`getDecimals()` get number of decimal
`Codec<?>`	`getDefaultCodec(Configuration conf)` return column codec from column server type
`int`	`getDisplaySize()` get display size
`String`	`getExtTypeName()` retrieve extended metadata name if any
`int`	`getFlags()` Retrieve metadata flag
`long`	`getLength()` column maximum length if known
`int`	`getPrecision()` Return metadata precision.
`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
`String`	`getTypeName(Configuration conf)`
`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)
`void`	`useAliasAsName()` Use column alias as name

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

- Constructor Detail
  - ColumnDefinitionPacket
```
public ColumnDefinitionPacket(com.singlestore.jdbc.client.ReadableByteBuf buf,
                              boolean extendedInfo)
```
    Generate object from mysql packet
    
    Parameters:
    
    buf - mysql packet buffer
    
    extendedInfo - support extended information
- Method Detail
  - create
```
public static ColumnDefinitionPacket create(String name,
                                            com.singlestore.jdbc.client.DataType type,
                                            int flags)
```
    Generate column definition from name
    
    Parameters:
    
    name - column name
    
    type - server type
    
    flags - columns flags
    
    Returns:
    
    column definition
  - 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
  - getLength
```
public long getLength()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    column maximum length if known
    
    Specified by:
    
    getLength 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
  - getTypeName
```
public String getTypeName(Configuration conf)
```
    Specified by:
    
    getTypeName in interface com.singlestore.jdbc.client.Column
  - 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
  - getPrecision
```
public int getPrecision()
```
    Return metadata precision.
    
    Specified by:
    
    getPrecision in interface com.singlestore.jdbc.client.Column
    
    Returns:
    
    precision
  - getColumnType
```
public int getColumnType(Configuration conf)
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    return column type from column server type
    
    Specified by:
    
    getColumnType in interface com.singlestore.jdbc.client.Column
    
    Parameters:
    
    conf - configuration
    
    Returns:
    
    column type
  - getDefaultCodec
```
public Codec<?> getDefaultCodec(Configuration conf)
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    return column codec from column server type
    
    Specified by:
    
    getDefaultCodec in interface com.singlestore.jdbc.client.Column
    
    Parameters:
    
    conf - configuration
    
    Returns:
    
    decoding codec
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - useAliasAsName
```
public void useAliasAsName()
```
    Description copied from interface: com.singlestore.jdbc.client.Column
    
    Use column alias as name
    
    Specified by:
    
    useAliasAsName in interface com.singlestore.jdbc.client.Column

Class ColumnDefinitionPacket

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ColumnDefinitionPacket

Method Detail

create

getSchema

getTableAlias

getTable

getColumnAlias

getColumnName

getLength

getType

getTypeName

getDecimals

isSigned

getDisplaySize

isPrimaryKey

isAutoIncrement

hasDefault

isBinary

getFlags

getExtTypeName

getPrecision

getColumnType

getDefaultCodec

equals

hashCode

useAliasAsName