Package com.clickhouse.client

Class ClickHouseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.clickhouse.client.ClickHouseException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ClickHouseTransactionException

public class ClickHouseException
extends Exception

Exception thrown from ClickHouse server. See full list at https://github.com/ClickHouse/ClickHouse/blob/master/src/Common/ErrorCodes.cpp.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ERROR_ABORTED
static final int	ERROR_CANCELLED
static final int	ERROR_NETWORK
static final int	ERROR_POCO
static final int	ERROR_SESSION_IS_LOCKED
static final int	ERROR_SESSION_NOT_FOUND
static final int	ERROR_TIMEOUT
static final int	ERROR_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
	ClickHouseException(int code, String message, ClickHouseNode server)	Constructs an exception without cause.
protected	ClickHouseException(int code, String message, Throwable cause)	Constructs an exception.
	ClickHouseException(int code, Throwable cause, ClickHouseNode server)	Constructs an exception with cause.

Method Summary

Modifier and Type	Method	Description
static String	buildErrorMessage(int code, String detail)	Builds error message like "Code: <code>, <detail>".
static ClickHouseException	forCancellation(Exception e, ClickHouseNode server)	Creates an exception for cancellation.
int	getErrorCode()	Gets error code.
static boolean	isConnectTimedOut(Throwable t)	Checks if the given exception represents connection timeout error.
static ClickHouseException	of(String message, ClickHouseNode server)	Creates an exception to encapsulate the given error message.
static ClickHouseException	of(Throwable e, ClickHouseNode server)	Creates an exception to encapsulate cause of the given exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Details

ERROR_ABORTED

public static final int ERROR_ABORTED

See Also:

• Constant Field Values

ERROR_CANCELLED

public static final int ERROR_CANCELLED

See Also:

• Constant Field Values

ERROR_NETWORK

public static final int ERROR_NETWORK

See Also:

• Constant Field Values

ERROR_SESSION_NOT_FOUND

public static final int ERROR_SESSION_NOT_FOUND

See Also:

• Constant Field Values

ERROR_SESSION_IS_LOCKED

public static final int ERROR_SESSION_IS_LOCKED

See Also:

• Constant Field Values

ERROR_POCO

public static final int ERROR_POCO

See Also:

• Constant Field Values

ERROR_TIMEOUT

public static final int ERROR_TIMEOUT

See Also:

• Constant Field Values

ERROR_UNKNOWN

public static final int ERROR_UNKNOWN

See Also:

• Constant Field Values

Constructor Details

ClickHouseException

public ClickHouseException(int code,
 Throwable cause,
 ClickHouseNode server)

Constructs an exception with cause.

Parameters:

code - error code

cause - cause of the exception

server - server

ClickHouseException

public ClickHouseException(int code,
 String message,
 ClickHouseNode server)

Constructs an exception without cause.

Parameters:

code - error code

message - error message

server - server

ClickHouseException

protected ClickHouseException(int code,
 String message,
 Throwable cause)

Constructs an exception.

Parameters:

code - error code

message - error message

cause - cause

Method Details

buildErrorMessage

public static String buildErrorMessage(int code,
 String detail)

Builds error message like "Code: <code>, <detail>".

Parameters:

code - error code

detail - detail of the error

Returns:

non-null error message

forCancellation

public static ClickHouseException forCancellation(Exception e,
 ClickHouseNode server)

Creates an exception for cancellation.

Parameters:

e - exception

server - server

Returns:

ClickHouseException

isConnectTimedOut

public static boolean isConnectTimedOut(Throwable t)

Checks if the given exception represents connection timeout error.

Parameters:

t - exception

Returns:

true if the exception represents connection timeout error; false otherwise

of

public static ClickHouseException of(Throwable e,
 ClickHouseNode server)

Creates an exception to encapsulate cause of the given exception.

Parameters:

e - exception

server - server

Returns:

ClickHouseException

of

public static ClickHouseException of(String message,
 ClickHouseNode server)

Creates an exception to encapsulate the given error message.

Parameters:

message - error message

server - server

Returns:

ClickHouseException

getErrorCode

public int getErrorCode()

Gets error code.

Returns:

error code