Skip to content

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

Snowflake: stop over-escaping schema names in the dynamic-table probe (#78807)

Ngoc Khuat0f1f3ce5ef22
diff --git a/modules/drivers/snowflake/src/metabase/driver/snowflake.clj b/modules/drivers/snowflake/src/metabase/driver/snowflake.clj
index 4404ab7217f..bb241db47a7 100644
--- a/modules/drivers/snowflake/src/metabase/driver/snowflake.clj
+++ b/modules/drivers/snowflake/src/metabase/driver/snowflake.clj
@@ -841,8 +841,15 @@
[_ entity-name]
(escape-name-for-metadata entity-name))
+(defn- show-dynamic-tables-sql
+ "Takes raw, unescaped names. Only the LIKE argument is a pattern, where `_` is a wildcard; the IN SCHEMA
+ names are plain identifiers and must not be escaped (#78541)."
+ [db-name schema-name table-name]
+ (format "SHOW DYNAMIC TABLES LIKE '%s' IN SCHEMA %s.%s;"
+ (escape-name-for-metadata table-name) (quote-schema db-name) (quote-schema schema-name)))
+
(mu/defn- dynamic-table?
- "Check if the table is a dynamic table.
+ "Check if the table is a dynamic table. Takes raw, unescaped names.
You can't rely on :table_type from INFORMATION_SCHEMA.TABLES or :type from getTables because in
both cases it returns `Table` for dynamic tables."
@@ -854,15 +861,13 @@
;; there is another way of checking this by using SHOW TABLES command and check `is_dynamic` column.
;; But this column is not documented on https://docs.snowflake.com/en/sql-reference/sql/show-tables (2024/05/07),
;; So we avoid using it here.
- (-> (jdbc/query
- {:connection conn}
- [(format "SHOW DYNAMIC TABLES LIKE '%s' IN SCHEMA %s.%s;"
- table-name (quote-schema db-name) (quote-schema schema-name))])
+ (-> (jdbc/query {:connection conn} [(show-dynamic-tables-sql db-name schema-name table-name)])
first
some?)
(catch SnowflakeSQLException e
- (log/warnf "Failed to check if table is dynamic: %s" (ex-message e))
- ;; query will fail if schema doesn't exist
+ ;; query will fail if schema doesn't exist. This runs once per table, so skip the stack trace.
+ (log/warnf "Failed to check if table %s.%s.%s is dynamic: %s"
+ db-name schema-name table-name (ex-message e))
false)))
(defn- table->db-name
@@ -902,11 +907,11 @@
^String db-name :- [:maybe :string]
^String schema :- [:maybe :string]
^String table-name :- :string]
- ;; Snowflake bug: schema and table name are interpreted as patterns
- (let [schema (escape-name-for-metadata schema)
- table-name (escape-name-for-metadata table-name)]
- (when-not (dynamic-table? conn db-name schema table-name)
- (sql-jdbc.sync/reducible-table-fks-from-jdbc-metadata metadata db-name schema table-name))))
+ (when-not (dynamic-table? conn db-name schema table-name)
+ ;; Snowflake bug: schema and table name are interpreted as patterns
+ (sql-jdbc.sync/reducible-table-fks-from-jdbc-metadata metadata db-name
+ (escape-name-for-metadata schema)
+ (escape-name-for-metadata table-name))))
(mu/defmethod driver/describe-fks :snowflake :- ::driver/describe-fks.result
[driver :- :keyword
diff --git a/modules/drivers/snowflake/test/metabase/driver/snowflake_test.clj b/modules/drivers/snowflake/test/metabase/driver/snowflake_test.clj
index e9b9c06e439..5e22aa8ca98 100644
--- a/modules/drivers/snowflake/test/metabase/driver/snowflake_test.clj
+++ b/modules/drivers/snowflake/test/metabase/driver/snowflake_test.clj
@@ -451,6 +451,30 @@
{:schema-names [(:schema dynamic-table)]
:table-names [(:name dynamic-table)]}))))))))))))
+(deftest ^:parallel show-dynamic-tables-sql-test
+ (testing "only the LIKE pattern escapes `_`; the IN SCHEMA identifiers stay raw (#78541)"
+ (is (= "SHOW DYNAMIC TABLES LIKE 'MY\\_TABLE' IN SCHEMA \"MY_DB\".\"RAW_DATA\";"
+ (#'driver.snowflake/show-dynamic-tables-sql "MY_DB" "RAW_DATA" "MY_TABLE")))))
+
+(deftest ^:synchronized describe-fks-dynamic-table-check-test
+ (testing "the FK path passes raw names to the dynamic table check (#78541)"
+ (let [dynamic-table-args (atom nil)
+ fk-args (atom nil)]
+ (with-redefs [driver.snowflake/dynamic-table?
+ (fn [_conn db-name schema table-name]
+ (reset! dynamic-table-args [db-name schema table-name])
+ false)
+
+ sql-jdbc.sync/reducible-table-fks-from-jdbc-metadata
+ (fn [_metadata db-name schema table-name]
+ (reset! fk-args [db-name schema table-name])
+ [])]
+ (#'driver.snowflake/reducible-table-fks-from-jdbc-metadata
+ (reify java.sql.Connection) (reify java.sql.DatabaseMetaData) "MY_DB" "RAW_DATA" "MY_TABLE"))
+ (is (= ["MY_DB" "RAW_DATA" "MY_TABLE"] @dynamic-table-args))
+ (testing "but still escapes for the JDBC metadata call, which treats them as patterns"
+ (is (= ["MY_DB" "RAW\\_DATA" "MY\\_TABLE"] @fk-args))))))
+
(deftest ^:sequential describe-table-fields-uuid-column-test
(mt/test-driver :snowflake
(testing "Snowflake tables with UUID columns should sync successfully (#71595)"