Package com.clickhouse.client.api.data_formats.internal

Class AbstractBinaryFormatReader

java.lang.Object

com.clickhouse.client.api.data_formats.internal.AbstractBinaryFormatReader

All Implemented Interfaces:

ClickHouseBinaryFormatReader

Direct Known Subclasses:

NativeFormatReader, RowBinaryFormatReader, RowBinaryWithNamesAndTypesFormatReader, RowBinaryWithNamesFormatReader

public abstract class AbstractBinaryFormatReader
extends Object
implements ClickHouseBinaryFormatReader

Field Summary

Fields

Modifier and Type	Field	Description
protected BinaryStreamReader	binaryStreamReader
protected Map<String,Object>	currentRecord
protected InputStream	input
protected Map<String,Object>	nextRecord
protected Map<String,Object>	settings

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBinaryFormatReader(InputStream inputStream, QuerySettings querySettings, TableSchema schema)

Method Summary

Modifier and Type	Method	Description
protected void	endReached()
BigDecimal	getBigDecimal(int index)	Reads column with name `colName` as a BigDecimal.
BigDecimal	getBigDecimal(String colName)	Reads column with name `colName` as a BigDecimal.
BigInteger	getBigInteger(int index)	Reads column with name `colName` as a BigInteger.
BigInteger	getBigInteger(String colName)	Reads column with name `colName` as a BigInteger.
boolean	getBoolean(int index)	Reads column with name `colName` as a boolean.
boolean	getBoolean(String colName)	Reads column with name `colName` as a boolean.
byte	getByte(int index)	Reads column with name `colName` as a byte.
byte	getByte(String colName)	Reads column with name `colName` as a byte.
byte[]	getByteArray(int index)	Reads column with name `colName` as a string.
byte[]	getByteArray(String colName)	Reads column with name `colName` as a string.
double	getDouble(int index)	Reads column with name `colName` as a double.
double	getDouble(String colName)	Reads column with name `colName` as a double.
double[]	getDoubleArray(int index)	Reads column with name `colName` as a string.
double[]	getDoubleArray(String colName)	Reads column with name `colName` as a string.
Duration	getDuration(int index)	Returns the value of the specified column as a Duration.
Duration	getDuration(String colName)	Returns the value of the specified column as a Duration.
short	getEnum16(int index)
short	getEnum16(String colName)
byte	getEnum8(int index)
byte	getEnum8(String colName)
float	getFloat(int index)	Reads column with name `colName` as a float.
float	getFloat(String colName)	Reads column with name `colName` as a float.
float[]	getFloatArray(int index)	Reads column with name `colName` as a string.
float[]	getFloatArray(String colName)	Reads column with name `colName` as a string.
com.clickhouse.data.value.ClickHouseGeoMultiPolygonValue	getGeoMultiPolygon(int index)	Returns the value of the specified column as a ClickHouseGeoMultiPolygonValue.
com.clickhouse.data.value.ClickHouseGeoMultiPolygonValue	getGeoMultiPolygon(String colName)	Returns the value of the specified column as a ClickHouseGeoMultiPolygonValue.
com.clickhouse.data.value.ClickHouseGeoPointValue	getGeoPoint(int index)	Returns the value of the specified column as a ClickHouseGeoPointValue.
com.clickhouse.data.value.ClickHouseGeoPointValue	getGeoPoint(String colName)	Returns the value of the specified column as a ClickHouseGeoPointValue.
com.clickhouse.data.value.ClickHouseGeoPolygonValue	getGeoPolygon(int index)	Returns the value of the specified column as a ClickHouseGeoPolygonValue.
com.clickhouse.data.value.ClickHouseGeoPolygonValue	getGeoPolygon(String colName)	Returns the value of the specified column as a ClickHouseGeoPolygonValue.
com.clickhouse.data.value.ClickHouseGeoRingValue	getGeoRing(int index)	Returns the value of the specified column as a ClickHouseGeoRingValue.
com.clickhouse.data.value.ClickHouseGeoRingValue	getGeoRing(String colName)	Returns the value of the specified column as a ClickHouseGeoRingValue.
Inet4Address	getInet4Address(int index)	Returns the value of the specified column as an Inet4Address.
Inet4Address	getInet4Address(String colName)	Returns the value of the specified column as an Inet4Address.
Inet6Address	getInet6Address(int index)	Returns the value of the specified column as an Inet6Address.
Inet6Address	getInet6Address(String colName)	Returns the value of the specified column as an Inet6Address.
Instant	getInstant(int index)	Returns the value of the specified column as an Instant.
Instant	getInstant(String colName)	Returns the value of the specified column as an Instant.
int[]	getIntArray(int index)	Reads column with name `colName` as a string.
int[]	getIntArray(String colName)	Reads column with name `colName` as a string.
int	getInteger(int index)	Reads column with name `colName` as an integer.
int	getInteger(String colName)	Reads column with name `colName` as an integer.
<T> List<T>	getList(int index)	Reads column with name `colName` as a string.
<T> List<T>	getList(String colName)	Reads column with name `colName` as a string.
LocalDate	getLocalDate(int index)
LocalDate	getLocalDate(String colName)
LocalDateTime	getLocalDateTime(int index)
LocalDateTime	getLocalDateTime(String colName)
long	getLong(int index)	Reads column with name `colName` as a long.
long	getLong(String colName)	Reads column with name `colName` as a long.
long[]	getLongArray(int index)	Reads column with name `colName` as a string.
long[]	getLongArray(String colName)	Reads column with name `colName` as a string.
TableSchema	getSchema()
short	getShort(int index)	Reads column with name `colName` as a short.
short	getShort(String colName)	Reads column with name `colName` as a short.
String	getString(int index)	Reads column with name `colName` as a string.
String	getString(String colName)	Reads column with name `colName` as a string.
Object[]	getTuple(int index)
Object[]	getTuple(String colName)
UUID	getUUID(int index)	Returns the value of the specified column as a UUID.
UUID	getUUID(String colName)	Returns the value of the specified column as a UUID.
ZonedDateTime	getZonedDateTime(int index)	Returns the value of the specified column as a ZonedDateTime.
ZonedDateTime	getZonedDateTime(String colName)	Returns the value of the specified column as a ZonedDateTime.
boolean	hasNext()	Checks if there are more rows to read.
boolean	hasValue(int colIndex)
boolean	hasValue(String colName)
Map<String,Object>	next()	Moves cursor to the next row.
protected void	readNextRecord()
protected boolean	readRecord(Map<String,Object> record)
<T> T	readValue(int colIndex)	Reads a single value from the stream.
<T> T	readValue(String colName)	Reads a row to an array of objects.
protected void	setSchema(TableSchema schema)

