Package com.clickhouse.client

Class ClickHouseStreamResponse

java.lang.Object

com.clickhouse.client.ClickHouseStreamResponse

All Implemented Interfaces:

ClickHouseResponse, Serializable, AutoCloseable

public class ClickHouseStreamResponse
extends Object
implements ClickHouseResponse

A stream response from server.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClickHouseConfig	config
protected static final List<ClickHouseColumn>	defaultTypes
protected final ClickHouseDataProcessor	processor
protected final ClickHouseResponseSummary	summary

Fields inherited from interface com.clickhouse.client.ClickHouseResponse

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClickHouseStreamResponse(ClickHouseConfig config, ClickHouseInputStream input, Map<String,Serializable> settings, List<ClickHouseColumn> columns, ClickHouseResponseSummary summary, TimeZone timeZone)

Method Summary

Modifier and Type	Method	Description
void	close()
List<ClickHouseColumn>	getColumns()	Gets list of columns.
ClickHouseFormat	getFormat()
ClickHouseInputStream	getInputStream()	Gets input stream of the response.
ClickHouseResponseSummary	getSummary()	Gets summary of this response.
TimeZone	getTimeZone()	Returns a server timezone if it is returned by server in a header X-ClickHouse-Timezone or other way.
boolean	isClosed()	Checks whether the response has been closed or not.
static ClickHouseResponse	of(ClickHouseConfig config, ClickHouseInputStream input, Map<String,Serializable> settings, List<ClickHouseColumn> columns, ClickHouseResponseSummary summary, TimeZone timeZone)
Iterable<ClickHouseRecord>	records()	Returns an iterable collection of records which can be walked through in a foreach loop.
<T> Iterable<T>	records(Class<T> objClass)	Returns an iterable collection of mapped objects which can be walked through in a foreach loop.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.clickhouse.client.ClickHouseResponse

firstRecord, firstRecord, pipe, stream, stream

Field Details

defaultTypes

protected static final List<ClickHouseColumn> defaultTypes

config

protected final ClickHouseConfig config

processor

protected final transient ClickHouseDataProcessor processor

summary

protected final ClickHouseResponseSummary summary

Constructor Details

ClickHouseStreamResponse

protected ClickHouseStreamResponse(ClickHouseConfig config,
 ClickHouseInputStream input,
 Map<String,Serializable> settings,
 List<ClickHouseColumn> columns,
 ClickHouseResponseSummary summary,
 TimeZone timeZone)
                            throws IOException

Throws:

IOException

Method Details

of

public static ClickHouseResponse of(ClickHouseConfig config,
 ClickHouseInputStream input,
 Map<String,Serializable> settings,
 List<ClickHouseColumn> columns,
 ClickHouseResponseSummary summary,
 TimeZone timeZone)
                             throws IOException

Throws:

IOException

isClosed

public boolean isClosed()

Description copied from interface: ClickHouseResponse

Checks whether the response has been closed or not.

Specified by:

isClosed in interface ClickHouseResponse

Returns:

true if the response has been closed; false otherwise

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ClickHouseResponse

getColumns

public List<ClickHouseColumn> getColumns()

Description copied from interface: ClickHouseResponse

Gets list of columns.

Specified by:

getColumns in interface ClickHouseResponse

Returns:

non-null list of column

getFormat

public ClickHouseFormat getFormat()

getSummary

public ClickHouseResponseSummary getSummary()

Description copied from interface: ClickHouseResponse

Gets summary of this response. Keep in mind that the summary may change over time until response is closed.

Specified by:

getSummary in interface ClickHouseResponse

Returns:

non-null summary of this response

getInputStream

public ClickHouseInputStream getInputStream()

Description copied from interface: ClickHouseResponse

Gets input stream of the response. In general, this is the most memory-efficient way for streaming data from server to client. However, this also means additional work is required for deserialization, especially when using a binary format.

Specified by:

getInputStream in interface ClickHouseResponse

Returns:

non-null input stream for getting raw data returned from server

records

public Iterable<ClickHouseRecord> records()

Description copied from interface: ClickHouseResponse

Returns an iterable collection of records which can be walked through in a foreach loop. Please pay attention that: 1) UncheckedIOException might be thrown when iterating through the collection; and 2) it's not supposed to be called for more than once.

Specified by:

records in interface ClickHouseResponse

Returns:

non-null iterable collection

getTimeZone

public TimeZone getTimeZone()

Description copied from interface: ClickHouseResponse

Returns a server timezone if it is returned by server in a header X-ClickHouse-Timezone or other way. If not, it returns null

Specified by:

getTimeZone in interface ClickHouseResponse

Returns:

server timezone from server response or null

records

public <T> Iterable<T> records(Class<T> objClass)

Description copied from interface: ClickHouseResponse

Returns an iterable collection of mapped objects which can be walked through in a foreach loop. When objClass is null or ClickHouseRecord, it's same as calling ClickHouseResponse.records().

Specified by:

records in interface ClickHouseResponse

Type Parameters:

T - type of the mapped object

Parameters:

objClass - non-null class of the mapped object

Returns:

non-null iterable collection