Package com.clickhouse.client

Enum ClickHouseProtocol

java.lang.Object

java.lang.Enum<ClickHouseProtocol>

com.clickhouse.client.ClickHouseProtocol

All Implemented Interfaces:

Serializable, Comparable<ClickHouseProtocol>

public enum ClickHouseProtocol
extends Enum<ClickHouseProtocol>

This defines protocols can be used to connect to ClickHouse.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANY	Protocol detection is needed when establishing connection.
GRPC	GRPC interface.
HTTP	HTTP/HTTPS interface.
MYSQL	MySQL interface.
POSTGRESQL	PostgreSQL interface.
TCP	Native interface.

Method Summary

Modifier and Type	Method	Description
static ClickHouseProtocol	fromUriScheme(String scheme)	Gets most suitable protocol according to given URI scheme.
int	getDefaultPort()	Get default port used by the protocol.
List<String>	getUriSchemes()	Gets supported URI schemes.
static ClickHouseProtocol	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ClickHouseProtocol[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANY

public static final ClickHouseProtocol ANY

Protocol detection is needed when establishing connection.

HTTP

public static final ClickHouseProtocol HTTP

HTTP/HTTPS interface.

TCP

public static final ClickHouseProtocol TCP

Native interface.

MYSQL

public static final ClickHouseProtocol MYSQL

MySQL interface.

POSTGRESQL

public static final ClickHouseProtocol POSTGRESQL

PostgreSQL interface.

GRPC

public static final ClickHouseProtocol GRPC

GRPC interface.

Method Detail

values

public static ClickHouseProtocol[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClickHouseProtocol c : ClickHouseProtocol.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClickHouseProtocol valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromUriScheme

public static ClickHouseProtocol fromUriScheme(String scheme)

Gets most suitable protocol according to given URI scheme.

Parameters:

scheme - case insensitive URI scheme

Returns:

suitable protocol, ANY if not found

getDefaultPort

public int getDefaultPort()

Get default port used by the protocol.

Returns:

default port used by the protocol

getUriSchemes

public List<String> getUriSchemes()

Gets supported URI schemes.

Returns:

URI schemes