Methods inherited from class java.lang.Object

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

Field Details

input

protected InputStream input

settings

protected Map<String,Object> settings

binaryStreamReader

protected BinaryStreamReader binaryStreamReader

currentRecord

protected Map<String,Object> currentRecord

nextRecord

protected Map<String,Object> nextRecord

Constructor Details

AbstractBinaryFormatReader

protected AbstractBinaryFormatReader(InputStream inputStream,
 QuerySettings querySettings,
 TableSchema schema)

Method Details

readRecord

protected boolean readRecord(Map<String,Object> record)
                      throws IOException

Throws:

IOException

readValue

public <T> T readValue(int colIndex)

Description copied from interface: ClickHouseBinaryFormatReader

Reads a single value from the stream.

Specified by:

readValue in interface ClickHouseBinaryFormatReader

Returns:

readValue

public <T> T readValue(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads a row to an array of objects.

Specified by:

readValue in interface ClickHouseBinaryFormatReader

Returns:

hasNext

public boolean hasNext()

Description copied from interface: ClickHouseBinaryFormatReader

Checks if there are more rows to read.

Specified by:

hasNext in interface ClickHouseBinaryFormatReader

Returns:

readNextRecord

protected void readNextRecord()

next

public Map<String,Object> next()

Description copied from interface: ClickHouseBinaryFormatReader

Moves cursor to the next row. Must be called before reading the first row.

Specified by:

next in interface ClickHouseBinaryFormatReader

Returns:

map filled with column values or null if no more records are available

endReached

protected void endReached()

setSchema

protected void setSchema(TableSchema schema)

getSchema

public TableSchema getSchema()

Specified by:

getSchema in interface ClickHouseBinaryFormatReader

getString

public String getString(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getString in interface ClickHouseBinaryFormatReader

Parameters:

colName - - column name

Returns:

getString

public String getString(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getString in interface ClickHouseBinaryFormatReader

Returns:

getByte

public byte getByte(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a byte.

Specified by:

getByte in interface ClickHouseBinaryFormatReader

Parameters:

colName - - column name

Returns:

getShort

public short getShort(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a short.

Specified by:

getShort in interface ClickHouseBinaryFormatReader

Parameters:

colName - - column name

Returns:

getInteger

public int getInteger(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as an integer.

Specified by:

getInteger in interface ClickHouseBinaryFormatReader

Parameters:

colName - - column name

Returns:

getLong

public long getLong(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a long.

Specified by:

getLong in interface ClickHouseBinaryFormatReader

Parameters:

colName - - column name

Returns:

getFloat

public float getFloat(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a float.

Specified by:

getFloat in interface ClickHouseBinaryFormatReader

Returns:

getDouble

public double getDouble(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a double.

Specified by:

getDouble in interface ClickHouseBinaryFormatReader

Returns:

getBoolean

public boolean getBoolean(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a boolean.

Specified by:

getBoolean in interface ClickHouseBinaryFormatReader

Returns:

getBigInteger

public BigInteger getBigInteger(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a BigInteger.

Specified by:

getBigInteger in interface ClickHouseBinaryFormatReader

Returns:

getBigDecimal

public BigDecimal getBigDecimal(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a BigDecimal.

Specified by:

getBigDecimal in interface ClickHouseBinaryFormatReader

Returns:

getInstant

public Instant getInstant(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as an Instant. Timezone is derived from the column definition. If no timezone is specified in the column definition then UTC will be used. If column value is Date or Date32 it will return an Instant with time set to 00:00:00. If column value is DateTime or DateTime32 it will return an Instant with the time part.

Specified by:

getInstant in interface ClickHouseBinaryFormatReader

Returns:

getZonedDateTime

public ZonedDateTime getZonedDateTime(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a ZonedDateTime. Timezone is derived from the column definition. If no timezone is specified in the column definition then UTC will be used. If column value is Date or Date32 it will return a ZonedDateTime with time set to 00:00:00. If column value is DateTime or DateTime32 it will return a ZonedDateTime with the time part.

Specified by:

getZonedDateTime in interface ClickHouseBinaryFormatReader

Returns:

getDuration

public Duration getDuration(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a Duration. If a stored value is bigger than Long.MAX_VALUE then exception will be thrown. In such case use asBigInteger() method. If value of IntervalQuarter then Duration will be in the unit of Months.

Specified by:

getDuration in interface ClickHouseBinaryFormatReader

Returns:

Duration in the unit of column type.

getInet4Address

public Inet4Address getInet4Address(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as an Inet4Address.

Specified by:

getInet4Address in interface ClickHouseBinaryFormatReader

Returns:

getInet6Address

public Inet6Address getInet6Address(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as an Inet6Address.

Specified by:

getInet6Address in interface ClickHouseBinaryFormatReader

Returns:

getUUID

public UUID getUUID(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a UUID.

Specified by:

getUUID in interface ClickHouseBinaryFormatReader

Returns:

getGeoPoint

public com.clickhouse.data.value.ClickHouseGeoPointValue getGeoPoint(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a ClickHouseGeoPointValue.

Specified by:

getGeoPoint in interface ClickHouseBinaryFormatReader

Returns:

getGeoRing

public com.clickhouse.data.value.ClickHouseGeoRingValue getGeoRing(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a ClickHouseGeoRingValue.

Specified by:

getGeoRing in interface ClickHouseBinaryFormatReader

Returns:

getGeoPolygon

public com.clickhouse.data.value.ClickHouseGeoPolygonValue getGeoPolygon(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a ClickHouseGeoPolygonValue.

Specified by:

getGeoPolygon in interface ClickHouseBinaryFormatReader

Returns:

getGeoMultiPolygon

public com.clickhouse.data.value.ClickHouseGeoMultiPolygonValue getGeoMultiPolygon(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a ClickHouseGeoMultiPolygonValue.

Specified by:

getGeoMultiPolygon in interface ClickHouseBinaryFormatReader

Returns:

getList

public <T> List<T> getList(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getList in interface ClickHouseBinaryFormatReader

Parameters:

colName - - column name

Returns:

getByteArray

public byte[] getByteArray(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getByteArray in interface ClickHouseBinaryFormatReader

Parameters:

colName - - column name

Returns:

getIntArray

public int[] getIntArray(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getIntArray in interface ClickHouseBinaryFormatReader

Parameters:

colName - - column name

Returns:

getLongArray

public long[] getLongArray(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getLongArray in interface ClickHouseBinaryFormatReader

Parameters:

colName - - column name

Returns:

getFloatArray

public float[] getFloatArray(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getFloatArray in interface ClickHouseBinaryFormatReader

Parameters:

colName - - column name

Returns:

getDoubleArray

public double[] getDoubleArray(String colName)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getDoubleArray in interface ClickHouseBinaryFormatReader

Parameters:

colName - - column name

Returns:

hasValue

public boolean hasValue(int colIndex)

Specified by:

hasValue in interface ClickHouseBinaryFormatReader

hasValue

public boolean hasValue(String colName)

Specified by:

hasValue in interface ClickHouseBinaryFormatReader

getByte

public byte getByte(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a byte.

Specified by:

getByte in interface ClickHouseBinaryFormatReader

Returns:

getShort

public short getShort(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a short.

Specified by:

getShort in interface ClickHouseBinaryFormatReader

Returns:

getInteger

public int getInteger(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as an integer.

Specified by:

getInteger in interface ClickHouseBinaryFormatReader

Returns:

getLong

public long getLong(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a long.

Specified by:

getLong in interface ClickHouseBinaryFormatReader

Returns:

getFloat

public float getFloat(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a float.

Specified by:

getFloat in interface ClickHouseBinaryFormatReader

Returns:

getDouble

public double getDouble(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a double.

Specified by:

getDouble in interface ClickHouseBinaryFormatReader

Returns:

getBoolean

public boolean getBoolean(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a boolean.

Specified by:

getBoolean in interface ClickHouseBinaryFormatReader

Returns:

getBigInteger

public BigInteger getBigInteger(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a BigInteger.

Specified by:

getBigInteger in interface ClickHouseBinaryFormatReader

Returns:

getBigDecimal

public BigDecimal getBigDecimal(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a BigDecimal.

Specified by:

getBigDecimal in interface ClickHouseBinaryFormatReader

Returns:

getInstant

public Instant getInstant(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as an Instant. Timezone is derived from the column definition. If no timezone is specified in the column definition then UTC will be used. If column value is Date or Date32 it will return an Instant with time set to 00:00:00. If column value is DateTime or DateTime32 it will return an Instant with the time part.

Specified by:

getInstant in interface ClickHouseBinaryFormatReader

Returns:

getZonedDateTime

public ZonedDateTime getZonedDateTime(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a ZonedDateTime. Timezone is derived from the column definition. If no timezone is specified in the column definition then UTC will be used. If column value is Date or Date32 it will return a ZonedDateTime with time set to 00:00:00. If column value is DateTime or DateTime32 it will return a ZonedDateTime with the time part.

Specified by:

getZonedDateTime in interface ClickHouseBinaryFormatReader

Returns:

getDuration

public Duration getDuration(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a Duration. If a stored value is bigger than Long.MAX_VALUE then exception will be thrown. In such case use asBigInteger() method. If value of IntervalQuarter then Duration will be in the unit of Months.

Specified by:

getDuration in interface ClickHouseBinaryFormatReader

Returns:

Duration in the unit of column type.

getInet4Address

public Inet4Address getInet4Address(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as an Inet4Address.

Specified by:

getInet4Address in interface ClickHouseBinaryFormatReader

Returns:

getInet6Address

public Inet6Address getInet6Address(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as an Inet6Address.

Specified by:

getInet6Address in interface ClickHouseBinaryFormatReader

Returns:

getUUID

public UUID getUUID(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a UUID.

Specified by:

getUUID in interface ClickHouseBinaryFormatReader

Returns:

getGeoPoint

public com.clickhouse.data.value.ClickHouseGeoPointValue getGeoPoint(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a ClickHouseGeoPointValue.

Specified by:

getGeoPoint in interface ClickHouseBinaryFormatReader

Returns:

getGeoRing

public com.clickhouse.data.value.ClickHouseGeoRingValue getGeoRing(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a ClickHouseGeoRingValue.

Specified by:

getGeoRing in interface ClickHouseBinaryFormatReader

Returns:

getGeoPolygon

public com.clickhouse.data.value.ClickHouseGeoPolygonValue getGeoPolygon(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a ClickHouseGeoPolygonValue.

Specified by:

getGeoPolygon in interface ClickHouseBinaryFormatReader

Returns:

getGeoMultiPolygon

public com.clickhouse.data.value.ClickHouseGeoMultiPolygonValue getGeoMultiPolygon(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Returns the value of the specified column as a ClickHouseGeoMultiPolygonValue.

Specified by:

getGeoMultiPolygon in interface ClickHouseBinaryFormatReader

Returns:

getList

public <T> List<T> getList(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getList in interface ClickHouseBinaryFormatReader

Parameters:

index - - column name

Returns:

getByteArray

public byte[] getByteArray(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getByteArray in interface ClickHouseBinaryFormatReader

Parameters:

index - - column name

Returns:

getIntArray

public int[] getIntArray(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getIntArray in interface ClickHouseBinaryFormatReader

Parameters:

index - - column name

Returns:

getLongArray

public long[] getLongArray(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getLongArray in interface ClickHouseBinaryFormatReader

Parameters:

index - - column name

Returns:

getFloatArray

public float[] getFloatArray(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getFloatArray in interface ClickHouseBinaryFormatReader

Parameters:

index - - column name

Returns:

getDoubleArray

public double[] getDoubleArray(int index)

Description copied from interface: ClickHouseBinaryFormatReader

Reads column with name `colName` as a string.

Specified by:

getDoubleArray in interface ClickHouseBinaryFormatReader

Parameters:

index - - column name

Returns:

getTuple

public Object[] getTuple(int index)

Specified by:

getTuple in interface ClickHouseBinaryFormatReader

getTuple

public Object[] getTuple(String colName)

Specified by:

getTuple in interface ClickHouseBinaryFormatReader

getEnum8

public byte getEnum8(String colName)

Specified by:

getEnum8 in interface ClickHouseBinaryFormatReader

getEnum8

public byte getEnum8(int index)

Specified by:

getEnum8 in interface ClickHouseBinaryFormatReader

getEnum16

public short getEnum16(String colName)

Specified by:

getEnum16 in interface ClickHouseBinaryFormatReader

getEnum16

public short getEnum16(int index)

Specified by:

getEnum16 in interface ClickHouseBinaryFormatReader

getLocalDate

public LocalDate getLocalDate(String colName)

Specified by:

getLocalDate in interface ClickHouseBinaryFormatReader

getLocalDate

public LocalDate getLocalDate(int index)

Specified by:

getLocalDate in interface ClickHouseBinaryFormatReader

getLocalDateTime

public LocalDateTime getLocalDateTime(String colName)

Specified by:

getLocalDateTime in interface ClickHouseBinaryFormatReader

getLocalDateTime

public LocalDateTime getLocalDateTime(int index)

Specified by:

getLocalDateTime in interface ClickHouseBinaryFormatReader