feat: add ClickHouse support and related migrations (#38)

Author: chinhnguyen-95

.github/workflows/ci.yaml

@@ -42,7 +42,7 @@ jobs:
   integration-tests:
     strategy:
       matrix:
-        dialect: [mysql, postgresql, sqlite, mssql]
+        dialect: [mysql, postgresql, sqlite, mssql, clickhouse]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

README.md

@@ -131,6 +131,7 @@ The provider supports the following databases:
 * PostgreSQL
 * SQLite
 * Microsoft SQL Server
+* ClickHouse
 
 ### FAQ
 

atlas_provider_sqlalchemy/main.py

@@ -23,6 +23,7 @@ class Dialect(str, Enum):
     postgresql = "postgresql"
     sqlite = "sqlite"
     mssql = "mssql"
+    clickhouse = "clickhouse"
 
 
 def run(

poetry.lock

@@ -10,6 +10,7 @@ packages = [{include = "atlas_provider_sqlalchemy"}]
 python = "^3.9"
 typer = ">0.9.0,<=1.0.0"
 sqlalchemy = "^2.0.41"
+clickhouse-sqlalchemy = "^0.3.2"
 
 [tool.pyrefly]
 project-includes = [

pyproject.toml

@@ -8,6 +8,7 @@ locals {
     postgresql = "docker://postgres/15"
     sqlite = "sqlite://?mode=memory&_fk=1"
     mssql = "docker://sqlserver/2022-latest"
+    clickhouse = "docker://clickhouse/25.9/dev"
   }[var.dialect]
 }
 
@@ -17,7 +18,7 @@ data "external_schema" "sqlalchemy" {
     "run",
     "python3",
     "load_models.py",
-    var.dialect, // mysql | postgresql | sqlite | mssql
+    var.dialect, // mysql | postgresql | sqlite | mssql | clickhouse
   ]
 }
 

tests/atlas-script.hcl

@@ -13,6 +13,7 @@ locals {
     postgresql = "docker://postgres/15"
     sqlite = "sqlite://?mode=memory&_fk=1"
     mssql = "docker://sqlserver/2022-latest"
+    clickhouse = "docker://clickhouse/23.11/dev"
   }[var.dialect]
 }
 
@@ -23,7 +24,7 @@ data "external_schema" "sqlalchemy" {
     "python3",
     "../atlas_provider_sqlalchemy/main.py",
     "--path", var.path,
-    "--dialect", var.dialect, // mysql | postgresql | sqlite | mssql
+    "--dialect", var.dialect, // mysql | postgresql | sqlite | mssql | clickhouse
   ]
 }
 

tests/atlas-standalone.hcl

@@ -0,0 +1,14 @@
+-- Create "address" table
+CREATE TABLE `address` (
+  `id` Int32,
+  `email_address` FixedString(30),
+  `user_id` Int32
+) ENGINE = MergeTree
+PRIMARY KEY (`id`) ORDER BY (`id`) SETTINGS index_granularity = 8192;
+-- Create "user_account" table
+CREATE TABLE `user_account` (
+  `id` Int32,
+  `name` FixedString(30),
+  `fullname` FixedString(30)
+) ENGINE = MergeTree
+PRIMARY KEY (`id`) ORDER BY (`id`) SETTINGS index_granularity = 8192;

tests/migrations/clickhouse/20251007100727.sql

@@ -0,0 +1,2 @@
+h1:erjqmA/a6B0TjDxdO09+CH0ToQUBXoN9Nhos0cswMpc=
+20251007100727.sql h1:sOg0sT6jinsVMTDsIeArCpUIcljWYu4lmBqLPuBKGQo=

tests/migrations/clickhouse/atlas.sum

@@ -23,6 +23,7 @@
     [
         (Dialect.postgresql, "tests/testdata/models/ddl_postgres.sql"),
         (Dialect.mysql, "tests/testdata/models/ddl_mysql.sql"),
+        (Dialect.clickhouse, "tests/testdata/models/ddl_clickhouse.sql"),
     ],
 )
 def test_run_models(
@@ -44,6 +45,7 @@ def test_run_models(
     [
         (Dialect.postgresql, "tests/testdata/old_models/ddl_postgres.sql"),
         (Dialect.mysql, "tests/testdata/old_models/ddl_mysql.sql"),
+        (Dialect.clickhouse, "tests/testdata/old_models/ddl_clickhouse.sql"),
     ],
 )
 def test_run_old_models(
@@ -65,6 +67,7 @@ def test_run_old_models(
     [
         (Dialect.postgresql, "tests/testdata/structured_models/ddl_postgres.sql"),
         (Dialect.mysql, "tests/testdata/structured_models/ddl_mysql.sql"),
+        (Dialect.clickhouse, "tests/testdata/structured_models/ddl_clickhouse.sql"),
     ],
 )
 def test_run_structured_models(
@@ -83,7 +86,7 @@ def test_run_structured_models(
 
 @pytest.mark.parametrize(
     "dialect",
-    [Dialect.postgresql, Dialect.mysql],
+    [Dialect.postgresql, Dialect.mysql, Dialect.clickhouse],
 )
 def test_run_multiple_paths(
     dialect: Dialect,
@@ -109,6 +112,7 @@ def test_run_multiple_paths(
     [
         (Dialect.postgresql, "tests/testdata/tables/ddl_postgres.sql"),
         (Dialect.mysql, "tests/testdata/tables/ddl_mysql.sql"),
+        (Dialect.clickhouse, "tests/testdata/tables/ddl_clickhouse.sql"),
     ],
 )
 def test_run_models_2(