Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename clickhouse-jdbc repo to clickhouse-java #712

Merged
merged 1 commit into from
Jan 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ import ConnectionDetails from '@site/docs/en/_snippets/_gather_your_details_http

## 3. Download the ClickHouse JDBC driver

1. Visit the <a href="https://github.com/ClickHouse/clickhouse-jdbc/releases" target="_blank">ClickHouse JDBC driver release page</a> on GitHub and look for the latest JDBC release version
2. In the release version, click on "Show all xx assets" and look for the JAR file containing the keyword "shaded", for example, `clickhouse-jdbc-0.3.2-patch11-shaded.jar`
1. Visit the <a href="https://github.com/ClickHouse/clickhouse-java/releases" target="_blank">ClickHouse JDBC driver release page</a> on GitHub and look for the latest JDBC release version
2. In the release version, click on "Show all xx assets" and look for the JAR file containing the keyword "shaded", for example, `clickhouse-jdbc-0.4.0-shaded.jar`
3. Place the JAR file in a folder accessible by Apache NiFi and take note of the absolute path

## 4. Add DBCPConnectionPool Controller Service and configure its properties
Expand All @@ -48,7 +48,7 @@ import ConnectionDetails from '@site/docs/en/_snippets/_gather_your_details_http
| Property | Value | Remark |
| --------------------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------------- |
| Database Connection URL | jdbc:ch:https://HOSTNAME:8443/default?ssl=true | Replace HOSTNAME in the connection URL accordingly |
| Database Driver Class Name | com.clickhouse.jdbc.ClickHouseDriver | Avoid using `ru.yandex.clickhouse.ClickHouseDriver` as it has been deprecated |
| Database Driver Class Name | com.clickhouse.jdbc.ClickHouseDriver ||
| Database Driver Location(s) | /etc/nifi/nifi-X.XX.X/lib/clickhouse-jdbc-0.X.X-patchXX-shaded.jar | Absolute path to the ClickHouse JDBC driver JAR file |
| Database User | default | ClickHouse username |
| Password | password | ClickHouse password |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ For sending data to ClickHouse from Kafka, we use the Sink component of the conn

### 2. Download and install the JDBC Driver

