Package org.apache.beam.sdk.io.clickhouse

Class TableSchema.ColumnType

java.lang.Object

org.apache.beam.sdk.io.clickhouse.TableSchema.ColumnType

All Implemented Interfaces:

Serializable

Enclosing class:

TableSchema

public abstract static class TableSchema.ColumnType
extends Object
implements Serializable

A descriptor for a column type.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final TableSchema.ColumnType	BOOL
static final TableSchema.ColumnType	DATE
static final TableSchema.ColumnType	DATETIME
static final int	DEFAULT_DATETIME64_PRECISION	Default DateTime64 precision in ClickHouse.
static final int	DEFAULT_DECIMAL_PRECISION	Default Decimal precision in ClickHouse when none is specified.
static final int	DEFAULT_DECIMAL_SCALE	Default Decimal scale in ClickHouse when none is specified.
static final TableSchema.ColumnType	FLOAT32
static final TableSchema.ColumnType	FLOAT64
static final TableSchema.ColumnType	INT16
static final TableSchema.ColumnType	INT32
static final TableSchema.ColumnType	INT64
static final TableSchema.ColumnType	INT8
static final TableSchema.ColumnType	STRING
static final TableSchema.ColumnType	TUPLE
static final TableSchema.ColumnType	UINT16
static final TableSchema.ColumnType	UINT32
static final TableSchema.ColumnType	UINT64
static final TableSchema.ColumnType	UINT8

Constructor Summary

Constructors

Constructor	Description
ColumnType()

Method Summary

Modifier and Type	Method	Description
static TableSchema.ColumnType	array(TableSchema.ColumnType arrayElementType)
abstract @Nullable TableSchema.ColumnType	arrayElementType()
static org.apache.beam.sdk.io.clickhouse.TableSchema.ColumnType.Builder	builder()
static TableSchema.ColumnType	dateTime64()	Returns a DateTime64 type with ClickHouse's default precision of 3.
static TableSchema.ColumnType	dateTime64(int precision)
static TableSchema.ColumnType	decimal(int precision, int scale)	Returns a Decimal(precision, scale) type.
static TableSchema.ColumnType	enum16(Map<String,Integer> enumValues)
static TableSchema.ColumnType	enum8(Map<String,Integer> enumValues)
abstract @Nullable Map<String,Integer>	enumValues()
static TableSchema.ColumnType	fixedString(int size)
abstract @Nullable Integer	fixedStringSize()
abstract boolean	nullable()
static TableSchema.ColumnType	nullable(TableSchema.TypeName typeName)
static TableSchema.ColumnType	of(TableSchema.TypeName typeName)
static TableSchema.ColumnType	parse(String str)	Parse string with ClickHouse type to TableSchema.ColumnType.
static Object	parseDefaultExpression(TableSchema.ColumnType columnType, String value)	Get default value of a column based on expression.
abstract @Nullable Integer	precision()	Sub-second precision (0–9) of DateTime64, or total number of decimal digits (1–76) of Decimal.
abstract @Nullable Integer	scale()	Number of fractional decimal digits (0–precision) of Decimal.
static TableSchema.ColumnType	tuple(Map<String,TableSchema.ColumnType> elements)
abstract @Nullable Map<String,TableSchema.ColumnType>	tupleTypes()
abstract TableSchema.TypeName	typeName()
TableSchema.ColumnType	withNullable(boolean nullable)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DATE

public static final TableSchema.ColumnType DATE

DATETIME

public static final TableSchema.ColumnType DATETIME

FLOAT32

public static final TableSchema.ColumnType FLOAT32

FLOAT64

public static final TableSchema.ColumnType FLOAT64

INT8

public static final TableSchema.ColumnType INT8

INT16

public static final TableSchema.ColumnType INT16

INT32

public static final TableSchema.ColumnType INT32

INT64

public static final TableSchema.ColumnType INT64

STRING

public static final TableSchema.ColumnType STRING

UINT8

