Skip to content

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

Set explicit default binning when "Don't bin" is specified (#76930)

metambene0d007399fca
diff --git a/frontend/src/metabase-lib/query/temporal_bucket.ts b/frontend/src/metabase-lib/query/temporal_bucket.ts
index 83ffe2596e9..ad1de659092 100644
--- a/frontend/src/metabase-lib/query/temporal_bucket.ts
+++ b/frontend/src/metabase-lib/query/temporal_bucket.ts
@@ -26,7 +26,7 @@ export function isTemporalBucketable(
export function withTemporalBucket(
column: ColumnMetadata,
- bucket: Bucket | null,
+ bucket: Bucket | "default" | null,
): ColumnMetadata {
return ML.with_temporal_bucket(column, bucket);
}
diff --git a/frontend/src/metabase-lib/query/types.ts b/frontend/src/metabase-lib/query/types.ts
index e0b66395539..4bc4dff34d3 100644
--- a/frontend/src/metabase-lib/query/types.ts
+++ b/frontend/src/metabase-lib/query/types.ts
@@ -3,13 +3,13 @@ import type {
CardId,
DatabaseId,
DatasetColumn,
+ DatetimeUnit,
FieldId,
FieldValuesType,
RowValue,
SchemaId,
TableId,
TableVisibilityType,
- TemporalUnit,
} from "metabase-types/api";
import type {
@@ -148,7 +148,7 @@ declare const BucketSymbol: unique symbol;
export type Bucket = unknown & { _opaque: typeof BucketSymbol };
export type BucketDisplayInfo = {
- shortName: TemporalUnit;
+ shortName: DatetimeUnit;
displayName: string;
default?: boolean;
selected?: boolean;
diff --git a/frontend/src/metabase/common/components/QueryColumnPicker/ColumnBucketPickerPopover/TemporalBucketPickerPopover.tsx b/frontend/src/metabase/common/components/QueryColumnPicker/ColumnBucketPickerPopover/TemporalBucketPickerPopover.tsx
index efd5d5f5b89..6ddb68325eb 100644
--- a/frontend/src/metabase/common/components/QueryColumnPicker/ColumnBucketPickerPopover/TemporalBucketPickerPopover.tsx
+++ b/frontend/src/metabase/common/components/QueryColumnPicker/ColumnBucketPickerPopover/TemporalBucketPickerPopover.tsx
@@ -37,37 +37,61 @@ export function TemporalBucketPickerPopover({
classNames,
}: CommonBucketPickerProps) {
const selectedBucket = useMemo(() => Lib.temporalBucket(column), [column]);
+ const isExplicitlyUnbucketed = useMemo(
+ () =>
+ selectedBucket != null &&
+ Lib.displayInfo(query, stageIndex, selectedBucket).shortName ===
+ "default",
+ [query, stageIndex, selectedBucket],
+ );
const items: BucketItem[] = useMemo(
() => [
...buckets.map((bucket) => getBucketItem(query, stageIndex, bucket)),
{
displayName: t`Don't bin`,
- isSelected: !selectedBucket && isEditing,
+ isSelected: isEditing && (isExplicitlyUnbucketed || !selectedBucket),
},
],
- [buckets, selectedBucket, isEditing, query, stageIndex],
+ [
+ buckets,
+ selectedBucket,
+ isExplicitlyUnbucketed,
+ isEditing,
+ query,
+ stageIndex,
+ ],
);
const triggerLabel = useMemo(() => {
- const displayBucket = isEditing
- ? selectedBucket
- : buckets.find((bucket) => {
- const info = Lib.displayInfo(query, stageIndex, bucket);
- return info.default;
- });
+ const displayBucket =
+ isEditing && !isExplicitlyUnbucketed
+ ? selectedBucket
+ : !isEditing
+ ? buckets.find((bucket) => {
+ const info = Lib.displayInfo(query, stageIndex, bucket);
+ return info.default;
+ })
+ : undefined;
if (displayBucket) {
const info = Lib.displayInfo(query, stageIndex, displayBucket);
return t`by ${info.displayName.toLowerCase()}`;
}
return t`Unbinned`;
- }, [query, stageIndex, isEditing, selectedBucket, buckets]);
+ }, [
+ query,
+ stageIndex,
+ isEditing,
+ isExplicitlyUnbucketed,
+ selectedBucket,
+ buckets,
+ ]);
const handleSelect = useCallback(
(item: BucketItem) => {
const index = items.indexOf(item);
- const bucket = buckets.at(index) ?? null;
- onSelect(Lib.withTemporalBucket(column, bucket));
+ const bucket = buckets.at(index);
+ onSelect(Lib.withTemporalBucket(column, bucket ?? "default"));
},
[column, items, buckets, onSelect],
);
diff --git a/frontend/src/metabase/embedding/mcp/hooks/useTemporalGranularity.ts b/frontend/src/metabase/embedding/mcp/hooks/useTemporalGranularity.ts
index 4435e4d6855..ecb4f55661c 100644
--- a/frontend/src/metabase/embedding/mcp/hooks/useTemporalGranularity.ts
+++ b/frontend/src/metabase/embedding/mcp/hooks/useTemporalGranularity.ts
@@ -70,20 +70,26 @@ export function useTemporalGranularity(
? Lib.temporalBucket(temporalColumn)
: null;
- const currentUnit = currentBucket
+ const currentShortName = currentBucket
? Lib.displayInfo(query, stageIndex, currentBucket).shortName
: undefined;
+ const currentUnit: TemporalUnit | undefined =
+ currentShortName && currentShortName !== "default"
+ ? currentShortName
+ : undefined;
const availableBuckets = temporalColumn
? Lib.availableTemporalBuckets(query, stageIndex, temporalColumn)
: [];
- const availableItems: TemporalGranularityItem[] = availableBuckets.map(
+ const availableItems: TemporalGranularityItem[] = availableBuckets.flatMap(
(bucket) => {
const info = Lib.displayInfo(query, stageIndex, bucket);
+ if (info.shortName === "default") {
+ return [];
+ }
const unit = info.shortName;
-
- return { bucket, unit, label: Lib.describeTemporalUnit(unit) };
+ return [{ bucket, unit, label: Lib.describeTemporalUnit(unit) }];
},
);
diff --git a/frontend/src/metabase/querying/filters/components/TimeseriesChrome/TimeseriesBucketPicker/TimeseriesBucketPicker.tsx b/frontend/src/metabase/querying/filters/components/TimeseriesChrome/TimeseriesBucketPicker/TimeseriesBucketPicker.tsx
index 3a20fe071d1..06b83f50759 100644
--- a/frontend/src/metabase/querying/filters/components/TimeseriesChrome/TimeseriesBucketPicker/TimeseriesBucketPicker.tsx
+++ b/frontend/src/metabase/querying/filters/components/TimeseriesChrome/TimeseriesBucketPicker/TimeseriesBucketPicker.tsx
@@ -27,6 +27,7 @@ export function TimeseriesBucketPicker({
const bucket = Lib.temporalBucket(breakout);
return bucket ? Lib.displayInfo(query, stageIndex, bucket) : undefined;
}, [query, stageIndex, breakout]);
+ const isExplicitlyUnbucketed = bucketInfo?.shortName === "default";
const handleChange = (newColumn: Lib.ColumnMetadata) => {
onChange(newColumn);
@@ -41,7 +42,9 @@ export function TimeseriesBucketPicker({
data-testid="timeseries-bucket-button"
onClick={() => setIsOpened(!isOpened)}
>
- {bucketInfo ? bucketInfo.displayName : t`Unbinned`}
+ {bucketInfo && !isExplicitlyUnbucketed
+ ? bucketInfo.displayName
+ : t`Unbinned`}
</Button>
</Popover.Target>
<Popover.Dropdown>
@@ -78,13 +81,19 @@ function TimeseriesBucketDropdown({
column,
);
- const availableItems = availableBuckets.map((bucket) => {
+ const availableItems = availableBuckets.flatMap((bucket) => {
const bucketInfo = Lib.displayInfo(query, stageIndex, bucket);
- return {
- bucket,
- value: bucketInfo.shortName,
- label: bucketInfo.displayName,
- };
+ // `availableTemporalBuckets` never returns the `:default` synthetic bucket, but the type
+ // permits it; skip it here so the picker's `value: TemporalUnit` contract holds.
+ return bucketInfo.shortName === "default"
+ ? []
+ : [
+ {
+ bucket,
+ value: bucketInfo.shortName,
+ label: bucketInfo.displayName,
+ },
+ ];
});
const handleChange = (newValue: TemporalUnit) => {
@@ -95,13 +104,17 @@ function TimeseriesBucketDropdown({
};
const handleRemove = () => {
- const newColumn = Lib.withTemporalBucket(column, null);
+ const newColumn = Lib.withTemporalBucket(column, "default");
onChange(newColumn);
};
return (
<TemporalUnitPicker
- value={bucketInfo?.shortName}
+ value={
+ bucketInfo && bucketInfo.shortName !== "default"
+ ? bucketInfo.shortName
+ : undefined
+ }
availableItems={availableItems}
canRemove
onChange={handleChange}
diff --git a/frontend/src/metabase/querying/filters/components/TimeseriesChrome/TimeseriesBucketPicker/TimeseriesBucketPicker.unit.spec.tsx b/frontend/src/metabase/querying/filters/components/TimeseriesChrome/TimeseriesBucketPicker/TimeseriesBucketPicker.unit.spec.tsx
index ff544e5dd3e..6ea905e0dc8 100644
--- a/frontend/src/metabase/querying/filters/components/TimeseriesChrome/TimeseriesBucketPicker/TimeseriesBucketPicker.unit.spec.tsx
+++ b/frontend/src/metabase/querying/filters/components/TimeseriesChrome/TimeseriesBucketPicker/TimeseriesBucketPicker.unit.spec.tsx
@@ -70,7 +70,11 @@ function setup({ query, breakout, column, stageIndex = -1 }: SetupOpts) {
const getNextBucketName = () => {
const [column] = onChange.mock.lastCall;
const breakout = Lib.temporalBucket(column);
- return breakout ? Lib.displayInfo(query, 0, breakout).displayName : null;
+ if (breakout == null) {
+ return null;
+ }
+ const info = Lib.displayInfo(query, 0, breakout);
+ return info.shortName === "default" ? null : info.displayName;
};
return { onChange, getNextBucketName };
diff --git a/frontend/src/metabase/querying/notebook/components/JoinStep/JoinConditionDraft/JoinConditionDraft.tsx b/frontend/src/metabase/querying/notebook/components/JoinStep/JoinConditionDraft/JoinConditionDraft.tsx
index 7b8b2e3fed2..a97bc937155 100644
--- a/frontend/src/metabase/querying/notebook/components/JoinStep/JoinConditionDraft/JoinConditionDraft.tsx
+++ b/frontend/src/metabase/querying/notebook/components/JoinStep/JoinConditionDraft/JoinConditionDraft.tsx
@@ -60,11 +60,24 @@ export function JoinConditionDraft({
rhsTemporalBucket: Lib.Bucket | null,
) => {
if (lhsExpression != null && rhsExpression != null) {
+ // Prefer a real bucket over the explicit `:default` ("Don't bin") when picking which side's
+ // bucket to propagate: the "first non-empty" contract treats `:default` as empty. If both
+ // sides are `:default`, fall through so the join still gets synced to `:default`.
+ const nonDefault = (b: Lib.Bucket | null): Lib.Bucket | null =>
+ b !== null &&
+ Lib.displayInfo(query, stageIndex, b).shortName === "default"
+ ? null
+ : b;
+ const chosenBucket =
+ nonDefault(lhsTemporalBucket) ??
+ nonDefault(rhsTemporalBucket) ??
+ lhsTemporalBucket ??
+ rhsTemporalBucket;
const newCondition = Lib.joinConditionUpdateTemporalBucketing(
query,
stageIndex,
Lib.joinConditionClause(operator, lhsExpression, rhsExpression),
- lhsTemporalBucket ?? rhsTemporalBucket,
+ chosenBucket,
);
onChange(newCondition);
}
diff --git a/src/metabase/driver/sqlite.clj b/src/metabase/driver/sqlite.clj
index 4433d82ac0f..65b406eaac8 100644
--- a/src/metabase/driver/sqlite.clj
+++ b/src/metabase/driver/sqlite.clj
@@ -203,7 +203,17 @@
;; See also the [SQLite Date and Time Functions Reference](http://www.sqlite.org/lang_datefunc.html).
-(defmethod sql.qp/date [:sqlite :default] [_driver _unit expr] expr)
+;; SQLite stores datetimes as text and the QP wraps datetime literals in `DATETIME(...)` (space-separated),
+;; so raw column reads (T-separated) don't compare equal to those literals. Wrap only when we can
+;; confirm the expr is a table-level datetime column (via its `:database-type`) so both sides
+;; normalize to the same canonical form. Nested-query outer refs lose `:database-type`; leaving them
+;; alone avoids widening `DATE(...)`-typed inner projections to datetime, and keeps value-side date/time
+;; literals from being wrapped in `DATETIME(DATE(...))` or `DATETIME(TIME(...))`.
+(defmethod sql.qp/date [:sqlite :default]
+ [_driver _unit expr]
+ (if (#{"datetime" "timestamp"} (some-> (h2x/database-type expr) u/lower-case-en))
+ (->datetime expr)
+ expr))
(defmethod sql.qp/date [:sqlite :second]
[_driver _unit expr]
diff --git a/src/metabase/lib/join.cljc b/src/metabase/lib/join.cljc
index 0d684601571..62771726111 100644
--- a/src/metabase/lib/join.cljc
+++ b/src/metabase/lib/join.cljc
@@ -1236,8 +1236,15 @@
stage-number (lib.util/canonical-stage-index query stage-number)
available-lhs (lib.temporal-bucket/available-temporal-buckets query stage-number lhs)
available-rhs (lib.temporal-bucket/available-temporal-buckets query stage-number rhs)
- sync-lhs? (or (nil? unit) (contains? (set (map :unit available-lhs)) unit))
- sync-rhs? (or (nil? unit) (contains? (set (map :unit available-rhs)) unit))]
+ ;; `:default` (the explicit "Don't bin" state) isn't listed in
+ ;; `available-temporal-buckets`, but it should still propagate — a join needs both
+ ;; sides bucketed the same way. Accept it alongside `nil` and the available units.
+ sync-lhs? (or (nil? unit)
+ (= :default unit)
+ (contains? (set (map :unit available-lhs)) unit))
+ sync-rhs? (or (nil? unit)
+ (= :default unit)
+ (contains? (set (map :unit available-rhs)) unit))]
(cond-> join-condition
sync-lhs? (update 2 lib.temporal-bucket/with-temporal-bucket unit)
sync-rhs? (update 3 lib.temporal-bucket/with-temporal-bucket unit))))))))
diff --git a/src/metabase/lib/js.cljs b/src/metabase/lib/js.cljs
index 29e1225de90..5e6a22174bb 100644
--- a/src/metabase/lib/js.cljs
+++ b/src/metabase/lib/js.cljs
@@ -644,11 +644,17 @@
(defn ^:export with-temporal-bucket
"Add the specified `bucketing-option` to `a-clause-or-column`, returning an updated form of the clause or column.
- If `bucketing-option` is `nil` (JS `undefined` or `null`), any existing temporal bucketing is removed.
+ `bucketing-option` may be a bucket object (from [[available-temporal-buckets]]) or a unit name string
+ (e.g. `\"day\"`, `\"default\"`). The string `\"default\"` sets an explicit no-truncation bucket that
+ survives the `auto-bucket-datetimes` middleware; contrast with `nil` (JS `undefined` or `null`), which
+ removes the bucket entirely and lets the middleware add `:day` back.
> **Code health:** Healthy"
[a-clause-or-column bucketing-option]
- (lib.core/with-temporal-bucket a-clause-or-column bucketing-option))
+ (lib.core/with-temporal-bucket
+ a-clause-or-column
+ (cond-> bucketing-option
+ (string? bucketing-option) keyword)))
(defn ^:export available-temporal-buckets
"Get a list of available temporal bucketing options for `a-clause-or-column` in the context of `a-query`
diff --git a/test/metabase/driver/sqlite_test.clj b/test/metabase/driver/sqlite_test.clj
index 5c9d4bdb587..1a33d3b30c1 100644
--- a/test/metabase/driver/sqlite_test.clj
+++ b/test/metabase/driver/sqlite_test.clj
@@ -34,6 +34,42 @@
(is (= ["TIME(STRFTIME('%H:00', \"test_col\"))"]
(sql.qp/format-honeysql :sqlite (sql.qp/date :sqlite :hour expr)))))))
+(deftest ^:parallel default-bucketing-test
+ (testing (str "`:default` (explicit 'Don't bin') on SQLite wraps confirmed datetime columns in "
+ "DATETIME(...) so raw text storage compares equal to the QP-supplied DATETIME(literal) "
+ "value; everything else passes through so we don't widen types or double-wrap literals")
+ (let [ts-col (h2x/with-database-type-info :ts "timestamp")
+ dt-col (h2x/with-database-type-info :dt "datetime")
+ date-col (h2x/with-database-type-info :d "date")
+ time-col (h2x/with-database-type-info :t "time")
+ dt-lit [:datetime (h2x/literal "2022-03-15 00:20:48")]
+ date-lit [:date (h2x/literal "2014-03-05")]
+ time-lit [:time (h2x/literal "09:30:00")]]
+ (testing "TIMESTAMP columns get wrapped"
+ (is (= ["DATETIME(\"ts\")"]
+ (sql.qp/format-honeysql :sqlite (sql.qp/date :sqlite :default ts-col)))))
+ (testing "DATETIME columns get wrapped"
+ (is (= ["DATETIME(\"dt\")"]
+ (sql.qp/format-honeysql :sqlite (sql.qp/date :sqlite :default dt-col)))))
+ (testing "DATE columns pass through so their type isn't widened to datetime"
+ (is (= ["\"d\""]
+ (sql.qp/format-honeysql :sqlite (sql.qp/date :sqlite :default date-col)))))
+ (testing "TIME columns pass through so their type isn't widened to datetime"
+ (is (= ["\"t\""]
+ (sql.qp/format-honeysql :sqlite (sql.qp/date :sqlite :default time-col)))))
+ (testing "untyped exprs (e.g. nested-query outer refs) pass through so we don't wrap DATE results"
+ (is (= ["\"col\""]
+ (sql.qp/format-honeysql :sqlite (sql.qp/date :sqlite :default :col)))))
+ (testing "datetime literals aren't double-wrapped"
+ (is (= ["DATETIME('2022-03-15 00:20:48')"]
+ (sql.qp/format-honeysql :sqlite (sql.qp/date :sqlite :default dt-lit)))))
+ (testing "date literals aren't wrapped in DATETIME(DATE(...))"
+ (is (= ["DATE('2014-03-05')"]
+ (sql.qp/format-honeysql :sqlite (sql.qp/date :sqlite :default date-lit)))))
+ (testing "time literals aren't wrapped in DATETIME(TIME(...))"
+ (is (= ["TIME('09:30:00')"]
+ (sql.qp/format-honeysql :sqlite (sql.qp/date :sqlite :default time-lit))))))))
+
(deftest current-user-table-privileges-test
(testing "SQLite table privileges normalization"
(mt/test-driver :sqlite
diff --git a/test/metabase/lib/join_test.cljc b/test/metabase/lib/join_test.cljc
index 9853e0bd386..da1db428b59 100644
--- a/test/metabase/lib/join_test.cljc
+++ b/test/metabase/lib/join_test.cljc
@@ -1510,7 +1510,17 @@
query
-1
join-condition
- :year)))))))
+ :year)))))
+ (testing ":default (explicit 'Don't bin') propagates to both sides"
+ (is (=? [:= {}
+ [:field {:temporal-unit :default} (meta/id :orders :created-at)]
+ [:field {:temporal-unit :default} (meta/id :products :created-at)]]
+ (lib/join-condition-update-temporal-bucketing
+ query
+ -1
+ (lib/= orders-created-at
+ products-created-at)
+ :default))))))
(deftest ^:parallel default-join-alias-test
(testing "default join-alias set without overwriting other aliases (#32897)"