Skip to content

Commit

Permalink
Fix misleading docs about timestamp_field location (#4873)
Browse files Browse the repository at this point in the history
  • Loading branch information
rdettai authored Apr 16, 2024
1 parent ec88657 commit 7ab5af1
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/configuration/index-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -680,7 +680,7 @@ explicitly in the schema, or may refer to a field captured by the dynamic mode.

## Retention policy

This section describes how Quickwit manages data retention. In Quickwit, the retention policy manager drops data on a split basis as opposed to individually dropping documents. Splits are evaluated based on their `time_range` which is derived from the index timestamp field specified in the (`indexing_settings.timestamp_field`) settings. Using this setting, the retention policy will delete a split when `now() - split.time_range.end >= retention_policy.period`
This section describes how Quickwit manages data retention. In Quickwit, the retention policy manager drops data on a split basis as opposed to individually dropping documents. Splits are evaluated based on their `time_range` which is derived from the index timestamp field specified in the (`doc_mapping.timestamp_field`) settings. Using this setting, the retention policy will delete a split when `now() - split.time_range.end >= retention_policy.period`

```yaml
version: 0.7
Expand Down
2 changes: 1 addition & 1 deletion quickwit/quickwit-config/src/index_config/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -561,7 +561,7 @@ pub(super) fn validate_index_config(

ensure!(
doc_mapping.timestamp_field.is_some(),
"retention policy requires a timestamp field, but indexing settings do not declare one"
"retention policy requires a timestamp field, but doc mapping does not declare one"
);
}
Ok(())
Expand Down

0 comments on commit 7ab5af1

Please sign in to comment.