{"id":16284973,"url":"https://github.com/goodforgod/micronaut-clickhouse","last_synced_at":"2025-03-20T02:31:28.409Z","repository":{"id":41061082,"uuid":"246640063","full_name":"GoodforGod/micronaut-clickhouse","owner":"GoodforGod","description":"⚙️ Integration between Micronaut and ClickHouse.","archived":false,"fork":false,"pushed_at":"2023-08-13T21:27:20.000Z","size":318,"stargazers_count":11,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-17T13:46:33.284Z","etag":null,"topics":["clickhouse","clickhouse-client","clickhouse-native","configuration","integration","micronaut","micronaut-clickhouse","micronaut-configuration","native"],"latest_commit_sha":null,"homepage":"https://micronaut.io","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GoodforGod.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-11T17:43:19.000Z","updated_at":"2023-08-13T20:23:48.000Z","dependencies_parsed_at":"2024-10-10T19:21:56.319Z","dependency_job_id":"d479f0b5-1c09-40f9-b61d-99e7fcf4aa17","html_url":"https://github.com/GoodforGod/micronaut-clickhouse","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoodforGod%2Fmicronaut-clickhouse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoodforGod%2Fmicronaut-clickhouse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoodforGod%2Fmicronaut-clickhouse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GoodforGod%2Fmicronaut-clickhouse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GoodforGod","download_url":"https://codeload.github.com/GoodforGod/micronaut-clickhouse/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244538590,"owners_count":20468745,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clickhouse","clickhouse-client","clickhouse-native","configuration","integration","micronaut","micronaut-clickhouse","micronaut-configuration","native"],"created_at":"2024-10-10T19:21:45.985Z","updated_at":"2025-03-20T02:31:28.080Z","avatar_url":"https://github.com/GoodforGod.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Micronaut ClickHouse Configuration\n\n[![Minimum required Java version](https://img.shields.io/badge/Java-17%2B-blue?logo=openjdk)](https://openjdk.org/projects/jdk/17/)\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.goodforgod/micronaut-clickhouse/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.goodforgod/micronaut-clickhouse)\n![Java CI](https://github.com/GoodforGod/micronaut-clickhouse/workflows/CI%20Master/badge.svg)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=GoodforGod_micronaut-clickhouse\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=GoodforGod_micronaut-clickhouse)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=GoodforGod_micronaut-clickhouse\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=GoodforGod_micronaut-clickhouse)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=GoodforGod_micronaut-clickhouse\u0026metric=sqale_rating)](https://sonarcloud.io/dashboard?id=GoodforGod_micronaut-clickhouse)\n\nThis project includes integration between Micronaut and ClickHouse, autocompletion for configuration, health check.\n\n## Dependency :rocket:\n\n**Gradle**\n```groovy\nimplementation \"com.github.goodforgod:micronaut-clickhouse:6.0.0\"\n```\n\n**Maven**\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.goodforgod\u003c/groupId\u003e\n    \u003cartifactId\u003emicronaut-clickhouse\u003c/artifactId\u003e\n    \u003cversion\u003e6.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## JDBC\n\nOfficial JDBC driver provides *DataSource*:\n```java\n@Inject\nprivate ClickHouseDataSource clickHouseDataSource;\n\n@Named(\"clickhouse\")\n@Inject\nprivate DataSource dataSource;\n```\n\n### Configuration\n\nOfficial Configuration supports all available ClickHouse driver settings.\n\nCheck [ClickHouse Official settings file](https://github.com/ClickHouse/clickhouse-java/blob/main/clickhouse-client/src/main/java/com/clickhouse/client/config/ClickHouseDefaults.java)\nfor info about all parameters.\n```yaml\nclickhouse:\n  jdbc:\n    url: jdbc:clickhouse://localhost:8529/default?compress=1\n    use-options: true             # default - true\n    options:\n      user: default\n      password: default\n    use-custom-options: true      # default - true\n    custom-options:\n      my-option: 1\n```\n\n## R2DBC\n\nOfficial R2DBC driver provides *ConnectionFactory*:\n```java\n@Named(\"clickhouse\")\n@Inject\nprivate ConnectionFactory connectionFactory;\n```\n\n### Configuration\n\nR2DBC configuration example:\n```yaml\nclickhouse:\n  r2dbc:\n    url: r2dbc:clickhouse:http://localhost:8529/default?compress=1\n```\n\n## Health Check\n\nHealth check for ClickHouse is provided for *JDBC* \u0026 *R2DBC* and is *turned on* by default.\n\nMicronaut health check is part of [Micronaut Health Endpoint](https://docs.micronaut.io/latest/guide/index.html#healthEndpoint).\n\nExample of ClickHouse health:\n```json\n{\n  \"name\": \"service\",\n  \"status\": \"UP\",\n  \"details\": {\n    \"clickhouse-jdbc\": {\n      \"name\": \"clickhouse\",\n      \"status\": \"UP\"\n    },\n    \"clickhouse-r2dbc\": {\n      \"name\": \"clickhouse\",\n      \"status\": \"UP\"\n    }\n  }\n}\n```\n\nWhere *database* name service is connected same as [configuration says](#Configuration).\n\nYou can explicitly *turn off* health check or configure it.\n\n```yaml\nendpoints:\n  health:\n   clickhouse:\n     enabled: true               # default - true \n     jdbc:\n       enabled: true             # default - true \n       timeout: 10000ms          # default - 10000ms\n       retry: 2                  # default - 2\n     r2dbc:\n       enabled: true             # default - true \n       timeout: 10000ms          # default - 10000ms\n       retry: 2                  # default - 2\n```\n\n## Testing\n\nFor testing purposes you can use [ClickHouse TestContainer library](https://www.testcontainers.org/modules/databases/clickhouse/).\n\nTestContainers allows you to use integration tests against real database in all docker friendly environments, \ncheck here for [TestContainers](https://www.testcontainers.org/).\n\n## Micronaut Compatability\n\nStarting from version *6.0.0* library ships for *Micronaut 4* \u0026 Java 17 is required.\n\nStarting from version *3.0.0* library ships for *Micronaut 3*.\n\nStarting from version *2.1.0* Java 11+ is required.\n\nStarting from version *2.0.0* library ships for *Micronaut 2* \u0026 Java 1.8 is required.\n\nLast release for **Micronaut 1** is [version *1.0.2*](https://github.com/GoodforGod/micronaut-clickhouse/releases/tag/v1.0.2).\n\n## License\n\nThis project licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoodforgod%2Fmicronaut-clickhouse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgoodforgod%2Fmicronaut-clickhouse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoodforgod%2Fmicronaut-clickhouse/lists"}