searchengines-web/MeiliSearch
searchengines-web/MeiliSearch
1
0
Fork 0
mirror of https://github.com/meilisearch/MeiliSearch synced 2024-12-23 21:20:24 +01:00
Code Issues Releases Wiki Activity

Fixup documentation

Browse Source
This commit is contained in:
Louis Dureuil 2023-11-09 16:23:20 +01:00
parent 825257da76
commit 264b10ec20
No known key found for this signature in database
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
milli/src/update/index_documents/transform.rs
View File

@ -481,16 +481,16 @@ impl<'a, 'i> Transform<'a, 'i> {
Ok(documents_deleted) Ok(documents_deleted)
} }
/// The counter part of `read_documents` that removes documents either from the transform or the database. /// Removes documents from db using their internal document ids.
/// It can be called before, after or in between two calls of the `read_documents`.
/// ///
/// It needs to update all the internal datastructure in the transform. /// # Warning
/// - If the document is coming from the database -> it's marked as a to_delete document ///
/// - If the document to remove was inserted by the `read_documents` method before AND was present in the db, /// This function is dangerous and will only work correctly if:
/// it's marked as `to_delete` + added into the grenad to ensure we don't reinsert it. ///
/// - If the document to remove was inserted by the `read_documents` method before but was NOT present in the db, /// - All the passed ids currently exist in the database
/// it's added into the grenad to ensure we don't insert it + removed from the list of new documents ids. /// - No batching using the standards `remove_documents` and `add_documents` took place
/// - If the document to remove was not present in either the db or the transform we do nothing. ///
/// TODO: make it impossible to call `remove_documents` or `add_documents` on an instance that calls this function.
#[logging_timer::time] #[logging_timer::time]
pub fn remove_documents_from_db_no_batch<FA>( pub fn remove_documents_from_db_no_batch<FA>(
&mut self, &mut self,