ClickHouse

ClickHouse is an open-source column-oriented database management system for online analytical processing.

Example Usage

---

Terraform

clickhouse-integration.tf

resource "apono_integration" "clickhouse-integration" {
  name                     = "ClickHouse"
  type                     = "clickhouse"
  connector_id             = "apono-connector-id"
  connected_resource_types = ["clickhouse-database"]
  metadata = {
    hostname = "<Hostname>"
    port = "<Native Port>"
    http_port = "<HTTP Port>"
    secure = "<Enable Secure Connection>"
    skip_verify = "<Skip Certification Verification>"
    database = "<Database>"
    cluster = "<Cluster Name>"
    credentials_rotation_period_in_days = "<Credentials rotation period (in days)>"
    credentials_cleanup_period_in_days = "<User cleanup after access is revoked (in days)>"
  }
  kubernetes_secret = {
    name      = "name_template_value"
    namespace = "namespace_template_value"
  }
}

Terraform V2

clickhouse-integration.tf

resource "apono_resource_integration" "clickhouse-integration" {
  name                     = "ClickHouse"
  type                     = "clickhouse"
  connector_id             = "apono-connector-id"
  connected_resource_types = ["clickhouse-database"]
  integration_config = {
    hostname = "<Hostname>"
    port = "<Native Port>"
    http_port = "<HTTP Port>"
    secure = "<Enable Secure Connection>"
    skip_verify = "<Skip Certification Verification>"
    database = "<Database>"
    cluster = "<Cluster Name>"
    credentials_rotation_period_in_days = "<Credentials rotation period (in days)>"
    credentials_cleanup_period_in_days = "<User cleanup after access is revoked (in days)>"
  }
  secret_store_config = {
    kubernetes = {
      name      = "name_template_value"
      namespace = "namespace_template_value"
    }
}

Public API

clickhouse-integration.json

{
    "clickhouse-integration": {
        "name": "ClickHouse",
        "type": "clickhouse",
        "connector_id": "apono-connector-id",
        "connected_resource_types": [
            "clickhouse-database"
        ],
        "integration_config": {
            "hostname": "<Hostname>",
            "port": "<Native Port>",
            "http_port": "<HTTP Port>",
            "secure": "<Enable Secure Connection>",
            "skip_verify": "<Skip Certification Verification>",
            "database": "<Database>",
            "cluster": "<Cluster Name>",
            "credentials_rotation_period_in_days": "<Credentials rotation period (in days)>",
            "credentials_cleanup_period_in_days": "<User cleanup after access is revoked (in days)>",
        },
	"secret_store_config": {
    	    "name": "name_template_value",
    	    "namespace": "namespace_template_value"
  	    }
    }
}

Schema

---

• type clickhouse

• connected_resource_types List of resource types to sync.

Available resource types you can use

• clickhouse-database

• clickhouse-table

• clickhouse-materialized-view

• clickhouse-dictionary

Integration Config

---

• hostname (Required | String) Hostname

• port (Required | String) Native Port

  • Default value: 9000

• http_port (Required | String) HTTP Port

  • Default value: 8123

• secure (Required | String) Enable Secure Connection

  • Default value: false

  • Possible values: true, false

• skip_verify (Required | String) Skip Certification Verification

  • Default value: false

  • Possible values: true, false

• database (Optional | String) Database

  • Default value: default

• cluster (Optional | String) Cluster Name

• credentials_rotation_period_in_days (Optional | String) Credentials rotation period (in days)

• credentials_cleanup_period_in_days (Optional | String) User cleanup after access is revoked (in days)