diff options
Diffstat (limited to 'src/mongo/db/query/sbe_stage_builder_coll_scan.h')
-rw-r--r-- | src/mongo/db/query/sbe_stage_builder_coll_scan.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/src/mongo/db/query/sbe_stage_builder_coll_scan.h b/src/mongo/db/query/sbe_stage_builder_coll_scan.h index b204c5487a8..3b6e1b861ae 100644 --- a/src/mongo/db/query/sbe_stage_builder_coll_scan.h +++ b/src/mongo/db/query/sbe_stage_builder_coll_scan.h @@ -41,7 +41,10 @@ namespace mongo::stage_builder { class PlanStageSlots; /** - * Generates an SBE plan stage sub-tree implementing an collection scan. + * Generates an SBE plan stage sub-tree implementing an collection scan. 'fields' can be used to + * specify top-level fields that should be retrieved during the scan. For each name in 'fields', + * there will be a corresponding kField slot in the PlanStageSlots object returned with the same + * name. * * On success, a tuple containing the following data is returned: * * A slot to access a fetched document (a resultSlot) @@ -56,6 +59,7 @@ std::pair<std::unique_ptr<sbe::PlanStage>, PlanStageSlots> generateCollScan( StageBuilderState& state, const CollectionPtr& collection, const CollectionScanNode* csn, + const std::vector<std::string>& fields, PlanYieldPolicy* yieldPolicy, bool isTailableResumeBranch); |