Documentation

Connecting to ClickHouse with Java

In this example we will be using the official Java client maintained by the ClickHouse team.

Dependencies

Add the dependencies below to your project

For tarball installation:

<dependencies>
  <dependency>
    <groupId>com.clickhouse</groupId>
    <artifactId>clickhouse-http-client</artifactId>
    <version>0.6.0</version>
  <dependency>
  <dependency>
    <groupId>org.apache.httpcomponents.client5</groupId>
    <artifactId>httpclient5</artifactId>
    <version>5.2.3</version>
  <dependency>
<dependencies>

<groupId>com.clickhouse</groupId>

<artifactId>clickhouse-http-client</artifactId>

<groupId>org.apache.httpcomponents.client5</groupId>

<artifactId>httpclient5</artifactId>

Java Code

Use this code below to build connections to the nodes and try executing a SELECT query on the cluster

import com.clickhouse.client.*; 
import com.clickhouse.client.config.ClickHouseClientOption; 
import com.clickhouse.client.config.ClickHouseSslMode; 
import com.clickhouse.data.ClickHouseFormat; 

import java.util.List; 
import java.util.Map; 
import java.util.stream.Collectors; 

public class ClickhouseClient { 
public static void main(String[] args) throws ClickHouseException { 
  ClickHouseCluster cluster = ClickHouseCluster.of("f95e6eeb-9a7b-4866-a357-e643c1a31db4", 
    buildNodes(List.of("ip-54-235-186-192.9736e71d4a9c41299e993646add8e071.cu.dev.instaclustr.com","ip-52-200-239-133.9736e71d4a9c41299e993646add8e071.cu.dev.instaclustr.com","ip-3-215-239-34.9736e71d4a9c41299e993646add8e071.cu.dev.instaclustr.com")) 
  ); 

  try (ClickHouseClient client = ClickHouseClient.newInstance(ClickHouseProtocol.HTTP); 
  ClickHouseResponse response = client.read(cluster) 
    .format(ClickHouseFormat.RowBinaryWithNamesAndTypes) 
    .query("SHOW CLUSTERS") 
    .executeAndWait(); 
  ) { 
    System.out.println(response.firstRecord().getValue("cluster").asString()); 
    } 
  } 

private static List&lt;ClickHouseNode&gt; buildNodes(final List&lt;String&gt; hostnames) { 
  return hostnames.stream().map(ClickhouseClient::buildNode).collect(Collectors.toList()); 
} 
private static ClickHouseNode buildNode(final String hostname) { 
  return ClickHouseNode.builder() 
    .host(hostname) 
    .port(ClickHouseProtocol.HTTP, 8443) 
    .credentials(ClickHouseCredentials.fromUserAndPassword( 
    "icclickhouse", "&lt;icclickhouse-user-password&gt;")) 
    .options( Map.of( 
      ClickHouseClientOption.SSL.getKey(), "true", 
      ClickHouseClientOption.SSL_ROOT_CERTIFICATE.getKey(), "path/to/isrgrootx1.pem", 
      ClickHouseClientOption.COMPRESS.getKey(), "0" 
    )).build(); 
  } 
}

import com.clickhouse.client.*;

import com.clickhouse.client.config.ClickHouseClientOption;

import com.clickhouse.client.config.ClickHouseSslMode;

import com.clickhouse.data.ClickHouseFormat;

import java.util.List;

import java.util.Map;

import java.util.stream.Collectors;

public class ClickhouseClient {

public static void main(String[] args) throws ClickHouseException {

ClickHouseCluster cluster = ClickHouseCluster.of("f95e6eeb-9a7b-4866-a357-e643c1a31db4",

buildNodes(List.of("ip-54-235-186-192.9736e71d4a9c41299e993646add8e071.cu.dev.instaclustr.com","ip-52-200-239-133.9736e71d4a9c41299e993646add8e071.cu.dev.instaclustr.com","ip-3-215-239-34.9736e71d4a9c41299e993646add8e071.cu.dev.instaclustr.com"))

);

try (ClickHouseClient client = ClickHouseClient.newInstance(ClickHouseProtocol.HTTP);

ClickHouseResponse response = client.read(cluster)

.format(ClickHouseFormat.RowBinaryWithNamesAndTypes)

.query("SHOW CLUSTERS")

.executeAndWait();

) {

System.out.println(response.firstRecord().getValue("cluster").asString());

}

private static List<ClickHouseNode> buildNodes(final List<String> hostnames) {

return hostnames.stream().map(ClickhouseClient::buildNode).collect(Collectors.toList());

}

private static ClickHouseNode buildNode(final String hostname) {

return ClickHouseNode.builder()

.host(hostname)

.port(ClickHouseProtocol.HTTP, 8443)

.credentials(ClickHouseCredentials.fromUserAndPassword(

"icclickhouse", "<icclickhouse-user-password>"))

.options( Map.of(

ClickHouseClientOption.SSL.getKey(), "true",

ClickHouseClientOption.SSL_ROOT_CERTIFICATE.getKey(), "path/to/isrgrootx1.pem",

ClickHouseClientOption.COMPRESS.getKey(), "0"

)).build();

}

Simply replace the password of the icclickhouse user with that from the Connection Info page. The isrgrootx1.pem file is also available for downloading from the same page on the console.

By Instaclustr Support

Previous Article Connecting to a ClickHouse Cluster Next Article Connecting to ClickHouse with ClickHouse Client

Need Support?

Learn More

Experiencing difficulties on the website or console?

Status page for known incidents

Already have an account?

Need help with your cluster?

Contact Support

Why sign up?

To experience the ease of creating and managing clusters via the Instaclustr Console

Spin up a cluster in minutes

Free Trial