Package com.clickhouse.client
Class ClickHouseResponseSummary
- java.lang.Object
-
- com.clickhouse.client.ClickHouseResponseSummary
-
- All Implemented Interfaces:
Serializable
public class ClickHouseResponseSummary extends Object implements Serializable
Summary of ClickHouse response.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ClickHouseResponseSummary.Progress
Progress of a query.static class
ClickHouseResponseSummary.Statistics
Statistics of a query.
-
Field Summary
Fields Modifier and Type Field Description static ClickHouseResponseSummary
EMPTY
-
Constructor Summary
Constructors Modifier Constructor Description ClickHouseResponseSummary(ClickHouseResponseSummary.Progress progress, ClickHouseResponseSummary.Statistics stats)
Default constructor.protected
ClickHouseResponseSummary(ClickHouseResponseSummary.Progress progress, ClickHouseResponseSummary.Statistics stats, boolean sealed)
Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ClickHouseResponseSummary.Progress
getProgress()
Gets current progress of the query.long
getReadBytes()
long
getReadRows()
ClickHouseResponseSummary.Statistics
getStatistics()
Gets statistics of the query.long
getTotalRowsToRead()
int
getUpdateCount()
long
getWrittenBytes()
long
getWrittenRows()
void
seal()
Seals the object so that it cannot be updated any more.int
update()
Increases update counter.void
update(ClickHouseResponseSummary.Progress progress)
Updates query progress.void
update(ClickHouseResponseSummary.Statistics stats)
-
-
-
Field Detail
-
EMPTY
public static final ClickHouseResponseSummary EMPTY
-
-
Constructor Detail
-
ClickHouseResponseSummary
public ClickHouseResponseSummary(ClickHouseResponseSummary.Progress progress, ClickHouseResponseSummary.Statistics stats)
Default constructor.- Parameters:
progress
- progress which may or may not be nullstats
- statistics which may or may not be null
-
ClickHouseResponseSummary
protected ClickHouseResponseSummary(ClickHouseResponseSummary.Progress progress, ClickHouseResponseSummary.Statistics stats, boolean sealed)
Default constructor.- Parameters:
progress
- progress which may or may not be nullstats
- statistics which may or may not be nullsealed
- whether the summary is sealed
-
-
Method Detail
-
seal
public void seal()
Seals the object so that it cannot be updated any more.
-
update
public int update()
Increases update counter.- Returns:
- increased update counter
-
update
public void update(ClickHouseResponseSummary.Progress progress)
Updates query progress.- Parameters:
progress
- query progress, null value will be simply ignored
-
update
public void update(ClickHouseResponseSummary.Statistics stats)
-
getProgress
public ClickHouseResponseSummary.Progress getProgress()
Gets current progress of the query.- Returns:
- non-null progress
-
getStatistics
public ClickHouseResponseSummary.Statistics getStatistics()
Gets statistics of the query.- Returns:
- non-null statistics
-
getReadRows
public long getReadRows()
-
getReadBytes
public long getReadBytes()
-
getTotalRowsToRead
public long getTotalRowsToRead()
-
getWrittenRows
public long getWrittenRows()
-
getWrittenBytes
public long getWrittenBytes()
-
getUpdateCount
public int getUpdateCount()
-
-