mirror of
https://github.com/meilisearch/meilisearch.git
synced 2025-10-10 21:56:27 +00:00
Introduce a new executeAfterUpdate index setting
This commit is contained in:
committed by
Kerollmops
parent
84cf389354
commit
128a4629f9
@@ -338,6 +338,7 @@ pub(crate) mod test {
|
|||||||
prefix_search: Setting::NotSet,
|
prefix_search: Setting::NotSet,
|
||||||
chat: Setting::NotSet,
|
chat: Setting::NotSet,
|
||||||
vector_store: Setting::NotSet,
|
vector_store: Setting::NotSet,
|
||||||
|
execute_after_update: Setting::NotSet,
|
||||||
_kind: std::marker::PhantomData,
|
_kind: std::marker::PhantomData,
|
||||||
};
|
};
|
||||||
settings.check()
|
settings.check()
|
||||||
|
@@ -422,6 +422,7 @@ impl<T> From<v5::Settings<T>> for v6::Settings<v6::Unchecked> {
|
|||||||
prefix_search: v6::Setting::NotSet,
|
prefix_search: v6::Setting::NotSet,
|
||||||
chat: v6::Setting::NotSet,
|
chat: v6::Setting::NotSet,
|
||||||
vector_store: v6::Setting::NotSet,
|
vector_store: v6::Setting::NotSet,
|
||||||
|
execute_after_update: v6::Setting::NotSet,
|
||||||
_kind: std::marker::PhantomData,
|
_kind: std::marker::PhantomData,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@@ -320,6 +320,7 @@ InvalidSettingsDisplayedAttributes , InvalidRequest , BAD_REQU
|
|||||||
InvalidSettingsDistinctAttribute , InvalidRequest , BAD_REQUEST ;
|
InvalidSettingsDistinctAttribute , InvalidRequest , BAD_REQUEST ;
|
||||||
InvalidSettingsProximityPrecision , InvalidRequest , BAD_REQUEST ;
|
InvalidSettingsProximityPrecision , InvalidRequest , BAD_REQUEST ;
|
||||||
InvalidSettingsFacetSearch , InvalidRequest , BAD_REQUEST ;
|
InvalidSettingsFacetSearch , InvalidRequest , BAD_REQUEST ;
|
||||||
|
InvalidSettingsexecuteAfterUpdate , InvalidRequest , BAD_REQUEST ;
|
||||||
InvalidSettingsPrefixSearch , InvalidRequest , BAD_REQUEST ;
|
InvalidSettingsPrefixSearch , InvalidRequest , BAD_REQUEST ;
|
||||||
InvalidSettingsFaceting , InvalidRequest , BAD_REQUEST ;
|
InvalidSettingsFaceting , InvalidRequest , BAD_REQUEST ;
|
||||||
InvalidSettingsFilterableAttributes , InvalidRequest , BAD_REQUEST ;
|
InvalidSettingsFilterableAttributes , InvalidRequest , BAD_REQUEST ;
|
||||||
|
@@ -326,6 +326,12 @@ pub struct Settings<T> {
|
|||||||
#[schema(value_type = Option<VectorStoreBackend>)]
|
#[schema(value_type = Option<VectorStoreBackend>)]
|
||||||
pub vector_store: Setting<VectorStoreBackend>,
|
pub vector_store: Setting<VectorStoreBackend>,
|
||||||
|
|
||||||
|
/// Function to execute after an update
|
||||||
|
#[serde(default, skip_serializing_if = "Setting::is_not_set")]
|
||||||
|
#[deserr(default, error = DeserrJsonError<InvalidSettingsexecuteAfterUpdate>)]
|
||||||
|
#[schema(value_type = Option<String>, example = json!("doc.likes += 1"))]
|
||||||
|
pub execute_after_update: Setting<String>,
|
||||||
|
|
||||||
#[serde(skip)]
|
#[serde(skip)]
|
||||||
#[deserr(skip)]
|
#[deserr(skip)]
|
||||||
pub _kind: PhantomData<T>,
|
pub _kind: PhantomData<T>,
|
||||||
@@ -393,6 +399,7 @@ impl Settings<Checked> {
|
|||||||
prefix_search: Setting::Reset,
|
prefix_search: Setting::Reset,
|
||||||
chat: Setting::Reset,
|
chat: Setting::Reset,
|
||||||
vector_store: Setting::Reset,
|
vector_store: Setting::Reset,
|
||||||
|
execute_after_update: Setting::Reset,
|
||||||
_kind: PhantomData,
|
_kind: PhantomData,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -421,6 +428,7 @@ impl Settings<Checked> {
|
|||||||
prefix_search,
|
prefix_search,
|
||||||
chat,
|
chat,
|
||||||
vector_store,
|
vector_store,
|
||||||
|
execute_after_update,
|
||||||
_kind,
|
_kind,
|
||||||
} = self;
|
} = self;
|
||||||
|
|
||||||
@@ -447,6 +455,7 @@ impl Settings<Checked> {
|
|||||||
prefix_search,
|
prefix_search,
|
||||||
vector_store,
|
vector_store,
|
||||||
chat,
|
chat,
|
||||||
|
execute_after_update,
|
||||||
_kind: PhantomData,
|
_kind: PhantomData,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -499,6 +508,7 @@ impl Settings<Unchecked> {
|
|||||||
prefix_search: self.prefix_search,
|
prefix_search: self.prefix_search,
|
||||||
chat: self.chat,
|
chat: self.chat,
|
||||||
vector_store: self.vector_store,
|
vector_store: self.vector_store,
|
||||||
|
execute_after_update: self.execute_after_update,
|
||||||
_kind: PhantomData,
|
_kind: PhantomData,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -580,6 +590,10 @@ impl Settings<Unchecked> {
|
|||||||
prefix_search: other.prefix_search.or(self.prefix_search),
|
prefix_search: other.prefix_search.or(self.prefix_search),
|
||||||
chat: other.chat.clone().or(self.chat.clone()),
|
chat: other.chat.clone().or(self.chat.clone()),
|
||||||
vector_store: other.vector_store.or(self.vector_store),
|
vector_store: other.vector_store.or(self.vector_store),
|
||||||
|
execute_after_update: other
|
||||||
|
.execute_after_update
|
||||||
|
.clone()
|
||||||
|
.or(self.execute_after_update.clone()),
|
||||||
_kind: PhantomData,
|
_kind: PhantomData,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -620,6 +634,7 @@ pub fn apply_settings_to_builder(
|
|||||||
prefix_search,
|
prefix_search,
|
||||||
chat,
|
chat,
|
||||||
vector_store,
|
vector_store,
|
||||||
|
execute_after_update,
|
||||||
_kind,
|
_kind,
|
||||||
} = settings;
|
} = settings;
|
||||||
|
|
||||||
@@ -843,6 +858,14 @@ pub fn apply_settings_to_builder(
|
|||||||
Setting::Reset => builder.reset_vector_store(),
|
Setting::Reset => builder.reset_vector_store(),
|
||||||
Setting::NotSet => (),
|
Setting::NotSet => (),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
match execute_after_update {
|
||||||
|
Setting::Set(execute_after_update) => {
|
||||||
|
builder.set_execute_after_update(execute_after_update.clone())
|
||||||
|
}
|
||||||
|
Setting::Reset => builder.reset_execute_after_update(),
|
||||||
|
Setting::NotSet => (),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub enum SecretPolicy {
|
pub enum SecretPolicy {
|
||||||
@@ -942,13 +965,13 @@ pub fn settings(
|
|||||||
.collect();
|
.collect();
|
||||||
|
|
||||||
let vector_store = index.get_vector_store(rtxn)?;
|
let vector_store = index.get_vector_store(rtxn)?;
|
||||||
|
|
||||||
let embedders = Setting::Set(embedders);
|
let embedders = Setting::Set(embedders);
|
||||||
let search_cutoff_ms = index.search_cutoff(rtxn)?;
|
let search_cutoff_ms = index.search_cutoff(rtxn)?;
|
||||||
let localized_attributes_rules = index.localized_attributes_rules(rtxn)?;
|
let localized_attributes_rules = index.localized_attributes_rules(rtxn)?;
|
||||||
let prefix_search = index.prefix_search(rtxn)?.map(PrefixSearchSettings::from);
|
let prefix_search = index.prefix_search(rtxn)?.map(PrefixSearchSettings::from);
|
||||||
let facet_search = index.facet_search(rtxn)?;
|
let facet_search = index.facet_search(rtxn)?;
|
||||||
let chat = index.chat_config(rtxn).map(ChatSettings::from)?;
|
let chat = index.chat_config(rtxn).map(ChatSettings::from)?;
|
||||||
|
let execute_after_update = index.execute_after_update(rtxn)?;
|
||||||
|
|
||||||
let mut settings = Settings {
|
let mut settings = Settings {
|
||||||
displayed_attributes: match displayed_attributes {
|
displayed_attributes: match displayed_attributes {
|
||||||
@@ -993,6 +1016,10 @@ pub fn settings(
|
|||||||
Some(vector_store) => Setting::Set(vector_store),
|
Some(vector_store) => Setting::Set(vector_store),
|
||||||
None => Setting::Reset,
|
None => Setting::Reset,
|
||||||
},
|
},
|
||||||
|
execute_after_update: match execute_after_update {
|
||||||
|
Some(function) => Setting::Set(function.to_string()),
|
||||||
|
None => Setting::NotSet,
|
||||||
|
},
|
||||||
_kind: PhantomData,
|
_kind: PhantomData,
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -1223,6 +1250,7 @@ pub(crate) mod test {
|
|||||||
prefix_search: Setting::NotSet,
|
prefix_search: Setting::NotSet,
|
||||||
chat: Setting::NotSet,
|
chat: Setting::NotSet,
|
||||||
vector_store: Setting::NotSet,
|
vector_store: Setting::NotSet,
|
||||||
|
execute_after_update: Setting::NotSet,
|
||||||
_kind: PhantomData::<Unchecked>,
|
_kind: PhantomData::<Unchecked>,
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -1256,7 +1284,7 @@ pub(crate) mod test {
|
|||||||
prefix_search: Setting::NotSet,
|
prefix_search: Setting::NotSet,
|
||||||
chat: Setting::NotSet,
|
chat: Setting::NotSet,
|
||||||
vector_store: Setting::NotSet,
|
vector_store: Setting::NotSet,
|
||||||
|
execute_after_update: Setting::NotSet,
|
||||||
_kind: PhantomData::<Unchecked>,
|
_kind: PhantomData::<Unchecked>,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@@ -498,6 +498,17 @@ make_setting_routes!(
|
|||||||
camelcase_attr: "facetSearch",
|
camelcase_attr: "facetSearch",
|
||||||
analytics: FacetSearchAnalytics
|
analytics: FacetSearchAnalytics
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
route: "/execute-after-update",
|
||||||
|
update_verb: put,
|
||||||
|
value_type: String,
|
||||||
|
err_type: meilisearch_types::deserr::DeserrJsonError<
|
||||||
|
meilisearch_types::error::deserr_codes::InvalidSettingsexecuteAfterUpdate,
|
||||||
|
>,
|
||||||
|
attr: execute_after_update,
|
||||||
|
camelcase_attr: "executeAfterUpdate",
|
||||||
|
analytics: ExecuteAfterUpdateAnalytics
|
||||||
|
},
|
||||||
{
|
{
|
||||||
route: "/prefix-search",
|
route: "/prefix-search",
|
||||||
update_verb: put,
|
update_verb: put,
|
||||||
@@ -619,6 +630,9 @@ pub async fn update_all(
|
|||||||
new_settings.non_separator_tokens.as_ref().set(),
|
new_settings.non_separator_tokens.as_ref().set(),
|
||||||
),
|
),
|
||||||
facet_search: FacetSearchAnalytics::new(new_settings.facet_search.as_ref().set()),
|
facet_search: FacetSearchAnalytics::new(new_settings.facet_search.as_ref().set()),
|
||||||
|
execute_after_update: ExecuteAfterUpdateAnalytics::new(
|
||||||
|
new_settings.execute_after_update.as_ref().set(),
|
||||||
|
),
|
||||||
prefix_search: PrefixSearchAnalytics::new(new_settings.prefix_search.as_ref().set()),
|
prefix_search: PrefixSearchAnalytics::new(new_settings.prefix_search.as_ref().set()),
|
||||||
chat: ChatAnalytics::new(new_settings.chat.as_ref().set()),
|
chat: ChatAnalytics::new(new_settings.chat.as_ref().set()),
|
||||||
vector_store: VectorStoreAnalytics::new(new_settings.vector_store.as_ref().set()),
|
vector_store: VectorStoreAnalytics::new(new_settings.vector_store.as_ref().set()),
|
||||||
|
@@ -42,6 +42,7 @@ pub struct SettingsAnalytics {
|
|||||||
pub prefix_search: PrefixSearchAnalytics,
|
pub prefix_search: PrefixSearchAnalytics,
|
||||||
pub chat: ChatAnalytics,
|
pub chat: ChatAnalytics,
|
||||||
pub vector_store: VectorStoreAnalytics,
|
pub vector_store: VectorStoreAnalytics,
|
||||||
|
pub execute_after_update: ExecuteAfterUpdateAnalytics,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Aggregate for SettingsAnalytics {
|
impl Aggregate for SettingsAnalytics {
|
||||||
@@ -197,6 +198,9 @@ impl Aggregate for SettingsAnalytics {
|
|||||||
set: new.facet_search.set | self.facet_search.set,
|
set: new.facet_search.set | self.facet_search.set,
|
||||||
value: new.facet_search.value.or(self.facet_search.value),
|
value: new.facet_search.value.or(self.facet_search.value),
|
||||||
},
|
},
|
||||||
|
execute_after_update: ExecuteAfterUpdateAnalytics {
|
||||||
|
set: new.execute_after_update.set | self.execute_after_update.set,
|
||||||
|
},
|
||||||
prefix_search: PrefixSearchAnalytics {
|
prefix_search: PrefixSearchAnalytics {
|
||||||
set: new.prefix_search.set | self.prefix_search.set,
|
set: new.prefix_search.set | self.prefix_search.set,
|
||||||
value: new.prefix_search.value.or(self.prefix_search.value),
|
value: new.prefix_search.value.or(self.prefix_search.value),
|
||||||
@@ -669,6 +673,21 @@ impl FacetSearchAnalytics {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Default)]
|
||||||
|
pub struct ExecuteAfterUpdateAnalytics {
|
||||||
|
pub set: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ExecuteAfterUpdateAnalytics {
|
||||||
|
pub fn new(distinct: Option<&String>) -> Self {
|
||||||
|
Self { set: distinct.is_some() }
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn into_settings(self) -> SettingsAnalytics {
|
||||||
|
SettingsAnalytics { execute_after_update: self, ..Default::default() }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Serialize, Default)]
|
#[derive(Serialize, Default)]
|
||||||
pub struct PrefixSearchAnalytics {
|
pub struct PrefixSearchAnalytics {
|
||||||
pub set: bool,
|
pub set: bool,
|
||||||
|
@@ -84,6 +84,7 @@ pub mod main_key {
|
|||||||
pub const SEARCH_CUTOFF: &str = "search_cutoff";
|
pub const SEARCH_CUTOFF: &str = "search_cutoff";
|
||||||
pub const LOCALIZED_ATTRIBUTES_RULES: &str = "localized_attributes_rules";
|
pub const LOCALIZED_ATTRIBUTES_RULES: &str = "localized_attributes_rules";
|
||||||
pub const FACET_SEARCH: &str = "facet_search";
|
pub const FACET_SEARCH: &str = "facet_search";
|
||||||
|
pub const EXECUTE_AFTER_UPDATE: &str = "execute-after-update";
|
||||||
pub const PREFIX_SEARCH: &str = "prefix_search";
|
pub const PREFIX_SEARCH: &str = "prefix_search";
|
||||||
pub const DOCUMENTS_STATS: &str = "documents_stats";
|
pub const DOCUMENTS_STATS: &str = "documents_stats";
|
||||||
pub const DISABLED_TYPOS_TERMS: &str = "disabled_typos_terms";
|
pub const DISABLED_TYPOS_TERMS: &str = "disabled_typos_terms";
|
||||||
@@ -1761,6 +1762,22 @@ impl Index {
|
|||||||
self.main.remap_key_type::<Str>().delete(txn, main_key::CHAT)
|
self.main.remap_key_type::<Str>().delete(txn, main_key::CHAT)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn execute_after_update<'t>(&self, txn: &'t RoTxn<'_>) -> heed::Result<Option<&'t str>> {
|
||||||
|
self.main.remap_types::<Str, Str>().get(txn, main_key::EXECUTE_AFTER_UPDATE)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn put_execute_after_update(
|
||||||
|
&self,
|
||||||
|
txn: &mut RwTxn<'_>,
|
||||||
|
val: &str,
|
||||||
|
) -> heed::Result<()> {
|
||||||
|
self.main.remap_types::<Str, Str>().put(txn, main_key::EXECUTE_AFTER_UPDATE, &val)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn delete_execute_after_update(&self, txn: &mut RwTxn<'_>) -> heed::Result<bool> {
|
||||||
|
self.main.remap_key_type::<Str>().delete(txn, main_key::EXECUTE_AFTER_UPDATE)
|
||||||
|
}
|
||||||
|
|
||||||
pub fn localized_attributes_rules(
|
pub fn localized_attributes_rules(
|
||||||
&self,
|
&self,
|
||||||
rtxn: &RoTxn<'_>,
|
rtxn: &RoTxn<'_>,
|
||||||
|
@@ -202,6 +202,7 @@ pub struct Settings<'a, 't, 'i> {
|
|||||||
facet_search: Setting<bool>,
|
facet_search: Setting<bool>,
|
||||||
chat: Setting<ChatSettings>,
|
chat: Setting<ChatSettings>,
|
||||||
vector_store: Setting<VectorStoreBackend>,
|
vector_store: Setting<VectorStoreBackend>,
|
||||||
|
execute_after_update: Setting<String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a, 't, 'i> Settings<'a, 't, 'i> {
|
impl<'a, 't, 'i> Settings<'a, 't, 'i> {
|
||||||
@@ -242,6 +243,7 @@ impl<'a, 't, 'i> Settings<'a, 't, 'i> {
|
|||||||
facet_search: Setting::NotSet,
|
facet_search: Setting::NotSet,
|
||||||
chat: Setting::NotSet,
|
chat: Setting::NotSet,
|
||||||
vector_store: Setting::NotSet,
|
vector_store: Setting::NotSet,
|
||||||
|
execute_after_update: Setting::NotSet,
|
||||||
indexer_config,
|
indexer_config,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -488,6 +490,14 @@ impl<'a, 't, 'i> Settings<'a, 't, 'i> {
|
|||||||
self.vector_store = Setting::Reset;
|
self.vector_store = Setting::Reset;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn set_execute_after_update(&mut self, value: String) {
|
||||||
|
self.execute_after_update = Setting::Set(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn reset_execute_after_update(&mut self) {
|
||||||
|
self.execute_after_update = Setting::Reset;
|
||||||
|
}
|
||||||
|
|
||||||
#[tracing::instrument(
|
#[tracing::instrument(
|
||||||
level = "trace"
|
level = "trace"
|
||||||
skip(self, progress_callback, should_abort, settings_diff, embedder_stats),
|
skip(self, progress_callback, should_abort, settings_diff, embedder_stats),
|
||||||
@@ -1059,6 +1069,18 @@ impl<'a, 't, 'i> Settings<'a, 't, 'i> {
|
|||||||
Ok(changed)
|
Ok(changed)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn update_execute_after_update(&mut self) -> Result<()> {
|
||||||
|
match self.execute_after_update.as_ref() {
|
||||||
|
Setting::Set(new) => {
|
||||||
|
self.index.put_execute_after_update(self.wtxn, &new).map_err(Into::into)
|
||||||
|
}
|
||||||
|
Setting::Reset => {
|
||||||
|
self.index.delete_execute_after_update(self.wtxn).map(drop).map_err(Into::into)
|
||||||
|
}
|
||||||
|
Setting::NotSet => Ok(()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
fn update_embedding_configs(&mut self) -> Result<BTreeMap<String, EmbedderAction>> {
|
fn update_embedding_configs(&mut self) -> Result<BTreeMap<String, EmbedderAction>> {
|
||||||
match std::mem::take(&mut self.embedder_settings) {
|
match std::mem::take(&mut self.embedder_settings) {
|
||||||
Setting::Set(configs) => self.update_embedding_configs_set(configs),
|
Setting::Set(configs) => self.update_embedding_configs_set(configs),
|
||||||
@@ -1469,6 +1491,7 @@ impl<'a, 't, 'i> Settings<'a, 't, 'i> {
|
|||||||
self.update_proximity_precision()?;
|
self.update_proximity_precision()?;
|
||||||
self.update_prefix_search()?;
|
self.update_prefix_search()?;
|
||||||
self.update_facet_search()?;
|
self.update_facet_search()?;
|
||||||
|
self.update_execute_after_update()?;
|
||||||
self.update_localized_attributes_rules()?;
|
self.update_localized_attributes_rules()?;
|
||||||
self.update_disabled_typos_terms()?;
|
self.update_disabled_typos_terms()?;
|
||||||
self.update_chat_config()?;
|
self.update_chat_config()?;
|
||||||
|
@@ -899,6 +899,7 @@ fn test_correct_settings_init() {
|
|||||||
disable_on_numbers,
|
disable_on_numbers,
|
||||||
chat,
|
chat,
|
||||||
vector_store,
|
vector_store,
|
||||||
|
execute_after_update,
|
||||||
} = settings;
|
} = settings;
|
||||||
assert!(matches!(searchable_fields, Setting::NotSet));
|
assert!(matches!(searchable_fields, Setting::NotSet));
|
||||||
assert!(matches!(displayed_fields, Setting::NotSet));
|
assert!(matches!(displayed_fields, Setting::NotSet));
|
||||||
@@ -929,6 +930,7 @@ fn test_correct_settings_init() {
|
|||||||
assert!(matches!(disable_on_numbers, Setting::NotSet));
|
assert!(matches!(disable_on_numbers, Setting::NotSet));
|
||||||
assert!(matches!(chat, Setting::NotSet));
|
assert!(matches!(chat, Setting::NotSet));
|
||||||
assert!(matches!(vector_store, Setting::NotSet));
|
assert!(matches!(vector_store, Setting::NotSet));
|
||||||
|
assert!(matches!(execute_after_update, Setting::NotSet));
|
||||||
})
|
})
|
||||||
.unwrap();
|
.unwrap();
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user