Package com.clickhouse.client

Enum ClickHouseFormat

java.lang.Object

java.lang.Enum<ClickHouseFormat>

com.clickhouse.client.ClickHouseFormat

All Implemented Interfaces:

Serializable, Comparable<ClickHouseFormat>

public enum ClickHouseFormat
extends Enum<ClickHouseFormat>

All formats supported by ClickHouse. More information at: https://clickhouse.com/docs/en/interfaces/formats/.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Arrow
ArrowStream
Avro
AvroConfluent
CapnProto
CSV
CSVWithNames
CustomSeparated
CustomSeparatedIgnoreSpaces
JSON
JSONAsString
JSONCompact
JSONCompactEachRow
JSONCompactEachRowWithNamesAndTypes
JSONCompactStrings
JSONCompactStringsEachRow
JSONCompactStringsEachRowWithNamesAndTypes
JSONEachRow
JSONEachRowWithProgress
JSONStringEachRow
JSONStrings
JSONStringsEachRow
JSONStringsEachRowWithProgress
LineAsString
Markdown
MsgPack
MySQLWire
Native
Null
ODBCDriver2
ORC
Parquet
PostgreSQLWire
Pretty
PrettyCompact
PrettyCompactMonoBlock
PrettyCompactNoEscapes
PrettyNoEscapes
PrettySpace
PrettySpaceNoEscapes
Protobuf
ProtobufSingle
RawBLOB
Regexp
RowBinary
RowBinaryWithNamesAndTypes
TabSeparated
TabSeparatedRaw
TabSeparatedWithNames
TabSeparatedWithNamesAndTypes
Template
TemplateIgnoreSpaces
TSKV
TSV
TSVRaw
TSVWithNames
TSVWithNamesAndTypes
Values
Vertical
XML

Method Summary

Modifier and Type	Method	Description
boolean	hasHeader()
boolean	isBinary()
boolean	isRowBased()	Check whether the format is row based(e.g.
boolean	isText()
boolean	supportsInput()
boolean	supportsOutput()
static ClickHouseFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ClickHouseFormat[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Arrow

public static final ClickHouseFormat Arrow

ArrowStream

public static final ClickHouseFormat ArrowStream

Avro

public static final ClickHouseFormat Avro

AvroConfluent

public static final ClickHouseFormat AvroConfluent

CSV

public static final ClickHouseFormat CSV

CSVWithNames

public static final ClickHouseFormat CSVWithNames

CapnProto

public static final ClickHouseFormat CapnProto

CustomSeparated

public static final ClickHouseFormat CustomSeparated

CustomSeparatedIgnoreSpaces

public static final ClickHouseFormat CustomSeparatedIgnoreSpaces

JSON

public static final ClickHouseFormat JSON

JSONAsString

public static final ClickHouseFormat JSONAsString

JSONCompact

public static final ClickHouseFormat JSONCompact

JSONCompactEachRow

public static final ClickHouseFormat JSONCompactEachRow

JSONCompactEachRowWithNamesAndTypes

public static final ClickHouseFormat JSONCompactEachRowWithNamesAndTypes

JSONCompactStrings

public static final ClickHouseFormat JSONCompactStrings

JSONCompactStringsEachRow

public static final ClickHouseFormat JSONCompactStringsEachRow

JSONCompactStringsEachRowWithNamesAndTypes

public static final ClickHouseFormat JSONCompactStringsEachRowWithNamesAndTypes

JSONEachRow

public static final ClickHouseFormat JSONEachRow

JSONEachRowWithProgress

public static final ClickHouseFormat JSONEachRowWithProgress

JSONStringEachRow

public static final ClickHouseFormat JSONStringEachRow

JSONStrings

public static final ClickHouseFormat JSONStrings

JSONStringsEachRow

public static final ClickHouseFormat JSONStringsEachRow

JSONStringsEachRowWithProgress

public static final ClickHouseFormat JSONStringsEachRowWithProgress

LineAsString

public static final ClickHouseFormat LineAsString

Markdown

public static final ClickHouseFormat Markdown

MsgPack

public static final ClickHouseFormat MsgPack

MySQLWire

public static final ClickHouseFormat MySQLWire

Native

public static final ClickHouseFormat Native

Null

public static final ClickHouseFormat Null

ODBCDriver2

public static final ClickHouseFormat ODBCDriver2

ORC

public static final ClickHouseFormat ORC

Parquet

public static final ClickHouseFormat Parquet

PostgreSQLWire

public static final ClickHouseFormat PostgreSQLWire

Pretty

public static final ClickHouseFormat Pretty

PrettyCompact

public static final ClickHouseFormat PrettyCompact

PrettyCompactMonoBlock

public static final ClickHouseFormat PrettyCompactMonoBlock

PrettyCompactNoEscapes

public static final ClickHouseFormat PrettyCompactNoEscapes

PrettyNoEscapes

public static final ClickHouseFormat PrettyNoEscapes

PrettySpace

public static final ClickHouseFormat PrettySpace

PrettySpaceNoEscapes

public static final ClickHouseFormat PrettySpaceNoEscapes

Protobuf

public static final ClickHouseFormat Protobuf

ProtobufSingle

public static final ClickHouseFormat ProtobufSingle

RawBLOB

public static final ClickHouseFormat RawBLOB

Regexp

public static final ClickHouseFormat Regexp

RowBinary

public static final ClickHouseFormat RowBinary

RowBinaryWithNamesAndTypes

public static final ClickHouseFormat RowBinaryWithNamesAndTypes

TSKV

public static final ClickHouseFormat TSKV

TSV

public static final ClickHouseFormat TSV

TSVRaw

public static final ClickHouseFormat TSVRaw

TSVWithNames

public static final ClickHouseFormat TSVWithNames

TSVWithNamesAndTypes

public static final ClickHouseFormat TSVWithNamesAndTypes

TabSeparated

public static final ClickHouseFormat TabSeparated

TabSeparatedRaw

public static final ClickHouseFormat TabSeparatedRaw

TabSeparatedWithNames

public static final ClickHouseFormat TabSeparatedWithNames

TabSeparatedWithNamesAndTypes

public static final ClickHouseFormat TabSeparatedWithNamesAndTypes

Template

public static final ClickHouseFormat Template

TemplateIgnoreSpaces

public static final ClickHouseFormat TemplateIgnoreSpaces

Values

public static final ClickHouseFormat Values

Vertical

public static final ClickHouseFormat Vertical

XML

public static final ClickHouseFormat XML

Method Detail

values

public static ClickHouseFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClickHouseFormat c : ClickHouseFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClickHouseFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

supportsInput

public boolean supportsInput()

supportsOutput

public boolean supportsOutput()

isBinary

public boolean isBinary()

isText

public boolean isText()

hasHeader

public boolean hasHeader()

isRowBased

public boolean isRowBased()

Check whether the format is row based(e.g. read/write by row), which is a very useful hint on how to process the data.

Returns:

true if the format is row based; false otherwise(e.g. column, document, or structured-object etc.)