[DOCS-12249] Docs for SERVER-38063: executionStats or allPlansExecution level explain of an aggregate with a $out does writes Created: 07/Dec/18 Updated: 13/Nov/23 Resolved: 26/Feb/19 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | manual, Server |
| Affects Version/s: | None |
| Fix Version/s: | 4.1.7, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113 |
| Type: | Task | Priority: | Major - P3 |
| Reporter: | Kay Kim (Inactive) | Assignee: | Kay Kim (Inactive) |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||
| Participants: | |||||||||
| Days since reply: | 4 years, 50 weeks, 1 day ago | ||||||||
| Epic Link: | DOCS: 4.2 Server/Tools | ||||||||
| Description |
DescriptionDescription:We should document that explain of an $out pipeline with "executionStats" or "allPlansExecution" is disallowed in 4.2. This was not enforced in 3.6 or 4.0, the two existing stable versions that support execution-level explain of aggregate (see If users want explain information from an $out pipeline, they have two options: Engineering Ticket Description:We allow explaining write operations such as the update and delete commands. However, these operations are never supposed to perform writes. An explain of an $out aggregation stage should behave similarly. However, an "executionStats" or "allPlansExecution" verbosity explain of an $out will actually persist the results to the target collection:
This behavior was most likely introduced by the fixes to executionStats agg explain under Instead, we should probably raise an error if a user attempts to perform this operation with an error message such as "$out cannot be explain with 'executionStats' level verbosity or higher". Users who wish to explain an $out operation with execution stats can simply drop the $out stage from the tail of their pipeline. Scope of changesincludes:
Impact to Other DocsMVP (Work and Date)Resources (Scope or Design Docs, Invision, etc.) |
| Comments |
| Comment by Githook User [ 26/Feb/19 ] |
|
Author: {'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}Message: |
| Comment by Githook User [ 26/Feb/19 ] |
|
Author: {'name': 'Kay Kim', 'email': 'kay.kim@10gen.com', 'username': 'kay-kim'}Message: |