Skip to content

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

Use jdbc-type for SQL Server user defined types as fallback (#82860)

metambenb6f625ed4b0c
diff --git a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
index 2453be72739..ce006f777c0 100644
--- a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
+++ b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
@@ -40,7 +40,7 @@
[next.jdbc :as next.jdbc])
(:import
(com.microsoft.sqlserver.jdbc ISQLServerConnection)
- (java.sql Connection DatabaseMetaData PreparedStatement ResultSet Time)
+ (java.sql Connection DatabaseMetaData PreparedStatement ResultSet Time Types)
(java.time LocalDate LocalDateTime LocalTime OffsetDateTime OffsetTime ZonedDateTime)
(java.time.format DateTimeFormatter)
(java.util UUID)))
@@ -165,6 +165,42 @@
(keyword "decimal identity") :type/Decimal
(keyword "numeric identity") :type/Decimal} column-type))
+(def ^:private jdbc-type->base-type
+ {Types/BIGINT :type/BigInteger
+ Types/BIT :type/Boolean
+ Types/BOOLEAN :type/Boolean
+ Types/CHAR :type/Text
+ Types/DATE :type/Date
+ Types/DECIMAL :type/Decimal
+ Types/DOUBLE :type/Float
+ Types/FLOAT :type/Float
+ Types/INTEGER :type/Integer
+ Types/LONGNVARCHAR :type/Text
+ Types/LONGVARCHAR :type/Text
+ Types/NCHAR :type/Text
+ Types/NUMERIC :type/Decimal
+ Types/NVARCHAR :type/Text
+ Types/REAL :type/Float
+ Types/SMALLINT :type/Integer
+ Types/TIME :type/Time
+ Types/TIME_WITH_TIMEZONE :type/TimeWithTZ
+ Types/TIMESTAMP :type/DateTime
+ Types/TIMESTAMP_WITH_TIMEZONE :type/DateTimeWithZoneOffset
+ Types/TINYINT :type/Integer
+ Types/VARCHAR :type/Text})
+
+(defmethod sql-jdbc.sync/describe-table-fields :sqlserver
+ [driver conn table db-name-or-nil]
+ ;; When TYPE_NAME is a user-defined type alias (`CREATE TYPE Key10 FROM varchar(10)`),
+ ;; `database-type->base-type` can't resolve it. The MSSQL JDBC driver already exposes the underlying
+ ;; base type as `DATA_TYPE` (a `java.sql.Types` code), so use it as a fallback. `:database-type` stays
+ ;; the alias name, so the original type is still visible in field metadata.
+ (into #{}
+ (map (fn [{:keys [base-type jdbc-type] :as col}]
+ (cond-> col
+ (= base-type :type/*) (assoc :base-type (get jdbc-type->base-type jdbc-type base-type)))))
+ ((get-method sql-jdbc.sync/describe-table-fields :sql-jdbc) driver conn table db-name-or-nil)))
+
(defmulti ^:private type->database-type
"Internal type->database-type multimethod for SQL Server that dispatches on type."
{:arglists '([type])}
diff --git a/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj b/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
index b5ba8343159..46acfd18141 100644
--- a/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
+++ b/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
@@ -2,6 +2,7 @@
{:clj-kondo/config '{:linters {:deprecated-var {:exclude {metabase.test.data/mbql-query {:namespaces [metabase.driver.sqlserver-test]}
metabase.test.data/run-mbql-query {:namespaces [metabase.driver.sqlserver-test]}}}}}}
(:require
+ [clojure.java.jdbc :as jdbc]
[clojure.string :as str]
[clojure.test :refer :all]
[colorize.core :as colorize]
@@ -28,7 +29,9 @@
[metabase.query-processor.test :as qp]
[metabase.query-processor.test-util :as qp.test-util]
[metabase.query-processor.timezone :as qp.timezone]
+ [metabase.sync.core :as sync]
[metabase.test :as mt]
+ [metabase.test.data.interface :as tx]
[metabase.test.util.timezone :as test.tz]
[metabase.util :as u]
[metabase.util.date-2 :as u.date]
@@ -1040,6 +1043,39 @@
(is (= :type/BigInteger
(t2/select-one-fn :base_type :model/Field (mt/id :bigint_identity_test :id))))))))
+(def ^:private udt-alias-db-details
+ (delay (mt/dbdef->connection-details :sqlserver :db {:database-name "udt_alias_test"})))
+
+(def ^:private udt-alias-db-ddl
+ ["CREATE TYPE dbo.Key10 FROM varchar(10);"
+ "CREATE TYPE dbo.Importe FROM numeric(19,2);"
+ (str "CREATE TABLE dbo.udt_alias_test ("
+ " id int NOT NULL PRIMARY KEY,"
+ " customer dbo.Key10 NOT NULL,"
+ " amount dbo.Importe NULL,"
+ " plain varchar(10) NULL);")])
+
+(defn- create-udt-alias-db! []
+ (tx/drop-if-exists-and-create-db! :sqlserver "udt_alias_test")
+ (let [spec (sql-jdbc.conn/connection-details->spec :sqlserver @udt-alias-db-details)]
+ (doseq [stmt udt-alias-db-ddl]
+ (jdbc/execute! spec [stmt] {:transaction? false}))))
+
+(deftest user-defined-type-alias-sync-test
+ (testing "UDT aliases (like `CREATE TYPE Key10 FROM varchar(10)`) sync to their underlying base type (#62335)"
+ (mt/test-driver :sqlserver
+ (create-udt-alias-db!)
+ (mt/with-temp [:model/Database database {:engine :sqlserver, :details @udt-alias-db-details}]
+ (sync/sync-database! database)
+ (let [table-id (t2/select-one-pk :model/Table :db_id (:id database) :name "udt_alias_test")
+ fields (into {} (map (juxt :name identity))
+ (t2/select :model/Field :table_id table-id))]
+ (is (=? {:database_type "Key10" :base_type :type/Text} (get fields "customer")))
+ (is (=? {:database_type "Importe" :base_type :type/Decimal} (get fields "amount")))
+ (testing "known base types are untouched"
+ (is (=? {:database_type "int" :base_type :type/Integer} (get fields "id")))
+ (is (=? {:database_type "varchar" :base_type :type/Text} (get fields "plain")))))))))
+
(deftest ^:parallel type->database-type-test
(testing "type->database-type multimethod returns correct SQL Server types"
(are [base-type expected] (= expected (driver/type->database-type :sqlserver base-type))