comment the stats method

This commit is contained in:
Tamo 2023-06-06 12:28:27 +02:00
parent 3cfd653db1
commit 4a3405afec
No known key found for this signature in database
GPG Key ID: 20CD8020AFA88D69
2 changed files with 5 additions and 1 deletions

View File

@ -743,6 +743,10 @@ impl IndexScheduler {
Ok(tasks) Ok(tasks)
} }
/// The returned structure contains:
/// 1. The name of the property being observed can be `statuses`, `types`, or `indexes`.
/// 2. The name of the specific data related to the property can be `enqueued` for the `statuses`, `settingsUpdate` for the `types`, or the name of the index for the `indexes`, for example.
/// 3. The number of times the properties appeared.
pub fn get_stats(&self) -> Result<BTreeMap<String, BTreeMap<String, u64>>> { pub fn get_stats(&self) -> Result<BTreeMap<String, BTreeMap<String, u64>>> {
let rtxn = self.read_txn()?; let rtxn = self.read_txn()?;