From fd346ef0e281e3831c42cee4997764ca1e58e85a Mon Sep 17 00:00:00 2001 From: Allison Moore Date: Fri, 23 Jan 2015 12:38:22 -0500 Subject: [PATCH 1/2] DOCS-4663: include with token -> extract through fact-agg-comparison-expressions.rst fact-agg-top-level-expressions fact-agg-accumulator & fact-command-puts-secondary-into-recovering fixes minor fact-copydb-behavior && fact-count-on-sharded-clusters deleting unused include files fact-covered-query-sharded-collection removes unused includes --- source/core/query-optimization.txt | 4 +- source/includes/access-eval.rst | 8 --- .../admonition-javascript-prevalence.rst | 6 -- source/includes/admonitions-eval.rst | 2 +- source/includes/behavior-drop-role.rst | 19 ------- .../example-server-status-projection.rst | 11 ---- source/includes/extracts-access-eval.yaml | 22 ++++++++ .../extracts-admonition-js-prevalence.yaml | 28 ++++++++++ source/includes/extracts-examples-eval.yaml | 49 ++++++++++++++++ .../extracts-fact-2.6-wc-gle-change.yaml | 21 +++++++ ...ts-fact-3.0-tools-drop-dbpath-support.yaml | 35 ++++++++++++ .../includes/extracts-fact-agg-boolean.yaml | 42 ++++++++++++++ ...tracts-fact-agg-top-level-expressions.yaml | 49 ++++++++++++++++ ...extracts-fact-aggregation-accumulator.yaml | 56 +++++++++++++++++++ ...ommand-puts-secondary-into-recovering.yaml | 14 +++++ .../extracts-fact-copydb-behavior.yaml | 14 +++++ ...tracts-fact-count-on-sharded-clusters.yaml | 21 +++++++ ...fact-covered-query-sharded-collection.yaml | 14 +++++ .../includes/extracts-parent-access-eval.yaml | 9 +++ ...racts-parent-admonition-js-prevalence.yaml | 11 ++++ ...cts-parent-agg-comparison-expressions.yaml | 6 ++ ...xtracts-parent-fact-2.6-wc-gle-change.yaml | 16 ++++++ ...nt-fact-3.0-tools-drop-dbpath-support.yaml | 10 ++++ .../extracts-parent-fact-agg-boolean.yaml | 7 +++ ...parent-fact-agg-top-level-expressions.yaml | 5 ++ ...s-parent-fact-aggregation-accumulator.yaml | 6 ++ ...ommand-puts-secondary-into-recovering.yaml | 18 ++++++ .../extracts-parent-fact-copydb-behavior.yaml | 29 ++++++++++ ...parent-fact-count-on-sharded-clusters.yaml | 33 +++++++++++ ...fact-covered-query-sharded-collection.yaml | 16 ++++++ ...racts-parent-server-status-projection.yaml | 14 +++++ .../extracts-server-status-projection.yaml | 14 +++++ source/includes/fact-2.6-wc-gle-change.rst | 11 ---- .../fact-3.0-tools-drop-dbpath-support.rst | 4 -- source/includes/fact-agg-boolean.rst | 4 -- .../fact-agg-comparison-expressions.rst | 3 - .../fact-agg-top-level-expressions.rst | 3 - .../includes/fact-aggregation-accumulator.rst | 3 - source/includes/fact-aggregation-types.rst | 3 - ...command-puts-secondary-into-recovering.rst | 15 ----- source/includes/fact-copydb-behavior.rst | 26 --------- .../fact-count-on-sharded-clusters.rst | 30 ---------- .../fact-covered-query-sharded-collection.rst | 13 ----- source/includes/fact-eval-authentication.rst | 6 -- source/includes/fact-id-values-generated.rst | 8 --- .../fact-limits-multiple-in-expressions.rst | 8 --- source/includes/fact-multiple-hosts.rst | 6 -- .../fact-report-security-vulnerability.rst | 5 -- .../fact-shard-ranges-inclusive-exclusive.rst | 2 - source/includes/fact-upsert-multi-options.rst | 4 -- source/includes/fact-write-concern.rst | 10 ---- source/includes/intro-aggregation-boolean.rst | 4 +- .../includes/introduction-query-matching.rst | 8 --- .../includes/list-set-parameters-mongod.rst | 17 ------ .../includes/list-set-parameters-mongos.rst | 10 ---- .../note-disable-profiling-fsynclock.rst | 9 --- source/includes/note-duplicate-id-field.rst | 7 --- source/includes/note-ref-equality.rst | 18 ------ source/includes/note-ssl-tool.rst | 14 ----- source/includes/seealso-elections.rst | 1 - .../includes/warning-blocking-collection.rst | 4 -- source/includes/warning-internal.rst | 5 -- ...warning-text-search-not-for-production.rst | 11 ---- source/reference/command/applyOps.txt | 3 +- source/reference/command/compact.txt | 3 +- source/reference/command/copydb.txt | 4 +- source/reference/command/count.txt | 4 +- source/reference/command/eval.txt | 4 +- source/reference/command/getLastError.txt | 4 +- source/reference/command/group.txt | 3 +- source/reference/command/mapReduce.txt | 3 +- .../reference/command/replSetMaintenance.txt | 3 +- source/reference/command/serverStatus.txt | 3 +- source/reference/limits.txt | 4 +- source/reference/method.txt | 2 +- source/reference/method/cursor.count.txt | 4 +- .../reference/method/db.collection.copyTo.txt | 3 +- .../reference/method/db.collection.count.txt | 4 +- source/reference/method/db.copyDatabase.txt | 4 +- source/reference/method/db.eval.txt | 1 - source/reference/method/db.getLastError.txt | 4 +- .../reference/method/db.getLastErrorObj.txt | 4 +- source/reference/method/db.serverStatus.txt | 3 +- .../operator/aggregation/addToSet.txt | 3 +- .../operator/aggregation/allElementsTrue.txt | 8 +-- source/reference/operator/aggregation/and.txt | 4 +- .../operator/aggregation/anyElementTrue.txt | 8 +-- source/reference/operator/aggregation/avg.txt | 3 +- source/reference/operator/aggregation/cmp.txt | 6 +- source/reference/operator/aggregation/eq.txt | 4 +- .../reference/operator/aggregation/first.txt | 3 +- source/reference/operator/aggregation/gt.txt | 4 +- source/reference/operator/aggregation/gte.txt | 4 +- .../reference/operator/aggregation/last.txt | 3 +- source/reference/operator/aggregation/lt.txt | 6 +- source/reference/operator/aggregation/lte.txt | 4 +- source/reference/operator/aggregation/max.txt | 3 +- source/reference/operator/aggregation/min.txt | 3 +- source/reference/operator/aggregation/ne.txt | 2 +- source/reference/operator/aggregation/not.txt | 4 +- source/reference/operator/aggregation/or.txt | 4 +- .../reference/operator/aggregation/push.txt | 3 +- .../operator/aggregation/setDifference.txt | 4 +- .../operator/aggregation/setEquals.txt | 4 +- .../operator/aggregation/setIntersection.txt | 4 +- .../operator/aggregation/setIsSubset.txt | 4 +- .../operator/aggregation/setUnion.txt | 4 +- source/reference/operator/aggregation/sum.txt | 3 +- source/reference/program/mongodump.txt | 3 +- source/reference/program/mongoexport.txt | 3 +- source/reference/program/mongofiles.txt | 3 +- source/reference/program/mongoimport.txt | 3 +- source/reference/program/mongooplog.txt | 3 +- 113 files changed, 615 insertions(+), 450 deletions(-) delete mode 100644 source/includes/access-eval.rst delete mode 100644 source/includes/admonition-javascript-prevalence.rst delete mode 100644 source/includes/behavior-drop-role.rst delete mode 100644 source/includes/example-server-status-projection.rst create mode 100644 source/includes/extracts-access-eval.yaml create mode 100644 source/includes/extracts-admonition-js-prevalence.yaml create mode 100644 source/includes/extracts-examples-eval.yaml create mode 100644 source/includes/extracts-fact-2.6-wc-gle-change.yaml create mode 100644 source/includes/extracts-fact-3.0-tools-drop-dbpath-support.yaml create mode 100644 source/includes/extracts-fact-agg-boolean.yaml create mode 100644 source/includes/extracts-fact-agg-top-level-expressions.yaml create mode 100644 source/includes/extracts-fact-aggregation-accumulator.yaml create mode 100644 source/includes/extracts-fact-command-puts-secondary-into-recovering.yaml create mode 100644 source/includes/extracts-fact-copydb-behavior.yaml create mode 100644 source/includes/extracts-fact-count-on-sharded-clusters.yaml create mode 100644 source/includes/extracts-fact-covered-query-sharded-collection.yaml create mode 100644 source/includes/extracts-parent-access-eval.yaml create mode 100644 source/includes/extracts-parent-admonition-js-prevalence.yaml create mode 100644 source/includes/extracts-parent-agg-comparison-expressions.yaml create mode 100644 source/includes/extracts-parent-fact-2.6-wc-gle-change.yaml create mode 100644 source/includes/extracts-parent-fact-3.0-tools-drop-dbpath-support.yaml create mode 100644 source/includes/extracts-parent-fact-agg-boolean.yaml create mode 100644 source/includes/extracts-parent-fact-agg-top-level-expressions.yaml create mode 100644 source/includes/extracts-parent-fact-aggregation-accumulator.yaml create mode 100644 source/includes/extracts-parent-fact-command-puts-secondary-into-recovering.yaml create mode 100644 source/includes/extracts-parent-fact-copydb-behavior.yaml create mode 100644 source/includes/extracts-parent-fact-count-on-sharded-clusters.yaml create mode 100644 source/includes/extracts-parent-fact-covered-query-sharded-collection.yaml create mode 100644 source/includes/extracts-parent-server-status-projection.yaml create mode 100644 source/includes/extracts-server-status-projection.yaml delete mode 100644 source/includes/fact-2.6-wc-gle-change.rst delete mode 100644 source/includes/fact-3.0-tools-drop-dbpath-support.rst delete mode 100644 source/includes/fact-agg-boolean.rst delete mode 100644 source/includes/fact-agg-comparison-expressions.rst delete mode 100644 source/includes/fact-agg-top-level-expressions.rst delete mode 100644 source/includes/fact-aggregation-accumulator.rst delete mode 100644 source/includes/fact-aggregation-types.rst delete mode 100644 source/includes/fact-command-puts-secondary-into-recovering.rst delete mode 100644 source/includes/fact-copydb-behavior.rst delete mode 100644 source/includes/fact-count-on-sharded-clusters.rst delete mode 100644 source/includes/fact-covered-query-sharded-collection.rst delete mode 100644 source/includes/fact-eval-authentication.rst delete mode 100644 source/includes/fact-id-values-generated.rst delete mode 100644 source/includes/fact-limits-multiple-in-expressions.rst delete mode 100644 source/includes/fact-multiple-hosts.rst delete mode 100644 source/includes/fact-report-security-vulnerability.rst delete mode 100644 source/includes/fact-shard-ranges-inclusive-exclusive.rst delete mode 100644 source/includes/fact-upsert-multi-options.rst delete mode 100644 source/includes/fact-write-concern.rst delete mode 100644 source/includes/introduction-query-matching.rst delete mode 100644 source/includes/list-set-parameters-mongod.rst delete mode 100644 source/includes/list-set-parameters-mongos.rst delete mode 100644 source/includes/note-disable-profiling-fsynclock.rst delete mode 100644 source/includes/note-duplicate-id-field.rst delete mode 100644 source/includes/note-ref-equality.rst delete mode 100644 source/includes/note-ssl-tool.rst delete mode 100644 source/includes/seealso-elections.rst delete mode 100644 source/includes/warning-blocking-collection.rst delete mode 100644 source/includes/warning-internal.rst delete mode 100644 source/includes/warning-text-search-not-for-production.rst diff --git a/source/core/query-optimization.txt b/source/core/query-optimization.txt index d885915b71e..17c139c78f7 100644 --- a/source/core/query-optimization.txt +++ b/source/core/query-optimization.txt @@ -173,9 +173,7 @@ An index **cannot** cover a query if: Restrictions on Sharded Collection `````````````````````````````````` -.. |cover| replace:: cover - -.. include:: /includes/fact-covered-query-sharded-collection.rst +.. include:: /includes/extracts-fact-covered-query-sharded-collection-cover.rst ``explain`` ~~~~~~~~~~~ diff --git a/source/includes/access-eval.rst b/source/includes/access-eval.rst deleted file mode 100644 index 7bf66bc6a62..00000000000 --- a/source/includes/access-eval.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. per DOCS-2493 & SERVER-7489 - -If authorization is enabled, you must have access to all actions -on all resources in order to run -|eval-object|. Providing such access is not recommended, but if your -organization requires a user to run |eval-object|, create a role that -grants :authaction:`anyAction` on :ref:`resource-anyresource`. Do not -assign this role to any other user. diff --git a/source/includes/admonition-javascript-prevalence.rst b/source/includes/admonition-javascript-prevalence.rst deleted file mode 100644 index 2a6534f0f87..00000000000 --- a/source/includes/admonition-javascript-prevalence.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. admonition:: JavaScript in MongoDB - - Although |javascript-using-operation| JavaScript, most interactions - with MongoDB do not use JavaScript but use an :doc:`idiomatic driver - ` in the language of the interacting - application. diff --git a/source/includes/admonitions-eval.rst b/source/includes/admonitions-eval.rst index c9b476d74a0..3783be4bf87 100644 --- a/source/includes/admonitions-eval.rst +++ b/source/includes/admonitions-eval.rst @@ -24,7 +24,7 @@ Access Control .. versionchanged:: 2.6 -.. include:: /includes/access-eval.rst +.. include:: /includes/extracts/access-eval-eval.rst JavaScript Engine ~~~~~~~~~~~~~~~~~ diff --git a/source/includes/behavior-drop-role.rst b/source/includes/behavior-drop-role.rst deleted file mode 100644 index 80c5a755a55..00000000000 --- a/source/includes/behavior-drop-role.rst +++ /dev/null @@ -1,19 +0,0 @@ -When you drop a role, users authenticated with the role lose the role's -privileges but remain logged in. They continue to have privileges from other -roles. - -If a user is authenticated with the role on a :program:`mongod`, the -user loses the role's privileges immediately. - -If the user is authenticated on a :program:`mongos`, on the -:program:`mongos` used to make the change, the user loses the access -immediately. If there are other :program:`mongos` instances in the -cluster, the user loses the access when the :program:`mongos` refreshes -their user caches. :program:`mongos` refreshes the user cache -automatically every :parameter:`userCacheInvalidationIntervalSecs` -(default is 30) seconds if there are changes. You can also manually -refresh the cache with the :dbcommand:`invalidateUserCache` command. - -When you drop a role, MongoDB first revokes the role from all users that -currently have it, then revokes it from other roles, and finally removes -the role definition itself from the database. diff --git a/source/includes/example-server-status-projection.rst b/source/includes/example-server-status-projection.rst deleted file mode 100644 index 131c7b61c5f..00000000000 --- a/source/includes/example-server-status-projection.rst +++ /dev/null @@ -1,11 +0,0 @@ -|operation-name| includes all fields by default, except -:data:`~serverStatus.workingSet` :data:`~serverStatus.rangeDeleter`, -and some content in the :data:`~serverStatus.repl` document. - -.. note:: - - You may only dynamically include top-level fields from the - :doc:`serverStatus ` - document that are not included by default. You - can exclude any field that |operation-name| includes by - default. diff --git a/source/includes/extracts-access-eval.yaml b/source/includes/extracts-access-eval.yaml new file mode 100644 index 00000000000..ccbb870991b --- /dev/null +++ b/source/includes/extracts-access-eval.yaml @@ -0,0 +1,22 @@ +ref: access-eval-applyOps +inherit: + ref: _access-eval + file: extracts-parent-access-eval.yaml +replacement: + evalObject: ":dbcommand:`applyOps`" +--- +ref: access-eval-copyTo +inherit: + ref: _access-eval + file: extracts-parent-access-eval.yaml +replacement: + evalObject: ":method:`db.collection.copyTo()`" + +--- +ref: access-eval-eval +inherit: + ref: _access-eval + file: extracts-parent-access-eval.yaml +replacement: + evalObject: ":dbcommand:`eval`" +... \ No newline at end of file diff --git a/source/includes/extracts-admonition-js-prevalence.yaml b/source/includes/extracts-admonition-js-prevalence.yaml new file mode 100644 index 00000000000..9699f6ba51a --- /dev/null +++ b/source/includes/extracts-admonition-js-prevalence.yaml @@ -0,0 +1,28 @@ +ref: admonition-js-prevalence-eval +inherit: + ref: _admonition-js-prevalence + file: extracts-parent-admonition-js-prevalence.yaml +replacement: + javascriptUsingOperation: ":dbcommand:`eval` uses" +--- +ref: admonition-js-prevalence-group +inherit: + ref: _admonition-js-prevalence + file: extracts-parent-admonition-js-prevalence.yaml +replacement: + javascriptUsingOperation: ":dbcommand:`group` uses" +--- +ref: admonition-js-prevalence-mapReduce +inherit: + ref: _admonition-js-prevalence + file: extracts-parent-admonition-js-prevalence.yaml +replacement: + javascriptUsingOperation: ":dbcommand:`mapReduce` uses" +--- +ref: admonition-js-prevalence-methods +inherit: + ref: _admonition-js-prevalence + file: extracts-parent-admonition-js-prevalence.yaml +replacement: + javascriptUsingOperation: "these methods use" +... diff --git a/source/includes/extracts-examples-eval.yaml b/source/includes/extracts-examples-eval.yaml new file mode 100644 index 00000000000..a65b631cdba --- /dev/null +++ b/source/includes/extracts-examples-eval.yaml @@ -0,0 +1,49 @@ +ref: fact-agg-comparison-expression-cmp +replacement: + comparisonExpression: ":expression:`$cmp`" +inherit: + ref: _agg-comparison-expressions + file: extracts-parent-agg-comparison-expressions.yaml +--- +ref: fact-agg-comparison-expression-eq +replacement: + comparisonExpression: ":expression:`$eq`" +inherit: + ref: _agg-comparison-expressions + file: extracts-parent-agg-comparison-expressions.yaml +--- +ref: fact-agg-comparison-expression-gt +replacement: + comparisonExpression: ":expression:`$gt`" +inherit: + ref: _agg-comparison-expressions + file: extracts-parent-agg-comparison-expressions.yaml +--- +ref: fact-agg-comparison-expression-gte +replacement: + comparisonExpression: ":expression:`$gte`" +inherit: + ref: _agg-comparison-expressions + file: extracts-parent-agg-comparison-expressions.yaml +--- +ref: fact-agg-comparison-expression-lt +replacement: + comparisonExpression: ":expression:`$lt`" +inherit: + ref: _agg-comparison-expressions + file: extracts-parent-agg-comparison-expressions.yaml +--- +ref: fact-agg-comparison-expression-lte +replacement: + comparisonExpression: ":expression:`$lte`" +inherit: + ref: _agg-comparison-expressions + file: extracts-parent-agg-comparison-expressions.yaml +--- +ref: fact-agg-comparison-expression-ne +replacement: + comparisonExpression: ":expression:`$ne`" +inherit: + ref: _agg-comparison-expressions + file: extracts-parent-agg-comparison-expressions.yaml +... \ No newline at end of file diff --git a/source/includes/extracts-fact-2.6-wc-gle-change.yaml b/source/includes/extracts-fact-2.6-wc-gle-change.yaml new file mode 100644 index 00000000000..7e85963cfc9 --- /dev/null +++ b/source/includes/extracts-fact-2.6-wc-gle-change.yaml @@ -0,0 +1,21 @@ +ref: fact-2.6-wc-gle-change-cmd-getLastError +replacement: + gle: ":dbcommand:`getLastError`" +inherit: + ref: _wc-gle-change + file: extracts-parent-fact-2.6-wc-gle-change.yaml +--- +ref: fact-2.6-wc-gle-change-method-db.getLastError +replacement: + gle: ":method:`db.getLastError()`" +inherit: + ref: _wc-gle-change + file: extracts-parent-fact-2.6-wc-gle-change.yaml +--- +ref: fact-2.6-wc-gle-change-method-db.getLastErrorObj +replacement: + gle: ":method:`db.getLastErrorObj()`" +inherit: + ref: _wc-gle-change + file: extracts-parent-fact-2.6-wc-gle-change.yaml +... \ No newline at end of file diff --git a/source/includes/extracts-fact-3.0-tools-drop-dbpath-support.yaml b/source/includes/extracts-fact-3.0-tools-drop-dbpath-support.yaml new file mode 100644 index 00000000000..0c76cfa8777 --- /dev/null +++ b/source/includes/extracts-fact-3.0-tools-drop-dbpath-support.yaml @@ -0,0 +1,35 @@ +ref: fact-3.0-tools-drop-dbpath-support-mongodump +replacement: + program: ":program:`mongodump`" +inherit: + ref: _tools-drop-dbpath + file: extracts-parent-fact-3.0-tools-drop-dbpath-support.yaml +--- +ref: fact-3.0-tools-drop-dbpath-support-mongoexport +replacement: + program: ":program:`mongoexport`" +inherit: + ref: _tools-drop-dbpath + file: extracts-parent-fact-3.0-tools-drop-dbpath-support.yaml +--- +ref: fact-3.0-tools-drop-dbpath-support-mongofiles +replacement: + program: ":program:`mongofiles`" +inherit: + ref: _tools-drop-dbpath + file: extracts-parent-fact-3.0-tools-drop-dbpath-support.yaml +--- +ref: fact-3.0-tools-drop-dbpath-support-mongoimport +replacement: + program: ":program:`mongoimport`" +inherit: + ref: _tools-drop-dbpath + file: extracts-parent-fact-3.0-tools-drop-dbpath-support.yaml +--- +ref: fact-3.0-tools-drop-dbpath-support-mongooplog +replacement: + program: ":program:`mongooplog`" +inherit: + ref: _tools-drop-dbpath + file: extracts-parent-fact-3.0-tools-drop-dbpath-support.yaml +... \ No newline at end of file diff --git a/source/includes/extracts-fact-agg-boolean.yaml b/source/includes/extracts-fact-agg-boolean.yaml new file mode 100644 index 00000000000..25b363e388e --- /dev/null +++ b/source/includes/extracts-fact-agg-boolean.yaml @@ -0,0 +1,42 @@ +ref: fact-agg-boolean-allElementsTrue +replacement: + booleanExp: ":expression:`$allElementsTrue`" +inherit: + ref: _fact-agg-boolean + file: extracts-parent-fact-agg-boolean.yaml +--- +ref: fact-agg-boolean-and +replacement: + booleanExp: ":expression:`$and`" +inherit: + ref: _fact-agg-boolean + file: extracts-parent-fact-agg-boolean.yaml +--- +ref: fact-agg-boolean-anyElementTrue +replacement: + booleanExp: ":expression:`$anyElementTrue`" +inherit: + ref: _fact-agg-boolean + file: extracts-parent-fact-agg-boolean.yaml +--- +ref: fact-agg-boolean-not +replacement: + booleanExp: ":expression:`$not`" +inherit: + ref: _fact-agg-boolean + file: extracts-parent-fact-agg-boolean.yaml +--- +ref: fact-agg-boolean-or +replacement: + booleanExp: ":expression:`$or`" +inherit: + ref: _fact-agg-boolean + file: extracts-parent-fact-agg-boolean.yaml +--- +ref: fact-agg-boolean-intro +replacement: + booleanExp: "Boolean expression" +inherit: + ref: _fact-agg-boolean + file: extracts-parent-fact-agg-boolean.yaml +... \ No newline at end of file diff --git a/source/includes/extracts-fact-agg-top-level-expressions.yaml b/source/includes/extracts-fact-agg-top-level-expressions.yaml new file mode 100644 index 00000000000..0e9ee4155af --- /dev/null +++ b/source/includes/extracts-fact-agg-top-level-expressions.yaml @@ -0,0 +1,49 @@ +ref: fact-agg-top-level-expressions-allElementsTrue +replacement: + exp: ":expression:`$allElementsTrue`" +inherit: + ref: _agg-top-level-expressions + file: extracts-parent-fact-agg-top-level-expressions.yaml +--- +ref: fact-agg-top-level-expressions-anyElementsTrue +replacement: + exp: ":expression:`$anyElementsTrue`" +inherit: + ref: _agg-top-level-expressions + file: extracts-parent-fact-agg-top-level-expressions.yaml +--- +ref: fact-agg-top-level-expressions-setDifference +replacement: + exp: ":expression:`$setDifference`" +inherit: + ref: _agg-top-level-expressions + file: extracts-parent-fact-agg-top-level-expressions.yaml +--- +ref: fact-agg-top-level-expressions-setEquals +replacement: + exp: ":expression:`$setEquals`" +inherit: + ref: _agg-top-level-expressions + file: extracts-parent-fact-agg-top-level-expressions.yaml +--- +ref: fact-agg-top-level-expressions-setIntersection +replacement: + exp: ":expression:`$setIntersection`" +inherit: + ref: _agg-top-level-expressions + file: extracts-parent-fact-agg-top-level-expressions.yaml +--- +ref: fact-agg-top-level-expressions-setIsSubset +replacement: + exp: ":expression:`$setIsSubset`" +inherit: + ref: _agg-top-level-expressions + file: extracts-parent-fact-agg-top-level-expressions.yaml +--- +ref: fact-agg-top-level-expressions-setUnion +replacement: + exp: ":expression:`$setUnion`" +inherit: + ref: _agg-top-level-expressions + file: extracts-parent-fact-agg-top-level-expressions.yaml +... \ No newline at end of file diff --git a/source/includes/extracts-fact-aggregation-accumulator.yaml b/source/includes/extracts-fact-aggregation-accumulator.yaml new file mode 100644 index 00000000000..bfdf522bf11 --- /dev/null +++ b/source/includes/extracts-fact-aggregation-accumulator.yaml @@ -0,0 +1,56 @@ +ref: fact-aggregation-accumulator-addToSet +replacement: + accumulator: ":group:`$addToSet`" +inherit: + ref: _fact-agg-accumulator + file: extracts-parent-fact-aggregation-accumulator.yaml +--- +ref: fact-aggregation-accumulator-avg +replacement: + accumulator: ":group:`$avg`" +inherit: + ref: _fact-agg-accumulator + file: extracts-parent-fact-aggregation-accumulator.yaml +--- +ref: fact-aggregation-accumulator-first +replacement: + accumulator: ":group:`$first`" +inherit: + ref: _fact-agg-accumulator + file: extracts-parent-fact-aggregation-accumulator.yaml +--- +ref: fact-aggregation-accumulator-last +replacement: + accumulator: ":group:`$last`" +inherit: + ref: _fact-agg-accumulator + file: extracts-parent-fact-aggregation-accumulator.yaml +--- +ref: fact-aggregation-accumulator-max +replacement: + accumulator: ":group:`$max`" +inherit: + ref: _fact-agg-accumulator + file: extracts-parent-fact-aggregation-accumulator.yaml +--- +ref: fact-aggregation-accumulator-min +replacement: + accumulator: ":group:`$min`" +inherit: + ref: _fact-agg-accumulator + file: extracts-parent-fact-aggregation-accumulator.yaml +--- +ref: fact-aggregation-accumulator-push +replacement: + accumulator: ":group:`$push`" +inherit: + ref: _fact-agg-accumulator + file: extracts-parent-fact-aggregation-accumulator.yaml +--- +ref: fact-aggregation-accumulator-sum +replacement: + accumulator: ":group:`$sum`" +inherit: + ref: _fact-agg-accumulator + file: extracts-parent-fact-aggregation-accumulator.yaml +... \ No newline at end of file diff --git a/source/includes/extracts-fact-command-puts-secondary-into-recovering.yaml b/source/includes/extracts-fact-command-puts-secondary-into-recovering.yaml new file mode 100644 index 00000000000..c9e3de3f8fd --- /dev/null +++ b/source/includes/extracts-fact-command-puts-secondary-into-recovering.yaml @@ -0,0 +1,14 @@ +ref: fact-command-puts-secondary-into-recovering-compact +replacement: + cmdName: ":dbcommand:`compact`" +inherit: + ref: _command-secondary-into-recovering + file: extracts-parent-fact-command-puts-secondary-into-recovering.yaml +--- +ref: fact-command-puts-secondary-into-recovering-replSetMaintenance +replacement: + cmdName: ":dbcommand:`replSetMaintenance`" +inherit: + ref: _command-secondary-into-recovering + file: extracts-parent-fact-command-puts-secondary-into-recovering.yaml +... \ No newline at end of file diff --git a/source/includes/extracts-fact-copydb-behavior.yaml b/source/includes/extracts-fact-copydb-behavior.yaml new file mode 100644 index 00000000000..5ca791c4e31 --- /dev/null +++ b/source/includes/extracts-fact-copydb-behavior.yaml @@ -0,0 +1,14 @@ +ref: fact-copydb-behavior-cmd-copydb +inherit: + ref: _copydb + file: extracts-parent-fact-copydb-behavior.yaml +replacement: + copydb: ":dbcommand:`copydb`" +--- +ref: fact-copydb-behavior-method-db.copyDatabase +inherit: + ref: _copydb + file: extracts-parent-fact-copydb-behavior.yaml +replacement: + copydb: ":method:`db.copyDatabase()`" +... \ No newline at end of file diff --git a/source/includes/extracts-fact-count-on-sharded-clusters.yaml b/source/includes/extracts-fact-count-on-sharded-clusters.yaml new file mode 100644 index 00000000000..33899b8544b --- /dev/null +++ b/source/includes/extracts-fact-count-on-sharded-clusters.yaml @@ -0,0 +1,21 @@ +ref: fact-count-on-sharded-clusters-cmd-count +inherit: + ref: _fact-count-sharded-clusters + file: extracts-parent-fact-count-on-sharded-clusters.yaml +replacement: + countOp: ":dbcommand:`count`" +--- +ref: fact-count-on-sharded-clusters-method-cusor.count +inherit: + ref: _fact-count-sharded-clusters + file: extracts-parent-fact-count-on-sharded-clusters.yaml +replacement: + countOp: ":method:`~cursor.count()`" +--- +ref: fact-count-on-sharded-clusters-method-db.collection.count +inherit: + ref: _fact-count-sharded-clusters + file: extracts-parent-fact-count-on-sharded-clusters.yaml +replacement: + countOp: ":method:`db.collection.count()`" +... \ No newline at end of file diff --git a/source/includes/extracts-fact-covered-query-sharded-collection.yaml b/source/includes/extracts-fact-covered-query-sharded-collection.yaml new file mode 100644 index 00000000000..f27eb3bac16 --- /dev/null +++ b/source/includes/extracts-fact-covered-query-sharded-collection.yaml @@ -0,0 +1,14 @@ +ref: fact-covered-query-sharded-collection-cover +inherit: + ref: _fact-covered-query-sharded-collection + file: extracts-parent-fact-covered-query-sharded-collection.yaml +replacement: + cover: "cover" +--- +ref: fact-covered-query-sharded-collection-covered-queries +inherit: + ref: _fact-covered-query-sharded-collection + file: extracts-parent-fact-covered-query-sharded-collection.yaml +replacement: + cover: ":ref:`cover `" +... \ No newline at end of file diff --git a/source/includes/extracts-parent-access-eval.yaml b/source/includes/extracts-parent-access-eval.yaml new file mode 100644 index 00000000000..f29ad593f9f --- /dev/null +++ b/source/includes/extracts-parent-access-eval.yaml @@ -0,0 +1,9 @@ +ref: _access-eval +content: | + If authorization is enabled, you must have access to all actions on + all resources in order to run {{evalObject}}. Providing such access + is not recommended, but if your organization requires a user to run + {{evalObject}}, create a role that grants :authaction:`anyAction` on + :ref:`resource-anyresource`. Do not assign this role to any other + user. +... diff --git a/source/includes/extracts-parent-admonition-js-prevalence.yaml b/source/includes/extracts-parent-admonition-js-prevalence.yaml new file mode 100644 index 00000000000..121fbb693ba --- /dev/null +++ b/source/includes/extracts-parent-admonition-js-prevalence.yaml @@ -0,0 +1,11 @@ +ref: _admonition-js-prevalence +content: | + + + .. admonition:: JavaScript in MongoDB + + Although {{javascriptUsingOperation}} JavaScript, most + interactions with MongoDB do not use JavaScript but use an + :doc:`idiomatic driver ` in the language + of the interacting application. +... \ No newline at end of file diff --git a/source/includes/extracts-parent-agg-comparison-expressions.yaml b/source/includes/extracts-parent-agg-comparison-expressions.yaml new file mode 100644 index 00000000000..32c1c552938 --- /dev/null +++ b/source/includes/extracts-parent-agg-comparison-expressions.yaml @@ -0,0 +1,6 @@ +ref: _agg-comparison-expressions +content: | + The {{comparisonExpression}} compares both value and type, using the + :ref:`specified BSON comparison order ` + for values of different types. +... diff --git a/source/includes/extracts-parent-fact-2.6-wc-gle-change.yaml b/source/includes/extracts-parent-fact-2.6-wc-gle-change.yaml new file mode 100644 index 00000000000..5435fde56ec --- /dev/null +++ b/source/includes/extracts-parent-fact-2.6-wc-gle-change.yaml @@ -0,0 +1,16 @@ +ref: _wc-gle-change +content: | + + + .. versionchanged:: 2.6 + + A new protocol for :ref:`write operations + ` integrates write concerns with the + write operations, eliminating the need for a separate + |gle|. Write methods now return the status of the write + operation, including error information. + + In previous versions, clients typically used the |gle| in + combination with the write operations to ensure that the write + succeeds. +... diff --git a/source/includes/extracts-parent-fact-3.0-tools-drop-dbpath-support.yaml b/source/includes/extracts-parent-fact-3.0-tools-drop-dbpath-support.yaml new file mode 100644 index 00000000000..00f9f19763f --- /dev/null +++ b/source/includes/extracts-parent-fact-3.0-tools-drop-dbpath-support.yaml @@ -0,0 +1,10 @@ +ref: _tools-drop-dbpath +content: | + + + .. versionchanged:: 3.0.0 + + {{program}} removed the ``--dbpath`` as well as related + ``--directoryperdb`` and ``--journal`` options. You must use + {{program}} while connected to a :program:`mongod` instance. +... diff --git a/source/includes/extracts-parent-fact-agg-boolean.yaml b/source/includes/extracts-parent-fact-agg-boolean.yaml new file mode 100644 index 00000000000..5111e303e58 --- /dev/null +++ b/source/includes/extracts-parent-fact-agg-boolean.yaml @@ -0,0 +1,7 @@ +ref: _fact-agg-boolean +content: | + In addition to the ``false`` boolean value, {{booleanExp}} evaluates + as ``false`` the following: ``null``, ``0``, and ``undefined`` + values. The {{booleanExp}} evaluates all other values as ``true``, + including non-zero numeric values and arrays. +... diff --git a/source/includes/extracts-parent-fact-agg-top-level-expressions.yaml b/source/includes/extracts-parent-fact-agg-top-level-expressions.yaml new file mode 100644 index 00000000000..5366b8d724f --- /dev/null +++ b/source/includes/extracts-parent-fact-agg-top-level-expressions.yaml @@ -0,0 +1,5 @@ +ref: _agg-top-level-expressions +content: | + If a set contains a nested array element, {{exp}} does *not* descend + into the nested array but evaluates the array at top-level. +... \ No newline at end of file diff --git a/source/includes/extracts-parent-fact-aggregation-accumulator.yaml b/source/includes/extracts-parent-fact-aggregation-accumulator.yaml new file mode 100644 index 00000000000..db8902945c8 --- /dev/null +++ b/source/includes/extracts-parent-fact-aggregation-accumulator.yaml @@ -0,0 +1,6 @@ +ref: _fact-agg-accumulator +content: | + {{accumulator}} is an :ref:`accumulator operator + ` available only in the + :pipeline:`$group` stage. +... \ No newline at end of file diff --git a/source/includes/extracts-parent-fact-command-puts-secondary-into-recovering.yaml b/source/includes/extracts-parent-fact-command-puts-secondary-into-recovering.yaml new file mode 100644 index 00000000000..3e137e3e335 --- /dev/null +++ b/source/includes/extracts-parent-fact-command-puts-secondary-into-recovering.yaml @@ -0,0 +1,18 @@ +ref: _command-secondary-into-recovering +content: | + + + - On secondaries, the {{cmdname}} command forces the secondary to + enter :replstate:`RECOVERING` state. Read operations issued to an + instance in the :replstate:`RECOVERING` state will fail. This + prevents clients from reading during the operation. When the + operation completes, the secondary returns + to:replstate:`SECONDARY` state. + + - See :doc:`/reference/replica-states/` for more information about + replica set member states. + + See :doc:`/tutorial/perform-maintence-on-replica-set-members` for an + example replica set maintenance procedure to maximize availability + during maintenance operations. +... \ No newline at end of file diff --git a/source/includes/extracts-parent-fact-copydb-behavior.yaml b/source/includes/extracts-parent-fact-copydb-behavior.yaml new file mode 100644 index 00000000000..1c497720ccf --- /dev/null +++ b/source/includes/extracts-parent-fact-copydb-behavior.yaml @@ -0,0 +1,29 @@ +ref: _copydb +content: | + Be aware of the following properties of {{copydb}}: + + - {{copydb}} runs on the destination :program:`mongod` + instance, i.e. the host receiving the copied data. + + - If the destination :program:`mongod` has + :setting:`~security.authorization` + enabled, {{copydb}} *must* specify the credentials of a user present + in the *source* database who has the privileges described in + :ref:`copyDatabases-requiredAccess`. + + - {{copydb}} creates the target database if it does not exist. + + - {{copydb}} requires enough free disk space on the host + instance for the copied database. Use the :method:`db.stats()` + operation to check the size of the database on the source + :program:`mongod` instance. + + - {{copydb}} and :dbcommand:`clone` do not produce + point-in-time snapshots of the source database. Write traffic to + the source or destination database during the copy process will + result in divergent data sets. + + - {{copydb}} does not lock the destination server during + its operation, so the copy will occasionally yield to allow other + operations to complete. +... \ No newline at end of file diff --git a/source/includes/extracts-parent-fact-count-on-sharded-clusters.yaml b/source/includes/extracts-parent-fact-count-on-sharded-clusters.yaml new file mode 100644 index 00000000000..b06299f19f0 --- /dev/null +++ b/source/includes/extracts-parent-fact-count-on-sharded-clusters.yaml @@ -0,0 +1,33 @@ +ref: _fact-count-sharded-clusters +content: | + On a sharded cluster, {{countOp}} can result in an *inaccurate* count if + :term:`orphaned documents ` exist or if a + :doc:`chunk migration ` is in progress. + + To avoid these situations, on a sharded cluster, use the + :pipeline:`$group` stage of the :method:`db.collection.aggregate()` + method to :group:`$sum` the documents. For example, the following + operation counts the documents in a collection: + + .. code-block:: javascript + + db.collection.aggregate( + [ + { $group: { _id: null, count: { $sum: 1 } } } + ] + ) + + To get a count of documents that match a query condition, include the + :pipeline:`$match` stage as well: + + .. code-block:: javascript + + db.collection.aggregate( + [ + { $match: }, + { $group: { _id: null, count: { $sum: 1 } } } + ] + ) + + See :ref:`match-perform-a-count` for an example. +... \ No newline at end of file diff --git a/source/includes/extracts-parent-fact-covered-query-sharded-collection.yaml b/source/includes/extracts-parent-fact-covered-query-sharded-collection.yaml new file mode 100644 index 00000000000..8e1890789ca --- /dev/null +++ b/source/includes/extracts-parent-fact-covered-query-sharded-collection.yaml @@ -0,0 +1,16 @@ +ref: _fact-covered-query-sharded-collection +content: | + An index cannot {{cover}} a query on a :term:`sharded ` collection + when run against a :program:`mongos` if the index does not contain the + shard key, with the following exception for the ``_id`` index: If a + query on a sharded collection only specifies a condition on the ``_id`` + field and returns only the ``_id`` field, the ``_id`` index can cover + the query when run against a :program:`mongos` even if the ``_id`` + field is not the shard key. + + .. versionchanged:: 3.0 + + In previous versions, an index cannot :ref:`cover ` + a query on a :term:`sharded ` collection when run against a + :program:`mongos`. +... \ No newline at end of file diff --git a/source/includes/extracts-parent-server-status-projection.yaml b/source/includes/extracts-parent-server-status-projection.yaml new file mode 100644 index 00000000000..edadc0031c2 --- /dev/null +++ b/source/includes/extracts-parent-server-status-projection.yaml @@ -0,0 +1,14 @@ +ref: _ex-server-status-projection +content: | + + {{operationName}} includes all fields by default, except + :data:`~serverStatus.workingSet` :data:`~serverStatus.rangeDeleter`, + and some content in the :data:`~serverStatus.repl` document. + + .. note:: + + You may only dynamically include top-level fields from the + :doc:`serverStatus ` document + that are not included by default. You can exclude any field that + {{operationName}} includes by default. +... \ No newline at end of file diff --git a/source/includes/extracts-server-status-projection.yaml b/source/includes/extracts-server-status-projection.yaml new file mode 100644 index 00000000000..29e4c2c0a2d --- /dev/null +++ b/source/includes/extracts-server-status-projection.yaml @@ -0,0 +1,14 @@ +ref: example-server-status-projection-serverStatus +inherit: + ref: _ex-server-status-projection + file: extracts-parent-server-status-projection.yaml +replacement: + operationName: ":dbcommand:`serverStatus`" +--- +ref: example-server-status-projection-db.serverStatus() +inherit: + ref: _ex-server-status-projection + file: extracts-parent-server-status-projection.yaml +replacement: + operationName: ":method:`db.serverStatus()`" +... \ No newline at end of file diff --git a/source/includes/fact-2.6-wc-gle-change.rst b/source/includes/fact-2.6-wc-gle-change.rst deleted file mode 100644 index f56f0254b98..00000000000 --- a/source/includes/fact-2.6-wc-gle-change.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. versionchanged:: 2.6 - - A new protocol for :ref:`write operations - ` integrates write concerns with the - write operations, eliminating the need for a separate - |gle|. Write methods now return the - status of the write operation, including error information. - - In previous versions, clients typically used the |gle| in - combination with the write operations to ensure that the write - succeeds. diff --git a/source/includes/fact-3.0-tools-drop-dbpath-support.rst b/source/includes/fact-3.0-tools-drop-dbpath-support.rst deleted file mode 100644 index 64b9ba62311..00000000000 --- a/source/includes/fact-3.0-tools-drop-dbpath-support.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. versionchanged:: 3.0.0 - |program| removed the ``--dbpath`` as well as related - ``--directoryperdb`` and ``--journal`` options. You must use - |program| while connected to a :program:`mongod` instance. diff --git a/source/includes/fact-agg-boolean.rst b/source/includes/fact-agg-boolean.rst deleted file mode 100644 index 4cf06900f1f..00000000000 --- a/source/includes/fact-agg-boolean.rst +++ /dev/null @@ -1,4 +0,0 @@ -In addition to the ``false`` boolean value, |boolean-exp| evaluates as -``false`` the following: ``null``, ``0``, and ``undefined`` values. The -|boolean-exp| evaluates all other values as ``true``, including non-zero -numeric values and arrays. diff --git a/source/includes/fact-agg-comparison-expressions.rst b/source/includes/fact-agg-comparison-expressions.rst deleted file mode 100644 index 7c0af222500..00000000000 --- a/source/includes/fact-agg-comparison-expressions.rst +++ /dev/null @@ -1,3 +0,0 @@ -The |comparison-expression| compares both value and type, using the -:ref:`specified BSON comparison order ` -for values of different types. diff --git a/source/includes/fact-agg-top-level-expressions.rst b/source/includes/fact-agg-top-level-expressions.rst deleted file mode 100644 index 5955bd6ebb0..00000000000 --- a/source/includes/fact-agg-top-level-expressions.rst +++ /dev/null @@ -1,3 +0,0 @@ -If a set contains a nested array element, -|exp| does *not* descend into the nested array but evaluates the array -at top-level. diff --git a/source/includes/fact-aggregation-accumulator.rst b/source/includes/fact-aggregation-accumulator.rst deleted file mode 100644 index f518849cd11..00000000000 --- a/source/includes/fact-aggregation-accumulator.rst +++ /dev/null @@ -1,3 +0,0 @@ -|accumulator| is an :ref:`accumulator operator -` available only in the -:pipeline:`$group` stage. diff --git a/source/includes/fact-aggregation-types.rst b/source/includes/fact-aggregation-types.rst deleted file mode 100644 index cb66d9ee96e..00000000000 --- a/source/includes/fact-aggregation-types.rst +++ /dev/null @@ -1,3 +0,0 @@ -The :ref:`aggregation pipeline ` cannot operate -on values of the following types: ``Symbol``, ``MinKey``, ``MaxKey``, -``DBRef``, ``Code``, and ``CodeWScope``. diff --git a/source/includes/fact-command-puts-secondary-into-recovering.rst b/source/includes/fact-command-puts-secondary-into-recovering.rst deleted file mode 100644 index f01777e9a87..00000000000 --- a/source/includes/fact-command-puts-secondary-into-recovering.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. specified in the including file - -- On secondaries, the |cmd-name| command forces - the secondary to enter :replstate:`RECOVERING` state. Read - operations issued to an instance in the :replstate:`RECOVERING` - state will fail. This prevents clients from reading during the - operation. When the operation completes, the secondary returns - to:replstate:`SECONDARY` state. - -- See :doc:`/reference/replica-states/` for more information about - replica set member states. - -See :doc:`/tutorial/perform-maintence-on-replica-set-members` for an -example replica set maintenance procedure to maximize availability -during maintenance operations. diff --git a/source/includes/fact-copydb-behavior.rst b/source/includes/fact-copydb-behavior.rst deleted file mode 100644 index cde64f3ed4e..00000000000 --- a/source/includes/fact-copydb-behavior.rst +++ /dev/null @@ -1,26 +0,0 @@ -Be aware of the following properties of |copydb|: - -- |copydb| runs on the destination :program:`mongod` - instance, i.e. the host receiving the copied data. - -- If the destination :program:`mongod` has - :setting:`~security.authorization` - enabled, |copydb| *must* specify the credentials of a user present - in the *source* database who has the privileges described in - :ref:`copyDatabases-requiredAccess`. - -- |copydb| creates the target database if it does not exist. - -- |copydb| requires enough free disk space on the host - instance for the copied database. Use the :method:`db.stats()` - operation to check the size of the database on the source - :program:`mongod` instance. - -- |copydb| and :dbcommand:`clone` do not produce - point-in-time snapshots of the source database. Write traffic to - the source or destination database during the copy process will - result in divergent data sets. - -- |copydb| does not lock the destination server during - its operation, so the copy will occasionally yield to allow other - operations to complete. diff --git a/source/includes/fact-count-on-sharded-clusters.rst b/source/includes/fact-count-on-sharded-clusters.rst deleted file mode 100644 index 6f8aa347e81..00000000000 --- a/source/includes/fact-count-on-sharded-clusters.rst +++ /dev/null @@ -1,30 +0,0 @@ -On a sharded cluster, |count-op| can result in an *inaccurate* count if -:term:`orphaned documents ` exist or if a -:doc:`chunk migration ` is in progress. - -To avoid these situations, on a sharded cluster, use the -:pipeline:`$group` stage of the :method:`db.collection.aggregate()` -method to :group:`$sum` the documents. For example, the following -operation counts the documents in a collection: - -.. code-block:: javascript - - db.collection.aggregate( - [ - { $group: { _id: null, count: { $sum: 1 } } } - ] - ) - -To get a count of documents that match a query condition, include the -:pipeline:`$match` stage as well: - -.. code-block:: javascript - - db.collection.aggregate( - [ - { $match: }, - { $group: { _id: null, count: { $sum: 1 } } } - ] - ) - -See :ref:`match-perform-a-count` for an example. diff --git a/source/includes/fact-covered-query-sharded-collection.rst b/source/includes/fact-covered-query-sharded-collection.rst deleted file mode 100644 index 3a893b3c180..00000000000 --- a/source/includes/fact-covered-query-sharded-collection.rst +++ /dev/null @@ -1,13 +0,0 @@ -An index cannot |cover| a query on a :term:`sharded ` collection -when run against a :program:`mongos` if the index does not contain the -shard key, with the following exception for the ``_id`` index: If a -query on a sharded collection only specifies a condition on the ``_id`` -field and returns only the ``_id`` field, the ``_id`` index can cover -the query when run against a :program:`mongos` even if the ``_id`` -field is not the shard key. - -.. versionchanged:: 3.0 - - In previous versions, an index cannot :ref:`cover ` - a query on a :term:`sharded ` collection when run against a - :program:`mongos`. diff --git a/source/includes/fact-eval-authentication.rst b/source/includes/fact-eval-authentication.rst deleted file mode 100644 index a99d9159f1c..00000000000 --- a/source/includes/fact-eval-authentication.rst +++ /dev/null @@ -1,6 +0,0 @@ -With :setting:`authorization ` enabled, |object| will fail -during the operation if you do not have the permission to perform a -specified task. - -.. versionchanged:: 2.4 - You must have full admin access to run. diff --git a/source/includes/fact-id-values-generated.rst b/source/includes/fact-id-values-generated.rst deleted file mode 100644 index 5cd43eda358..00000000000 --- a/source/includes/fact-id-values-generated.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. This can precede each of the query sections in the getting started - Query page to facilitate breaking up sections into separate pages - -.. Also, will use in the Modify Data page - -Because MongoDB generates ``_id`` values on insert if you do not -specify an ``_id`` value, the ``_id`` values for your documents will -differ from those displayed on this page. diff --git a/source/includes/fact-limits-multiple-in-expressions.rst b/source/includes/fact-limits-multiple-in-expressions.rst deleted file mode 100644 index be36f30d5a8..00000000000 --- a/source/includes/fact-limits-multiple-in-expressions.rst +++ /dev/null @@ -1,8 +0,0 @@ -Querying with two or more :query:`$in` expressions (e.g. ``{ a: { $in: -[ "a", "b", "c" ] }, b: { $in: [ "b", "c" ] } }`` ) can hit a -combinatorial limit if the query uses a compound index on these fields -(e.g. ``{ a: 1, b: 1 }`` ). Specifically, if the number of combinations -(i.e. the product of the number of **distinct** elements in the -respective arrays) is equal to or greater than 4000000, MongoDB will -throw an exception of ``"combinatorial limit of $in partitioning of -result set exceeded"``. diff --git a/source/includes/fact-multiple-hosts.rst b/source/includes/fact-multiple-hosts.rst deleted file mode 100644 index 071c3b3cee8..00000000000 --- a/source/includes/fact-multiple-hosts.rst +++ /dev/null @@ -1,6 +0,0 @@ -To connect to a replica set, you can specify the replica set seed -name, and a seed list of set members, in the following format: - -.. code-block:: javascript - - /<:port>,,... diff --git a/source/includes/fact-report-security-vulnerability.rst b/source/includes/fact-report-security-vulnerability.rst deleted file mode 100644 index 42e94f6ba5d..00000000000 --- a/source/includes/fact-report-security-vulnerability.rst +++ /dev/null @@ -1,5 +0,0 @@ -MongoDB takes security very -seriously. If you discover a vulnerability in MongoDB, -or would like to know more about our vulnerability reporting -and response process, see the -:doc:`/tutorial/create-a-vulnerability-report` document. diff --git a/source/includes/fact-shard-ranges-inclusive-exclusive.rst b/source/includes/fact-shard-ranges-inclusive-exclusive.rst deleted file mode 100644 index fdb1b263ec4..00000000000 --- a/source/includes/fact-shard-ranges-inclusive-exclusive.rst +++ /dev/null @@ -1,2 +0,0 @@ -Shard ranges are always inclusive of the lower value and exclusive -of the upper boundary. diff --git a/source/includes/fact-upsert-multi-options.rst b/source/includes/fact-upsert-multi-options.rst deleted file mode 100644 index 0a53e19fe66..00000000000 --- a/source/includes/fact-upsert-multi-options.rst +++ /dev/null @@ -1,4 +0,0 @@ -Prior to version 2.2, in the :program:`mongo` shell, you would specify -the ``upsert`` and the ``multi`` options in the -:method:`~db.collection.update()` method as positional boolean options. -See :method:`~db.collection.update()` for details. diff --git a/source/includes/fact-write-concern.rst b/source/includes/fact-write-concern.rst deleted file mode 100644 index 3967795cbdd..00000000000 --- a/source/includes/fact-write-concern.rst +++ /dev/null @@ -1,10 +0,0 @@ -As of these :ref:`driver versions `, -MongoDB will acknowledge all write operations. By default drivers -issue a :dbcommand:`getLastError` command to confirm that the database -has received the write operation: - -.. code-block:: javascript - - { getLastError: 1 } - -See :doc:`/core/write-concern` for more information. diff --git a/source/includes/intro-aggregation-boolean.rst b/source/includes/intro-aggregation-boolean.rst index 6bc06667d1b..fbd6a8f07f5 100644 --- a/source/includes/intro-aggregation-boolean.rst +++ b/source/includes/intro-aggregation-boolean.rst @@ -1,6 +1,4 @@ Boolean expressions evaluate their argument expressions as booleans and return a boolean as the result. -.. |boolean-exp| replace:: Boolean expression - -.. include:: /includes/fact-agg-boolean.rst +.. include:: /includes/extracts/fact-agg-boolean-intro.rst diff --git a/source/includes/introduction-query-matching.rst b/source/includes/introduction-query-matching.rst deleted file mode 100644 index e54ad9bc0f4..00000000000 --- a/source/includes/introduction-query-matching.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. note:: - - .. include:: /includes/fact-id-values-generated.rst - -Queries can specify criteria, or conditions, that determine which -documents to return. Specify the criteria using a document data -structure and pass as a parameter to the :method:`db.collection.find()` -method. diff --git a/source/includes/list-set-parameters-mongod.rst b/source/includes/list-set-parameters-mongod.rst deleted file mode 100644 index 93e9c1b7b8b..00000000000 --- a/source/includes/list-set-parameters-mongod.rst +++ /dev/null @@ -1,17 +0,0 @@ -- :parameter:`enableLocalhostAuthBypass` -- :parameter:`enableTestCommands` -- :parameter:`journalCommitInterval` -- :parameter:`logLevel` -- :parameter:`logUserIds` -- :parameter:`notablescan` -- :parameter:`quiet` -- :parameter:`replApplyBatchSize` -- :parameter:`replIndexPrefetch` -- :parameter:`supportCompatibilityFormPrivilegeDocuments` -- :parameter:`syncdelay` -- :parameter:`textSearchEnabled` -- :parameter:`traceExceptions` -- :parameter:`saslauthdPath` -- :parameter:`authenticationMechanisms` -- :parameter:`sslMode` -- :parameter:`clusterAuthMode` diff --git a/source/includes/list-set-parameters-mongos.rst b/source/includes/list-set-parameters-mongos.rst deleted file mode 100644 index 66407322be6..00000000000 --- a/source/includes/list-set-parameters-mongos.rst +++ /dev/null @@ -1,10 +0,0 @@ -- :parameter:`enableLocalhostAuthBypass` -- :parameter:`enableTestCommands` -- :parameter:`logLevel` -- :parameter:`logUserIds` -- :parameter:`notablescan` -- :parameter:`quiet` -- :parameter:`supportCompatibilityFormPrivilegeDocuments` -- :parameter:`syncdelay` -- :parameter:`textSearchEnabled` -- :parameter:`userCacheInvalidationIntervalSecs` diff --git a/source/includes/note-disable-profiling-fsynclock.rst b/source/includes/note-disable-profiling-fsynclock.rst deleted file mode 100644 index 5e22b0b3bed..00000000000 --- a/source/includes/note-disable-profiling-fsynclock.rst +++ /dev/null @@ -1,9 +0,0 @@ -The database cannot be locked with :method:`db.fsyncLock()` while -profiling is enabled. You must disable profiling before locking -the database with :method:`db.fsyncLock()`. Disable profiling -using :method:`db.setProfilingLevel()` as follows in the -:program:`mongo` shell: - -.. code-block:: javascript - - db.setProfilingLevel(0) diff --git a/source/includes/note-duplicate-id-field.rst b/source/includes/note-duplicate-id-field.rst deleted file mode 100644 index 4e098e6e848..00000000000 --- a/source/includes/note-duplicate-id-field.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. note:: - - The ``_id`` field must hold a unique value. If you specify a value - for ``_id`` that already exists in a collection the - :program:`mongod` will produce a duplicate key exception and reject - this document. To detect these situations always use appropriate - :ref:`write concern `. diff --git a/source/includes/note-ref-equality.rst b/source/includes/note-ref-equality.rst deleted file mode 100644 index 4571e1abadc..00000000000 --- a/source/includes/note-ref-equality.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. note:: - - To express ``equal to`` (e.g. ``=``) in the MongoDB query language, - use JSON ``{ key:value }`` structure. Consider the following - prototype: - - .. code-block:: javascript - - db.collection.find( { field: value } ) - - For example: - - .. code-block:: javascript - - db.collection.find( { a: 42 } ) - - This query selects all the documents the where the ``a`` field - holds a value of ``42``. diff --git a/source/includes/note-ssl-tool.rst b/source/includes/note-ssl-tool.rst deleted file mode 100644 index 33690e987d6..00000000000 --- a/source/includes/note-ssl-tool.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. versionadded:: 2.4 - MongoDB added support for SSL connections to :program:`mongod` - instances in |tool-binary|. - -.. note:: - - SSL support in |tool-binary| is not compiled into the default - distribution of MongoDB. See - :doc:`/tutorial/configure-ssl` for more information on SSL - and MongoDB. - - Additionally, |tool-binary| does not support connections to - :program:`mongod` instances that require client certificate - validation. diff --git a/source/includes/seealso-elections.rst b/source/includes/seealso-elections.rst deleted file mode 100644 index 7f796d9be32..00000000000 --- a/source/includes/seealso-elections.rst +++ /dev/null @@ -1 +0,0 @@ -.. seealso:: The :doc:`/core/replica-set-elections`. diff --git a/source/includes/warning-blocking-collection.rst b/source/includes/warning-blocking-collection.rst deleted file mode 100644 index 9360eee338d..00000000000 --- a/source/includes/warning-blocking-collection.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. warning:: - - This command obtains a write lock on the affected collection - and will block other operations until it has completed. diff --git a/source/includes/warning-internal.rst b/source/includes/warning-internal.rst deleted file mode 100644 index df0a7d39f0d..00000000000 --- a/source/includes/warning-internal.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. admonition:: Internal MongoDB Metadata - - The :data:`config` database is internal: applications and - administrators should not modify or depend upon its content in the - course of normal operation. diff --git a/source/includes/warning-text-search-not-for-production.rst b/source/includes/warning-text-search-not-for-production.rst deleted file mode 100644 index cc6726d19e7..00000000000 --- a/source/includes/warning-text-search-not-for-production.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. warning:: - - .. not-for-production - - - Do **not** enable or use text search on production systems. - - .. significant-storage-requirements - - - Text indexes have significant storage requirements and performance - costs. See :ref:`text-index-storage-requirements` for more - information. diff --git a/source/reference/command/applyOps.txt b/source/reference/command/applyOps.txt index 1528a56ca67..d3ddf8d482e 100644 --- a/source/reference/command/applyOps.txt +++ b/source/reference/command/applyOps.txt @@ -13,8 +13,7 @@ Definition instance. The :dbcommand:`applyOps` command is primarily an internal command. - .. |eval-object| replace:: :dbcommand:`applyOps` - .. include:: /includes/access-eval.rst + .. include:: /includes/extracts/access-eval-applyOps.rst The :dbcommand:`applyOps` command has the following prototype form: diff --git a/source/reference/command/compact.txt b/source/reference/command/compact.txt index b87b429325b..749fd1501d7 100644 --- a/source/reference/command/compact.txt +++ b/source/reference/command/compact.txt @@ -166,8 +166,7 @@ Replica Sets - Ideally run :dbcommand:`compact` on a secondary. See option ``force:true`` above for information regarding compacting the primary. -.. |cmd-name| replace:: :dbcommand:`compact` -.. include:: /includes/fact-command-puts-secondary-into-recovering.rst +.. include:: /includes/extracts/fact-command-puts-secondary-into-recovering-compact.rst Sharded Clusters ~~~~~~~~~~~~~~~~ diff --git a/source/reference/command/copydb.txt b/source/reference/command/copydb.txt index 5e0cd5a9e1f..ce74323c2a9 100644 --- a/source/reference/command/copydb.txt +++ b/source/reference/command/copydb.txt @@ -35,9 +35,7 @@ Definition Behavior -------- -.. |copydb| replace:: :dbcommand:`copydb` - -.. include:: /includes/fact-copydb-behavior.rst +.. include:: /includes/extracts/fact-copydb-behavior-cmd-copydb.rst Required Access --------------- diff --git a/source/reference/command/count.txt b/source/reference/command/count.txt index f387a72eb11..09818499611 100644 --- a/source/reference/command/count.txt +++ b/source/reference/command/count.txt @@ -32,9 +32,7 @@ Definition Behavior -------- -.. |count-op| replace:: :dbcommand:`count` - -.. include:: /includes/fact-count-on-sharded-clusters.rst +.. include:: /includes/extracts/fact-count-on-sharded-clusters-cmd-count.rst Examples -------- diff --git a/source/reference/command/eval.txt b/source/reference/command/eval.txt index b82cb6751c7..b4e271e2742 100644 --- a/source/reference/command/eval.txt +++ b/source/reference/command/eval.txt @@ -26,13 +26,11 @@ eval .. include:: /reference/command/eval-param.rst - .. |javascript-using-operation| replace:: :dbcommand:`eval` uses - .. include:: /includes/admonition-javascript-prevalence.rst + .. include:: /includes/extracts/admonition-js-prevalence-eval.rst Behavior -------- -.. |eval-object| replace:: :dbcommand:`eval` .. |object| replace:: :dbcommand:`eval` .. |nolockobject| replace:: :dbcommand:`eval` command .. include:: /includes/admonitions-eval.rst diff --git a/source/reference/command/getLastError.txt b/source/reference/command/getLastError.txt index 74c995379a5..111a4fd629d 100644 --- a/source/reference/command/getLastError.txt +++ b/source/reference/command/getLastError.txt @@ -9,9 +9,7 @@ Definition .. dbcommand:: getLastError - .. |gle| replace:: :dbcommand:`getLastError` command - - .. include:: /includes/fact-2.6-wc-gle-change.rst + .. include:: /includes/extracts/fact-2.6-wc-gle-change-cmd-getLastError.rst Returns the error status of the preceding write operation on the *current connection*. diff --git a/source/reference/command/group.txt b/source/reference/command/group.txt index f553a515522..b230e519473 100644 --- a/source/reference/command/group.txt +++ b/source/reference/command/group.txt @@ -73,8 +73,7 @@ instance's JavaScript lock which blocked all other JavaScript execution. .. include:: /includes/fact-group-map-reduce-where-limitations-in-24.rst -.. |javascript-using-operation| replace:: :dbcommand:`group` uses -.. include:: /includes/admonition-javascript-prevalence.rst +.. include:: /includes/extracts/admonition-js-prevalence-group.rst Examples -------- diff --git a/source/reference/command/mapReduce.txt b/source/reference/command/mapReduce.txt index b8504864592..102277ad24d 100644 --- a/source/reference/command/mapReduce.txt +++ b/source/reference/command/mapReduce.txt @@ -54,8 +54,7 @@ mapReduce } ) - .. |javascript-using-operation| replace:: :dbcommand:`mapReduce` uses - .. include:: /includes/admonition-javascript-prevalence.rst + .. include:: /includes/extracts/admonition-js-prevalence-mapReduce.rst .. note:: diff --git a/source/reference/command/replSetMaintenance.txt b/source/reference/command/replSetMaintenance.txt index 0511bf42f71..c2df02697f9 100644 --- a/source/reference/command/replSetMaintenance.txt +++ b/source/reference/command/replSetMaintenance.txt @@ -36,7 +36,6 @@ Consider the following behavior when running the - The member continues to sync its :term:`oplog` from the Primary. -.. |cmd-name| replace:: :dbcommand:`compact` -.. include:: /includes/fact-command-puts-secondary-into-recovering.rst +.. include:: /includes/extracts/fact-command-puts-secondary-into-recovering-replSetMaintenance.rst .. admin-only diff --git a/source/reference/command/serverStatus.txt b/source/reference/command/serverStatus.txt index d640848f664..ce631588d4a 100644 --- a/source/reference/command/serverStatus.txt +++ b/source/reference/command/serverStatus.txt @@ -32,8 +32,7 @@ Definition db.runCommand( { serverStatus: 1, repl: 0, indexCounters: 0 } ) db.runCommand( { serverStatus: 1, workingSet: 1, metrics: 0, locks: 0 } ) - .. |operation-name| replace:: :dbcommand:`serverStatus` - .. include:: /includes/example-server-status-projection.rst + .. include:: /includes/extracts/example-server-status-projection-db.serverStatus().rst .. seealso:: :method:`db.serverStatus()` diff --git a/source/reference/limits.txt b/source/reference/limits.txt index 23d9fe06155..20068892f49 100644 --- a/source/reference/limits.txt +++ b/source/reference/limits.txt @@ -213,9 +213,7 @@ Sharding Operational Restrictions .. limit:: Covered Queries in Sharded Clusters - .. |cover| replace:: :ref:`cover ` - - .. include:: /includes/fact-covered-query-sharded-collection.rst + .. include:: /includes/excludes/fact-covered-query-sharded-collection-covered-queries.rst .. limit:: Sharding Existing Collection Data Size diff --git a/source/reference/method.txt b/source/reference/method.txt index f1a039fc317..d11b1f0f79c 100644 --- a/source/reference/method.txt +++ b/source/reference/method.txt @@ -7,7 +7,7 @@ .. default-domain:: mongodb .. |javascript-using-operation| replace:: these methods use -.. include:: /includes/admonition-javascript-prevalence.rst +.. include:: /includes/excerpts/admonition-js-prevalence-methods.rst Collection ---------- diff --git a/source/reference/method/cursor.count.txt b/source/reference/method/cursor.count.txt index 78628817944..b22e3509270 100644 --- a/source/reference/method/cursor.count.txt +++ b/source/reference/method/cursor.count.txt @@ -44,9 +44,7 @@ Behavior Sharded Clusters ~~~~~~~~~~~~~~~~ -.. |count-op| replace:: :method:`~cursor.count()` method - -.. include:: /includes/fact-count-on-sharded-clusters.rst +.. include:: /includes/extracts/fact-count-on-sharded-clusters-method-cursor.rst Index Use ~~~~~~~~~ diff --git a/source/reference/method/db.collection.copyTo.txt b/source/reference/method/db.collection.copyTo.txt index 3aea7e59bf5..3382dfef10c 100644 --- a/source/reference/method/db.collection.copyTo.txt +++ b/source/reference/method/db.collection.copyTo.txt @@ -13,8 +13,7 @@ Definition server-side JavaScript. If ``newCollection`` does not exist, MongoDB creates it. - .. |eval-object| replace:: :method:`db.collection.copyTo()` - .. include:: /includes/access-eval.rst + .. include:: /includes/extracts/access-eval-copyTo.rst .. include:: /reference/method/db.collection.copyTo-param.rst diff --git a/source/reference/method/db.collection.count.txt b/source/reference/method/db.collection.count.txt index 2ac62ef3cec..9857ec2dd76 100644 --- a/source/reference/method/db.collection.count.txt +++ b/source/reference/method/db.collection.count.txt @@ -30,9 +30,7 @@ Behavior Sharded Clusters ~~~~~~~~~~~~~~~~ -.. |count-op| replace:: :method:`db.collection.count()` - -.. include:: /includes/fact-count-on-sharded-clusters.rst +.. include:: /includes/extracts/fact-count-on-sharded-clusters-method-db.collection.count.rst Index Use ~~~~~~~~~ diff --git a/source/reference/method/db.copyDatabase.txt b/source/reference/method/db.copyDatabase.txt index 70bacde62cc..84ccf45acea 100644 --- a/source/reference/method/db.copyDatabase.txt +++ b/source/reference/method/db.copyDatabase.txt @@ -19,9 +19,7 @@ Definition Behavior -------- -.. |copydb| replace:: :method:`db.copyDatabase()` - -.. include:: /includes/fact-copydb-behavior.rst +.. include:: /includes/extracts/fact-copydb-behavior-method-db.copyDatabase.rst .. _copyDatabases-requiredAccess: diff --git a/source/reference/method/db.eval.txt b/source/reference/method/db.eval.txt index acd8ab11ef2..426c0f2b05c 100644 --- a/source/reference/method/db.eval.txt +++ b/source/reference/method/db.eval.txt @@ -42,7 +42,6 @@ Definition Behavior -------- -.. |eval-object| replace:: :method:`db.eval()` .. |object| replace:: :method:`db.eval()` .. |nolockobject| replace:: :dbcommand:`eval` *command* .. include:: /includes/admonitions-eval.rst diff --git a/source/reference/method/db.getLastError.txt b/source/reference/method/db.getLastError.txt index b87930a5902..ab97857cb30 100644 --- a/source/reference/method/db.getLastError.txt +++ b/source/reference/method/db.getLastError.txt @@ -6,9 +6,7 @@ db.getLastError() .. method:: db.getLastError() - .. |gle| replace:: :method:`db.getLastError()` method - - .. include:: /includes/fact-2.6-wc-gle-change.rst + .. include:: /includes/extracts/fact-2.6-wc-gle-change-method-db.getLastError.rst :returns: The last error message string. diff --git a/source/reference/method/db.getLastErrorObj.txt b/source/reference/method/db.getLastErrorObj.txt index a5bb5c67e9b..66a1b5d6108 100644 --- a/source/reference/method/db.getLastErrorObj.txt +++ b/source/reference/method/db.getLastErrorObj.txt @@ -6,9 +6,7 @@ db.getLastErrorObj() .. method:: db.getLastErrorObj() - .. |gle| replace:: :method:`db.getLastError()` method - - .. include:: /includes/fact-2.6-wc-gle-change.rst + .. include:: /includes/extracts/fact-2.6-wc-gle-change-method-db.getLastErrorObj.rst :returns: A full :term:`document` with status information. diff --git a/source/reference/method/db.serverStatus.txt b/source/reference/method/db.serverStatus.txt index f8dc94643f6..f8943c9e615 100644 --- a/source/reference/method/db.serverStatus.txt +++ b/source/reference/method/db.serverStatus.txt @@ -23,8 +23,7 @@ db.serverStatus() db.serverStatus( { repl: 0, indexCounters: 0, locks: 0 } ) db.serverStatus( { workingSet: 1, metrics: 0, locks: 0 } ) - .. |operation-name| replace:: :method:`db.serverStatus()` - .. include:: /includes/example-server-status-projection.rst + .. include:: /includes/extracts/example-server-status-projection-serverStatus.rst .. seealso:: :doc:`/reference/command/serverStatus` for complete documentation of the output of this function. diff --git a/source/reference/operator/aggregation/addToSet.txt b/source/reference/operator/aggregation/addToSet.txt index 78de3c0dc3e..1aad46e6a0b 100644 --- a/source/reference/operator/aggregation/addToSet.txt +++ b/source/reference/operator/aggregation/addToSet.txt @@ -14,8 +14,7 @@ Definition the same group by key. Order of the elements in the output array is unspecified. - .. |accumulator| replace:: :group:`$addToSet` - .. include:: /includes/fact-aggregation-accumulator.rst + .. include:: /includes/extracts/fact-aggregation-accumulator-addToSet.rst :expression:`$addToSet` has the following syntax: diff --git a/source/reference/operator/aggregation/allElementsTrue.txt b/source/reference/operator/aggregation/allElementsTrue.txt index c52f952b194..49411b823f9 100644 --- a/source/reference/operator/aggregation/allElementsTrue.txt +++ b/source/reference/operator/aggregation/allElementsTrue.txt @@ -28,13 +28,9 @@ Definition Behavior -------- -.. |exp| replace:: :expression:`$allElementsTrue` +.. include:: /includes/extracts/fact-agg-top-level-expressions-allElementsTrue.rst -.. include:: /includes/fact-agg-top-level-expressions.rst - -.. |boolean-exp| replace:: :expression:`$allElementsTrue` - -.. include:: /includes/fact-agg-boolean.rst +.. include:: /includes/extracts/fact-agg-boolean-allElementsTrue.rst .. list-table:: :header-rows: 1 diff --git a/source/reference/operator/aggregation/and.txt b/source/reference/operator/aggregation/and.txt index ad8a0c0b77a..7ea9b2a6731 100644 --- a/source/reference/operator/aggregation/and.txt +++ b/source/reference/operator/aggregation/and.txt @@ -28,9 +28,7 @@ Behavior :expression:`$and` uses short-circuit logic: the operation stops evaluation after encountering the first ``false`` expression. -.. |boolean-exp| replace:: :expression:`$and` - -.. include:: /includes/fact-agg-boolean.rst +.. include:: /includes/extracts/fact-agg-boolean-and.rst .. list-table:: :header-rows: 1 diff --git a/source/reference/operator/aggregation/anyElementTrue.txt b/source/reference/operator/aggregation/anyElementTrue.txt index 6523f68d9ae..d2835a621ac 100644 --- a/source/reference/operator/aggregation/anyElementTrue.txt +++ b/source/reference/operator/aggregation/anyElementTrue.txt @@ -28,13 +28,9 @@ Definition Behavior -------- -.. |exp| replace:: :expression:`$anyElementTrue` +.. include:: /includes/extracts/fact-agg-top-level-expressions-anyElementsTrue.rst -.. include:: /includes/fact-agg-top-level-expressions.rst - -.. |boolean-exp| replace:: :expression:`$anyElementTrue` - -.. include:: /includes/fact-agg-boolean.rst +.. include:: /includes/extracts/fact-agg-boolean-anyElementsTrue.rst .. list-table:: :header-rows: 1 diff --git a/source/reference/operator/aggregation/avg.txt b/source/reference/operator/aggregation/avg.txt index c753010644e..b803f3529a5 100644 --- a/source/reference/operator/aggregation/avg.txt +++ b/source/reference/operator/aggregation/avg.txt @@ -14,8 +14,7 @@ Definition documents that share the same group by key. :group:`$avg` ignores non-numeric values. - .. |accumulator| replace:: :group:`$avg` - .. include:: /includes/fact-aggregation-accumulator.rst + .. include:: /includes/extracts/fact-aggregation-accumulator-avg.rst :expression:`$avg` has the following syntax: diff --git a/source/reference/operator/aggregation/cmp.txt b/source/reference/operator/aggregation/cmp.txt index 5f3ee748600..2652c308f75 100644 --- a/source/reference/operator/aggregation/cmp.txt +++ b/source/reference/operator/aggregation/cmp.txt @@ -1,4 +1,4 @@ -================== +e================== $cmp (aggregation) ================== @@ -17,9 +17,7 @@ Definition - ``0`` if the two values are equivalent. - .. |comparison-expression| replace:: :expression:`$cmp` - - .. include:: /includes/fact-agg-comparison-expressions.rst + .. include:: /includes/extracts/fact-agg-comparison-expression-cmp.rst :expression:`$cmp` has the following syntax: diff --git a/source/reference/operator/aggregation/eq.txt b/source/reference/operator/aggregation/eq.txt index 397e9a3d15e..abebb44e821 100644 --- a/source/reference/operator/aggregation/eq.txt +++ b/source/reference/operator/aggregation/eq.txt @@ -15,9 +15,7 @@ Definition - ``false`` when the values are **not** equivalent. - .. |comparison-expression| replace:: :expression:`$eq` - - .. include:: /includes/fact-agg-comparison-expressions.rst + .. include:: /includes/extracts/fact-agg-comparison-expression-eq.rst :expression:`$eq` has the following syntax: diff --git a/source/reference/operator/aggregation/first.txt b/source/reference/operator/aggregation/first.txt index 661a6af3b19..4a4ea59094e 100644 --- a/source/reference/operator/aggregation/first.txt +++ b/source/reference/operator/aggregation/first.txt @@ -13,8 +13,7 @@ Definition first document in a group of documents that share the same group by key. Only meaningful when documents are in a defined order. - .. |accumulator| replace:: :group:`$first` - .. include:: /includes/fact-aggregation-accumulator.rst + .. include:: /includes/extracts/fact-aggregation-accumulator-first.rst :expression:`$first` has the following syntax: diff --git a/source/reference/operator/aggregation/gt.txt b/source/reference/operator/aggregation/gt.txt index a864baf65c6..c8d7fafc482 100644 --- a/source/reference/operator/aggregation/gt.txt +++ b/source/reference/operator/aggregation/gt.txt @@ -16,9 +16,7 @@ Definition - ``false`` when the first value is *less than or equivalent to* the second value. - .. |comparison-expression| replace:: :expression:`$gt` - - .. include:: /includes/fact-agg-comparison-expressions.rst + .. include:: /includes/extracts/fact-agg-comparison-expression-gt.rst :expression:`$gt` has the following syntax: diff --git a/source/reference/operator/aggregation/gte.txt b/source/reference/operator/aggregation/gte.txt index 1238f8cc752..e81c40d2a76 100644 --- a/source/reference/operator/aggregation/gte.txt +++ b/source/reference/operator/aggregation/gte.txt @@ -16,9 +16,7 @@ Definition - ``false`` when the first value is *less than* the second value. - .. |comparison-expression| replace:: :expression:`$gte` - - .. include:: /includes/fact-agg-comparison-expressions.rst + .. include:: /includes/extracts/fact-agg-comparison-expression-gte.rst :expression:`$gte` has the following syntax: diff --git a/source/reference/operator/aggregation/last.txt b/source/reference/operator/aggregation/last.txt index a95595d6b13..986897f858f 100644 --- a/source/reference/operator/aggregation/last.txt +++ b/source/reference/operator/aggregation/last.txt @@ -13,8 +13,7 @@ Definition last document in a group of documents that share the same group by a field. Only meaningful when documents are in a defined order. - .. |accumulator| replace:: :group:`$last` - .. include:: /includes/fact-aggregation-accumulator.rst + .. include:: /includes/extracts/fact-aggregation-accumulator-last.rst :expression:`$last` has the following syntax: diff --git a/source/reference/operator/aggregation/lt.txt b/source/reference/operator/aggregation/lt.txt index a66b6b38e85..0ebd75c0cdc 100644 --- a/source/reference/operator/aggregation/lt.txt +++ b/source/reference/operator/aggregation/lt.txt @@ -16,10 +16,8 @@ Definition - ``false`` when the first value is *greater than or equivalent to* the second value. - .. |comparison-expression| replace:: :expression:`$lt` - - .. include:: /includes/fact-agg-comparison-expressions.rst - + .. include:: /includes/extracts/fact-agg-comparison-expression-lt.rst + :expression:`$lt` has the following syntax: .. code-block:: javascript diff --git a/source/reference/operator/aggregation/lte.txt b/source/reference/operator/aggregation/lte.txt index de5856e47b3..09f109e63e1 100644 --- a/source/reference/operator/aggregation/lte.txt +++ b/source/reference/operator/aggregation/lte.txt @@ -17,9 +17,7 @@ Definition - ``false`` when the first value is *greater than* the second value. - .. |comparison-expression| replace:: :expression:`$lte` - - .. include:: /includes/fact-agg-comparison-expressions.rst + .. include:: /includes/extracts/fact-agg-comparison-expression-lte.rst :expression:`$lte` has the following syntax: diff --git a/source/reference/operator/aggregation/max.txt b/source/reference/operator/aggregation/max.txt index 4ddb91a99d0..2eecd2b85af 100644 --- a/source/reference/operator/aggregation/max.txt +++ b/source/reference/operator/aggregation/max.txt @@ -13,8 +13,7 @@ Definition each document in a group of documents that share the same group by key. - .. |accumulator| replace:: :group:`$max` - .. include:: /includes/fact-aggregation-accumulator.rst + .. include:: /includes/extracts/fact-aggregation-accumulator-max.rst :expression:`$max` has the following syntax: diff --git a/source/reference/operator/aggregation/min.txt b/source/reference/operator/aggregation/min.txt index 72f3af5a56c..0e43e9181f8 100644 --- a/source/reference/operator/aggregation/min.txt +++ b/source/reference/operator/aggregation/min.txt @@ -13,8 +13,7 @@ Definition each document in a group of documents that share the same group by key. - .. |accumulator| replace:: :group:`$min` - .. include:: /includes/fact-aggregation-accumulator.rst + .. include:: /includes/extracts/fact-aggregation-accumulator-min.rst :expression:`$min` has the following syntax: diff --git a/source/reference/operator/aggregation/ne.txt b/source/reference/operator/aggregation/ne.txt index 69c47d9cb1b..818be4115b7 100644 --- a/source/reference/operator/aggregation/ne.txt +++ b/source/reference/operator/aggregation/ne.txt @@ -15,7 +15,7 @@ Definition - ``false`` when the values are equivalent. - .. |comparison-expression| replace:: :expression:`$lte` + .. include:: /includes/extracts/fact-agg-comparison-expression-ne.rst .. include:: /includes/fact-agg-comparison-expressions.rst diff --git a/source/reference/operator/aggregation/not.txt b/source/reference/operator/aggregation/not.txt index 1b0d0ed13d3..9bb9aed5d6d 100644 --- a/source/reference/operator/aggregation/not.txt +++ b/source/reference/operator/aggregation/not.txt @@ -26,9 +26,7 @@ Definition Behavior -------- -.. |boolean-exp| replace:: :expression:`$not` - -.. include:: /includes/fact-agg-boolean.rst +.. include:: /includes/extracts/fact-agg-boolean-not.rst .. list-table:: :header-rows: 1 diff --git a/source/reference/operator/aggregation/or.txt b/source/reference/operator/aggregation/or.txt index 5dc187fbbf5..dd86805df81 100644 --- a/source/reference/operator/aggregation/or.txt +++ b/source/reference/operator/aggregation/or.txt @@ -28,9 +28,7 @@ Behavior :expression:`$or` uses short-circuit logic: the operation stops evaluation after encountering the first ``true`` expression. -.. |boolean-exp| replace:: :expression:`$or` - -.. include:: /includes/fact-agg-boolean.rst +.. include:: /includes/extracts/fact-agg-boolean-or.rst .. list-table:: :header-rows: 1 diff --git a/source/reference/operator/aggregation/push.txt b/source/reference/operator/aggregation/push.txt index d7e10e6f3d5..9d3d44a5fed 100644 --- a/source/reference/operator/aggregation/push.txt +++ b/source/reference/operator/aggregation/push.txt @@ -13,8 +13,7 @@ Definition expression to each document in a group of documents that share the same group by key. - .. |accumulator| replace:: :group:`$push` - .. include:: /includes/fact-aggregation-accumulator.rst + .. include:: /includes/extracts/fact-aggregation-accumulator-push.rst :expression:`$push` has the following syntax: diff --git a/source/reference/operator/aggregation/setDifference.txt b/source/reference/operator/aggregation/setDifference.txt index 5b72634f832..398a62bb4c6 100644 --- a/source/reference/operator/aggregation/setDifference.txt +++ b/source/reference/operator/aggregation/setDifference.txt @@ -34,9 +34,7 @@ Behavior .. include:: /includes/important-set-operator-semantics.rst -.. |exp| replace:: :expression:`$setDifference` - -.. include:: /includes/fact-agg-top-level-expressions.rst +.. include:: /includes/extracts/fact-agg-top-level-expressions-setDifference.rst .. list-table:: :header-rows: 1 diff --git a/source/reference/operator/aggregation/setEquals.txt b/source/reference/operator/aggregation/setEquals.txt index 2e01cb46558..f9a0ec7edb4 100644 --- a/source/reference/operator/aggregation/setEquals.txt +++ b/source/reference/operator/aggregation/setEquals.txt @@ -33,9 +33,7 @@ Behavior .. include:: /includes/important-set-operator-semantics.rst :end-before: .. set-output -.. |exp| replace:: :expression:`$setEquals` - -.. include:: /includes/fact-agg-top-level-expressions.rst +.. include:: /includes/extracts-fact-agg-top-level-expressions-setEquals.rst .. list-table:: :header-rows: 1 diff --git a/source/reference/operator/aggregation/setIntersection.txt b/source/reference/operator/aggregation/setIntersection.txt index 2344c65db94..9a2596ac71c 100644 --- a/source/reference/operator/aggregation/setIntersection.txt +++ b/source/reference/operator/aggregation/setIntersection.txt @@ -32,9 +32,7 @@ Behavior .. include:: /includes/important-set-operator-semantics.rst -.. |exp| replace:: :expression:`$setIntersection` - -.. include:: /includes/fact-agg-top-level-expressions.rst +.. include:: /includes/extracts/fact-agg-top-level-expressions-setIntersection.rst .. list-table:: :header-rows: 1 diff --git a/source/reference/operator/aggregation/setIsSubset.txt b/source/reference/operator/aggregation/setIsSubset.txt index 10e0e42097a..a6586a2cbab 100644 --- a/source/reference/operator/aggregation/setIsSubset.txt +++ b/source/reference/operator/aggregation/setIsSubset.txt @@ -34,9 +34,7 @@ Behavior .. include:: /includes/important-set-operator-semantics.rst :end-before: .. set-output -.. |exp| replace:: :expression:`$setIsSubset` - -.. include:: /includes/fact-agg-top-level-expressions.rst +.. include:: /includes/extracts/fact-agg-top-level-expressions-setIsSubset.rst .. list-table:: :header-rows: 1 diff --git a/source/reference/operator/aggregation/setUnion.txt b/source/reference/operator/aggregation/setUnion.txt index aeaf2d9e0f3..9e6549e96ff 100644 --- a/source/reference/operator/aggregation/setUnion.txt +++ b/source/reference/operator/aggregation/setUnion.txt @@ -32,9 +32,7 @@ Behavior .. include:: /includes/important-set-operator-semantics.rst -.. |exp| replace:: :expression:`$setUnion` - -.. include:: /includes/fact-agg-top-level-expressions.rst +.. include:: /includes/extracts/fact-agg-top-level-expressions-setUnion.rst .. list-table:: :header-rows: 1 diff --git a/source/reference/operator/aggregation/sum.txt b/source/reference/operator/aggregation/sum.txt index 8e04b49f47a..b1b2b326c35 100644 --- a/source/reference/operator/aggregation/sum.txt +++ b/source/reference/operator/aggregation/sum.txt @@ -14,8 +14,7 @@ Definition documents that share the same group by key. :group:`$sum` ignores non-numeric values. - .. |accumulator| replace:: :group:`$sum` - .. include:: /includes/fact-aggregation-accumulator.rst + .. include:: /includes/extracts/fact-aggregation-accumulator-sum.rst :expression:`$sum` has the following syntax: diff --git a/source/reference/program/mongodump.txt b/source/reference/program/mongodump.txt index 19c12a4be21..bbf5b06b857 100644 --- a/source/reference/program/mongodump.txt +++ b/source/reference/program/mongodump.txt @@ -57,8 +57,7 @@ Backup Users Options ------- -.. |program| replace:: :program:`mongodump` -.. include:: /includes/fact-3.0-tools-drop-dbpath-support.rst +.. include:: /includes/extracts/fact-3.0-tools-drop-dbpath-support-mongodump.rst .. binary:: mongodump diff --git a/source/reference/program/mongoexport.txt b/source/reference/program/mongoexport.txt index 483f9844847..87e5c75dfc5 100644 --- a/source/reference/program/mongoexport.txt +++ b/source/reference/program/mongoexport.txt @@ -29,8 +29,7 @@ kind of functionality. Options ------- -.. |program| replace:: :program:`mongoexport` -.. include:: /includes/fact-3.0-tools-drop-dbpath-support.rst +.. include:: /includes/extracts/fact-3.0-tools-drop-dbpath-support-mongoexport.rst .. versionchanged:: 3.0.0 :program:`mongoexport` also removed support for writing data to diff --git a/source/reference/program/mongofiles.txt b/source/reference/program/mongofiles.txt index fa6292f6854..6734ec8bbbe 100644 --- a/source/reference/program/mongofiles.txt +++ b/source/reference/program/mongofiles.txt @@ -49,8 +49,7 @@ stored in a MongoDB data directory without requiring a running Options ------- -.. |program| replace:: :program:`mongofiles` -.. include:: /includes/fact-3.0-tools-drop-dbpath-support.rst +.. include:: /includes/extracts/fact-3.0-tools-drop-dbpath-support-mongofiles.rst .. program:: mongofiles diff --git a/source/reference/program/mongoimport.txt b/source/reference/program/mongoimport.txt index 965cfa0d680..4269b6fecf9 100644 --- a/source/reference/program/mongoimport.txt +++ b/source/reference/program/mongoimport.txt @@ -34,8 +34,7 @@ better performance for specific workloads. Options ------- -.. |program| replace:: :program:`mongoimport` -.. include:: /includes/fact-3.0-tools-drop-dbpath-support.rst +.. include:: /includes/extracts/fact-3.0-tools-drop-dbpath-support-mongoimport.rst .. binary:: mongoimport diff --git a/source/reference/program/mongooplog.txt b/source/reference/program/mongooplog.txt index 3ca24b70f70..bfd9f1614b9 100644 --- a/source/reference/program/mongooplog.txt +++ b/source/reference/program/mongooplog.txt @@ -45,8 +45,7 @@ your operation. Options ------- -.. |program| replace:: :program:`mongooplog` -.. include:: /includes/fact-3.0-tools-drop-dbpath-support.rst +.. include:: /includes/extracts/fact-3.0-tools-drop-dbpath-support-mongooplog.rst .. binary:: mongooplog From 2718f1f905d401dc02b4d575124e890981367f69 Mon Sep 17 00:00:00 2001 From: Allison Moore Date: Mon, 2 Feb 2015 12:05:15 -0500 Subject: [PATCH 2/2] minor --- source/reference/operator/aggregation/cmp.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/operator/aggregation/cmp.txt b/source/reference/operator/aggregation/cmp.txt index 2652c308f75..1c3c744af45 100644 --- a/source/reference/operator/aggregation/cmp.txt +++ b/source/reference/operator/aggregation/cmp.txt @@ -1,4 +1,4 @@ -e================== +================== $cmp (aggregation) ==================