Skip to content

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

Do not set statement timeout for ClickHouse (#85865)

Riley Thompsond2c38cae2fa5
diff --git a/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj b/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
index 7e75ca94e99..9a51d8eff4d 100644
--- a/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
+++ b/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
@@ -69,6 +69,10 @@
:index/fetch true
:index/inline-create true
:index/standalone-create true
+ ;; The JDBC driver sends the query timeout as the `max_execution_time` server setting,
+ ;; which fails for users with `readonly = 1` (#85850). Long running queries will still
+ ;; be cancelled by `schedule-query-timeout-cancel!`.
+ :jdbc/set-query-timeout false
:left-join true
:metadata/key-constraints false
:native-pivot-tables true
diff --git a/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj b/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj
index 8a2ab1044c4..7668b61c05d 100644
--- a/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj
+++ b/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj
@@ -9,6 +9,7 @@
[metabase.driver-api.core :as driver-api]
[metabase.driver.clickhouse :as clickhouse]
[metabase.driver.clickhouse-qp :as clickhouse-qp]
+ [metabase.driver.settings :as driver.settings]
[metabase.driver.sql :as driver.sql]
[metabase.driver.sql-jdbc :as sql-jdbc]
[metabase.driver.sql-jdbc.connection :as sql-jdbc.conn]
@@ -27,6 +28,7 @@
[metabase.test :as mt]
[metabase.test.data.clickhouse :as ctd]
[metabase.upload.impl-test :as upload-test]
+ [metabase.util :as u]
[taoensso.nippy :as nippy]
[toucan2.tools.with-temp :as t2.with-temp])
(:import
@@ -912,6 +914,26 @@
(is (false? (#'sql-jdbc.execute/error-in-query? :clickhouse e)))
(is (true? (#'sql-jdbc.execute/error-in-query? :h2 e)))))))
+(deftest ^:synchronized cancel-slow-query-via-query-timeout-test
+ (mt/test-driver :clickhouse
+ (testing "Slow query is cancelled when *query-timeout-ms* elapses"
+ (sql-jdbc.conn/invalidate-pool-for-db! (mt/id))
+ ;; Make the pool before the binding. c3p0 sets `unreturnedConnectionTimeout` from `*query-timeout-ms*`.
+ (qp/process-query (lib/native-query (mt/metadata-provider) "SELECT 1"))
+ (binding [driver.settings/*query-timeout-ms* 5000]
+ (let [timer (u/start-timer)
+ query (lib/native-query (mt/metadata-provider)
+ "SELECT sleepEachRow(1) FROM numbers(120) SETTINGS max_block_size = 1")
+ result (try
+ (qp/process-query query)
+ (catch Throwable e e))
+ elapsed (u/since-ms timer)]
+ (is (instance? Throwable result))
+ (is (str/includes? (ex-message result) "QUERY_WAS_CANCELLED"))
+ (is (<= driver.settings/*query-timeout-ms*
+ elapsed
+ (* 3 driver.settings/*query-timeout-ms*))))))))
+
(deftest ^:parallel url-building-details-reject-separators-test
(doseq [details [{:host "https://a/b;c" :port 8443 :dbname "d"}
{:host "https://a/b?c" :port 8443 :dbname "d"}]]