Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/housepower/ClickHouse-Native-JDBC

ClickHouse Native Protocol JDBC implementation
https://github.com/housepower/ClickHouse-Native-JDBC

analytics clickhouse clickhouse-client database jdbc spark tcp-protocol

Last synced: 3 months ago
JSON representation

ClickHouse Native Protocol JDBC implementation

Host: GitHub
URL: https://github.com/housepower/ClickHouse-Native-JDBC
Owner: housepower
License: apache-2.0
Created: 2018-05-14T02:51:07.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-10-10T01:31:50.000Z (about 1 year ago)
Last Synced: 2024-06-24T09:22:38.148Z (4 months ago)
Topics: analytics, clickhouse, clickhouse-client, database, jdbc, spark, tcp-protocol
Language: Java
Homepage: https://housepower.github.io/ClickHouse-Native-JDBC/
Size: 2.06 MB
Stars: 519
Watchers: 21
Forks: 147
Open Issues: 32
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-clickhouse - housepower/ClickHouse-Native-JDBC - ClickHouse Native JDBC is a Java library implementing the ClickHouse Native Protocol for JDBC access. (Language bindings / Java)

README

        ClickHouse Native JDBC

===

[![Build Status](https://github.com/housepower/ClickHouse-Native-JDBC/workflows/build/badge.svg?branch=master)](https://github.com/housepower/ClickHouse-Native-JDBC/actions?query=workflow%3Abuild+branch%3Amaster)

[![codecov.io](https://codecov.io/github/housepower/ClickHouse-Native-JDBC/coverage.svg?branch=master)](https://codecov.io/github/housepower/ClickHouse-Native-JDBC?branch=master)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.housepower/clickhouse-native-jdbc-parent/badge.svg)](https://search.maven.org/search?q=com.github.housepower)

[![Total alerts](https://img.shields.io/lgtm/alerts/g/housepower/ClickHouse-Native-JDBC.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/housepower/ClickHouse-Native-JDBC/alerts/)

[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/housepower/ClickHouse-Native-JDBC.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/housepower/ClickHouse-Native-JDBC/context:java)

[![License](https://img.shields.io/github/license/housepower/ClickHouse-Native-JDBC)](https://github.com/housepower/ClickHouse-Native-JDBC/blob/master/LICENSE)

English | [简体中文](README_zh.md)

## [Home Page](https://housepower.github.io/ClickHouse-Native-JDBC/) | [GitHub](https://github.com/housepower/ClickHouse-Native-JDBC) | [Gitee](https://gitee.com/housepower/ClickHouse-Native-JDBC)

A Native JDBC library for accessing [ClickHouse](https://clickhouse.yandex/) in Java, also provide a library for 

integrating with [Apache Spark](https://github.com/apache/spark/).

## CONTRIBUTE

We welcome anyone that wants to help out in any way, whether that includes reporting problems, helping with documentations, or contributing code changes to fix bugs, add tests, or implement new features. Please follow [Contributing Guide](CONTRIBUTE.md).

Supported by [JetBrains Open Source License](https://www.jetbrains.com/?from=ClickHouse-Native-JDBC) 2020-2021. 

## JDBC Driver

### Requirements

- Java 8/11. 

**Notes:** We only do test with Java LTS versions.

### Differences from [yandex/clickhouse-jdbc](https://github.com/yandex/clickhouse-jdbc)

* Data is organized and compressed by columns.

* Implemented in the TCP Protocol, with higher performance than HTTP, here is the [benchmark report](docs/dev/benchmark.md).

### Limitations

* Not support insert complex values expression, like `INSERT INTO test_table VALUES(toDate(123456))`, but query is ok.

* Not support insert non-values format, like `TSV`.

* Not support more compression method, like `ZSTD`.

### Import

- Gradle

```groovy

// (recommended) shaded version, available since 2.3-stable

compile "com.github.housepower:clickhouse-native-jdbc-shaded:${clickhouse_native_jdbc_version}"

// normal version

compile "com.github.housepower:clickhouse-native-jdbc:${clickhouse_native_jdbc_version}"

```

- Maven

```xml

    com.github.housepower

    clickhouse-native-jdbc-shaded

    ${clickhouse-native-jdbc.version}

    com.github.housepower

    clickhouse-native-jdbc

    ${clickhouse-native-jdbc.version}

```

## Integration with Spark

### Requirements

- Java 8, Scala 2.11/2.12, Spark 2.4

- Or Java 8/11, Scala 2.12, Spark 3.0/3.1

For Spark 3.2, [Spark ClickHouse Connector](https://github.com/housepower/spark-clickhouse-connector) is recommended.

**Notes:** Spark 2.3.x(EOL) should also work fine. Actually we do test on both Java 8 and Java 11, 

but Spark official support on Java 11 since 3.0.0.

### Import

- Gradle

```groovy

// available since 2.4.0

compile "com.github.housepower:clickhouse-integration-spark_2.11:${clickhouse_native_jdbc_version}"

```

- Maven

```xml

    com.github.housepower

    clickhouse-integration-spark_2.11

    ${clickhouse-native-jdbc.version}

```

## License

This project is distributed under the terms of the Apache License (Version 2.0). See [LICENSE](LICENSE) for details.