Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

ClickHouse to always support schemas (#68517)

Riley Thompson5959ca6c82c6
diff --git a/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj b/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
index 62df8965243..d9e8203f063 100644
--- a/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
+++ b/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
@@ -53,6 +53,7 @@
:now true
:regex/lookaheads-and-lookbehinds false
:rename true
+ :schemas true
:set-timezone true
:split-part true
:standard-deviation-aggregations true
@@ -66,10 +67,6 @@
:window-functions/offset false}]
(defmethod driver/database-supports? [:clickhouse feature] [_driver _feature _db] supported?))
-(defmethod driver/database-supports? [:clickhouse :schemas]
- [_driver _feature db]
- (boolean (:enable-multiple-db (:details db))))
-
(def ^:private default-connection-details
{:user "default" :password "" :dbname "default" :host "localhost" :port 8123})
diff --git a/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj b/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj
index 6ad61563468..fab194d7d1f 100644
--- a/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj
+++ b/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj
@@ -1,18 +1,23 @@
(ns ^:mb/driver-tests metabase.driver.clickhouse-test
"Tests for specific behavior of the ClickHouse driver."
(:require
+ [clojure.java.jdbc :as jdbc]
[clojure.test :refer :all]
[metabase.driver :as driver]
[metabase.driver.clickhouse-qp :as clickhouse-qp]
+ [metabase.driver.clickhouse-version :as clickhouse-version]
[metabase.driver.sql-jdbc :as sql-jdbc]
[metabase.driver.sql-jdbc.connection :as sql-jdbc.conn]
+ [metabase.lib-be.core :as lib-be]
[metabase.lib.card :as lib.card]
[metabase.lib.core :as lib]
[metabase.lib.metadata :as lib.metadata]
[metabase.query-processor :as qp]
[metabase.query-processor.compile :as qp.compile]
+ [metabase.sync.sync :as sync]
[metabase.test :as mt]
[metabase.test.data.clickhouse :as ctd]
+ [metabase.upload.impl-test :as upload-test]
[taoensso.nippy :as nippy]
[toucan2.tools.with-temp :as t2.with-temp]))
@@ -327,11 +332,12 @@
:output-table "PRODUCTS_COPY"}))))))
(deftest ^:parallel clickhouse-db-supports-schemas-test
- (doseq [[schemas-supported? details] [[false? {}]
- [false? {:enable-multiple-db nil}]
- [false? {:enable-multiple-db false}]
- [true? {:enable-multiple-db true}]]]
- (is (schemas-supported? (driver/database-supports? :clickhouse :schemas {:details details})))))
+ (doseq [details [{}
+ {:enable-multiple-db nil}
+ {:enable-multiple-db false}
+ {:enable-multiple-db true}]]
+ ;; clickhouse will always use schemas after reversions in 65984 and 68517
+ (is (true? (driver/database-supports? :clickhouse :schemas {:details details})))))
(deftest ^:parallel humanize-connection-error-message-test
(is (= "random message" (driver/humanize-connection-error-message :clickhouse ["random message"])))
@@ -369,6 +375,51 @@
(is (true? (driver/database-supports? driver/*driver* :uploads (assoc-in (mt/db) [:dbms-version :cloud] true))))
(is (true? (driver/database-supports? driver/*driver* :uploads (assoc-in (mt/db) [:dbms_version :cloud] true))))))
+(deftest ^:synchronized csv-upload-and-sync-test
+ (testing "ClickHouse CSV uploads work correctly when cloud mode is enabled"
+ (mt/test-driver :clickhouse
+ (with-redefs [clickhouse-version/dbms-version (constantly {:cloud true
+ :version "24.8.1"
+ :semantic-version {:major 24 :minor 8}})]
+ (let [details (-> (mt/dbdef->connection-details :clickhouse :db {:database-name "uploads_schema"})
+ (assoc :enable-multiple-db false))
+ conn-spec (sql-jdbc.conn/connection-details->spec :clickhouse details)]
+ (driver/create-schema-if-needed! :clickhouse conn-spec "uploads_schema")
+ (try
+ (mt/with-temp [:model/Database db {:engine :clickhouse
+ :details details}]
+ (is (true? (driver/database-supports? :clickhouse :uploads db)))
+ (testing "an upload schema is required"
+ (is (thrown-with-msg?
+ clojure.lang.ExceptionInfo
+ #"A schema has not been set."
+ (upload-test/do-with-uploaded-example-csv!
+ {:db-id (:id db)
+ :auxiliary-sync-steps :synchronous
+ :schema-name ""}
+ identity))))
+ (testing "upload models work after sync"
+ (upload-test/do-with-uploaded-example-csv!
+ {:db-id (:id db)
+ :auxiliary-sync-steps :synchronous
+ :schema-name "uploads_schema"}
+ (fn [model]
+ (let [query-model (fn []
+ (let [mp (lib-be/application-database-metadata-provider (:id db))
+ card (lib.metadata/card mp (:id model))]
+ (->> (lib/query mp card)
+ (qp/process-query)
+ (mt/formatted-rows [int str]))))]
+ (is (= [[1 " Luke Skywalker"]
+ [2 " Darth Vader"]]
+ (query-model)))
+ (sync/sync-database! db {:scan :schema})
+ (is (= [[1 " Luke Skywalker"]
+ [2 " Darth Vader"]]
+ (query-model))))))))
+ (finally
+ (jdbc/execute! conn-spec ["DROP DATABASE IF EXISTS `uploads_schema`"]))))))))
+
(deftest ^:parallel type->database-type-test
(testing "type->database-type multimethod returns correct ClickHouse types"
(are [base-type expected] (= expected (driver/type->database-type :clickhouse base-type))