Skip to content

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

Simplify default search engine and active index logic (#65604)

Chris Truterf506b2ce36b8
diff --git a/enterprise/backend/src/metabase_enterprise/semantic_search/core.clj b/enterprise/backend/src/metabase_enterprise/semantic_search/core.clj
index e3823b2a0fa..e059f78c7ed 100644
--- a/enterprise/backend/src/metabase_enterprise/semantic_search/core.clj
+++ b/enterprise/backend/src/metabase_enterprise/semantic_search/core.clj
@@ -12,14 +12,14 @@
[metabase.analytics.core :as analytics]
[metabase.premium-features.core :refer [defenterprise]]
[metabase.search.engine :as search.engine]
+ [metabase.util :as u]
[metabase.util.log :as log]
[toucan2.realize :as t2.realize]))
(defn- fallback-engine
"Find the highest priority search engine available for fallback."
[]
- (first (filter search.engine/supported-engine?
- search.engine/fallback-engine-priority)))
+ (u/seek #(not= :search.engine/semantic %) (search.engine/supported-engines)))
(defn- index-active? [pgvector index-metadata]
(boolean (semantic.index-metadata/get-active-index-state pgvector index-metadata)))
diff --git a/src/metabase/search/appdb/core.clj b/src/metabase/search/appdb/core.clj
index ad241c805f8..0bf603e6737 100644
--- a/src/metabase/search/appdb/core.clj
+++ b/src/metabase/search/appdb/core.clj
@@ -42,8 +42,10 @@
(defmethod search.engine/supported-engine? :search.engine/appdb [_]
(and (or config/is-dev?
- ;; if the default engine is semantic we want appdb to be available,
- ;; as we want to mix results
+ ;; TODO (Chris 2025-11-07) This backwards dependency is unfortunate, we should find a better solution.
+ ;; Perhaps just an explicit setting for enabling it.
+ ;; This also opens us up to swapping out the fallback, e.g. to elastic search.
+ ;; if the default engine is semantic we want appdb to be available, as we want to mix results
(#{"appdb" "semantic"} (some-> (search.settings/search-engine) name)))
(supported-db? (mdb/db-type))))
diff --git a/src/metabase/search/engine.clj b/src/metabase/search/engine.clj
index b0a052bf220..9d3437aef39 100644
--- a/src/metabase/search/engine.clj
+++ b/src/metabase/search/engine.clj
@@ -3,9 +3,10 @@
(:require
[metabase.search.settings :as settings]))
-(def fallback-engine-priority
- "Search engines in order of preference for fallback scenarios."
- [:search.engine/appdb
+(def ^:private default-engine-precedence
+ "In the absence of explicit configuration, these are the engines to try using, in decreasing order of preference."
+ [:search.engine/semantic
+ :search.engine/appdb
:search.engine/in-place])
(defmulti supported-engine?
@@ -73,12 +74,19 @@
;; If we end up with more "abstract" nodes, we may want a better way to filter them out.
(keys (dissoc (methods supported-engine?) :default)))
+(defn supported-engines
+ "List the search engines that are supported, in order of usage preference.
+ The configured engine comes first, if it is supported."
+ []
+ (let [configured-engine (some->> (settings/search-engine) name (keyword "search.engine"))
+ potential-engines (cond->> default-engine-precedence configured-engine (cons configured-engine))]
+ (distinct (filter supported-engine? potential-engines))))
+
(defn active-engines
- "List the search engines that are supported. Does not mention the legacy in-place engine.
- Default engine comes first."
+ "A list of supported search engines for which we will maintain an index, in order of usage preference.
+ Excludes :search.engine/in-place, which does not use an index."
[]
- (->> (for [[k p] (dissoc (methods supported-engine?) :default :search.engine/in-place) :when (p k)] k)
- (sort-by #(if (= (name %) (name (settings/search-engine))) 0 1))))
+ (remove #{:search.engine/in-place} (supported-engines)))
(defn known-engine?
"Is the given engine recognized?"
diff --git a/src/metabase/search/impl.clj b/src/metabase/search/impl.clj
index 9a81fc29f84..bdc83fe0b04 100644
--- a/src/metabase/search/impl.clj
+++ b/src/metabase/search/impl.clj
@@ -11,7 +11,6 @@
[metabase.search.filter :as search.filter]
[metabase.search.in-place.filter :as search.in-place.filter]
[metabase.search.in-place.scoring :as scoring]
- [metabase.search.settings :as search.settings]
[metabase.util :as u]
[metabase.util.i18n :refer [deferred-tru tru]]
[metabase.util.json :as json]
@@ -219,14 +218,8 @@
(defn default-engine
"In the absence of an explicit engine argument in a request, which engine should be used?"
[]
- (if-let [s (search.settings/search-engine)]
- (let [engine (keyword "search.engine" (name s))]
- (if (search.engine/supported-engine? engine)
- engine
- ;; It would be good to have a warning on start up for this.
- :search.engine/in-place))
- (first (filter search.engine/supported-engine?
- search.engine/fallback-engine-priority))))
+ ;; TODO (Chris 2025-11-07) It would be good to have a warning on start up whenever this is *not* what's configured.
+ (first (search.engine/supported-engines)))
(defn- parse-engine [value]
(or (when-not (str/blank? value)
diff --git a/src/metabase/search/settings.clj b/src/metabase/search/settings.clj
index a27e5971e7e..a71a527c715 100644
--- a/src/metabase/search/settings.clj
+++ b/src/metabase/search/settings.clj
@@ -14,10 +14,11 @@
:audit :getter)
(defsetting search-engine
- (i18n/deferred-tru "Which engine to use by default when performing search. Supported values are :in-place, :appdb, and :semantic")
+ (i18n/deferred-tru "Which engine to use by default for search. Supported values are :in-place, :appdb, and :semantic")
:visibility :authenticated
:export? false
:setter :none
+ ;; TODO (Chris 2025-11-07) Would be good to remove the default and just use [search.engine/default-engine-precedence]
:default :appdb
:type :keyword)