Download and install the ClickHouse JDBC driver `clickhouse-jdbc-<version>-shaded.jar` from [here](https://github.com/ClickHouse/clickhouse-jdbc). Install this into Kafka Connect following the details [here](https://docs.confluent.io/kafka-connect-jdbc/current/#installing-jdbc-drivers). Other drivers may work but have not been tested.
Download and install the ClickHouse JDBC driver `clickhouse-jdbc-<version>-shaded.jar` from [here](https://github.com/ClickHouse/clickhouse-java/releases). Install this into Kafka Connect following the details [here](https://docs.confluent.io/kafka-connect-jdbc/current/#installing-jdbc-drivers). Other drivers may work but have not been tested.

:::note

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Two Sink connectors provided by Confluent are compatible with ClickHouse:
Each of these has benefits and limitations:


* The [JDBC connector](./kafka-connect-jdbc) relies on the user providing a [JDBC driver](https://github.com/ClickHouse/clickhouse-jdbc). This driver has several versions, including the official ClickHouse distribution. This version uses the HTTP interface, although native support is planned. Until the native interface is not supported, it provides no performance benefit over the HTTP Sink other than ease of configuration. [Other drivers](https://github.com/housepower/ClickHouse-Native-JDBC) support the native protocol, but these have not been tested.
* The [JDBC connector](./kafka-connect-jdbc) relies on the user providing a [JDBC driver](https://github.com/ClickHouse/clickhouse-java). This driver has several versions, including the official ClickHouse distribution. This version uses the HTTP interface, although native support is planned. Until the native interface is not supported, it provides no performance benefit over the HTTP Sink other than ease of configuration. [Other drivers](https://github.com/housepower/ClickHouse-Native-JDBC) support the native protocol, but these have not been tested.
* The JDBC connector requires a Kafka schema defining the types of the fields. It uses this schema, defined in JSON schema, to formulate insert statements. Whilst this is effective on primitive types, the connector does not support ClickHouse specific types, e.g., Arrays and Maps. Furthermore, this connector will not support several configuration options which rely on DDL queries - highlighted in the section [JDBC Connector](./kafka-connect-jdbc) below.
* The [HTTP Sink Connector](./kafka-connect-http) does not require a data schema. Our example assumes the data is in JSON format - although this approach should be compatible with any [formats](https://clickhouse.com/docs/en/interfaces/formats/#data-formatting) that the ClickHouse HTTP interface can consume.
* The HTTP Sink Connector is also deployed natively in Confluent Cloud and has been tested with ClickHouse Cloud, unlike the JDBC, which must be self-managed. We provide instructions for both scenarios below.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Tableau can use ClickHouse databases and tables as a data source. This requires
4. Store the TACO connector in the following folder (based on your OS):
- macOS: `~/Documents/My Tableau Repository/Connectors`
- Windows: `C:\Users[Windows User]\Documents\My Tableau Repository\Connectors`
5. Follow `clickhouse-tableau-connector-jdbc` instructions to download the compatible version of <a href="https://github.com/ClickHouse/clickhouse-jdbc/releases/" target="_blank">ClickHouse JDBC driver</a>.
5. Follow `clickhouse-tableau-connector-jdbc` instructions to download the compatible version of <a href="https://github.com/ClickHouse/clickhouse-java/releases/" target="_blank">ClickHouse JDBC driver</a>.

:::note
Make sure you download the **clickhouse-jdbc-x.x.x-shaded.jar** JAR file.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/integrations/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ We are actively compiling this list of ClickHouse integrations below, so it's no
|ClickHouse Client|<ClickHouseSVG style={{width: '3rem'}} />|SQL client|ClickHouse Client is the native command-line client for ClickHouse.|[Documentation](../interfaces/cli)|
|dbt|<DbtSVG style={{width: '3rem'}} />|Data ingestion|Use dbt (data build tool) to transform data in ClickHouse by simply writing select statements. dbt puts the T in ELT.|[Documentation](./dbt)|
|Go|<GoLangSVG style={{width: '3rem'}} />|Language client|The Go client uses the native interface for a performant, low-overhead means of connecting to ClickHouse.|[Documentation](/docs/en/integrations/language-clients/go/intro.md)|
|Java|<JavaSVG style={{width: '3rem' }} />|Language client|The Java client is an async, lightweight, and low-overhead library for ClickHouse.|[Documentation](https://github.com/clickhouse/clickhouse-jdbc#readme)|
|Java|<JavaSVG style={{width: '3rem' }} />|Language client|The Java client is an async, lightweight, and low-overhead library for ClickHouse.|[Documentation](https://github.com/clickhouse/clickhouse-java#readme)|
|Node.JS|<NodeSVG style={{width: '3rem', 'height': '3rem'}} />|Language client|The official Node.js client for connecting to ClickHouse.|[Documentation](/docs/en/integrations/language-clients/nodejs.md)|
|Python|<PythonSVG style={{width: '3rem', 'height': '3rem'}} />|Language client|A suite of Python packages for connecting Python to ClickHouse.|[Documentation](/docs/en/integrations/language-clients/python/intro.md)|
|Superset|<SupersetSVG style={{width: '3rem'}} />|Data visualization|Explore and visualize your ClickHouse data with Apache Superset.|[Documentation](../connect-a-ui/superset-and-clickhouse)|
Expand Down
2 changes: 1 addition & 1 deletion docs/en/integrations/language-clients/java/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: The ClickHouse JDBC driver enables a Java application to interact w

# Connecting Applications to ClickHouse with JDBC

**Overview:** The <a href="https://github.com/ClickHouse/clickhouse-jdbc/tree/master/clickhouse-jdbc" target="_blank">ClickHouse JDBC driver</a> enables a Java application to interact with ClickHouse:
**Overview:** The <a href="https://github.com/ClickHouse/clickhouse-java/tree/main/clickhouse-jdbc" target="_blank">ClickHouse JDBC driver</a> enables a Java application to interact with ClickHouse:
<img src={require('./images/jdbc-2-01.png').default} class="image" alt="ClickHouse JDBC Driver"/>

In this lesson we will create a minimal Java application that uses the ClickHouse JDBC driver for querying a ClickHouse database.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/integrations/sql-clients/datagrip.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ DataGrip is available at https://www.jetbrains.com/datagrip/
:::tip
The **HOST** entry in the DataGrip dialog is actually a URL, see the image below.

For more details on JDBC URL settings, please refer to the [ClickHouse JDBC driver](https://github.com/ClickHouse/clickhouse-jdbc) repository.
For more details on JDBC URL settings, please refer to the [ClickHouse JDBC driver](https://github.com/ClickHouse/clickhouse-java) repository.
:::

![](@site/docs/en/integrations/sql-clients/images/datagrip-7.png)
Expand Down