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 final class	ClickHouseResponseSummary.Progress	Progress of a query.
static class	ClickHouseResponseSummary.Statistics	Statistics of a query.

Field Summary

Fields

Modifier and Type	Field	Description
static final 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

Modifier and Type	Method	Description
void	add(ClickHouseResponseSummary summary)
void	add(ClickHouseResponseSummary.Progress progress)
void	add(ClickHouseResponseSummary.Statistics stats)
long	getElapsedTime()
ClickHouseResponseSummary.Progress	getProgress()	Gets current progress of the query.
String	getQueryId()
long	getReadBytes()
long	getReadRows()
long	getResultRows()
ClickHouseResponseSummary.Statistics	getStatistics()	Gets statistics of the query.
long	getTotalRowsToRead()
int	getUpdateCount()
long	getWrittenBytes()
long	getWrittenRows()
boolean	isEmpty()
void	seal()	Seals the object so that it cannot be updated any more.
String	toString()
int	update()	Increases update counter.
void	update(ClickHouseResponseSummary.Progress progress)	Updates query progress.
void	update(ClickHouseResponseSummary.Statistics stats)

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final ClickHouseResponseSummary EMPTY

Constructor Details

ClickHouseResponseSummary

public ClickHouseResponseSummary(ClickHouseResponseSummary.Progress progress,
 ClickHouseResponseSummary.Statistics stats)

Default constructor.

Parameters:

progress - progress which may or may not be null

stats - 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 null

stats - statistics which may or may not be null

sealed - whether the summary is sealed

Method Details

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

add

public void add(ClickHouseResponseSummary.Progress progress)

update

public void update(ClickHouseResponseSummary.Statistics stats)

add

public void add(ClickHouseResponseSummary.Statistics stats)

add

public void add(ClickHouseResponseSummary summary)

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()

getElapsedTime

public long getElapsedTime()

getResultRows

public long getResultRows()

getQueryId

public String getQueryId()

isEmpty

public boolean isEmpty()

toString

public String toString()

Overrides:

toString in class Object