POC - Enable support for clickhouse on SL

.github/workflows/cd-sql-engine-tests.yaml

@@ -114,10 +114,39 @@ jobs:
           python-version: "3.12"
           make-target: "test-trino"
 
+  clickhouse-tests:
+    # Clickhouse tests run on a local service container, which obviates the need for separate Environment hosting.
+    # We run them here instead of in the CI unit test suite because they are a bit slower, and because in future
+    # we may choose to execute them against a hosted instance, at which point this config will look like the other
+    # engine configs in this file.
+    name: Clickhouse Tests
+    if: ${{ github.event.action != 'labeled' || github.event.label.name == 'Run Tests With Other SQL Engines' }}
+    runs-on: ubuntu-latest
+    services:
+      clickhouse:
+        image: clickhouse/clickhouse-server
+        ports:
+          - 8123:8123
+        env:
+          CLICKHOUSE_USER: "metricflow"
+          CLICKHOUSE_PASSWORD: "metricflowing"
+          CLICKHOUSE_DB: "metricflow"
+    steps:
+      - name: Check-out the repo
+        uses: actions/checkout@v3
+
+      - name: Test w/ Python 3.12
+        uses: ./.github/actions/run-mf-tests
+        with:
+          python-version: "3.12"
+          make-target: "test-clickhouse"
+          mf_sql_engine_url: "clickhouse://metricflow:metricflowing@localhost:8123/metricflow"
+          mf_sql_engine_password: "metricflowing"
+
   remove-label:
     name: Remove Label After Running Tests
     runs-on: ubuntu-latest
-    needs: [ snowflake-tests, redshift-tests, bigquery-tests, databricks-tests ]
+    needs: [ snowflake-tests, redshift-tests, bigquery-tests, databricks-tests, clickhouse-tests ]
     # Default behavior for `needs` is that it requires success, so a success / failure needs to be specifically checked.
     if: ${{ (success() || failure()) && github.event.action == 'labeled' }}
     steps:

Makefile

@@ -71,6 +71,14 @@ populate-persistent-source-schema-snowflake:
 test-trino:
 	hatch -v run trino-env:pytest -vv -n $(PARALLELISM) $(ADDITIONAL_PYTEST_OPTIONS) $(TESTS_METRICFLOW)/
 
+.PHONY: test-clickhouse
+test-clickhouse:
+	hatch -v run clickhouse-env:pytest -vv -n $(PARALLELISM) $(ADDITIONAL_PYTEST_OPTIONS) $(TESTS_METRICFLOW)/
+
+.PHONY: populate-persistent-source-schema-clickhouse
+populate-persistent-source-schema-clickhouse:
+	hatch -v run clickhouse-env:pytest -vv $(ADDITIONAL_PYTEST_OPTIONS) $(USE_PERSISTENT_SOURCE_SCHEMA) $(POPULATE_PERSISTENT_SOURCE_SCHEMA)
+
 .PHONY: lint
 lint:
 	hatch -v run dev-env:pre-commit run --all-files
@@ -84,6 +92,10 @@ postgresql postgres:
 trino:
 	make -C local-data-warehouses trino
 
+.PHONY: clickhouse
+clickhouse:
+	make -C local-data-warehouses clickhouse
+
 # Re-generate test snapshots using all supported SQL engines.
 .PHONY: regenerate-test-snapshots
 regenerate-test-snapshots:

dbt-metricflow/dbt_metricflow/cli/dbt_connectors/adapter_backed_client.py

@@ -15,6 +15,7 @@
 from metricflow.data_table.mf_table import MetricFlowDataTable
 from metricflow.protocols.sql_client import SqlEngine
 from metricflow.sql.render.big_query import BigQuerySqlQueryPlanRenderer
+from metricflow.sql.render.clickhouse import ClickhouseSqlQueryPlanRenderer
 from metricflow.sql.render.databricks import DatabricksSqlQueryPlanRenderer
 from metricflow.sql.render.duckdb_renderer import DuckDbSqlQueryPlanRenderer
 from metricflow.sql.render.postgres import PostgresSQLSqlQueryPlanRenderer
@@ -42,6 +43,7 @@ class SupportedAdapterTypes(enum.Enum):
     BIGQUERY = "bigquery"
     DUCKDB = "duckdb"
     TRINO = "trino"
+    CLICKHOUSE = "clickhouse"
 
     @property
     def sql_engine_type(self) -> SqlEngine:
@@ -60,6 +62,8 @@ def sql_engine_type(self) -> SqlEngine:
             return SqlEngine.DUCKDB
         elif self is SupportedAdapterTypes.TRINO:
             return SqlEngine.TRINO
+        elif self is SupportedAdapterTypes.CLICKHOUSE:
+            return SqlEngine.CLICKHOUSE
         else:
             assert_values_exhausted(self)
 
@@ -80,6 +84,8 @@ def sql_query_plan_renderer(self) -> SqlQueryPlanRenderer:
             return DuckDbSqlQueryPlanRenderer()
         elif self is SupportedAdapterTypes.TRINO:
             return TrinoSqlQueryPlanRenderer()
+        elif self is SupportedAdapterTypes.CLICKHOUSE:
+            return ClickhouseSqlQueryPlanRenderer()
         else:
             assert_values_exhausted(self)
 

local-data-warehouses/Makefile

@@ -9,3 +9,7 @@ postgresql:
 .PHONY: trino
 trino:
 	docker-compose -f trino/docker-compose.yaml up
+
+.PHONY: clickhouse
+clickhouse:
+	docker-compose -f clickhouse/docker-compose.yaml up

local-data-warehouses/clickhouse/docker-compose.yaml

@@ -0,0 +1,16 @@
+version: "3.7"
+
+services:
+  clickhouse:
+    container_name: clickhouse
+    image: clickhouse/clickhouse-server
+    expose:
+      - "8123"
+      - "9000"
+    ports:
+      - "8123:8123"
+      - "9000:9000"
+    environment:
+      CLICKHOUSE_USER: "metricflow"
+      CLICKHOUSE_PASSWORD: "metricflowing"
+      CLICKHOUSE_DB: "metricflow"

metricflow/protocols/sql_client.py

@@ -25,6 +25,7 @@ class SqlEngine(Enum):
     SNOWFLAKE = "Snowflake"
     DATABRICKS = "Databricks"
     TRINO = "Trino"
+    CLICKHOUSE = "Clickhouse"
 
     @property
     def unsupported_granularities(self) -> Set[TimeGranularity]:
@@ -49,6 +50,8 @@ def unsupported_granularities(self) -> Set[TimeGranularity]:
             return {TimeGranularity.NANOSECOND}
         elif self is SqlEngine.TRINO:
             return {TimeGranularity.NANOSECOND, TimeGranularity.MICROSECOND}
+        elif self is SqlEngine.CLICKHOUSE:
+            return {TimeGranularity.NANOSECOND, TimeGranularity.MICROSECOND}
         else:
             assert_values_exhausted(self)