Skip to content

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

add-rows-truncated middleware => Lib (#63616)

Cam Saul8ecc5c6718e3
diff --git a/src/metabase/query_processor/middleware/add_rows_truncated.clj b/src/metabase/query_processor/middleware/add_rows_truncated.clj
index ac6b285e165..1c97898a0ea 100644
--- a/src/metabase/query_processor/middleware/add_rows_truncated.clj
+++ b/src/metabase/query_processor/middleware/add_rows_truncated.clj
@@ -1,20 +1,24 @@
(ns metabase.query-processor.middleware.add-rows-truncated
"Adds `:rows_truncated` to the query results if the results were truncated because of the query's constraints."
(:require
- [metabase.query-processor.middleware.limit :as limit]
- [metabase.query-processor.settings :as qp.settings]))
+ [metabase.lib.core :as lib]
+ [metabase.lib.schema :as lib.schema]
+ [metabase.query-processor.middleware.limit :as-alias limit]
+ [metabase.query-processor.schema :as qp.schema]
+ [metabase.query-processor.settings :as qp.settings]
+ [metabase.util.malli :as mu]))
(defn- results-limit
- [{{:keys [max-results max-results-bare-rows]} :constraints
- {aggregations :aggregation, :keys [limit page], ::limit/keys [original-limit]} :query
- :as _query}]
- (or (when (and (or (not limit)
- (= original-limit nil))
- (not page)
- (empty? aggregations))
- max-results-bare-rows)
- max-results
- qp.settings/absolute-max-results))
+ [{{:keys [max-results max-results-bare-rows]} :constraints
+ :as query}]
+ (let [{aggregations :aggregation, :keys [limit page], ::limit/keys [original-limit]} (lib/query-stage query -1)]
+ (or (when (and (or (not limit)
+ (= original-limit nil))
+ (not page)
+ (empty? aggregations))
+ max-results-bare-rows)
+ max-results
+ qp.settings/absolute-max-results)))
(defn- add-rows-truncated-xform [limit rf]
{:pre [(int? limit) (fn? rf)]}
@@ -33,10 +37,11 @@
(vswap! row-count inc)
(rf result row)))))
-(defn add-rows-truncated
+(mu/defn add-rows-truncated
"Add `:rows_truncated` to the result if the results were truncated because of the query's constraints. Only affects QP
results that are reduced to a map (e.g. the default reducing function; other reducing functions such as streaming to
a CSV are unaffected.)"
- [query rff]
+ [query :- ::lib.schema/query
+ rff :- ::qp.schema/rff]
(fn add-rows-truncated-rff* [metadata]
(add-rows-truncated-xform (results-limit query) (rff metadata))))
diff --git a/src/metabase/query_processor/postprocess.clj b/src/metabase/query_processor/postprocess.clj
index 72bf8c61d72..87413e7571a 100644
--- a/src/metabase/query_processor/postprocess.clj
+++ b/src/metabase/query_processor/postprocess.clj
@@ -34,7 +34,7 @@
[::mbql5 #'results-metadata/record-and-return-metadata!]
[::mbql5 #'limit/limit-result-rows]
[::mbql5 #'qp.middleware.enterprise/limit-download-result-rows]
- [::legacy #'qp.add-rows-truncated/add-rows-truncated]
+ [::mbql5 #'qp.add-rows-truncated/add-rows-truncated]
[::mbql5 #'qp.add-timezone-info/add-timezone-info]
[::mbql5 #'qp.middleware.enterprise/merge-sandboxing-metadata]
[::mbql5 #'qp.add-remaps/remap-results]
diff --git a/test/metabase/query_processor/middleware/add_rows_truncated_test.clj b/test/metabase/query_processor/middleware/add_rows_truncated_test.clj
index 5ace84e6b17..3d961da55e9 100644
--- a/test/metabase/query_processor/middleware/add_rows_truncated_test.clj
+++ b/test/metabase/query_processor/middleware/add_rows_truncated_test.clj
@@ -1,14 +1,14 @@
(ns metabase.query-processor.middleware.add-rows-truncated-test
(:require
[clojure.test :refer :all]
+ [metabase.lib.test-metadata :as meta]
[metabase.query-processor :as qp]
- [metabase.query-processor.middleware.add-rows-truncated
- :as add-rows-truncated]
+ [metabase.query-processor.middleware.add-rows-truncated :as add-rows-truncated]
[metabase.query-processor.reducible :as qp.reducible]
[metabase.test :as mt]))
(defn- add-rows-truncated [query rows]
- (let [rff (add-rows-truncated/add-rows-truncated query qp.reducible/default-rff)
+ (let [rff (add-rows-truncated/add-rows-truncated (assoc query :lib/type :mbql/query) qp.reducible/default-rff)
rf (rff nil)]
(transduce identity rf rows)))
@@ -19,8 +19,13 @@
:data {:rows [[1] [1] [1] [1] [1]]
:rows_truncated 5}}
(add-rows-truncated
- {:constraints {:max-results 10
- :max-results-bare-rows 5}}
+ {:lib/type :mbql/query
+ :database 1
+ :lib/metadata meta/metadata-provider
+ :stages [{:lib/type :mbql.stage/mbql
+ :source-table 1}]
+ :constraints {:max-results 10
+ :max-results-bare-rows 5}}
[[1] [1] [1] [1] [1]])))))
(deftest ^:parallel add-rows-truncated-test-2
@@ -29,9 +34,14 @@
:row_count 5
:data {:rows [[1] [1] [1] [1] [1]]}}
(add-rows-truncated
- {:query {:aggregation [[:count]]}
- :constraints {:max-results 10
- :max-results-bare-rows 5}}
+ {:lib/type :mbql/query
+ :database 1
+ :lib/metadata meta/metadata-provider
+ :stages [{:lib/type :mbql.stage/mbql
+ :source-table 1
+ :aggregation [[:count {:lib/uuid "00000000-0000-0000-0000-000000000000"}]]}]
+ :constraints {:max-results 10
+ :max-results-bare-rows 5}}
[[1] [1] [1] [1] [1]])))))
(deftest ^:parallel e2e-test