Package com.clickhouse.client.api.query

Class Records

java.lang.Object

com.clickhouse.client.api.query.Records

All Implemented Interfaces:

AutoCloseable, Iterable<GenericRecord>

public class Records
extends Object
implements Iterable<GenericRecord>, AutoCloseable

Constructor Summary

Constructors

Constructor	Description
Records(QueryResponse response, ClickHouseBinaryFormatReader reader)

Method Summary

Modifier and Type	Method	Description
void	close()
OperationMetrics	getMetrics()	Returns the metrics of this operation.
long	getReadBytes()	Alias for ServerMetrics.NUM_BYTES_READ
long	getReadRows()	Alias for ServerMetrics.NUM_ROWS_READ
long	getResultRows()	Alias for ServerMetrics.RESULT_ROWS
long	getServerTime()	Alias for ServerMetrics.ELAPSED_TIME
long	getWrittenBytes()	Alias for ServerMetrics.NUM_BYTES_WRITTEN
long	getWrittenRows()	Alias for ServerMetrics.NUM_ROWS_WRITTEN
boolean	isEmpty()	Returns true if this collection contains no elements.
Iterator<GenericRecord>	iterator()
Spliterator<GenericRecord>	spliterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach

Constructor Details

Records

public Records(QueryResponse response,
 ClickHouseBinaryFormatReader reader)

Method Details

iterator

public Iterator<GenericRecord> iterator()

Specified by:

iterator in interface Iterable<GenericRecord>

spliterator

public Spliterator<GenericRecord> spliterator()

Specified by:

spliterator in interface Iterable<GenericRecord>

isEmpty

public boolean isEmpty()

Returns true if this collection contains no elements. Prefer this method over getResultRows() == 0 because current method reflect actual state of the collection while getResultRows() is send from server before sending actual data.

Returns:

true if this collection contains no elements

getMetrics

public OperationMetrics getMetrics()

Returns the metrics of this operation.

Returns:

metrics of this operation

getReadRows

public long getReadRows()

Alias for ServerMetrics.NUM_ROWS_READ

Returns:

number of rows read by server from the storage

getReadBytes

public long getReadBytes()

Alias for ServerMetrics.NUM_BYTES_READ

Returns:

number of bytes read by server from the storage

getWrittenRows

public long getWrittenRows()

Alias for ServerMetrics.NUM_ROWS_WRITTEN

Returns:

number of rows written by server to the storage

getWrittenBytes

public long getWrittenBytes()

Alias for ServerMetrics.NUM_BYTES_WRITTEN

Returns:

number of bytes written by server to the storage

getServerTime

public long getServerTime()

Alias for ServerMetrics.ELAPSED_TIME

Returns:

elapsed time in nanoseconds

getResultRows

public long getResultRows()

Alias for ServerMetrics.RESULT_ROWS

Returns:

number of returned rows

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception