The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Lib column unique key (#64889)
Cam Saulf3b85b3e3374
diff --git a/src/metabase/lib/core.cljc b/src/metabase/lib/core.cljcindex 43d0e5054ad..b6f43ce51ae 100644--- a/src/metabase/lib/core.cljc+++ b/src/metabase/lib/core.cljc@@ -33,6 +33,7 @@[metabase.lib.limit :as lib.limit][metabase.lib.metadata][metabase.lib.metadata.calculation :as lib.metadata.calculation]+ [metabase.lib.metadata.column][metabase.lib.metadata.composed-provider :as lib.metadata.composed-provider][metabase.lib.metadata.protocols][metabase.lib.metric :as lib.metric]@@ -90,6 +91,7 @@lib.limit/keep-memetabase.lib.metadata/keep-melib.metadata.calculation/keep-me+ metabase.lib.metadata.column/keep-melib.metadata.composed-provider/keep-memetabase.lib.metadata.protocols/keep-melib.metric/keep-me@@ -356,6 +358,9 @@suggested-nametype-ofvisible-columns]+ [metabase.lib.metadata.column+ column-unique-key+ column-with-unique-key][lib.metadata.composed-providercomposed-metadata-provider][metabase.lib.metadata.protocolsdiff --git a/src/metabase/lib/metadata/calculation.cljc b/src/metabase/lib/metadata/calculation.cljcindex 7fd1017647a..103a2aca0b0 100644--- a/src/metabase/lib/metadata/calculation.cljc+++ b/src/metabase/lib/metadata/calculation.cljc@@ -455,9 +455,9 @@[:lib/source ::lib.schema.metadata/column.source]]])(mr/def ::returned-column+ "Schema for a returned column as returned by [[returned-columns]]; includes all the normal metadata but is also+ guaranteed to have `:lib/source`, `:lib/source-column-alias`, and `:lib/desired-column-alias`."[:merge- ;; visible column is just the normal column metadata schema but also requires `:lib/source` and- ;; `:lib/source-column-alias`[:ref ::visible-column][:map[:lib/desired-column-alias ::lib.schema.metadata/desired-column-alias]]])diff --git a/src/metabase/lib/metadata/column.cljc b/src/metabase/lib/metadata/column.cljcnew file mode 100644index 00000000000..ce70ae13b51--- /dev/null+++ b/src/metabase/lib/metadata/column.cljc@@ -0,0 +1,42 @@+(ns metabase.lib.metadata.column+ (:require+ [medley.core :as m]+ [metabase.lib.metadata.calculation :as lib.metadata.calculation]+ [metabase.lib.schema :as lib.schema]+ [metabase.util.malli :as mu]+ [metabase.util.malli.registry :as mr]))++(mr/def ::column-unique-key+ [:re+ #"^column-unique-key-v\d+\$.+$"])++(mr/def ::column-unique-key-version+ nat-int?)++(mu/defn- pack-unique-key :- ::column-unique-key+ [version :- ::column-unique-key-version+ column-key :- :string]+ (str "column-unique-key-v" version "$" column-key))++(mu/defn- unpack-unique-key :- [:tuple #_version ::column-unique-key-version #_rest :string]+ [unique-key :- ::column-unique-key]+ (let [[_match version-string column-key] (re-find #"^column-unique-key-v(\d+)\$(.+$)" unique-key)]+ [(parse-long version-string) column-key]))++(mu/defn column-unique-key :- ::column-unique-key+ "Create a unique key for returned column metadata. Treat this key as opaque!"+ [col :- ::lib.metadata.calculation/returned-column]+ (pack-unique-key 1 (:lib/desired-column-alias col)))++(mu/defn column-with-unique-key :- [:maybe ::lib.metadata.calculation/returned-column]+ "Get metadata for the returned column with `unique-key`."+ ([query unique-key]+ (column-with-unique-key query -1 unique-key))+ ([query :- ::lib.schema/query+ stage-number :- :int+ unique-key :- ::column-unique-key]+ (let [[version column-key] (unpack-unique-key unique-key)]+ (m/find-first+ (case version+ 1 #(= (:lib/desired-column-alias %) column-key))+ (lib.metadata.calculation/returned-columns query stage-number)))))diff --git a/test/metabase/lib/metadata/column_test.cljc b/test/metabase/lib/metadata/column_test.cljcnew file mode 100644index 00000000000..e33177fa40e--- /dev/null+++ b/test/metabase/lib/metadata/column_test.cljc@@ -0,0 +1,26 @@+(ns metabase.lib.metadata.column-test+ (:require+ [clojure.test :refer [deftest is]]+ [metabase.lib.core :as lib]+ [metabase.lib.metadata.column :as lib.metadata.column]+ [metabase.lib.test-metadata :as meta]+ [metabase.lib.test-util.notebook-helpers :as lib.tu.notebook]))++(deftest ^:parallel column-unique-key-test+ (let [query (-> (lib/query meta/metadata-provider (meta/table-metadata :venues))+ (lib/join (meta/table-metadata :categories)))+ categories-name (lib.tu.notebook/find-col-with-spec query+ (lib/returned-columns query)+ {:display-name "Categories"}+ {:display-name "Name"})]+ (is (= "column-unique-key-v1$Categories__NAME"+ (lib.metadata.column/column-unique-key categories-name)))+ (is (= categories-name+ (lib.metadata.column/column-with-unique-key query "column-unique-key-v1$Categories__NAME")))))++(deftest ^:parallel column-unique-key-error-on-unknown-version-test+ (let [query (lib/query meta/metadata-provider (meta/table-metadata :venues))]+ (is (thrown-with-msg?+ #?(:clj java.lang.IllegalArgumentException :cljs :default)+ #"No matching clause: 123456"+ (lib.metadata.column/column-with-unique-key query "column-unique-key-v123456$Categories__NAME")))))