Package com.clickhouse.data

Class ClickHouseColumn

java.lang.Object

com.clickhouse.data.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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ClickHouseColumn.DefaultValue

Field Summary

Fields

Modifier and Type	Field	Description
static final ClickHouseColumn[]	EMPTY_ARRAY
static final String	JSON_MAX_DYN_TYPES_PARAM
static final String	JSON_MAX_PATHS_PARAM
static final String	JSON_SKIP_MARKER
static final String	TYPE_NAME

Constructor Summary

Constructors

Constructor	Description
ClickHouseColumn(ClickHouseDataType dataType, String columnName, String originalTypeName, boolean nullable, boolean lowCardinality, List<String> parameters, List<ClickHouseColumn> nestedColumns)
ClickHouseColumn(ClickHouseDataType dataType, String columnName, String originalTypeName, boolean nullable, boolean lowCardinality, List<String> parameters, List<ClickHouseColumn> nestedColumns, ClickHouseEnum enumConstants)

Method Summary

Modifier and Type	Method	Description
static ClickHouseColumn	array(String columnName, boolean nullable, ClickHouseColumn innerColumn)
void	disableLowCardinality()
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()
String	getDefaultExpression()
ClickHouseColumn.DefaultValue	getDefaultValue()
ClickHouseEnum	getEnumConstants()
int	getEstimatedLength()
String	getFunction()	Gets function when column type is ClickHouseDataType.AggregateFunction.
Map<String,ClickHouseColumn>	getJsonPredefinedPaths()
ClickHouseColumn	getKeyInfo()
List<ClickHouseColumn>	getNestedColumns()
Class<?>	getObjectClass(ClickHouseDataConfig config)
Class<?>	getObjectClassForArray(ClickHouseDataConfig config)
String	getOriginalTypeName()
List<String>	getParameters()
int	getPrecision()
Class<?>	getPrimitiveClass(ClickHouseDataConfig config)
int	getScale()
TimeZone	getTimeZone()
TimeZone	getTimeZoneOrDefault(TimeZone defaultTz)
ClickHouseDataType	getValueDataType()	Returns column effective data type.
ClickHouseColumn	getValueInfo()
int	getVariantOrdNum(Object value)
boolean	hasDefault()
int	hashCode()
boolean	hasNestedColumn()
boolean	hasTimeZone()
boolean	isAggregateFunction()
boolean	isArray()
boolean	isEnum()
boolean	isFirstColumn()
boolean	isFixedLength()
boolean	isLastColumn()
boolean	isLowCardinality()
boolean	isLowCardinalityDisabled()
boolean	isMap()
boolean	isNested()
boolean	isNestedType()
boolean	isNullable()
boolean	isTuple()
static ClickHouseColumn	map(String columnName, boolean nullable, ClickHouseDataType keyColumn, ClickHouseColumn valueColumn)
ClickHouseArraySequence	newArrayValue(ClickHouseDataConfig config)
ClickHouseValue	newValue(ClickHouseDataConfig config)
static ClickHouseColumn	nullable(ClickHouseDataType dataType)
static ClickHouseColumn	of(ClickHouseDataType dataType)
static ClickHouseColumn	of(ClickHouseDataType dataType, boolean nullable)
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)
static void	parseJSONColumn(String args, List<ClickHouseColumn> nestedColumns, List<String> parameters)
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.
void	setDefaultExpression(String defaultExpression)
void	setDefaultValue(ClickHouseColumn.DefaultValue defaultValue)
void	setHasDefault(boolean hasDefault)
static ClickHouseColumn	string()
static ClickHouseColumn	string(boolean nullable)
String	toString()
static ClickHouseColumn	tuple(String columnName, boolean nullable, ClickHouseColumn... innerColumn)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

TYPE_NAME

public static final String TYPE_NAME

See Also:

• Constant Field Values

EMPTY_ARRAY

public static final ClickHouseColumn[] EMPTY_ARRAY

JSON_MAX_PATHS_PARAM

public static final String JSON_MAX_PATHS_PARAM

See Also:

• Constant Field Values

JSON_MAX_DYN_TYPES_PARAM

public static final String JSON_MAX_DYN_TYPES_PARAM

See Also:

• Constant Field Values

JSON_SKIP_MARKER

public static final String JSON_SKIP_MARKER

See Also:

• Constant Field Values

Constructor Details

ClickHouseColumn

public ClickHouseColumn(ClickHouseDataType dataType,
 String columnName,
 String originalTypeName,
 boolean nullable,
 boolean lowCardinality,
 List<String> parameters,
 List<ClickHouseColumn> nestedColumns)

ClickHouseColumn

public ClickHouseColumn(ClickHouseDataType dataType,
 String columnName,
 String originalTypeName,
 boolean nullable,
 boolean lowCardinality,
 List<String> parameters,
 List<ClickHouseColumn> nestedColumns,
 ClickHouseEnum enumConstants)

Method Details

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)

of

public static ClickHouseColumn of(ClickHouseDataType dataType)

of

public static ClickHouseColumn of(ClickHouseDataType dataType,
 boolean nullable)

nullable

public static ClickHouseColumn nullable(ClickHouseDataType dataType)

string

public static ClickHouseColumn string(boolean nullable)

string

public static ClickHouseColumn string()

array

public static ClickHouseColumn array(String columnName,
 boolean nullable,
 ClickHouseColumn innerColumn)

map

public static ClickHouseColumn map(String columnName,
 boolean nullable,
 ClickHouseDataType keyColumn,
 ClickHouseColumn valueColumn)

tuple

public static ClickHouseColumn tuple(String columnName,
 boolean nullable,
 ClickHouseColumn... innerColumn)

parse

public static List<ClickHouseColumn> parse(String args)

parseJSONColumn

public static void parseJSONColumn(String args,
 List<ClickHouseColumn> nestedColumns,
 List<String> parameters)

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()

getVariantOrdNum

public int getVariantOrdNum(Object value)

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(ClickHouseDataConfig config)

getObjectClassForArray

public Class<?> getObjectClassForArray(ClickHouseDataConfig config)

getPrimitiveClass

public Class<?> getPrimitiveClass(ClickHouseDataConfig config)

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()

hasDefault

public boolean hasDefault()

setHasDefault

public void setHasDefault(boolean hasDefault)

setDefaultValue

public void setDefaultValue(ClickHouseColumn.DefaultValue defaultValue)

getDefaultValue

public ClickHouseColumn.DefaultValue getDefaultValue()

setDefaultExpression

public void setDefaultExpression(String defaultExpression)

getDefaultExpression

public String getDefaultExpression()

isLowCardinality

public boolean isLowCardinality()

isLowCardinalityDisabled

public boolean isLowCardinalityDisabled()

disableLowCardinality

public void disableLowCardinality()

hasTimeZone

public boolean hasTimeZone()

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

getJsonPredefinedPaths

public Map<String,ClickHouseColumn> getJsonPredefinedPaths()

newArrayValue

public ClickHouseArraySequence newArrayValue(ClickHouseDataConfig config)

newValue

public ClickHouseValue newValue(ClickHouseDataConfig config)

getValueDataType

public ClickHouseDataType getValueDataType()

Returns column effective data type. In case of SimpleAggregateFunction returns type of the first column.

Returns:

ClickHouseDataType

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