Add docs for index.disable_sequence_numbers setting#144353
Add docs for index.disable_sequence_numbers setting#144353fcofdez merged 5 commits intoelastic:mainfrom
Conversation
Document the setting's behavior and limitations including disabled OCC, unsupported updates, weaker consistency for update and delete by query operations, inability to query/filter/sort by _seq_no, and random_score field requirement.
|
Pinging @elastic/es-storage-engine (Team:StorageEngine) |
🔍 Preview links for changed docs |
ℹ️ Important: Docs version tagging👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version. We use applies_to tags to mark version-specific features and changes. Expand for a quick overviewWhen to use applies_to tags:✅ At the page level to indicate which products/deployments the content applies to (mandatory) What NOT to do:❌ Don't remove or replace information that applies to an older version 🤔 Need help?
|
Vale Linting ResultsSummary: 2 warnings, 7 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control.md | 13 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control.md | 16 | Elastic.DontUse | Don't use 'thus'. |
💡 Suggestions (7)
| File | Line | Rule | Message |
|---|---|---|---|
| docs/reference/elasticsearch/index-settings/index-modules.md | 121 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| docs/reference/elasticsearch/index-settings/index-modules.md | 123 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control.md | 10 | Elastic.Versions | Use 'earlier version' instead of 'older version' when referring to versions. |
| docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control.md | 10 | Elastic.Versions | Use 'later version' instead of 'newer version' when referring to versions. |
| docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control.md | 13 | Elastic.WordChoice | Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI. |
| docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control.md | 16 | Elastic.Versions | Use 'earlier version' instead of 'older version' when referring to versions. |
| docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control.md | 16 | Elastic.Versions | Use 'later version' instead of 'newer version' when referring to versions. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
| * **Weaker consistency for update-by-query and delete-by-query**: [Update by query](/reference/elasticsearch/rest-apis/update-by-query-api.md) and [delete by query](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query) operations proceed without sequence number-based conflict detection. This means concurrent modifications to documents during these operations may be silently overwritten rather than triggering version conflicts. | ||
| * **`_seq_no` field not queryable**: Queries, filters, and sorts on the `_seq_no` field are not supported. | ||
| * **`random_score` requires an explicit `field`**: The [`random_score`](/reference/query-languages/query-dsl/query-dsl-function-score-query.md) function cannot fall back to using `_seq_no` as a source of randomness. A `field` parameter must be specified explicitly. | ||
| * **Requires `doc_values_only` sequence number index options**: Must be used with `index.seq_no.index_options` set to `doc_values_only`. |
There was a problem hiding this comment.
This last line probably needs to be with the main section of text and not in the limitations list.
|
|
||
| Disabling sequence numbers introduces the following limitations: | ||
|
|
||
| * **No [optimistic concurrency control](/reference/elasticsearch/rest-apis/optimistic-concurrency-control.md)**: The `if_seq_no` and `if_primary_term` parameters cannot be used with [index](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-index) or [bulk](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk) requests. |
There was a problem hiding this comment.
I wonder if we should mention disabled sequence numbers in optimistic-concurrency-control.md too? Maybe a warning or a note?
romseygeek
left a comment
There was a problem hiding this comment.
LGTM, but we should probably wait for a response to @shainaraskas's question before merging.
|
Gentle ping on this one, maybe @shainaraskas can take another look? |
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
|
@elasticmachine update branch |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Document the setting's behavior and limitations including disabled OCC, unsupported updates, weaker consistency for update and delete by query operations, inability to query/filter/sort by _seq_no, and random_score field requirement. Relates elastic#136305
Document the setting's behavior and limitations including disabled
OCC, unsupported updates, weaker consistency for update and delete
by query operations, inability to query/filter/sort by _seq_no,
and random_score field requirement.
Relates #136305
I used Claude Code for this.