java.lang.Object
- com.clickhouse.client.ClickHouseColumn

All Implemented Interfaces:

Serializable
```
public final class ClickHouseColumn
extends Object
implements Serializable
```
This class represents a column defined in database.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static ClickHouseColumn[] EMPTY_ARRAY

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`ClickHouseAggregateFunction`	`getAggregateFunction()`	Gets aggregate function when column type is `ClickHouseDataType.AggregateFunction`.
`ClickHouseColumn`	`getArrayBaseColumn()`
`int`	`getArrayNestedLevel()`
`int`	`getColumnCount()`
`int`	`getColumnIndex()`
`String`	`getColumnName()`
`ClickHouseDataType`	`getDataType()`
`ClickHouseEnum`	`getEnumConstants()`
`int`	`getEstimatedLength()`
`String`	`getFunction()`	Gets function when column type is `ClickHouseDataType.AggregateFunction`.
`ClickHouseColumn`	`getKeyInfo()`
`List<ClickHouseColumn>`	`getNestedColumns()`
`Class<?>`	`getObjectClass()`
`String`	`getOriginalTypeName()`
`List<String>`	`getParameters()`
`int`	`getPrecision()`
`Class<?>`	`getPrimitiveClass()`
`int`	`getScale()`
`TimeZone`	`getTimeZone()`
`TimeZone`	`getTimeZoneOrDefault(TimeZone defaultTz)`
`ClickHouseColumn`	`getValueInfo()`
`int`	`hashCode()`
`boolean`	`hasNestedColumn()`
`boolean`	`isAggregateFunction()`
`boolean`	`isArray()`
`boolean`	`isEnum()`
`boolean`	`isFirstColumn()`
`boolean`	`isFixedLength()`
`boolean`	`isLastColumn()`
`boolean`	`isMap()`
`boolean`	`isNested()`
`boolean`	`isNestedType()`
`boolean`	`isNullable()`
`boolean`	`isTuple()`
`static ClickHouseColumn`	`of(String columnName, ClickHouseDataType dataType, boolean nullable, boolean lowCardinality, String... parameters)`
`static ClickHouseColumn`	`of(String columnName, ClickHouseDataType dataType, boolean nullable, int precision, int scale)`
`static ClickHouseColumn`	`of(String columnName, ClickHouseDataType dataType, boolean nullable, ClickHouseColumn... nestedColumns)`
`static ClickHouseColumn`	`of(String columnName, String columnType)`
`static List<ClickHouseColumn>`	`parse(String args)`
`protected static int`	`readColumn(String args, int startIndex, int len, String name, List<ClickHouseColumn> list)`
`protected void`	`setColumnIndex(int index, int count)`	Sets zero-based column index and column count.
`String`	`toString()`

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

Field Detail

EMPTY_ARRAY

public static final ClickHouseColumn[] EMPTY_ARRAY

Method Detail

readColumn

protected static int readColumn(String args,
                                int startIndex,
                                int len,
                                String name,
                                List<ClickHouseColumn> list)

of

public static ClickHouseColumn of(String columnName,
                                  ClickHouseDataType dataType,
                                  boolean nullable,
                                  int precision,
                                  int scale)

of

public static ClickHouseColumn of(String columnName,
                                  ClickHouseDataType dataType,
                                  boolean nullable,
                                  boolean lowCardinality,
                                  String... parameters)

of

public static ClickHouseColumn of(String columnName,
                                  ClickHouseDataType dataType,
                                  boolean nullable,
                                  ClickHouseColumn... nestedColumns)

of

public static ClickHouseColumn of(String columnName,
                                  String columnType)

parse

public static List<ClickHouseColumn> parse(String args)

setColumnIndex
```
protected void setColumnIndex(int index,
                              int count)
```
Sets zero-based column index and column count.

Parameters:

index - zero-based column index, negative number is treated as zero

count - column count, should be always greater than one

isAggregateFunction
```
public boolean isAggregateFunction()
```

isArray
```
public boolean isArray()
```

isEnum
```
public boolean isEnum()
```

isFixedLength
```
public boolean isFixedLength()
```

isMap
```
public boolean isMap()
```

isNested
```
public boolean isNested()
```

isTuple
```
public boolean isTuple()
```

isNestedType
```
public boolean isNestedType()
```

getArrayNestedLevel
```
public int getArrayNestedLevel()
```

getArrayBaseColumn

public ClickHouseColumn getArrayBaseColumn()

getDataType

public ClickHouseDataType getDataType()

getObjectClass
```
public Class<?> getObjectClass()
```

getPrimitiveClass
```
public Class<?> getPrimitiveClass()
```

getEnumConstants

public ClickHouseEnum getEnumConstants()

getEstimatedLength
```
public int getEstimatedLength()
```

getColumnCount
```
public int getColumnCount()
```

getColumnIndex
```
public int getColumnIndex()
```

getColumnName
```
public String getColumnName()
```

getOriginalTypeName
```
public String getOriginalTypeName()
```

isFirstColumn
```
public boolean isFirstColumn()
```

isLastColumn
```
public boolean isLastColumn()
```

isNullable
```
public boolean isNullable()
```

getTimeZone
```
public TimeZone getTimeZone()
```

getTimeZoneOrDefault

public TimeZone getTimeZoneOrDefault(TimeZone defaultTz)

getPrecision
```
public int getPrecision()
```

getScale
```
public int getScale()
```

hasNestedColumn
```
public boolean hasNestedColumn()
```

getNestedColumns

public List<ClickHouseColumn> getNestedColumns()

getParameters
```
public List<String> getParameters()
```

getKeyInfo
```
public ClickHouseColumn getKeyInfo()
```

getValueInfo

public ClickHouseColumn getValueInfo()

getFunction
```
public String getFunction()
```
Gets function when column type is ClickHouseDataType.AggregateFunction. So it will return quantiles(0.5, 0.9) when the column type is AggregateFunction(quantiles(0.5, 0.9), UInt64).

Returns:

function, null when column type is not AggregateFunction

getAggregateFunction
```
public ClickHouseAggregateFunction getAggregateFunction()
```
Gets aggregate function when column type is ClickHouseDataType.AggregateFunction. So it will return ClickHouseAggregateFunction.quantile when the column type is AggregateFunction(quantiles(0.5, 0.9), UInt64).

Returns:

function name, null when column type is not AggregateFunction

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

Class ClickHouseColumn

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

Method Detail

readColumn

of

of

of

of

parse

setColumnIndex

isAggregateFunction

isArray

isEnum

isFixedLength

isMap

isNested

isTuple

isNestedType

getArrayNestedLevel

getArrayBaseColumn

getDataType

getObjectClass

getPrimitiveClass

getEnumConstants

getEstimatedLength

getColumnCount

getColumnIndex

getColumnName

getOriginalTypeName

isFirstColumn

isLastColumn

isNullable

getTimeZone

getTimeZoneOrDefault

getPrecision

getScale

hasNestedColumn

getNestedColumns

getParameters

getKeyInfo

getValueInfo

getFunction

getAggregateFunction

hashCode

equals

toString