[DOCS-13157] Investigate changes in SERVER-30357: Allow users to run the validate cmd with {background:true} Created: 21/Oct/19  Updated: 13/Nov/23  Resolved: 05/Feb/20

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 4.3.1, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Kay Kim (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-30357 Allow users to run the validate cmd w... Closed
documents SERVER-43134 Only run background validation on che... Closed
Duplicate
is duplicated by DOCS-12961 Investigate changes in SERVER-42768: ... Closed
is duplicated by DOCS-13031 Investigate changes in SERVER-43134: ... Closed
Related
related to DOCS-12958 Investigate changes in SERVER-42224: ... Closed
related to DOCS-13058 Investigate changes in SERVER-43644: ... Closed
related to DOCS-13681 Undocument background : true Closed
Participants:
Days since reply: 3 years, 33 weeks, 1 day ago
Epic Link: DOCS: 4.4 Server Release Work

 Description   

Description

Downstream Change Summary

The validate cmd can now run {background:true}. The default for the background parameter is false. {background:true} and {full:true} are incompatible: only one or the other may be true in a single cmd.

Background validation can run concurrently with CRUD and DDL operations. It periodically yields locks to allow CRUD and DDL ops to run concurrently, and will return an error if the collection or an index is dropped that it is validating.

Background validation only runs on checkpoint'ed data, which is only supported by the 'wiredTiger' storage engine, and so background validation is only supported on the 'wiredTiger' storage engine.

If a collection has not yet been checkpoint'ed, then the validate cmd benignly returns ok:1 with valid:true and only a warning in the 'warning' field.

If an index is too newly created to have been checkpoint'ed, then validate w/ background:true will ignore it (won't run validation on it). If an index has been checkpoint'ed, but dropped and the drop hasn't yet been checkpoint'ed, then that index will be ignored as well: no point validating a dropped index.

Description of Linked Ticket

Instead of the existing code

background = false;

in validate.cpp, we will parse the user cmd request's "background" field and initialize it with that value. If unspecified, "background" defaults to false. SERVER-42223 will set up the code to act on background==false.

Additionally, return an error if {full:true} is specified along with {background:true}.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 23/Jun/20 ]

Author:

{'name': 'Kay Kim', 'email': 'kay.kim@10gen.com', 'username': 'kay-kim'}

Message: Revert "DOCS-13157: background validation" per DOCS-13681

This reverts commit 931f303d1ccc9fec16dfb466d1c76133242a257c.
Branch: master
https://github.com/mongodb/docs/commit/12018796a5b3cd983cc0a974baafb2c5786235ab

Comment by Githook User [ 05/Feb/20 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-13157: background validation
Branch: master
https://github.com/mongodb/docs/commit/931f303d1ccc9fec16dfb466d1c76133242a257c

Comment by Kay Kim (Inactive) [ 30/Jan/20 ]

Will do.

I'll do the background validation docs in 2 parts.

Part 1: to lay the groundwork, with regards to the validate() parameters, etc. - DOCS-13058
Part 2: once that ticket is reviewed, will add more details regarding background validate with this DOC.

Comment by Dianna Hohensee (Inactive) [ 21/Oct/19 ]

Let me know if you need more information about checkpoints. I think checkpoints will have to be explained to a certain degree for the user to understand what background validation is running against.

Generated at Thu Feb 08 08:07:05 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.