public static final TableSchema.ColumnType UINT8

UINT16

public static final TableSchema.ColumnType UINT16

UINT32

public static final TableSchema.ColumnType UINT32

UINT64

public static final TableSchema.ColumnType UINT64

BOOL

public static final TableSchema.ColumnType BOOL

TUPLE

public static final TableSchema.ColumnType TUPLE

DEFAULT_DATETIME64_PRECISION

public static final int DEFAULT_DATETIME64_PRECISION

Default DateTime64 precision in ClickHouse.

See Also:

• Constant Field Values

DEFAULT_DECIMAL_PRECISION

public static final int DEFAULT_DECIMAL_PRECISION

Default Decimal precision in ClickHouse when none is specified.

See Also:

• Constant Field Values

DEFAULT_DECIMAL_SCALE

public static final int DEFAULT_DECIMAL_SCALE

Default Decimal scale in ClickHouse when none is specified.

See Also:

• Constant Field Values

Constructor Details

ColumnType

public ColumnType()

Method Details

nullable

public abstract boolean nullable()

typeName

public abstract TableSchema.TypeName typeName()

enumValues

public abstract @Nullable Map<String,Integer> enumValues()

fixedStringSize

public abstract @Nullable Integer fixedStringSize()

arrayElementType

public abstract @Nullable TableSchema.ColumnType arrayElementType()

tupleTypes

public abstract @Nullable Map<String,TableSchema.ColumnType> tupleTypes()

precision

public abstract @Nullable Integer precision()

Sub-second precision (0–9) of DateTime64, or total number of decimal digits (1–76) of Decimal. null for other types.

scale

public abstract @Nullable Integer scale()

Number of fractional decimal digits (0–precision) of Decimal. null for other types.

withNullable

public TableSchema.ColumnType withNullable(boolean nullable)

of

public static TableSchema.ColumnType of(TableSchema.TypeName typeName)

nullable

public static TableSchema.ColumnType nullable(TableSchema.TypeName typeName)

fixedString

public static TableSchema.ColumnType fixedString(int size)

dateTime64

public static TableSchema.ColumnType dateTime64()

Returns a DateTime64 type with ClickHouse's default precision of 3.

dateTime64

public static TableSchema.ColumnType dateTime64(int precision)

decimal

public static TableSchema.ColumnType decimal(int precision,
 int scale)

Returns a Decimal(precision, scale) type.

ClickHouse stores Decimal values as integers of a width chosen from the declared precision: 32 bits for precision 1–9, 64 for 10–18, 128 for 19–38 and 256 for 39–76. The width aliases Decimal32(S), Decimal64(S), Decimal128(S) and Decimal256(S) correspond to precisions 9, 18, 38 and 76.

Parameters:

precision - total number of decimal digits, in [1, 76]

scale - number of fractional decimal digits, in [0, precision]

enum8

public static TableSchema.ColumnType enum8(Map<String,Integer> enumValues)

enum16

public static TableSchema.ColumnType enum16(Map<String,Integer> enumValues)

array

public static TableSchema.ColumnType array(TableSchema.ColumnType arrayElementType)

tuple

public static TableSchema.ColumnType tuple(Map<String,TableSchema.ColumnType> elements)

parse

public static TableSchema.ColumnType parse(String str)

Parse string with ClickHouse type to TableSchema.ColumnType.

Parameters:

str - string representation of ClickHouse type

Returns:

type of ClickHouse column

Throws:

IllegalArgumentException - if str is not a valid ClickHouse column type

parseDefaultExpression

public static Object parseDefaultExpression(TableSchema.ColumnType columnType,
 String value)

Get default value of a column based on expression.

E.g., "CREATE TABLE hits(id Int32, count Int32 DEFAULT <str>)"

Parameters:

columnType - type of ClickHouse expression

value - ClickHouse expression

Returns:

value of ClickHouse expression

builder

public static org.apache.beam.sdk.io.clickhouse.TableSchema.ColumnType.Builder builder()