summaryrefslogtreecommitdiff
path: root/src/mongo/db/pipeline/pipeline_d.h
diff options
context:
space:
mode:
authorCharlie Swanson <charlie.swanson@mongodb.com>2017-10-18 17:34:16 -0400
committerCharlie Swanson <charlie.swanson@mongodb.com>2017-11-03 16:39:24 -0400
commit265fa69f73e083e07c0092d62dc0f5ed54bc9cfe (patch)
tree55ed978a0b0dbe46297c4fa27c1e198aaeeca823 /src/mongo/db/pipeline/pipeline_d.h
parent8bc6511422a1d3fecbed84d75bf707061c5a8efd (diff)
downloadmongo-265fa69f73e083e07c0092d62dc0f5ed54bc9cfe.tar.gz
SERVER-31443 Add support for change streams with non-simple collations.
Diffstat (limited to 'src/mongo/db/pipeline/pipeline_d.h')
-rw-r--r--src/mongo/db/pipeline/pipeline_d.h17
1 files changed, 7 insertions, 10 deletions
diff --git a/src/mongo/db/pipeline/pipeline_d.h b/src/mongo/db/pipeline/pipeline_d.h
index 0da6ebe2f20..467aa9a8d1c 100644
--- a/src/mongo/db/pipeline/pipeline_d.h
+++ b/src/mongo/db/pipeline/pipeline_d.h
@@ -60,17 +60,14 @@ struct DepsTracker;
class PipelineD {
public:
/**
- * Create a Cursor wrapped in a DocumentSourceCursor, which is suitable
- * to be the first source for a pipeline to begin with. This source
- * will feed the execution of the pipeline.
+ * If the first stage in the pipeline does not generate its own output documents, attaches a
+ * DocumentSourceCursor to the front of the pipeline which will output documents from the
+ * collection to feed into the pipeline.
*
- * This method looks for early pipeline stages that can be folded into
- * the underlying cursor, and when a cursor can absorb those, they
- * are removed from the head of the pipeline. For example, an
- * early match can be removed and replaced with a Cursor that will
- * do an index scan.
- *
- * The cursor is added to the front of the pipeline's sources.
+ * This method looks for early pipeline stages that can be folded into the underlying
+ * PlanExecutor, and removes those stages from the pipeline when they can be absorbed by the
+ * PlanExecutor. For example, an early $match can be removed and replaced with a
+ * DocumentSourceCursor containing a PlanExecutor that will do an index scan.
*
* Callers must take care to ensure that 'nss' is locked in at least IS-mode.
*