Skip to content

Commit 1de1846

Browse files
committed
Add documentation and ignore failing test
1 parent b9c0b69 commit 1de1846

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

docs/reference/rest-api.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,13 @@ Updates the configurations of an index. This endpoint follows PUT semantics, whi
332332
- The retention policy update is automatically picked up by the janitor service on its next state refresh.
333333
- The search settings update is automatically picked up by searcher nodes when the next query is executed.
334334
- The indexing settings update is automatically picked up by the indexer nodes once the control plane emits a new indexing plan.
335-
- The doc mapping update is automatically picked up by the indexer nodes once the control plane emit a new indexing plan.
335+
- The doc mapping update is automatically picked up by the indexer nodes once the control plane emit a new indexing plan.
336+
337+
:::warning
338+
339+
If you use the ingest or ES bulk API (V2), the old doc mapping will still be used to validate new documents that end up being persisted on existing shards (see [#5738](https://github.com/quickwit-oss/quickwit/issues/)).
340+
341+
:::
336342

337343
Updating the doc mapping doesn't reindex existing data. Queries and results are mapped on a best-effort basis when querying older splits. For more details, check [the reference](updating-mapper.md) out.
338344

docs/reference/updating-mapper.md

+6
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ Quickwit allows updating the mapping it uses to add more fields to an existing i
66

77
When you update a doc mapping for an index, Quickwit will restart indexing pipelines to take the changes into account. As both this operation and the document ingestion are asynchronous, there is no strict happens-before relationship between ingestion and update. This means a document ingested just before the update may be indexed according to the newer doc mapper, and document ingested just after the update may be indexed with the older doc mapper.
88

9+
:::warning
10+
11+
If you use the ingest or ES bulk API (V2), the old doc mapping will still be used to validate new documents that end up being persisted on existing shards (see [#5738](https://github.com/quickwit-oss/quickwit/issues/)).
12+
13+
:::
14+
915
## Querying
1016

1117
Quickwit always validate queries against the most recent mapping.

quickwit/quickwit-integration-tests/src/tests/update_tests/doc_mapping_tests.rs

+1
Original file line numberDiff line numberDiff line change
@@ -583,6 +583,7 @@ async fn test_update_doc_mapping_add_field_on_strict() {
583583
}
584584

585585
#[tokio::test]
586+
#[ignore]
586587
// TODO(#5738)
587588
async fn test_update_doc_validation() {
588589
quickwit_common::setup_logging_for_tests();

0 commit comments

Comments
 (0)