From 8193fda93959d6307239d66d4d034802c4c70e40 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Tue, 6 Oct 2020 11:24:59 -0400 Subject: [PATCH 01/96] (DOCSP-12590): Fix broken links --- source/core/hashed-sharding.txt | 2 +- source/core/index-ttl.txt | 2 +- source/core/security-ldap-external.txt | 13 ++-- source/core/security-ldap.txt | 14 +++-- source/geospatial-queries.txt | 4 +- source/includes/access-grant-roles.rst | 2 +- .../considerations-deploying-replica-set.rst | 5 +- source/includes/examples-map-reduce.rst | 8 +-- ...racts-concurrency-consistency-recency.yaml | 2 +- .../includes/fact-bulk-operation-batches.rst | 10 +-- .../fact-bulkwrite-operation-batches.rst | 4 +- ...config-server-replica-set-restrictions.rst | 3 +- .../fact-snmp-run-mongodb-as-snmp-master.rst | 9 +-- source/includes/stepdown-intro.rst | 2 +- ...ps-2.6-downgrade-authorization-prereq.yaml | 2 +- ...e-own-password-and-custom-data-prereq.yaml | 4 +- .../includes/steps-compass-query-builder.yaml | 44 ------------- ...-windows-with-kerberos-authentication.yaml | 14 ++--- ...eps-convert-replica-set-add-new-shard.yaml | 8 ++- .../steps-monitor-with-snmp-windows.yaml | 3 +- source/includes/steps-monitor-with-snmp.yaml | 5 +- ...re-sharded-config-primary-from-backup.yaml | 4 +- source/includes/steps-starting-compass.yaml | 61 ------------------- source/reference/command/aggregate.txt | 2 +- source/reference/command/find.txt | 2 +- source/reference/configuration-options.txt | 3 +- source/reference/database-profiler.txt | 2 +- source/reference/glossary.txt | 2 +- source/reference/limits.txt | 6 +- .../map-reduce-to-aggregation-pipeline.txt | 6 +- source/reference/method/cursor.maxTimeMS.txt | 2 +- .../method/cursor.noCursorTimeout.txt | 2 +- .../method/db.changeUserPassword.txt | 2 +- .../method/db.collection.aggregate.txt | 2 +- .../reference/method/db.collection.find.txt | 2 +- source/reference/method/db.dropAllRoles.txt | 6 +- .../reference/method/db.grantRolesToRole.txt | 5 +- .../operator/aggregation/accumulator.txt | 2 +- .../operator/aggregation/addToSet.txt | 2 +- .../reference/operator/aggregation/merge.txt | 4 +- .../operator/aggregation/regexFind.txt | 3 +- source/reference/operator/aggregation/sum.txt | 8 +-- .../operator/aggregation/unionWith.txt | 2 +- source/reference/read-concern-available.txt | 2 +- source/reference/read-concern.txt | 4 +- source/reference/replica-configuration.txt | 2 +- source/release-notes/3.0.txt | 6 +- source/replication.txt | 6 +- .../aggregation-zip-code-data-set.txt | 4 +- ...gure-secondary-only-replica-set-member.txt | 2 +- source/tutorial/expand-replica-set.txt | 3 +- .../tutorial/force-member-to-be-primary.txt | 4 +- .../tutorial/monitor-with-snmp-on-windows.txt | 5 +- source/tutorial/monitor-with-snmp.txt | 4 +- .../perform-incremental-map-reduce.txt | 4 +- source/tutorial/troubleshoot-snmp.txt | 8 ++- ...te-documents-with-aggregation-pipeline.txt | 2 +- 57 files changed, 127 insertions(+), 219 deletions(-) delete mode 100644 source/includes/steps-compass-query-builder.yaml delete mode 100644 source/includes/steps-starting-compass.yaml diff --git a/source/core/hashed-sharding.txt b/source/core/hashed-sharding.txt index fbd971e98ef..2f034c6cfd4 100644 --- a/source/core/hashed-sharding.txt +++ b/source/core/hashed-sharding.txt @@ -65,7 +65,7 @@ The field you choose as your hashed shard key should have a good Hashed keys are ideal for shard keys with fields that change :ref:`monotonically` like :term:`ObjectId` values or timestamps. A good example of this is the default ``_id`` field, assuming -it only contains :term:`ObjectID` values. +it only contains :term:`ObjectId` values. To shard a collection using a hashed shard key, see :ref:`deploy-hashed-sharded-cluster-shard-collection`. diff --git a/source/core/index-ttl.txt b/source/core/index-ttl.txt index 5149f49bca7..bb14143f041 100644 --- a/source/core/index-ttl.txt +++ b/source/core/index-ttl.txt @@ -86,7 +86,7 @@ Replica Sets On :term:`replica set ` members, the TTL background thread *only* deletes documents when a member is in state :term:`primary`. The TTL background -thread is idle when a member is in state :term:`secondary`. :term:`Secondary` members replicate +thread is idle when a member is in state :term:`secondary`. :term:`Secondary ` members replicate deletion operations from the primary. Support for Queries diff --git a/source/core/security-ldap-external.txt b/source/core/security-ldap-external.txt index 74740e3bd82..013edc85cff 100644 --- a/source/core/security-ldap-external.txt +++ b/source/core/security-ldap-external.txt @@ -293,7 +293,7 @@ configuration file: Defaults to ``DIGEST-MD5``. - - **NO**, unless setting :setting:`~security.ldap.bindMethod` to + - **NO**, unless setting :setting:`~security.ldap.bind.method` to ``sasl``, and you need different or additional SASL mechanisms. * - :setting:`security.ldap.bind.useOSDefaults` @@ -308,10 +308,11 @@ configuration file: * - :setting:`security.ldap.userToDNMapping` - - Depending on your :setting:`~security.ldap.queryTemplate`, the - authenticated client username may require transformation to support the - LDAP query URL. :setting:`~security.ldap.userToDNMapping` allows - MongoDB to transform incoming usernames. + - Depending on your :setting:`~security.ldap.authz.queryTemplate`, + the authenticated client username may require transformation to + support the LDAP query URL. + :setting:`~security.ldap.userToDNMapping` allows MongoDB to + transform incoming usernames. - **NO**, unless client usernames require transformation into LDAP DNs. @@ -446,7 +447,7 @@ MongoDB Roles for LDAP Authorization ------------------------------------ MongoDB maps each returned group distinguished name (DN) returned by -the LDAP :setting:`query ` to a +the LDAP :setting:`query ` to a :ref:`role ` on the ``admin`` database. If MongoDB acquires a group whose DN **exactly** matches the name of an diff --git a/source/core/security-ldap.txt b/source/core/security-ldap.txt index 3fd6e9b15f5..bda71692e88 100644 --- a/source/core/security-ldap.txt +++ b/source/core/security-ldap.txt @@ -262,13 +262,14 @@ configuration file: - The password used to authenticate to an LDAP server when using :setting:`~security.ldap.bind.queryUser`. - - **NO**, unless specifying :setting:`~security.ldap.queryUser` + - **NO**, unless specifying + :setting:`~security.ldap.bind.queryUser`. * - :setting:`security.ldap.bind.useOSDefaults` - Windows MongoDB deployments can use the operating system credentials in - place of :setting:`~security.ldap.queryUser` and - :setting:`~security.ldap.queryPassword` for authenticating or binding + place of :setting:`~security.ldap.bind.queryUser` and + :setting:`~security.ldap.bind.queryPassword` for authenticating or binding as when connecting to the LDAP server. - **NO**, unless replacing :setting:`~security.ldap.bind.queryUser` and @@ -288,9 +289,10 @@ configuration file: or an LDAP query template. If you specify a :setting:`~security.ldap.userToDNMapping` - transformation that uses LDAP queries as part of the transformation, - you must also specify a :setting:`~security.ldap.queryUser` with - the appropriate level of permissions for the LDAP server + transformation that uses LDAP queries as part of the + transformation, you must also specify a + :setting:`~security.ldap.bind.queryUser` with the appropriate + level of permissions for the LDAP server - **NO**, unless client authenticate using usernames that require transformation. diff --git a/source/geospatial-queries.txt b/source/geospatial-queries.txt index 9c7703c0dd7..c23f6a9c052 100644 --- a/source/geospatial-queries.txt +++ b/source/geospatial-queries.txt @@ -98,7 +98,7 @@ collections: .. |geo-operation| replace:: :query:`$near` and :query:`$nearSphere` You can also query for geospatial data for a sharded cluster using -:query:`$geoWithin` and :query:`$geoIntersect`. +:query:`$geoWithin` and :query:`$geoIntersects`. Covered Queries ~~~~~~~~~~~~~~~ @@ -341,7 +341,7 @@ farthest: } ) -The following operation uses the :pipeline:`geoNear` aggregation +The following operation uses the :pipeline:`$geoNear` aggregation operation to return documents that match the query filter ``{ category: "Parks" }``, sorted in order of nearest to farthest to the specified GeoJSON point: diff --git a/source/includes/access-grant-roles.rst b/source/includes/access-grant-roles.rst index 4fe715756a9..ef79ca970f1 100644 --- a/source/includes/access-grant-roles.rst +++ b/source/includes/access-grant-roles.rst @@ -1,2 +1,2 @@ -You must have the :authaction:`grantRole` :ref:`action +You must have the :authaction:`grantRole()` :ref:`action ` on a database to grant a role on that database. diff --git a/source/includes/considerations-deploying-replica-set.rst b/source/includes/considerations-deploying-replica-set.rst index 80ec4a68582..5be023f7ece 100644 --- a/source/includes/considerations-deploying-replica-set.rst +++ b/source/includes/considerations-deploying-replica-set.rst @@ -14,8 +14,9 @@ Hostnames IP Binding ~~~~~~~~~~ -Use the :setting:`bind_ip` option to ensure that MongoDB listens for -connections from applications on configured addresses. +Use the :option:`--bind_ip ` option to ensure that +MongoDB listens for connections from applications on configured +addresses. .. versionchanged:: 3.6 diff --git a/source/includes/examples-map-reduce.rst b/source/includes/examples-map-reduce.rst index 70d07664bcb..0013f8b4857 100644 --- a/source/includes/examples-map-reduce.rst +++ b/source/includes/examples-map-reduce.rst @@ -133,7 +133,7 @@ the map-reduce operation without defining custom functions: ]) #. The :pipeline:`$group` stage groups by the ``cust_id`` and - calculates the ``value`` field (See also :expression:`$sum`). The + calculates the ``value`` field (See also :group:`$sum`). The ``value`` field contains the total ``price`` for each ``cust_id``. The stage output the following documents to the next stage: @@ -315,7 +315,7 @@ the map-reduce operation without defining custom functions: documents with ``ord_date`` greater than or equal to ``new Date("2020-03-01")``. -#. The :pipeline:`$unwinds` stage breaks down the document by +#. The :pipeline:`$unwind` stage breaks down the document by the ``items`` array field to output a document for each array element. For example: @@ -335,11 +335,11 @@ the map-reduce operation without defining custom functions: #. The :pipeline:`$group` stage groups by the ``items.sku``, calculating for each sku: - The ``qty`` field. The ``qty`` field contains the - total ``qty`` ordered per each ``items.sku`` (See :expression:`$sum`). + total ``qty`` ordered per each ``items.sku`` (See :group:`$sum`). - The ``orders_ids`` array. The ``orders_ids`` field contains an array of distinct order ``_id``'s for the ``items.sku`` (See - :expression:`$addToSet`). + :group:`$addToSet`). .. code-block:: javascript :copyable: false diff --git a/source/includes/extracts-concurrency-consistency-recency.yaml b/source/includes/extracts-concurrency-consistency-recency.yaml index 4c560b88dfa..67d2c8a832e 100644 --- a/source/includes/extracts-concurrency-consistency-recency.yaml +++ b/source/includes/extracts-concurrency-consistency-recency.yaml @@ -146,7 +146,7 @@ content: | With :rsconf:`writeConcernMajorityJournalDefault` set to ``false``, MongoDB does not wait for :writeconcern:`w: "majority" <"majority">` writes to be written to the on-disk journal before acknowledging the - writes. As such, :writeconcern:`majority` write operations could + writes. As such, :writeconcern:`"majority"` write operations could possibly roll back in the event of a transient loss (e.g. crash and restart) of a majority of nodes in a given replica set. diff --git a/source/includes/fact-bulk-operation-batches.rst b/source/includes/fact-bulk-operation-batches.rst index 1bf08e06914..31129bfbc68 100644 --- a/source/includes/fact-bulk-operation-batches.rst +++ b/source/includes/fact-bulk-operation-batches.rst @@ -1,8 +1,8 @@ -Each group of operations can have at most :limit:`1000 operations `. If a group exceeds this :limit:`limit -`, MongoDB will divide the group into -smaller groups of 1000 or less. For example, if the bulk operations list -consists of 2000 insert operations, MongoDB creates 2 groups, each with -1000 operations. +Each group of operations can have at most :limit:`1000 operations `. If a group exceeds this +:limit:`limit `, MongoDB will divide +the group into smaller groups of 1000 or less. For example, if the bulk +operations list consists of 2000 insert operations, MongoDB creates 2 +groups, each with 1000 operations. The sizes and grouping mechanics are internal performance details and are subject to change in future versions. diff --git a/source/includes/fact-bulkwrite-operation-batches.rst b/source/includes/fact-bulkwrite-operation-batches.rst index ba64f975ef5..1ac92e29f53 100644 --- a/source/includes/fact-bulkwrite-operation-batches.rst +++ b/source/includes/fact-bulkwrite-operation-batches.rst @@ -4,7 +4,7 @@ the database. As of MongoDB 3.6, this value is ``100,000``. This value is shown in the :data:`isMaster.maxWriteBatchSize` field. This limit prevents issues with oversized error messages. If a group -exceeds this :limit:`limit`, +exceeds this :limit:`limit `, the client driver divides the group into smaller groups with counts less than or equal to the value of the limit. For example, with the ``maxWriteBatchSize`` value of ``100,000``, if the queue consists of @@ -25,4 +25,4 @@ string. Currently, begins once there are at least 2 error messages with total size greater than ``1MB``. The sizes and grouping mechanics are internal performance details and -are subject to change in future versions. \ No newline at end of file +are subject to change in future versions. diff --git a/source/includes/fact-config-server-replica-set-restrictions.rst b/source/includes/fact-config-server-replica-set-restrictions.rst index 088a319a20b..f685efd9636 100644 --- a/source/includes/fact-config-server-replica-set-restrictions.rst +++ b/source/includes/fact-config-server-replica-set-restrictions.rst @@ -7,5 +7,4 @@ for config servers: `. - Must build indexes (i.e. no member should have - :data:`~replSetGetConfig.members[n].buildIndexes` setting set to - false). + :rsconf:`members[n].buildIndexes` setting set to false). diff --git a/source/includes/fact-snmp-run-mongodb-as-snmp-master.rst b/source/includes/fact-snmp-run-mongodb-as-snmp-master.rst index 8c15c779152..7389f2e0b87 100644 --- a/source/includes/fact-snmp-run-mongodb-as-snmp-master.rst +++ b/source/includes/fact-snmp-run-mongodb-as-snmp-master.rst @@ -1,4 +1,5 @@ -You can run |mongod-program| with the :setting:`snmp-master` -option for testing purposes. To do this, use the SNMP master -configuration file instead of the subagent configuration file. From -the directory containing the unpacked MongoDB installation files: +You can run |mongod-program| with the +:option:`snmp-master ` option for testing +purposes. To do this, use the SNMP master configuration file instead of +the subagent configuration file. From the directory containing the +unpacked MongoDB installation files: diff --git a/source/includes/stepdown-intro.rst b/source/includes/stepdown-intro.rst index 444c3bcf39a..02133883992 100644 --- a/source/includes/stepdown-intro.rst +++ b/source/includes/stepdown-intro.rst @@ -3,7 +3,7 @@ Instructs the :term:`primary` of the replica set to become a hold an :ref:`election for primary `. The |command-method| does not immediately step down the primary. If no -:data:`electable <~replSetGetConfig.members[n].priority>` secondaries +:rsconf:`electable ` secondaries are up to date with the primary, the primary waits up to ``secondaryCatchUpPeriodSecs`` (by default 10 seconds) for a secondary to catch up. Once an electable secondary is diff --git a/source/includes/steps-2.6-downgrade-authorization-prereq.yaml b/source/includes/steps-2.6-downgrade-authorization-prereq.yaml index ccc35375252..a13e9ca8598 100644 --- a/source/includes/steps-2.6-downgrade-authorization-prereq.yaml +++ b/source/includes/steps-2.6-downgrade-authorization-prereq.yaml @@ -13,7 +13,7 @@ title: stepnum: 2 ref: create-role-with-required-privileges pre: | - Using the :method:`db.createRole` method, create a + Using the :method:`db.createRole()` method, create a :ref:`role ` with the required privileges. action: language: javascript diff --git a/source/includes/steps-change-own-password-and-custom-data-prereq.yaml b/source/includes/steps-change-own-password-and-custom-data-prereq.yaml index cfa879b630c..8441d398af6 100644 --- a/source/includes/steps-change-own-password-and-custom-data-prereq.yaml +++ b/source/includes/steps-change-own-password-and-custom-data-prereq.yaml @@ -19,7 +19,7 @@ stepnum: 2 title: Create a role with appropriate privileges. ref: create-role pre: | - In the ``admin`` database, :method:`create ` a new + In the ``admin`` database, :method:`create ` a new role with :authaction:`changeOwnPassword` and :authaction:`changeOwnCustomData`. action: @@ -42,7 +42,7 @@ stepnum: 3 title: Add a user with this role. ref: add-user pre: | - In the ``test`` database, :method:`create ` a new user with + In the ``test`` database, :method:`create ` a new user with the created ``"changeOwnPasswordCustomDataRole"`` role. For example, the following operation creates a user with both the built-in role :authrole:`readWrite` and the user-created ``"changeOwnPasswordCustomDataRole"``. diff --git a/source/includes/steps-compass-query-builder.yaml b/source/includes/steps-compass-query-builder.yaml deleted file mode 100644 index 845594e6e54..00000000000 --- a/source/includes/steps-compass-query-builder.yaml +++ /dev/null @@ -1,44 +0,0 @@ -title: Select values from charts -level: 4 -ref: select-values -action: - pre: | - Charts in Compass are fully interactive. Clicking on a chart value or bar - will automatically build a MongoDB query that matches the documents - pertaining to that section of the chart. - - In the example below, clicking on the "JFK" bar builds a query matching all - documents whose ``departureAirportFsCode`` field matches "JFK". - - .. figure:: /images/compass/query-builder-jfk.png - - Clicking on other field values adds them to the selection, creating a more - complex query. - - Continuing with the example, this selects a particular ``flightId`` in - addition to departures from JFK Airport. - - .. figure:: /images/compass/query-builder-jfk-flight-code.png - - To select multiple values within the same field, click and drag the mouse - over a selection of values. Alternatively, hold the Shift key while - selecting the desired values. - - .. figure:: /images/compass/query-builder-multi-select.png - - To deselect a previously-selected value, hold the Shift key while clicking - on the selection. - - .. figure:: /images/compass/query-builder-deselect.png ---- -title: Apply the query -level: 4 -ref: apply -action: - pre: | - After building a query, run it by clicking the Apply button. To clear the - query, use the Reset button. - - Note that composing "OR" queries is **not yet possible** with the automatic - query builder. -... diff --git a/source/includes/steps-control-access-to-mongodb-windows-with-kerberos-authentication.yaml b/source/includes/steps-control-access-to-mongodb-windows-with-kerberos-authentication.yaml index 5a445e6edfa..020c2a72f84 100644 --- a/source/includes/steps-control-access-to-mongodb-windows-with-kerberos-authentication.yaml +++ b/source/includes/steps-control-access-to-mongodb-windows-with-kerberos-authentication.yaml @@ -2,13 +2,13 @@ title: Start ``mongod.exe`` without Kerberos. stepnum: 1 ref: start-mongod-exe-without-kerberos-support pre: | - For the initial addition of Kerberos users, start :binary:`~bin.mongod.exe` + For the initial addition of Kerberos users, start ``mongod.exe`` without Kerberos support. post: | If a Kerberos user is already in MongoDB and has the :ref:`privileges required to create a user `, you can start - :binary:`~bin.mongod.exe` with Kerberos support. + ``mongod.exe`` with Kerberos support. Include additional settings as appropriate to your deployment. @@ -20,7 +20,7 @@ title: Connect to ``mongod``. stepnum: 2 ref: connect-to-mongod pre: | - Connect via the :binary:`~bin.mongo.exe` shell to the :binary:`~bin.mongod.exe` + Connect via the :binary:`~bin.mongo` shell to the :binary:`~bin.mongod.exe` instance. If :binary:`~bin.mongod.exe` has :option:`--auth ` enabled, ensure you connect with the :ref:`privileges required to create a user `. @@ -97,12 +97,12 @@ action: - pre: | You can connect and authenticate from the command line. - Using :binary:`~bin.cmd.exe`: + Using ``cmd.exe``: language: sh code: | mongo.exe --host hostname.example.net --authenticationMechanism=GSSAPI --authenticationDatabase=$external --username reportingapp@EXAMPLE.NET - pre: | - Using :binary:`~bin.Windows PowerShell`: + Using ``Windows PowerShell``: language: sh code: | mongo.exe --host hostname.example.net --authenticationMechanism=GSSAPI --authenticationDatabase='$external' --username reportingapp@EXAMPLE.NET @@ -116,8 +116,8 @@ action: match the Kerberos name, use :option:`--gssapiHostName ` to specify the Kerberos FQDN that it responds to. - pre: | - Alternatively, you can first connect :binary:`~bin.mongo.exe` to the - :binary:`~bin.mongod.exe`, and then from the :binary:`~bin.mongo.exe` shell, use + Alternatively, you can first connect ``mongo.exe`` to the + ``mongod.exe``, and then from the :binary:`~bin.mongo` shell, use the :method:`db.auth()` method to authenticate in the ``$external`` database. language: javascript diff --git a/source/includes/steps-convert-replica-set-add-new-shard.yaml b/source/includes/steps-convert-replica-set-add-new-shard.yaml index 5e3294aea92..5c7a3d29047 100644 --- a/source/includes/steps-convert-replica-set-add-new-shard.yaml +++ b/source/includes/steps-convert-replica-set-add-new-shard.yaml @@ -4,9 +4,11 @@ title: ref: start-mongod pre: | For each member, start a :binary:`~bin.mongod`, specifying the replica - set name through the :setting:`replSet` option and its role as a - shard with the :option:`--shardsvr ` option. Specify additional options, - such as :option:`--bind_ip `, as appropriate. + set name through the :option:`--replSet ` option + and its role as a shard with the + :option:`--shardsvr ` option. Specify additional + options, such as :option:`--bind_ip `, as + appropriate. .. include:: /includes/warning-bind-ip-security-considerations.rst diff --git a/source/includes/steps-monitor-with-snmp-windows.yaml b/source/includes/steps-monitor-with-snmp-windows.yaml index 0e74578369f..6cb721926df 100644 --- a/source/includes/steps-monitor-with-snmp-windows.yaml +++ b/source/includes/steps-monitor-with-snmp-windows.yaml @@ -30,7 +30,8 @@ title: Start MongoDB. stepnum: 2 ref: start-with-snmp pre: | - Start |mongod-program| with the :setting:`snmp-subagent` to send data + Start |mongod-program| with the + :option:`snmp-subagent ` to send data to the SNMP master. action: language: powershell diff --git a/source/includes/steps-monitor-with-snmp.yaml b/source/includes/steps-monitor-with-snmp.yaml index eb8d3aafd4a..53ffeeca644 100644 --- a/source/includes/steps-monitor-with-snmp.yaml +++ b/source/includes/steps-monitor-with-snmp.yaml @@ -184,8 +184,9 @@ title: Start MongoDB. stepnum: 4 ref: start-with-snmp pre: | - Start |mongod-program| with the :setting:`snmp-subagent` to send data - to the SNMP master. + Start |mongod-program| with the + :option:`snmp-subagent ` to send data to the + SNMP master. action: language: sh code: mongod --snmp-subagent diff --git a/source/includes/steps-restore-sharded-config-primary-from-backup.yaml b/source/includes/steps-restore-sharded-config-primary-from-backup.yaml index dd3edf37455..6ac3bfb9d3d 100644 --- a/source/includes/steps-restore-sharded-config-primary-from-backup.yaml +++ b/source/includes/steps-restore-sharded-config-primary-from-backup.yaml @@ -289,9 +289,9 @@ content: | {{code}} If you want to add the member with specific replica - :rsconf:`member ` configuration settings, you can pass a + :rsconf:`member ` configuration settings, you can pass a document to :method:`rs.add()` that defines the member hostname - and any :rsconf:`members[n]` settings your deployment requires. + and any :rsconf:`members` settings your deployment requires. {{morecode}} diff --git a/source/includes/steps-starting-compass.yaml b/source/includes/steps-starting-compass.yaml deleted file mode 100644 index 7bd294035ce..00000000000 --- a/source/includes/steps-starting-compass.yaml +++ /dev/null @@ -1,61 +0,0 @@ -title: Run and connect to MongoDB -level: 4 -ref: run-connect -action: - pre: | - When Compass is run for the first time, it presents the following initial - connection dialog: - - .. figure:: /images/compass/new-connection-form.png - - The following information is requested: - - a. Hostname: The hostname of the machine where :binary:`~bin.mongod` is running. - b. Port: The port of the machine where :binary:`~bin.mongod` is running. - c. Authentication: The authentication mechanism to connect to the target - host. Supported authentication mechanisms include: - - - MongoDB-CR (*Removed in MongoDB 4.0*) - - SCRAM-SHA-1 - - SCRAM-SHA-256 (*Added in MongoDB 4.0*) - - Kerberos - - LDAP - - You cannot specify MongoDB-CR when connecting to MongoDB 4.0 deployments. - - d. SSL: Whether or not Compass should connect to the target host with TLS/SSL. - Several TLS/SSL options are available: - - - Unvalidated: If this option is used, the server cerficiate is not - validated and no client certificate will be provided. The server must be - set up to allow connections without valid certificates. - - Server Validation: The server certificate will be validated, but no - client certificate will be provided. The server must be set up to allow - connections without valid certificates. - - Server and Client Validation: The server certificate will be validated - and a client certificate must be provided. - - e. Favorite Name (Optional): A nickname for the connection. Previous - connections are saved in Compass; a descriptive name simplifies - re-establishing the connection on future runs. - - .. figure:: /images/compass/favorite-connections.png - - After providing the requested information, click "Connect" to launch the - main Compass window. ---- -title: Select a database and collection -level: 4 -ref: select-db-coll -action: - pre: | - Use the navigation pane to select a database and collection to analyze. - - .. figure:: /images/compass/select-collection.png - - After making a selection, Compass will begin analyzing documents and present - a summary screen. Below is an example; results will vary based on the - contents of the collection. - - .. figure:: /images/compass/analysis-page.png -... diff --git a/source/reference/command/aggregate.txt b/source/reference/command/aggregate.txt index d1c5365c304..990671251d4 100644 --- a/source/reference/command/aggregate.txt +++ b/source/reference/command/aggregate.txt @@ -254,7 +254,7 @@ Session Idle Timeout For operations that return a cursor, if the cursor may be idle for longer than 30 minutes, issue the operation within an explicit session -using :method:`Session.startSession()` and periodically refresh the +using :method:`Mongo.startSession()` and periodically refresh the session using the :dbcommand:`refreshSessions` command. See :limit:`Session Idle Timeout` for more information. diff --git a/source/reference/command/find.txt b/source/reference/command/find.txt index ef3b2446357..0fd210db04e 100644 --- a/source/reference/command/find.txt +++ b/source/reference/command/find.txt @@ -502,7 +502,7 @@ Session Idle Timeout For operations that return a cursor, if the cursor may be idle for longer than 30 minutes, issue the operation within an explicit session -using :method:`Session.startSession()` and periodically refresh the +using :method:`Mongo.startSession()` and periodically refresh the session using the :dbcommand:`refreshSessions` command. See :limit:`Session Idle Timeout` for more information. diff --git a/source/reference/configuration-options.txt b/source/reference/configuration-options.txt index 2b0154c5fbd..13efc773d31 100644 --- a/source/reference/configuration-options.txt +++ b/source/reference/configuration-options.txt @@ -2968,7 +2968,8 @@ Key Management Configuration Options .. versionadded:: 3.4 Available in MongoDB Enterprise only. The method :binary:`~bin.mongod` or :binary:`~bin.mongos` uses to authenticate to an LDAP server. - Use with :setting:`~security.ldap.queryUser` and :setting:`~security.ldap.queryPassword` to + Use with :setting:`~security.ldap.bind.queryUser` and + :setting:`~security.ldap.bind.queryPassword` to connect to the LDAP server. :setting:`~security.ldap.bind.method` supports the following values: diff --git a/source/reference/database-profiler.txt b/source/reference/database-profiler.txt index 1d8b5be1580..899b6cad566 100644 --- a/source/reference/database-profiler.txt +++ b/source/reference/database-profiler.txt @@ -365,7 +365,7 @@ operation. .. data:: system.profile.nMatched - The number of documents that match the :data:`system.profile.query` + The number of documents that match the query condition for the update operation. .. data:: system.profile.nModified diff --git a/source/reference/glossary.txt b/source/reference/glossary.txt index 24732f449a5..cac396b1a03 100644 --- a/source/reference/glossary.txt +++ b/source/reference/glossary.txt @@ -214,7 +214,7 @@ Glossary data partition A distributed system architecture that splits data into ranges. - :term:`Sharding` uses partitioning. See + :term:`Sharding ` uses partitioning. See :ref:`sharding-data-partitioning`. data-center awareness diff --git a/source/reference/limits.txt b/source/reference/limits.txt index 80ef43141e4..7aa4adcc1ed 100644 --- a/source/reference/limits.txt +++ b/source/reference/limits.txt @@ -145,8 +145,8 @@ Indexes .. note:: Changed in version 4.2 - Starting in version 4.2, MongoDB removes the :limit:`Index Name Length - Limit` for MongoDB versions with + Starting in version 4.2, MongoDB removes the + :limit:`Index Name Length` limit for MongoDB versions with :ref:`featureCompatibilityVersion ` (fCV) set to ``"4.2"`` or greater. @@ -489,7 +489,7 @@ Sessions For operations that return a cursor, if the cursor may be idle for longer than 30 minutes, issue the operation within an explicit - session using :method:`Session.startSession()` and periodically + session using :method:`Mongo.startSession()` and periodically refresh the session using the :dbcommand:`refreshSessions` command. For example: diff --git a/source/reference/map-reduce-to-aggregation-pipeline.txt b/source/reference/map-reduce-to-aggregation-pipeline.txt index c9ce2c7d9dd..f508e606d77 100644 --- a/source/reference/map-reduce-to-aggregation-pipeline.txt +++ b/source/reference/map-reduce-to-aggregation-pipeline.txt @@ -322,7 +322,7 @@ functions: { "_id" : 9, "emit" : { "key" : "Don Quis", "value" : 55 } } { "_id" : 10, "emit" : { "key" : "Don Quis", "value" : 25 } } -#. Then, the :pipeline:`$group` uses the :expression:`$accumulator` +#. Then, the :pipeline:`$group` uses the :group:`$accumulator` operator to add the emitted values: .. code-block:: javascript @@ -443,7 +443,7 @@ functions: documents with ``ord_date`` greater than or equal to ``new Date("2020-03-01")``. -#. The :pipeline:`$unwinds` stage breaks down the document by +#. The :pipeline:`$unwind` stage breaks down the document by the ``items`` array field to output a document for each array element. For example: @@ -479,7 +479,7 @@ functions: { "_id" : 5, "emit" : { "key" : "chocolates", "value" : { "count" : 1, "qty" : 5 } } } ... -#. The :pipeline:`$group` uses the :expression:`$accumulator` +#. The :pipeline:`$group` uses the :group:`$accumulator` operator to add the emitted ``count`` and ``qty`` and calculate the ``avg`` field: diff --git a/source/reference/method/cursor.maxTimeMS.txt b/source/reference/method/cursor.maxTimeMS.txt index 1a255952710..029fc16edc5 100644 --- a/source/reference/method/cursor.maxTimeMS.txt +++ b/source/reference/method/cursor.maxTimeMS.txt @@ -92,7 +92,7 @@ error. For operations that return a cursor, if the cursor may be idle for longer than 30 minutes, issue the operation within an explicit session -using :method:`Session.startSession()` and periodically refresh the +using :method:`Mongo.startSession()` and periodically refresh the session using the :dbcommand:`refreshSessions` command. For example: .. code-block:: javascript diff --git a/source/reference/method/cursor.noCursorTimeout.txt b/source/reference/method/cursor.noCursorTimeout.txt index 800b8d6ae8d..e20be0a271a 100644 --- a/source/reference/method/cursor.noCursorTimeout.txt +++ b/source/reference/method/cursor.noCursorTimeout.txt @@ -45,7 +45,7 @@ error. For operations that return a cursor, if the cursor may be idle for longer than 30 minutes, issue the operation within an explicit session -using :method:`Session.startSession()` and periodically refresh the +using :method:`Mongo.startSession()` and periodically refresh the session using the :dbcommand:`refreshSessions` command. For example: .. code-block:: shell diff --git a/source/reference/method/db.changeUserPassword.txt b/source/reference/method/db.changeUserPassword.txt index a33c59ccee5..9ed533ea5d3 100644 --- a/source/reference/method/db.changeUserPassword.txt +++ b/source/reference/method/db.changeUserPassword.txt @@ -17,7 +17,7 @@ Definition Updates a user's password. Run the method in the database where the user is defined, i.e. the database you :method:`created - ` the user. + ` the user. .. list-table:: diff --git a/source/reference/method/db.collection.aggregate.txt b/source/reference/method/db.collection.aggregate.txt index b113395dc3e..7d902c60214 100644 --- a/source/reference/method/db.collection.aggregate.txt +++ b/source/reference/method/db.collection.aggregate.txt @@ -276,7 +276,7 @@ Session Idle Timeout For operations that return a cursor, if the cursor may be idle for longer than 30 minutes, issue the operation within an explicit session -using :method:`Session.startSession()` and periodically refresh the +using :method:`Mongo.startSession()` and periodically refresh the session using the :dbcommand:`refreshSessions` command. See :limit:`Session Idle Timeout` for more information. diff --git a/source/reference/method/db.collection.find.txt b/source/reference/method/db.collection.find.txt index 14473be0f90..d155e8ef655 100644 --- a/source/reference/method/db.collection.find.txt +++ b/source/reference/method/db.collection.find.txt @@ -191,7 +191,7 @@ Session Idle Timeout For operations that may be idle for longer than 30 minutes, associate the operation with an explicit session using -:method:`Session.startSession()` and periodically refresh the session +:method:`Mongo.startSession()` and periodically refresh the session using the :dbcommand:`refreshSessions` command. See :limit:`Session Idle Timeout` for more information. diff --git a/source/reference/method/db.dropAllRoles.txt b/source/reference/method/db.dropAllRoles.txt index bbf76ae97bc..80cd48099a2 100644 --- a/source/reference/method/db.dropAllRoles.txt +++ b/source/reference/method/db.dropAllRoles.txt @@ -20,10 +20,10 @@ Definition .. warning:: - The :method:`dropAllRoles` method removes *all* :ref:`user-defined - ` roles from the database. + The :method:`dropAllRoles()` method removes *all* + :ref:`user-defined ` roles from the database. - The :method:`dropAllRoles` method takes the following argument: + The :method:`dropAllRoles()` method takes the following argument: .. list-table:: diff --git a/source/reference/method/db.grantRolesToRole.txt b/source/reference/method/db.grantRolesToRole.txt index 4fbfbf2ff5e..f1340d5a906 100644 --- a/source/reference/method/db.grantRolesToRole.txt +++ b/source/reference/method/db.grantRolesToRole.txt @@ -17,13 +17,14 @@ Definition Grants roles to a :ref:`user-defined role `. - The :method:`grantRolesToRole` method uses the following syntax: + The :method:`grantRolesToRole()` method uses the following syntax: .. code-block:: javascript db.grantRolesToRole( "", [ ], { } ) - The :method:`grantRolesToRole` method takes the following arguments: + The :method:`grantRolesToRole()` method takes the following + arguments: .. list-table:: diff --git a/source/reference/operator/aggregation/accumulator.txt b/source/reference/operator/aggregation/accumulator.txt index cd4a53f0bb6..e7fc488301a 100644 --- a/source/reference/operator/aggregation/accumulator.txt +++ b/source/reference/operator/aggregation/accumulator.txt @@ -269,7 +269,7 @@ For example, :group:`$accumulator` may need to combine two states when: Javascript Enabled ~~~~~~~~~~~~~~~~~~ -To use :expression:`$accumulator`, you must have server-side scripting +To use :group:`$accumulator`, you must have server-side scripting enabled. If you do not use :group:`$accumulator` (or :expression:`$function`, diff --git a/source/reference/operator/aggregation/addToSet.txt b/source/reference/operator/aggregation/addToSet.txt index 51d733336b3..7226c1e9a76 100644 --- a/source/reference/operator/aggregation/addToSet.txt +++ b/source/reference/operator/aggregation/addToSet.txt @@ -22,7 +22,7 @@ Definition .. include:: /includes/extracts/fact-aggregation-accumulator-addToSet.rst - :expression:`$addToSet` has the following syntax: + :group:`$addToSet` has the following syntax: .. code-block:: javascript diff --git a/source/reference/operator/aggregation/merge.txt b/source/reference/operator/aggregation/merge.txt index 1f4fddbe82c..162a44c472a 100644 --- a/source/reference/operator/aggregation/merge.txt +++ b/source/reference/operator/aggregation/merge.txt @@ -1117,7 +1117,7 @@ following pipeline: First stage: The :pipeline:`$group` stage groups by the quarter and uses - :expression:`$sum` to add the ``qty`` fields into a new + :group:`$sum` to add the ``qty`` fields into a new ``purchased`` field. For example: .. code-block:: javascript @@ -1161,7 +1161,7 @@ Similarly, run the following aggregation pipeline against the First stage: The :pipeline:`$group` stage groups by the quarter and uses - :expression:`$sum` to add the ``qty`` fields into a new + :group:`$sum` to add the ``qty`` fields into a new ``sales`` field. For example: .. code-block:: javascript diff --git a/source/reference/operator/aggregation/regexFind.txt b/source/reference/operator/aggregation/regexFind.txt index 878f1a00861..04cb0d96ad7 100644 --- a/source/reference/operator/aggregation/regexFind.txt +++ b/source/reference/operator/aggregation/regexFind.txt @@ -598,7 +598,8 @@ the ``details`` array into an embedded document with an ``email`` and ]) First Stage - The stage :pipeline:`$unwinds` the array into separate documents: + The stage :pipeline:`$unwinds <$unwind>` the array into separate + documents: .. code-block:: javascript :copyable: false diff --git a/source/reference/operator/aggregation/sum.txt b/source/reference/operator/aggregation/sum.txt index d1b7d9421f8..dd5f3a0bae7 100644 --- a/source/reference/operator/aggregation/sum.txt +++ b/source/reference/operator/aggregation/sum.txt @@ -20,7 +20,7 @@ Definition .. include:: /includes/extracts/fact-aggregation-accumulator-sum.rst - When used in the :pipeline:`$group` stage, :expression:`$sum` has the + When used in the :pipeline:`$group` stage, :group:`$sum` has the following syntax and returns the collective sum of all the numeric values that result from applying a specified expression to each document in a group of documents that share the same group by key: @@ -29,17 +29,17 @@ Definition { $sum: } - When used in the other supported stages, :expression:`$sum` returns the + When used in the other supported stages, :group:`$sum` returns the sum of the specified expression or list of expressions for each document and has one of two syntaxes: - - :expression:`$sum` has one specified expression as its operand: + - :group:`$sum` has one specified expression as its operand: .. code-block:: javascript { $sum: } - - :expression:`$sum` has a list of specified expressions as its + - :group:`$sum` has a list of specified expressions as its operand: .. code-block:: javascript diff --git a/source/reference/operator/aggregation/unionWith.txt b/source/reference/operator/aggregation/unionWith.txt index ec7bf1b7b55..da4181d741f 100644 --- a/source/reference/operator/aggregation/unionWith.txt +++ b/source/reference/operator/aggregation/unionWith.txt @@ -431,7 +431,7 @@ that lists the yearly sales quantity per item: ... - The :pipeline:`$group` stage groups by the ``item`` field and uses - :expression:`$sum` to calculate the yearly total sales quantity per ``item``: + :group:`$sum` to calculate the yearly total sales quantity per ``item``: .. code-block:: javascript :copyable: false diff --git a/source/reference/read-concern-available.txt b/source/reference/read-concern-available.txt index 0febbd0ef12..66c32cef964 100644 --- a/source/reference/read-concern-available.txt +++ b/source/reference/read-concern-available.txt @@ -45,7 +45,7 @@ deployment or a replica set deployment), :readconcern:`"local"` and Availability ------------ -Read concern :readconcern:`available` is :red:`unavailable for use` +Read concern :readconcern:`"available"` is :red:`unavailable for use` with causally consistent sessions and transactions. diff --git a/source/reference/read-concern.txt b/source/reference/read-concern.txt index 117212e8a83..041b4a7d0c2 100644 --- a/source/reference/read-concern.txt +++ b/source/reference/read-concern.txt @@ -68,7 +68,7 @@ The following read concern levels are available: associated write operations use :writeconcern:`"majority"` write concern. - **Availability:** Read concern :readconcern:`local` is available + **Availability:** Read concern :readconcern:`"local"` is available for use with or without causally consistent sessions and transactions. @@ -84,7 +84,7 @@ The following read concern levels are available: **Default for:** reads against secondaries if the reads are :red:`not` associated with :ref:`causally consistent sessions `. - **Availability:** Read concern :readconcern:`available` is + **Availability:** Read concern :readconcern:`"available"` is :red:`unavailable for use` with causally consistent sessions and transactions. diff --git a/source/reference/replica-configuration.txt b/source/reference/replica-configuration.txt index 7c000542778..f11bd680803 100644 --- a/source/reference/replica-configuration.txt +++ b/source/reference/replica-configuration.txt @@ -198,7 +198,7 @@ Replica Set Configuration Fields An integer identifier of every member in the replica set. Values must be between 0 and 255 inclusive. Each replica set member must have a unique :rsconf:`_id `. Avoid re-using - ``_id`` values *even if* no :rsconf:`members[n]` entry is using + ``_id`` values *even if* no :rsconf:`members` entry is using that ``_id`` in the current configuration. Once set, you cannot change the diff --git a/source/release-notes/3.0.txt b/source/release-notes/3.0.txt index 918dc9e6e3b..7710d616ced 100644 --- a/source/release-notes/3.0.txt +++ b/source/release-notes/3.0.txt @@ -218,7 +218,7 @@ Issues fixed and improvements: :issue:`SERVER-17836`). - Performance improvements for longer running queries, particularly - :operator:`$text` and :operator:`$near` queries + :query:`$text` and :query:`$near` queries :issue:`SERVER-18926`. - `All issues closed in 3.0.5 @@ -248,7 +248,7 @@ Issues fixed: - `All issues closed in 3.0.4 `_ -.. _3.0.3-release-notes: +.. _3.0.3-release-notes: 3.0.3 -- May 12, 2015 ~~~~~~~~~~~~~~~~~~~~~ @@ -264,7 +264,7 @@ Issues fixed: - Crash caused by update with a *key too large to index* on WiredTiger and RocksDB storage engines: :issue:`SERVER-17882` -- Inconsistent support for :dbcommand:`mapReduce` in :dbcommand:`eval` +- Inconsistent support for :dbcommand:`mapReduce` in ``eval`` environment: :issue:`SERVER-17889` - `All issues closed in 3.0.3 diff --git a/source/replication.txt b/source/replication.txt index 02f8e1778df..317c68c4c49 100644 --- a/source/replication.txt +++ b/source/replication.txt @@ -129,9 +129,9 @@ Automatic Failover ------------------ When a primary does not communicate with the other members of the set -for more than the configured :rsconf:`electionTimeoutMillis` period -(10 seconds by default), an eligible secondary calls for an election -to nominate itself as the new primary. The cluster attempts to +for more than the configured :rsconf:`~settings.electionTimeoutMillis` +period (10 seconds by default), an eligible secondary calls for an +election to nominate itself as the new primary. The cluster attempts to complete the election of a new primary and resume normal operations. .. include:: /images/replica-set-trigger-election.rst diff --git a/source/tutorial/aggregation-zip-code-data-set.txt b/source/tutorial/aggregation-zip-code-data-set.txt index 1312d2333aa..bb4637e2da3 100644 --- a/source/tutorial/aggregation-zip-code-data-set.txt +++ b/source/tutorial/aggregation-zip-code-data-set.txt @@ -214,8 +214,8 @@ cities by population for each state: ] ) In this example, the :ref:`aggregation pipeline ` -consists of a :pipeline:`$group` stage, a :binary:`~bin.$sort` stage, -another :pipeline:`$group` stage, and a :binary:`~bin.$project` stage: +consists of a :pipeline:`$group` stage, a :pipeline:`$sort` stage, +another :pipeline:`$group` stage, and a :pipeline:`$project` stage: - The first :pipeline:`$group` stage groups the documents by the combination of the ``city`` and ``state``, calculates the :group:`sum diff --git a/source/tutorial/configure-secondary-only-replica-set-member.txt b/source/tutorial/configure-secondary-only-replica-set-member.txt index f597484ef86..2eef5062719 100644 --- a/source/tutorial/configure-secondary-only-replica-set-member.txt +++ b/source/tutorial/configure-secondary-only-replica-set-member.txt @@ -15,7 +15,7 @@ Overview In a replica set, by default all :term:`secondary` members are eligible to become primary through the election process. You can use the -:data:`priority ` to affect the +:rsconf:`priority ` to affect the outcome of these elections by making some members more likely to become primary and other members less likely or unable to become primary. diff --git a/source/tutorial/expand-replica-set.txt b/source/tutorial/expand-replica-set.txt index c82ab1495ea..6ae269340cc 100644 --- a/source/tutorial/expand-replica-set.txt +++ b/source/tutorial/expand-replica-set.txt @@ -24,8 +24,7 @@ A replica set can have a maximum of seven :ref:`voting members `. To add a member to a replica set that already has seven voting members, you must either add the member as a :ref:`non-voting member ` or remove a -vote from an :data:`existing member -`. +vote from an :rsconf:`existing member `. Init Scripts ~~~~~~~~~~~~ diff --git a/source/tutorial/force-member-to-be-primary.txt b/source/tutorial/force-member-to-be-primary.txt index 8505d594bdc..b74681c3272 100644 --- a/source/tutorial/force-member-to-be-primary.txt +++ b/source/tutorial/force-member-to-be-primary.txt @@ -104,8 +104,8 @@ This procedure assumes this configuration: amount of time with no primary following failover. - The step down forces on election in which ``m3.example.net`` - becomes primary based on its :data:`priority - ` setting. + becomes primary based on its + :rsconf:`priority ` setting. #. Optionally, if ``m3.example.net`` is more than 10 seconds behind ``m1.example.net``'s optime, and if you don't need to have a primary diff --git a/source/tutorial/monitor-with-snmp-on-windows.txt b/source/tutorial/monitor-with-snmp-on-windows.txt index 38cafa4b510..1e1c1fb2b94 100644 --- a/source/tutorial/monitor-with-snmp-on-windows.txt +++ b/source/tutorial/monitor-with-snmp-on-windows.txt @@ -57,8 +57,9 @@ Optional: Run MongoDB as SNMP Master copy mongod.conf.master C:\snmp\etc\config\mongod.conf -Additionally, start |mongod-program| with the :setting:`snmp-master` -option, as in the following: +Additionally, start |mongod-program| with the +:option:`snmp-master ` option, as in the +following: .. code-block:: powershell diff --git a/source/tutorial/monitor-with-snmp.txt b/source/tutorial/monitor-with-snmp.txt index d9ae4d880d9..d81d9e37cf5 100644 --- a/source/tutorial/monitor-with-snmp.txt +++ b/source/tutorial/monitor-with-snmp.txt @@ -66,8 +66,8 @@ Optional: Run MongoDB as SNMP Master range of 10.0.0.0/8 with a security name of "mynetwork" has been provided in the master configuration file as an example. -Then, start |mongod-program| with the :setting:`snmp-master` -option: +Then, start |mongod-program| with the +:option:`snmp-master ` option: .. code-block:: sh diff --git a/source/tutorial/perform-incremental-map-reduce.txt b/source/tutorial/perform-incremental-map-reduce.txt index 14886bbf4ca..d0b423d5b29 100644 --- a/source/tutorial/perform-incremental-map-reduce.txt +++ b/source/tutorial/perform-incremental-map-reduce.txt @@ -252,9 +252,9 @@ map-reduce example without defining custom functions: #. The :pipeline:`$group` groups by the ``userid`` and calculates: - - The ``total_time`` using the :expression:`$sum` operator + - The ``total_time`` using the :group:`$sum` operator - - The ``count`` using the :expression:`$sum` operator + - The ``count`` using the :group:`$sum` operator - The ``avg_time`` using the :group:`$avg` operator diff --git a/source/tutorial/troubleshoot-snmp.txt b/source/tutorial/troubleshoot-snmp.txt index 5c890460d42..0f2829521ee 100644 --- a/source/tutorial/troubleshoot-snmp.txt +++ b/source/tutorial/troubleshoot-snmp.txt @@ -94,9 +94,11 @@ Edition produce this error. :doc:`Install the Enterprise Edition ` and attempt to start :binary:`~bin.mongod` again. -Other MongoDB binaries, including :binary:`~bin.mongos` will produce this -error if you attempt to start them with :setting:`snmp-master` or -:setting:`snmp-subagent`. Only :binary:`~bin.mongod` supports SNMP. +Other MongoDB binaries, including :binary:`~bin.mongos` will produce +this error if you attempt to start them with +:option:`snmp-master ` or +:option:`snmp-subagent `. Only +:binary:`~bin.mongod` supports SNMP. .. include:: /includes/fact-macos-snmp.rst diff --git a/source/tutorial/update-documents-with-aggregation-pipeline.txt b/source/tutorial/update-documents-with-aggregation-pipeline.txt index a684da3a033..7995c1abe04 100644 --- a/source/tutorial/update-documents-with-aggregation-pipeline.txt +++ b/source/tutorial/update-documents-with-aggregation-pipeline.txt @@ -121,7 +121,7 @@ in the collection should have the same fields) and update the Specifically, the pipeline consists of: -- a :pipeline:`$replaceRoot` stage with an +- a :pipeline:`$replaceRoot` stage with a :expression:`$mergeObjects` expression to set default values for the ``quiz1``, ``quiz2``, ``test1`` and ``test2`` fields. The aggregation variable :variable:`ROOT` refers to the current From bccdacc76ab6f9950ce677c19bbdb1848d8f1c31 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 12:47:33 -0400 Subject: [PATCH 02/96] add missing alt tags to figure directives --- source/includes/driver-examples/driver-example-delete-58.rst | 4 ++++ source/includes/driver-examples/driver-example-insert-1.rst | 1 + source/includes/driver-examples/driver-example-insert-2.rst | 1 + source/includes/driver-examples/driver-example-query-10.rst | 1 + source/includes/driver-examples/driver-example-query-11.rst | 1 + source/includes/driver-examples/driver-example-query-12.rst | 1 + source/includes/driver-examples/driver-example-query-13.rst | 1 + source/includes/driver-examples/driver-example-query-15.rst | 1 + source/includes/driver-examples/driver-example-query-16.rst | 1 + source/includes/driver-examples/driver-example-query-17.rst | 1 + source/includes/driver-examples/driver-example-query-18.rst | 1 + source/includes/driver-examples/driver-example-query-19.rst | 1 + source/includes/driver-examples/driver-example-query-21.rst | 1 + source/includes/driver-examples/driver-example-query-22.rst | 1 + source/includes/driver-examples/driver-example-query-23.rst | 1 + source/includes/driver-examples/driver-example-query-24.rst | 1 + source/includes/driver-examples/driver-example-query-25.rst | 1 + source/includes/driver-examples/driver-example-query-26.rst | 1 + source/includes/driver-examples/driver-example-query-27.rst | 1 + source/includes/driver-examples/driver-example-query-28.rst | 1 + source/includes/driver-examples/driver-example-query-30.rst | 1 + source/includes/driver-examples/driver-example-query-31.rst | 1 + source/includes/driver-examples/driver-example-query-32.rst | 1 + source/includes/driver-examples/driver-example-query-33.rst | 1 + source/includes/driver-examples/driver-example-query-34.rst | 1 + source/includes/driver-examples/driver-example-query-35.rst | 1 + source/includes/driver-examples/driver-example-query-36.rst | 1 + source/includes/driver-examples/driver-example-query-37.rst | 1 + source/includes/driver-examples/driver-example-query-39.rst | 1 + source/includes/driver-examples/driver-example-query-40.rst | 1 + source/includes/driver-examples/driver-example-query-41.rst | 1 + source/includes/driver-examples/driver-example-query-7.rst | 1 + source/includes/driver-examples/driver-example-query-9.rst | 1 + source/includes/driver-list-database-indexes-tabs.rst | 2 +- source/tutorial/insert-documents.txt | 1 + 35 files changed, 38 insertions(+), 1 deletion(-) diff --git a/source/includes/driver-examples/driver-example-delete-58.rst b/source/includes/driver-examples/driver-example-delete-58.rst index 695751bf8cc..794899620e9 100644 --- a/source/includes/driver-examples/driver-example-delete-58.rst +++ b/source/includes/driver-examples/driver-example-delete-58.rst @@ -15,6 +15,7 @@ to access the :ref:`Table View `: .. figure:: /images/compass-table-btn-click-2.png + :alt: Compass Table View button .. raw:: html @@ -32,6 +33,7 @@ { item: "paper" } .. figure:: /images/compass-delete-paper-find.png + :alt: Compass Find button .. raw:: html @@ -45,6 +47,7 @@
.. figure:: /images/compass-delete-button-click.png + :alt: Compass Delete Document button .. raw:: html @@ -59,6 +62,7 @@
.. figure:: /images/compass-delete-confirm.png + :alt: Compass Confirm Deletion button .. raw:: html diff --git a/source/includes/driver-examples/driver-example-insert-1.rst b/source/includes/driver-examples/driver-example-insert-1.rst index f96cdc1e99c..62f2588a613 100644 --- a/source/includes/driver-examples/driver-example-insert-1.rst +++ b/source/includes/driver-examples/driver-example-insert-1.rst @@ -17,6 +17,7 @@ - id: compass content: | .. figure:: /images/compass-insert-document-inventory.png + :alt: Compass insert new document into collection - id: python content: | diff --git a/source/includes/driver-examples/driver-example-insert-2.rst b/source/includes/driver-examples/driver-example-insert-2.rst index eaa70e163e3..9de20737ffd 100644 --- a/source/includes/driver-examples/driver-example-insert-2.rst +++ b/source/includes/driver-examples/driver-example-insert-2.rst @@ -11,6 +11,7 @@ - id: compass content: | .. figure:: /images/compass-query-collection.png + :alt: Query for matching documents in a collection Specify a filter in the MongoDB Compass query bar and click :guilabel:`Find` to execute the query. diff --git a/source/includes/driver-examples/driver-example-query-10.rst b/source/includes/driver-examples/driver-example-query-10.rst index 64426773b9b..1cb7601a903 100644 --- a/source/includes/driver-examples/driver-example-query-10.rst +++ b/source/includes/driver-examples/driver-example-query-10.rst @@ -19,6 +19,7 @@ { status: { $in: [ "A", "D" ] } } .. figure:: /images/compass-find-filter-query-op.png + :alt: Query using query operators - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-11.rst b/source/includes/driver-examples/driver-example-query-11.rst index 16dcd5cc650..b020bf5f7e8 100644 --- a/source/includes/driver-examples/driver-example-query-11.rst +++ b/source/includes/driver-examples/driver-example-query-11.rst @@ -19,6 +19,7 @@ { status: "A", qty: { $lt: 30 } } .. figure:: /images/compass-find-filter-and.png + :alt: Query using multiple conditions with AND - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-12.rst b/source/includes/driver-examples/driver-example-query-12.rst index f732c740916..d5e0cc55f56 100644 --- a/source/includes/driver-examples/driver-example-query-12.rst +++ b/source/includes/driver-examples/driver-example-query-12.rst @@ -19,6 +19,7 @@ { $or: [ { status: "A" }, { qty: { $lt: 30 } } ] } .. figure:: /images/compass-find-filter-or.png + :alt: Query using OR - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-13.rst b/source/includes/driver-examples/driver-example-query-13.rst index 3c0d2c42d19..cc28fee06d4 100644 --- a/source/includes/driver-examples/driver-example-query-13.rst +++ b/source/includes/driver-examples/driver-example-query-13.rst @@ -22,6 +22,7 @@ { status: "A", $or: [ { qty: { $lt: 30 } }, { item: /^p/ } ] } .. figure:: /images/compass-find-filter-and-or.png + :alt: Query using AND as well as OR - id: python diff --git a/source/includes/driver-examples/driver-example-query-15.rst b/source/includes/driver-examples/driver-example-query-15.rst index 2e895914d75..041dd727623 100644 --- a/source/includes/driver-examples/driver-example-query-15.rst +++ b/source/includes/driver-examples/driver-example-query-15.rst @@ -19,6 +19,7 @@ { size: { h: 14, w: 21, uom: "cm" } } .. figure:: /images/compass-match-embedded.png + :alt: Query embedded field - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-16.rst b/source/includes/driver-examples/driver-example-query-16.rst index 115e0f189f3..55f09bcef5b 100644 --- a/source/includes/driver-examples/driver-example-query-16.rst +++ b/source/includes/driver-examples/driver-example-query-16.rst @@ -11,6 +11,7 @@ - id: compass content: | .. figure:: /images/compass-find-embedded-no-match.png + :alt: Query embedded field - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-17.rst b/source/includes/driver-examples/driver-example-query-17.rst index 05123f7e9fa..47e5dd8a677 100644 --- a/source/includes/driver-examples/driver-example-query-17.rst +++ b/source/includes/driver-examples/driver-example-query-17.rst @@ -19,6 +19,7 @@ { "size.uom": "in" } .. figure:: /images/compass-find-nested-field.png + :alt: Query single nested field - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-18.rst b/source/includes/driver-examples/driver-example-query-18.rst index 21e7648c33d..eb257d00a00 100644 --- a/source/includes/driver-examples/driver-example-query-18.rst +++ b/source/includes/driver-examples/driver-example-query-18.rst @@ -19,6 +19,7 @@ { "size.h": { $lt: 15 } } .. figure:: /images/compass-find-nested-query-op.png + :alt: Query single nested field - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-19.rst b/source/includes/driver-examples/driver-example-query-19.rst index 10ec6dee7c1..2a56ddc6322 100644 --- a/source/includes/driver-examples/driver-example-query-19.rst +++ b/source/includes/driver-examples/driver-example-query-19.rst @@ -19,6 +19,7 @@ { "size.h": { $lt: 15 }, "size.uom": "in", status: "D" } .. figure:: /images/compass-find-embedded-and.png + :alt: Query multiple nested fields - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-21.rst b/source/includes/driver-examples/driver-example-query-21.rst index de503454978..c0a575d6277 100644 --- a/source/includes/driver-examples/driver-example-query-21.rst +++ b/source/includes/driver-examples/driver-example-query-21.rst @@ -19,6 +19,7 @@ { tags: ["red", "blank"] } .. figure:: /images/compass-array-match-exact.png + :alt: Query array matching exactly - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-22.rst b/source/includes/driver-examples/driver-example-query-22.rst index ff56b505f84..c45f13eb958 100644 --- a/source/includes/driver-examples/driver-example-query-22.rst +++ b/source/includes/driver-examples/driver-example-query-22.rst @@ -19,6 +19,7 @@ { tags: { $all: ["red", "blank"] } } .. figure:: /images/compass-array-match-all.png + :alt: Query array matching all criteria - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-23.rst b/source/includes/driver-examples/driver-example-query-23.rst index 62c5033db84..4f481c9c291 100644 --- a/source/includes/driver-examples/driver-example-query-23.rst +++ b/source/includes/driver-examples/driver-example-query-23.rst @@ -19,6 +19,7 @@ { tags: "red" } .. figure:: /images/compass-array-elem-match.png + :alt: Query array matching multiple criteria - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-24.rst b/source/includes/driver-examples/driver-example-query-24.rst index 6c5ad46eeb3..35e98ba5e67 100644 --- a/source/includes/driver-examples/driver-example-query-24.rst +++ b/source/includes/driver-examples/driver-example-query-24.rst @@ -19,6 +19,7 @@ { dim_cm: { $gt: 25 } } .. figure:: /images/compass-array-query-op.png + :alt: Query array for at least one matching element - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-25.rst b/source/includes/driver-examples/driver-example-query-25.rst index c9b7a025104..fd21527ca1a 100644 --- a/source/includes/driver-examples/driver-example-query-25.rst +++ b/source/includes/driver-examples/driver-example-query-25.rst @@ -19,6 +19,7 @@ { dim_cm: { $gt: 15, $lt: 20 } } .. figure:: /images/compass-array-compound-filter.png + :alt: Query array using a compound filter - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-26.rst b/source/includes/driver-examples/driver-example-query-26.rst index b9526351e81..be53400c194 100644 --- a/source/includes/driver-examples/driver-example-query-26.rst +++ b/source/includes/driver-examples/driver-example-query-26.rst @@ -19,6 +19,7 @@ { dim_cm: { $elemMatch: { $gt: 22, $lt: 30 } } } .. figure:: /images/compass-array-compound-multiple-criteria.png + :alt: Query array by multiple conditions - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-27.rst b/source/includes/driver-examples/driver-example-query-27.rst index 51e165d839c..c4b224af31d 100644 --- a/source/includes/driver-examples/driver-example-query-27.rst +++ b/source/includes/driver-examples/driver-example-query-27.rst @@ -19,6 +19,7 @@ { "dim_cm.1": { $gt: 25 } } .. figure:: /images/compass-array-match-by-index.png + :alt: Query array by index - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-28.rst b/source/includes/driver-examples/driver-example-query-28.rst index e0bb51b33a3..49df5a49853 100644 --- a/source/includes/driver-examples/driver-example-query-28.rst +++ b/source/includes/driver-examples/driver-example-query-28.rst @@ -19,6 +19,7 @@ { "tags": { $size: 3 } } .. figure:: /images/compass-array-query-by-size.png + :alt: Query for array by number of elements - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-30.rst b/source/includes/driver-examples/driver-example-query-30.rst index b9eec4af71c..33bb00c8416 100644 --- a/source/includes/driver-examples/driver-example-query-30.rst +++ b/source/includes/driver-examples/driver-example-query-30.rst @@ -19,6 +19,7 @@ { "instock": { warehouse: "A", qty: 5 } } .. figure:: /images/compass-find-nested-in-array.png + :alt: Query for nested array element - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-31.rst b/source/includes/driver-examples/driver-example-query-31.rst index 00e8c939031..468f0cf7a30 100644 --- a/source/includes/driver-examples/driver-example-query-31.rst +++ b/source/includes/driver-examples/driver-example-query-31.rst @@ -11,6 +11,7 @@ - id: compass content: | .. figure:: /images/compass-find-nested-array-no-match.png + :alt: Query for nested array element - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-32.rst b/source/includes/driver-examples/driver-example-query-32.rst index a27cbbc4388..ddf786d967a 100644 --- a/source/includes/driver-examples/driver-example-query-32.rst +++ b/source/includes/driver-examples/driver-example-query-32.rst @@ -19,6 +19,7 @@ { 'instock.0.qty': { $lte: 20 } } .. figure:: /images/compass-find-array-index-embedded-doc.png + :alt: Query for array element matching single condition - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-33.rst b/source/includes/driver-examples/driver-example-query-33.rst index e15e9f3ad6c..64b951aa19f 100644 --- a/source/includes/driver-examples/driver-example-query-33.rst +++ b/source/includes/driver-examples/driver-example-query-33.rst @@ -19,6 +19,7 @@ { 'instock.qty': { $lte: 20 } } .. figure:: /images/compass-find-array-embedded-field-condition.png + :alt: Query for embedded field matching single condition - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-34.rst b/source/includes/driver-examples/driver-example-query-34.rst index 63ced088893..464e151e60f 100644 --- a/source/includes/driver-examples/driver-example-query-34.rst +++ b/source/includes/driver-examples/driver-example-query-34.rst @@ -19,6 +19,7 @@ { "instock": { $elemMatch: { qty: 5, warehouse: "A" } } } .. figure:: /images/compass-array-multiple-cond-single-doc.png + :alt: Query for single document matching multiple conditions - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-35.rst b/source/includes/driver-examples/driver-example-query-35.rst index 20b55bf25d0..d69fd03fd05 100644 --- a/source/includes/driver-examples/driver-example-query-35.rst +++ b/source/includes/driver-examples/driver-example-query-35.rst @@ -19,6 +19,7 @@ { "instock": { $elemMatch: { qty: { $gt: 10, $lte: 20 } } } } .. figure:: /images/compass-array-multiple-cond-single-doc-2.png + :alt: Query for single document matching multiple conditions - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-36.rst b/source/includes/driver-examples/driver-example-query-36.rst index 776b2770db0..a039bb8ab5c 100644 --- a/source/includes/driver-examples/driver-example-query-36.rst +++ b/source/includes/driver-examples/driver-example-query-36.rst @@ -19,6 +19,7 @@ { "instock.qty": { $gt: 10, $lte: 20 } } .. figure:: /images/compass-array-match-combination-of-elements.png + :alt: Query quantity value within range - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-37.rst b/source/includes/driver-examples/driver-example-query-37.rst index 50b47666a32..cacb26bbb12 100644 --- a/source/includes/driver-examples/driver-example-query-37.rst +++ b/source/includes/driver-examples/driver-example-query-37.rst @@ -19,6 +19,7 @@ { "instock.qty": 5, "instock.warehouse": "A" } .. figure:: /images/compass-array-match-combination-of-elements-2.png + :alt: Query matching quantity and warehouse location - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-39.rst b/source/includes/driver-examples/driver-example-query-39.rst index ba734e77b94..c6878bd7dee 100644 --- a/source/includes/driver-examples/driver-example-query-39.rst +++ b/source/includes/driver-examples/driver-example-query-39.rst @@ -20,6 +20,7 @@ { item: null } .. figure:: /images/compass-find-null-field.png + :alt: Query null value or missing field - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-40.rst b/source/includes/driver-examples/driver-example-query-40.rst index 9e480bb5844..3777e0764b6 100644 --- a/source/includes/driver-examples/driver-example-query-40.rst +++ b/source/includes/driver-examples/driver-example-query-40.rst @@ -20,6 +20,7 @@ { item : { $type: 10 } } .. figure:: /images/compass-find-null-type-check.png + :alt: Find null type - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-41.rst b/source/includes/driver-examples/driver-example-query-41.rst index d9c1e4830f6..ec979093970 100644 --- a/source/includes/driver-examples/driver-example-query-41.rst +++ b/source/includes/driver-examples/driver-example-query-41.rst @@ -20,6 +20,7 @@ { item : { $exists: false } } .. figure:: /images/compass-find-null-existence-check.png + :alt: Query for null value - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-7.rst b/source/includes/driver-examples/driver-example-query-7.rst index 7df21c6ba2b..68eeb414057 100644 --- a/source/includes/driver-examples/driver-example-query-7.rst +++ b/source/includes/driver-examples/driver-example-query-7.rst @@ -12,6 +12,7 @@ content: | .. figure:: /images/compass-select-all.png + :alt: Compass select all documents in collection - id: python content: | diff --git a/source/includes/driver-examples/driver-example-query-9.rst b/source/includes/driver-examples/driver-example-query-9.rst index f36cc2ec846..ba9e1824dac 100644 --- a/source/includes/driver-examples/driver-example-query-9.rst +++ b/source/includes/driver-examples/driver-example-query-9.rst @@ -19,6 +19,7 @@ { status: "D" } .. figure:: /images/compass-find-filter-inventory.png + :alt: Query using equality condition - id: python content: | diff --git a/source/includes/driver-list-database-indexes-tabs.rst b/source/includes/driver-list-database-indexes-tabs.rst index d16d40e56a1..a23ca5bfc01 100644 --- a/source/includes/driver-list-database-indexes-tabs.rst +++ b/source/includes/driver-list-database-indexes-tabs.rst @@ -4,7 +4,7 @@ - id: shell content: | List All Indexes for a Database - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To list all the collection indexes in a database, you can use the following operation in the :binary:`~bin.mongo` shell: diff --git a/source/tutorial/insert-documents.txt b/source/tutorial/insert-documents.txt index a2d0d5bd0ee..7c83344a226 100644 --- a/source/tutorial/insert-documents.txt +++ b/source/tutorial/insert-documents.txt @@ -59,6 +59,7 @@ Insert a Single Document 2. Click the :guilabel:`Insert Document` button: .. figure:: /images/compass-insert-button.png + :alt: Compass insert button 3. For each field in the document, select the field type and fill in the field name and value. Add fields by clicking From e8bfc4fe54bd30d5c534d2bd0504a13efa539d06 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 13:13:21 -0400 Subject: [PATCH 03/96] unlink mongosniff --- source/release-notes/3.4-compatibility.txt | 6 +++--- source/release-notes/3.4.txt | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/release-notes/3.4-compatibility.txt b/source/release-notes/3.4-compatibility.txt index 9d9eaa1feb8..99301958ed3 100644 --- a/source/release-notes/3.4-compatibility.txt +++ b/source/release-notes/3.4-compatibility.txt @@ -217,9 +217,9 @@ General Compatibility Changes - Removal of deprecated ``textSearchEnabled`` parameter. Starting from version 2.6, MongoDB enables the text search feature by default. -- Removal of :binary:`~bin.mongosniff`. In MongoDB 3.4, - :binary:`~bin.mongosniff` is replaced by :binary:`~bin.mongoreplay`, which - offers a more flexible superset of :binary:`~bin.mongosniff`'s +- Removal of ``mongosniff``. In MongoDB 3.4, + ``mongosniff`` is replaced by :binary:`~bin.mongoreplay`, which + offers a more flexible superset of ``mongosniff``'s functionality. - Updates to :pipeline:`$project` specification behavior: empty diff --git a/source/release-notes/3.4.txt b/source/release-notes/3.4.txt index f98589eb771..9387957cf6f 100644 --- a/source/release-notes/3.4.txt +++ b/source/release-notes/3.4.txt @@ -1142,7 +1142,7 @@ MongoDB Tools ~~~~~~~~~~~~~~~ MongoDB introduces :binary:`~bin.mongoreplay`, a workload capture and -analysis tool that replaces :binary:`~bin.mongosniff`. You can use +analysis tool that replaces ``mongosniff``. You can use :binary:`~bin.mongoreplay` to inspect and record commands sent to a MongoDB instance, and then replay the commands back onto another host at a later time. From e9052e67fe042895ac620bd9a823c8cde6235056 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 13:16:12 -0400 Subject: [PATCH 04/96] correct mongo shell links --- source/reference/operator/aggregation/first-array-element.txt | 2 +- source/reference/operator/aggregation/last-array-element.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/operator/aggregation/first-array-element.txt b/source/reference/operator/aggregation/first-array-element.txt index 42a0d90da72..3a2d3fe9153 100644 --- a/source/reference/operator/aggregation/first-array-element.txt +++ b/source/reference/operator/aggregation/first-array-element.txt @@ -202,7 +202,7 @@ The operation returns the following documents: { "_id" : 2, "team" : "Bears", "progress" : -2 } { "_id" : 3, "team" : "Cobras", "progress" : "Not enough data." } -By default, the :binary:`~bin.shell` uses the 64-bit floating-point +By default, the :binary:`~bin.mongo` shell uses the 64-bit floating-point double for numbers. To improve precision, you can use :ref:`shell-type-decimal` instead. diff --git a/source/reference/operator/aggregation/last-array-element.txt b/source/reference/operator/aggregation/last-array-element.txt index b0658c96645..5dd5aaafced 100644 --- a/source/reference/operator/aggregation/last-array-element.txt +++ b/source/reference/operator/aggregation/last-array-element.txt @@ -202,7 +202,7 @@ The operation returns the following documents: { "_id" : 2, "team" : "Bears", "progress" : -2 } { "_id" : 3, "team" : "Cobras", "progress" : "Not enough data." } -By default, the :binary:`~bin.shell` uses the 64-bit floating-point +By default, the :binary:`~bin.mongo` shell uses the 64-bit floating-point double for numbers. To improve precision, you can use :ref:`shell-type-decimal` instead. From 81df14c6c21fc0a7ed5deb95a59b7161b2d6d36f Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 13:17:06 -0400 Subject: [PATCH 05/96] correct mongod binary link --- source/reference/command/setDefaultRWConcern.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/command/setDefaultRWConcern.txt b/source/reference/command/setDefaultRWConcern.txt index 666c956bfd2..c722130a8df 100644 --- a/source/reference/command/setDefaultRWConcern.txt +++ b/source/reference/command/setDefaultRWConcern.txt @@ -23,7 +23,7 @@ Definition against the ``admin`` database. - For replica sets, issue the :dbcommand:`setDefaultRWConcern` - command on the :term:`primary` :binary:`~binary.mongod`. + command on the :term:`primary` :binary:`~bin.mongod`. - For sharded clusters, issue the :dbcommand:`setDefaultRWConcern` on a :binary:`~bin.mongos`. From 583c2601b0f561d815489f0c0401200654e8fd8a Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 13:17:58 -0400 Subject: [PATCH 06/96] remove install_compass link --- source/reference/program.txt | 2 +- source/reference/program/install_compass.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/program.txt b/source/reference/program.txt index 268b6b9b786..216f8c0a548 100644 --- a/source/reference/program.txt +++ b/source/reference/program.txt @@ -227,7 +227,7 @@ MongoDB Compass .. versionadded:: 3.6 - MongoDB is packaged with an :binary:`~bin.install_compass` script, which + MongoDB is packaged with an ``install_compass`` script, which is a platform-specific installer for :ref:`MongoDB Compass Community Edition `. diff --git a/source/reference/program/install_compass.txt b/source/reference/program/install_compass.txt index fb7f17694c6..53e5705dd89 100644 --- a/source/reference/program/install_compass.txt +++ b/source/reference/program/install_compass.txt @@ -17,7 +17,7 @@ Synopsis -------- -:binary:`~bin.install_compass` (``Install-Compass`` in Windows) is a +``install_compass`` (``Install-Compass`` in Windows) is a platform-specific installation script for :ref:`MongoDB Compass `. From 04a6bce4177dc72c22eb5613d53ca0db29f5dbed Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 13:24:21 -0400 Subject: [PATCH 07/96] link mongo.exe to only mongo binary page --- ...ps-configure-ldap-sasl-activedirectory-authentication.yaml | 2 +- ...ccess-to-mongodb-windows-with-kerberos-authentication.yaml | 2 +- .../includes/steps-kerberos-auth-activedirectory-authz.yaml | 4 ++-- source/reference/program/mongo.txt | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/source/includes/steps-configure-ldap-sasl-activedirectory-authentication.yaml b/source/includes/steps-configure-ldap-sasl-activedirectory-authentication.yaml index 01e5532c22e..6dc819a0e27 100644 --- a/source/includes/steps-configure-ldap-sasl-activedirectory-authentication.yaml +++ b/source/includes/steps-configure-ldap-sasl-activedirectory-authentication.yaml @@ -308,7 +308,7 @@ pre: | prompts for the password. :abbr:`Windows (Microsoft Windows)` MongoDB deployments must use - :binary:`~bin.mongo.exe` instead of :binary:`~bin.mongo`. + :binary:`mongo.exe ` instead of :binary:`~bin.mongo`. Given the configured :ref:`Active Directory users `, the user authenticates successfully and diff --git a/source/includes/steps-control-access-to-mongodb-windows-with-kerberos-authentication.yaml b/source/includes/steps-control-access-to-mongodb-windows-with-kerberos-authentication.yaml index 020c2a72f84..7bdd3c01d88 100644 --- a/source/includes/steps-control-access-to-mongodb-windows-with-kerberos-authentication.yaml +++ b/source/includes/steps-control-access-to-mongodb-windows-with-kerberos-authentication.yaml @@ -91,7 +91,7 @@ title: Connect ``mongo.exe`` shell to ``mongod.exe`` and authenticate. stepnum: 5 ref: authenticate-a-user-within-mongo-shell pre: | - Connect the :binary:`~bin.mongo.exe` shell client as the Kerberos + Connect the :binary:`mongo.exe ` shell client as the Kerberos principal ``application@EXAMPLE.NET``. action: - pre: | diff --git a/source/includes/steps-kerberos-auth-activedirectory-authz.yaml b/source/includes/steps-kerberos-auth-activedirectory-authz.yaml index 931ccacb996..ae659047447 100644 --- a/source/includes/steps-kerberos-auth-activedirectory-authz.yaml +++ b/source/includes/steps-kerberos-auth-activedirectory-authz.yaml @@ -113,7 +113,7 @@ pre: | .. note:: For :abbr:`Windows (Microsoft Windows)` MongoDB deployments, you should replace :binary:`~bin.mongo` with - :binary:`~bin.mongo.exe` + :binary:`mongo.exe ` --- title: Create user administrative role. @@ -504,7 +504,7 @@ pre: | prompts for the password. :abbr:`Windows (Microsoft Windows)` MongoDB deployments must use - :binary:`~bin.mongo.exe` instead of :binary:`~bin.mongo`. + :binary:`mongo.exe ` instead of :binary:`~bin.mongo`. Given the configured :ref:`Active Directory users `, the user authenticates successfully and diff --git a/source/reference/program/mongo.txt b/source/reference/program/mongo.txt index 2f74651c9d9..9fb04ec67a4 100644 --- a/source/reference/program/mongo.txt +++ b/source/reference/program/mongo.txt @@ -995,7 +995,7 @@ Files time value to attempt to create a unique file. :file:`%TEMP%\mongo_edit{}.js` - Created by :binary:`~bin.mongo.exe` on Windows when editing a file. If + Created by :binary:`mongo.exe ` on Windows when editing a file. If the file exists, :binary:`~bin.mongo` will append an integer from ``1`` to ``10`` to the time value to attempt to create a unique file. From 98ee1c4dffd46462a49f688b397c9fb99dbea996 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 13:28:29 -0400 Subject: [PATCH 08/96] add missing $ to $[] link --- source/reference/operator/update/positional-filtered.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/operator/update/positional-filtered.txt b/source/reference/operator/update/positional-filtered.txt index 32f6e69681e..b4dd7485b69 100644 --- a/source/reference/operator/update/positional-filtered.txt +++ b/source/reference/operator/update/positional-filtered.txt @@ -340,7 +340,7 @@ Consider a collection ``alumni`` with the following documents: } To modify all elements in the ``degrees`` array that do not have -``"level": "Bachelor"``, use the positional :update:`[]` +``"level": "Bachelor"``, use the positional :update:`$[]` operation with the :query:`$ne` query operator: .. cssclass:: copyable-code From 070ce0cffde9a9206905d69491f6f63e6e03cc18 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 13:33:46 -0400 Subject: [PATCH 09/96] fix lastHeartbeat and lastHeartbeatRecv capitalization in links --- source/reference/command/replSetGetStatus.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/command/replSetGetStatus.txt b/source/reference/command/replSetGetStatus.txt index d5f261b3c52..006888f283c 100644 --- a/source/reference/command/replSetGetStatus.txt +++ b/source/reference/command/replSetGetStatus.txt @@ -1416,7 +1416,7 @@ following fields: command received a response from a heartbeat that it sent to this member (``members[n]``). Compare this value to the values of the :data:`~replSetGetStatus.date` and - :data:`~replSetGetStatus.members[n].lastHeartBeatRecv` fields to + :data:`~replSetGetStatus.members[n].lastHeartbeatRecv` fields to track latency between these replica set members. This value is only available for replica set members other than the server specified by :data:`replSetGetStatus.members[n].self`. @@ -1429,7 +1429,7 @@ following fields: (``members[n]``). Compare this value to the values of the :data:`~replSetGetStatus.date` and - :data:`~replSetGetStatus.members[n].lastHeartBeat` fields to track + :data:`~replSetGetStatus.members[n].lastHeartbeat` fields to track latency between these replica set members. This value is only available for replica set members other than the server specified by :data:`replSetGetStatus.members[n].self`. From 7dac28e1595b5c1e8792187bc4c0c86cf2ac1b8a Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 13:56:01 -0400 Subject: [PATCH 10/96] unrelated MONGODB-CR typo fix --- source/release-notes/4.0-compatibility.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/4.0-compatibility.txt b/source/release-notes/4.0-compatibility.txt index 00269e3bdca..87bd02565b2 100644 --- a/source/release-notes/4.0-compatibility.txt +++ b/source/release-notes/4.0-compatibility.txt @@ -35,7 +35,7 @@ Removal of ``authSchemaUpgrade`` Command MongoDB 4.0 removes the ``authSchemaUpgrade`` command . The command, available in MongoDB 3.0 through MongoDB 3.6, supports the upgrade -process for systems with ``MONGDB-CR`` users to ``SCRAM`` users. +process for systems with ``MONGODB-CR`` users to ``SCRAM`` users. If your deployment has user credentials stored in ``MONGODB-CR`` schema, you must upgrade to :ref:`Salted Challenge Response From 37d89edda6d458d95312c081ea10a52d5508f677 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 14:07:28 -0400 Subject: [PATCH 11/96] fix exe links --- ...-windows-with-kerberos-authentication.yaml | 17 +++++++------- ...install-mongodb-on-windows-unattended.yaml | 23 +++++++++++-------- ...b-windows-with-kerberos-authentication.txt | 3 ++- 3 files changed, 25 insertions(+), 18 deletions(-) diff --git a/source/includes/steps-control-access-to-mongodb-windows-with-kerberos-authentication.yaml b/source/includes/steps-control-access-to-mongodb-windows-with-kerberos-authentication.yaml index 7bdd3c01d88..db9142fe576 100644 --- a/source/includes/steps-control-access-to-mongodb-windows-with-kerberos-authentication.yaml +++ b/source/includes/steps-control-access-to-mongodb-windows-with-kerberos-authentication.yaml @@ -2,13 +2,13 @@ title: Start ``mongod.exe`` without Kerberos. stepnum: 1 ref: start-mongod-exe-without-kerberos-support pre: | - For the initial addition of Kerberos users, start ``mongod.exe`` - without Kerberos support. + For the initial addition of Kerberos users, start + :binary:`~bin.mongod.exe` without Kerberos support. post: | If a Kerberos user is already in MongoDB and has the :ref:`privileges required to create a user - `, you can start - ``mongod.exe`` with Kerberos support. + `, you can start + :binary:`~bin.mongod.exe` with Kerberos support. Include additional settings as appropriate to your deployment. @@ -116,10 +116,11 @@ action: match the Kerberos name, use :option:`--gssapiHostName ` to specify the Kerberos FQDN that it responds to. - pre: | - Alternatively, you can first connect ``mongo.exe`` to the - ``mongod.exe``, and then from the :binary:`~bin.mongo` shell, use - the :method:`db.auth()` method to authenticate in the - ``$external`` database. + Alternatively, you can first connect :binary:`mongo.exe + ` to the :binary:`~bin.mongod.exe`, and then from the + :binary:`mongo.exe ` shell, use the + :method:`db.auth()` method to authenticate in the ``$external`` + database. language: javascript code: | use $external diff --git a/source/includes/steps-install-mongodb-on-windows-unattended.yaml b/source/includes/steps-install-mongodb-on-windows-unattended.yaml index 15361029155..4dd901de023 100644 --- a/source/includes/steps-install-mongodb-on-windows-unattended.yaml +++ b/source/includes/steps-install-mongodb-on-windows-unattended.yaml @@ -51,25 +51,30 @@ pre: | - Binaries Included in the Component Set * - ``ServerNoService`` - - ``mongod.exe`` + - :binary:`~bin.mongod.exe` * - ``ServerService`` - - Set up ``mongod.exe`` as a Windows service. + - Set up :binary:`~bin.mongod.exe` as a Windows service. * - ``Router`` - - ``mongos.exe`` + - :binary:`~bin.mongos.exe` * - ``Client`` - - ``mongo.exe`` + - :binary:`mongo.exe ` * - ``MonitoringTools`` - - ``mongostat.exe``, ``mongotop.exe`` + - :binary:`mongostat.exe `, + :binary:`mongotop.exe ` * - ``ImportExportTools`` - - ``mongodump.exe``, ``mongorestore.exe``, ``mongoexport.exe``, ``mongoimport.exe`` + - :binary:`mongodump.exe `, + :binary:`mongorestore.exe `, + :binary:`mongoexport.exe `, + :binary:`mongoimport.exe ` * - ``MiscellaneousTools`` - - ``bsondump.exe``, ``mongofiles.exe`` + - :binary:`bsondump.exe `, + :binary:`mongofiles.exe ` For example, to install just the MongoDB server - (``mongod.exe``) and the ``mongo.exe`` shell as well as - set up the MongoDB server as a Windows service, run: + (:binary:`~bin.mongod.exe`) and the :binary:`mongo.exe ` + shell as well as set up the MongoDB server as a Windows service, run: .. include:: {{release_specification_service}} diff --git a/source/tutorial/control-access-to-mongodb-windows-with-kerberos-authentication.txt b/source/tutorial/control-access-to-mongodb-windows-with-kerberos-authentication.txt index ac6174346ff..992c658f7db 100644 --- a/source/tutorial/control-access-to-mongodb-windows-with-kerberos-authentication.txt +++ b/source/tutorial/control-access-to-mongodb-windows-with-kerberos-authentication.txt @@ -72,7 +72,8 @@ Assign Service Principal Name to MongoDB Windows Service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Use ``setspn.exe`` to assign the service principal name (SPN) to the -account running the ``mongod.exe`` and the ``mongos.exe`` service: +account running the :binary:`~bin.mongod.exe` and the +:binary:`~bin.mongos.exe` service: .. code-block:: sh From 1ddae5abe44b636710e36066fc0574b6e047245a Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 14:56:36 -0400 Subject: [PATCH 12/96] adds additional missing alt tags to figures --- source/includes/steps-compass-manual-queries.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/includes/steps-compass-manual-queries.yaml b/source/includes/steps-compass-manual-queries.yaml index 0f0e9adedbd..cec87ce5ace 100644 --- a/source/includes/steps-compass-manual-queries.yaml +++ b/source/includes/steps-compass-manual-queries.yaml @@ -10,6 +10,7 @@ action: "JFK". .. figure:: /images/compass/manual-query.png + :alt: Compass query bar with query entered When a valid query is entered, the bar is colored green and can be executed. Invalid queries are colored red. The UI will automatically update @@ -27,6 +28,7 @@ action: matching documents. .. figure:: /images/compass/manual-query-results.png + :alt: Compass Apply button executes query To clear a query, use the Reset button. ... From 6fe7bdf2125e5fdc86a5a0ce245c323f2996d0bb Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 15:17:33 -0400 Subject: [PATCH 13/96] fix broken [] links --- source/core/document.txt | 2 +- source/reference/operator/update/positional-filtered.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/core/document.txt b/source/core/document.txt index a20684e5c86..daf47038793 100644 --- a/source/core/document.txt +++ b/source/core/document.txt @@ -143,7 +143,7 @@ For examples querying arrays, see: - :update:`$[]` all positional operator for update operations, - - :update:`$[/]` filtered positional operator for update operations, + - :update:`$[\]` filtered positional operator for update operations, - :update:`$` positional operator for update operations, diff --git a/source/reference/operator/update/positional-filtered.txt b/source/reference/operator/update/positional-filtered.txt index b4dd7485b69..c45b3c0c930 100644 --- a/source/reference/operator/update/positional-filtered.txt +++ b/source/reference/operator/update/positional-filtered.txt @@ -340,7 +340,7 @@ Consider a collection ``alumni`` with the following documents: } To modify all elements in the ``degrees`` array that do not have -``"level": "Bachelor"``, use the positional :update:`$[]` +``"level": "Bachelor"``, use the positional :update:`$[\]` operation with the :query:`$ne` query operator: .. cssclass:: copyable-code From 58e2f18c0628db743d27e41691ca2d78375bf475 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 15:22:31 -0400 Subject: [PATCH 14/96] fix members[n] links --- source/release-notes/2.0.txt | 2 +- source/release-notes/2.2.txt | 6 +++--- source/release-notes/2.6-compatibility.txt | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/source/release-notes/2.0.txt b/source/release-notes/2.0.txt index 431c65ee9f1..ec08cc69b80 100644 --- a/source/release-notes/2.0.txt +++ b/source/release-notes/2.0.txt @@ -200,7 +200,7 @@ During normal operation, the set will always chose ``B`` as primary. If ``B`` becomes unavailable, the set will elect ``A`` as primary. For more information, see the -:data:`~local.system.replset.members[n].priority` documentation. +:rsconf:`priority ` documentation. Data-Center Awareness `````````````````````` diff --git a/source/release-notes/2.2.txt b/source/release-notes/2.2.txt index 844320bcdf1..20f3984091d 100644 --- a/source/release-notes/2.2.txt +++ b/source/release-notes/2.2.txt @@ -667,11 +667,11 @@ Replica Set Members will not Sync from Members Without Indexes Unless ``buildInd To prevent inconsistency between members of replica sets, if the member of a replica set has -:data:`~local.system.replset.members[n].buildIndexes` set to ``true``, +:rsconf:`buildIndexes ` set to ``true``, other members of the replica set will *not* sync from this member, unless they also have -:data:`~local.system.replset.members[n].buildIndexes` set to -``true``. See :issue:`SERVER-4160` for more information. +:rsconf:`buildIndexes ` set to ``true``. See +:issue:`SERVER-4160` for more information. New Option To Configure Index Pre-Fetching during Replication ````````````````````````````````````````````````````````````` diff --git a/source/release-notes/2.6-compatibility.txt b/source/release-notes/2.6-compatibility.txt index 31a72b9a01c..4e0f35699e4 100644 --- a/source/release-notes/2.6-compatibility.txt +++ b/source/release-notes/2.6-compatibility.txt @@ -904,13 +904,13 @@ Replica Set Vote Configuration Validation Description MongoDB now deprecates giving any :term:`replica set` member more than a single vote. During configuration, - :data:`local.system.replset.members[n].votes` should only have a + :rsconf:`members[n].votes` should only have a value of 1 for voting members and 0 for non-voting members. MongoDB treats values other than 1 or 0 as a value of 1 and produces a warning message. Solution - Update :data:`local.system.replset.members[n].votes` with values + Update :rsconf:`members[n].votes` with values other than 1 or 0 to 1 or 0 as appropriate. .. _2.6-time-format-changes: From 0411049cf17381eb19c535ea3ae288b611d185a3 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 15:32:48 -0400 Subject: [PATCH 15/96] fix connPoolStats.replicaSets.[replicaSets].hosts links --- source/reference/command/connPoolStats.txt | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/source/reference/command/connPoolStats.txt b/source/reference/command/connPoolStats.txt index 29fecb9fbdd..4106bf1b4b8 100644 --- a/source/reference/command/connPoolStats.txt +++ b/source/reference/command/connPoolStats.txt @@ -476,26 +476,26 @@ Output .. data:: connPoolStats.replicaSets.[replicaSet].hosts[n].ismaster Reports ``true`` if this - :data:`~connPoolStats.replicaSets.[replicaSet].host` is the + :data:`host ` is the :term:`primary` member of the :term:`replica set`. .. data:: connPoolStats.replicaSets.[replicaSet].hosts[n].hidden Reports ``true`` if this - :data:`~connPoolStats.replicaSets.[replicaSet].host` is a + :data:`host ` is a :term:`hidden member` of the :term:`replica set`. .. data:: connPoolStats.replicaSets.[replicaSet].hosts[n].secondary Reports ``true`` if this - :data:`~connPoolStats.replicaSets.[replicaSet].host` is a + :data:`host ` is a :term:`secondary` member of the :term:`replica set`. .. data:: connPoolStats.replicaSets.[replicaSet].hosts[n].pingTimeMillis Reports the ping time in milliseconds from the :binary:`~bin.mongos` or :binary:`~bin.mongod` to this - :data:`~connPoolStats.replicaSets.[replicaSet].host`. + :data:`host `. .. data:: connPoolStats.replicaSets.[replicaSet].hosts[n].tags @@ -504,3 +504,6 @@ Output See also :ref:`command-response` for details on the ``ok`` status field, the ``operationTime`` field and the ``$clusterTime`` field. + + +:data:`host ` \ No newline at end of file From 19eba5869c632a938324923d21378b171d4556e6 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 15:36:11 -0400 Subject: [PATCH 16/96] fix dupe replSetGetStatus.members[n].self entry --- source/reference/command/replSetGetStatus.txt | 5 ----- 1 file changed, 5 deletions(-) diff --git a/source/reference/command/replSetGetStatus.txt b/source/reference/command/replSetGetStatus.txt index 006888f283c..f14ceaea5ec 100644 --- a/source/reference/command/replSetGetStatus.txt +++ b/source/reference/command/replSetGetStatus.txt @@ -1404,11 +1404,6 @@ following fields: :doc:`/core/replica-set-high-availability` for more information about elections. - .. data:: replSetGetStatus.members[n].self - - Indicates which replica set member processed the - :command:`replSetGetStatus` command. - .. data:: replSetGetStatus.members[n].lastHeartbeat An :term:`ISODate` formatted date and time that reflects the last From 895817ccfe2291e6a59a33edbc34fea820319eaa Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 15:56:54 -0400 Subject: [PATCH 17/96] fix dupe readconcern target --- source/reference/read-concern-available.txt | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/reference/read-concern-available.txt b/source/reference/read-concern-available.txt index 66c32cef964..349c6e215fe 100644 --- a/source/reference/read-concern-available.txt +++ b/source/reference/read-concern-available.txt @@ -2,8 +2,6 @@ .. .. class:: hidden -.. readconcern:: "available" - ============================ Read Concern ``"available"`` ============================ From 88688f842a3cd0cc867f2e6cc1fed6c62453428b Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 16:05:59 -0400 Subject: [PATCH 18/96] fix glossary term capitalizations --- source/administration/configuration.txt | 2 +- source/core/index-ttl.txt | 2 +- source/reference/command/serverStatus.txt | 2 +- source/reference/method/Date.txt | 4 ++-- source/reference/method/cursor.readConcern.txt | 2 +- source/reference/method/cursor.sort.txt | 9 +++++---- source/reference/operator/aggregation/collStats.txt | 2 +- source/tutorial/restore-sharded-cluster.txt | 4 ++-- source/tutorial/use-database-commands.txt | 2 +- 9 files changed, 15 insertions(+), 14 deletions(-) diff --git a/source/administration/configuration.txt b/source/administration/configuration.txt index 063ee0c438d..b8d211624ce 100644 --- a/source/administration/configuration.txt +++ b/source/administration/configuration.txt @@ -362,7 +362,7 @@ The :setting:`~storage.dbPath` value controls the location of the :binary:`~bin.mongod` instance's data directory. Ensure that each database has a distinct and well labeled data directory. The :setting:`~processManagement.pidFilePath` controls where :binary:`~bin.mongod` process -places it's :term:`process id ` file. As this tracks the specific +places it's :term:`process id (PID) ` file. As this tracks the specific :binary:`~bin.mongod` file, it is crucial that file be unique and well labeled to make it easy to start and stop these processes. diff --git a/source/core/index-ttl.txt b/source/core/index-ttl.txt index bb14143f041..dd516ab2210 100644 --- a/source/core/index-ttl.txt +++ b/source/core/index-ttl.txt @@ -56,7 +56,7 @@ If the field is an array, and there are multiple date values in the index, MongoDB uses *lowest* (i.e. earliest) date value in the array to calculate the expiration threshold. -If the indexed field in a document is not a :term:`date ` +If the indexed field in a document is not a :term:`date ` or an array that holds a date value(s), the document will not expire. If a document does not contain the indexed field, the document will not diff --git a/source/reference/command/serverStatus.txt b/source/reference/command/serverStatus.txt index 57828e59abf..cc77761e7ed 100644 --- a/source/reference/command/serverStatus.txt +++ b/source/reference/command/serverStatus.txt @@ -2078,7 +2078,7 @@ repl .. serverstatus:: repl.rbid - :term:`Rollback` identifier. Used to determine if a rollback has + :term:`Rollback ` identifier. Used to determine if a rollback has happened for this :binary:`~bin.mongod` instance. .. serverstatus:: repl.replicationProgress diff --git a/source/reference/method/Date.txt b/source/reference/method/Date.txt index 65ee8cebf97..09043a38cdf 100644 --- a/source/reference/method/Date.txt +++ b/source/reference/method/Date.txt @@ -41,8 +41,8 @@ Date() datetime in UTC. - ``new Date()`` specifies the datetime as milliseconds - since the :term:`Unix epoch` (Jan 1, 1970), and returns the - resulting ``ISODate`` instance. + since the :term:`UNIX epoch ` (Jan 1, 1970), and + returns the resulting ``ISODate`` instance. Behavior -------- diff --git a/source/reference/method/cursor.readConcern.txt b/source/reference/method/cursor.readConcern.txt index a846629a4e0..22543707eed 100644 --- a/source/reference/method/cursor.readConcern.txt +++ b/source/reference/method/cursor.readConcern.txt @@ -49,7 +49,7 @@ Definition - string - - :term:`Read concern` level. + - :term:`Read concern ` level. .. include:: /includes/fact-readConcern-option-description.rst diff --git a/source/reference/method/cursor.sort.txt b/source/reference/method/cursor.sort.txt index 5c32a53747f..fe871ad743c 100644 --- a/source/reference/method/cursor.sort.txt +++ b/source/reference/method/cursor.sort.txt @@ -178,11 +178,12 @@ fail *unless* the query specifies :method:`cursor.allowDiskUse()` .. _sort-with-projection: -Interaction with :term:`Projection` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Interaction with Projection +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -When a set of results are both sorted and projected, the MongoDB query engine -will always apply the sorting **first**. +When a set of results are both sorted *and* +:term:`projected `, the MongoDB query engine will always +apply the sorting **first**. Examples -------- diff --git a/source/reference/operator/aggregation/collStats.txt b/source/reference/operator/aggregation/collStats.txt index 3d966bf7619..568f07e80b9 100644 --- a/source/reference/operator/aggregation/collStats.txt +++ b/source/reference/operator/aggregation/collStats.txt @@ -131,7 +131,7 @@ Definition * - ``localTime`` - The current time on the MongoDB server, expressed as UTC - milliseconds since the :term:`Unix epoch`. + milliseconds since the :term:`UNIX epoch `. * - ``latencyStats`` - Statistics related to request latency for a collection or diff --git a/source/tutorial/restore-sharded-cluster.txt b/source/tutorial/restore-sharded-cluster.txt index 54fb4bae100..b4741ce5d85 100644 --- a/source/tutorial/restore-sharded-cluster.txt +++ b/source/tutorial/restore-sharded-cluster.txt @@ -94,12 +94,12 @@ Shut Down Running MongoDB Processes run :method:`db.isMaster()`: * If :data:`~isMaster.ismaster` is false, the ``mongod`` is a - :term:`secondary ` member of a replica set. You + :term:`secondary` member of a replica set. You can shut it down by running :method:`db.shutdownServer()` from the ``admin`` database. * If :data:`~isMaster.ismaster` is true, the ``mongod`` is the - :term:`primary ` member of a replica set. Shut down + :term:`primary` member of a replica set. Shut down the secondary members of the replica set *first*. Use :method:`rs.status()` to identify the other members of the replica set. diff --git a/source/tutorial/use-database-commands.txt b/source/tutorial/use-database-commands.txt index 2859d5f06db..5b40847f1f2 100644 --- a/source/tutorial/use-database-commands.txt +++ b/source/tutorial/use-database-commands.txt @@ -13,7 +13,7 @@ Use Database Commands :class: singlecol The MongoDB command interface provides access to all :term:`non CRUD -` database operations. Fetching server stats, initializing a +` database operations. Fetching server stats, initializing a replica set, and running a map-reduce job are all accomplished with commands. From 2b7ee7e3df524a96f9f98d060d5808695f514995 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 16:39:29 -0400 Subject: [PATCH 19/96] fix most expression link issues --- .../extracts-fact-aggregation-accumulator-base.yaml | 4 ++-- source/reference/command/update.txt | 2 +- source/reference/method/db.createView.txt | 4 ++-- source/reference/operator/aggregation/avg.txt | 8 ++++---- source/reference/operator/aggregation/binarySize.txt | 2 +- source/reference/operator/aggregation/max.txt | 8 ++++---- .../reference/operator/aggregation/mergeObjects.txt | 8 ++++---- source/reference/operator/aggregation/min.txt | 8 ++++---- source/reference/operator/aggregation/push.txt | 4 ++-- .../reference/operator/aggregation/replaceWith.txt | 2 +- source/reference/operator/aggregation/stdDevPop.txt | 12 ++++++------ source/reference/operator/aggregation/stdDevSamp.txt | 10 +++++----- source/reference/operator/aggregation/tan.txt | 2 +- source/reference/operator/aggregation/trunc.txt | 2 +- source/release-notes/3.4-compatibility.txt | 4 ++-- .../update-documents-with-aggregation-pipeline.txt | 2 +- 16 files changed, 41 insertions(+), 41 deletions(-) diff --git a/source/includes/extracts-fact-aggregation-accumulator-base.yaml b/source/includes/extracts-fact-aggregation-accumulator-base.yaml index 94e1310513f..0a5df666e08 100644 --- a/source/includes/extracts-fact-aggregation-accumulator-base.yaml +++ b/source/includes/extracts-fact-aggregation-accumulator-base.yaml @@ -20,7 +20,7 @@ content: | - :pipeline:`$replaceWith` (Available starting in MongoDB 4.2) - - :pipeline:`$match` stage that includes an :expression:`$expr` expression + - :pipeline:`$match` stage that includes an :query:`$expr` expression --- ref: _fact-agg-accumulator-availability-change @@ -40,7 +40,7 @@ content: | - :pipeline:`$replaceWith` (Available starting in MongoDB 4.2) - - :pipeline:`$match` stage that includes an :expression:`$expr` expression + - :pipeline:`$match` stage that includes an :query:`$expr` expression In MongoDB 3.2 and earlier, {{accumulator}} is available in the :pipeline:`$group` stage only. diff --git a/source/reference/command/update.txt b/source/reference/command/update.txt index 1f5ef36935d..b83c0f4ef87 100644 --- a/source/reference/command/update.txt +++ b/source/reference/command/update.txt @@ -783,7 +783,7 @@ calculated grade average and letter grade. First Stage The :pipeline:`$set` stage calculates a new field ``average`` based - on the average of the ``tests`` field. See :expression:`$avg` for + on the average of the ``tests`` field. See :group:`$avg` for more information on the ``$avg`` aggregation operator. Second Stage diff --git a/source/reference/method/db.createView.txt b/source/reference/method/db.createView.txt index 4c0df0e9d03..70804404b2f 100644 --- a/source/reference/method/db.createView.txt +++ b/source/reference/method/db.createView.txt @@ -211,7 +211,7 @@ Perform Aggregation Pipeline on a View `````````````````````````````````````` The following operation performs an aggregation on the -``managementFeedback`` view, using the :expression:`$sortByCount` to +``managementFeedback`` view, using the :pipeline:`$sortByCount` to group by the ``department`` field and sort in descending order by the count of each distinct department: @@ -320,7 +320,7 @@ Perform Aggregation Pipeline on a View `````````````````````````````````````` The following operation performs an aggregation on the ``orderDetails`` -view, using the :expression:`$sortByCount` to group by the ``item`` +view, using the :pipeline:`$sortByCount` to group by the ``item`` field and sort in descending order by the count of each distinct item: .. code-block:: javascript diff --git a/source/reference/operator/aggregation/avg.txt b/source/reference/operator/aggregation/avg.txt index 4d174581eb4..5451373c425 100644 --- a/source/reference/operator/aggregation/avg.txt +++ b/source/reference/operator/aggregation/avg.txt @@ -20,7 +20,7 @@ Definition .. include:: /includes/extracts/fact-aggregation-accumulator-avg.rst - When used in the :pipeline:`$group` stage, :expression:`$avg` has the + When used in the :pipeline:`$group` stage, :group:`$avg` has the following syntax and returns the collective average of all the numeric values that result from applying a specified expression to each document in a group of documents that share the same group by key: @@ -29,17 +29,17 @@ Definition { $avg: } - When used in the other supported stages, :expression:`$avg` returns + When used in the other supported stages, :group:`$avg` returns the average of the specified expression or list of expressions for each document and has one of two syntaxes: - - :expression:`$avg` has one specified expression as its operand: + - :group:`$avg` has one specified expression as its operand: .. code-block:: javascript { $avg: } - - :expression:`$avg` has a list of specified expressions as its + - :group:`$avg` has a list of specified expressions as its operand: .. code-block:: javascript diff --git a/source/reference/operator/aggregation/binarySize.txt b/source/reference/operator/aggregation/binarySize.txt index b0bce63353c..2ab55c0bdf3 100644 --- a/source/reference/operator/aggregation/binarySize.txt +++ b/source/reference/operator/aggregation/binarySize.txt @@ -187,7 +187,7 @@ First Stage - The ``name`` field - - The ``imageSize`` field, which uses :expression:`binarySize` to + - The ``imageSize`` field, which uses :expression:`$binarySize` to return the size of the document's ``binary`` field in bytes. This stage outputs the following documents to the next stage: diff --git a/source/reference/operator/aggregation/max.txt b/source/reference/operator/aggregation/max.txt index 85f6155ae85..e5030b1475d 100644 --- a/source/reference/operator/aggregation/max.txt +++ b/source/reference/operator/aggregation/max.txt @@ -21,7 +21,7 @@ Definition .. include:: /includes/extracts/fact-aggregation-accumulator-max.rst - When used in the :pipeline:`$group` stage, :expression:`$max` has the + When used in the :pipeline:`$group` stage, :group:`$max` has the following syntax and returns the maximum value that results from applying an expression to each document in a group of documents that share the same group by key: @@ -31,16 +31,16 @@ Definition { $max: } When used in the other supported stages, - :expression:`$max` returns the maximum of the specified expression + :group:`$max` returns the maximum of the specified expression or list of expressions for each document and has one of two syntaxes: - - :expression:`$max` has one specified expression as its operand: + - :group:`$max` has one specified expression as its operand: .. code-block:: javascript { $max: } - - :expression:`$max` has a list of specified expressions as its + - :group:`$max` has a list of specified expressions as its operand: .. code-block:: javascript diff --git a/source/reference/operator/aggregation/mergeObjects.txt b/source/reference/operator/aggregation/mergeObjects.txt index c1bbcf13538..26fc7ef317b 100644 --- a/source/reference/operator/aggregation/mergeObjects.txt +++ b/source/reference/operator/aggregation/mergeObjects.txt @@ -39,11 +39,11 @@ Definition Behavior -------- -- :expression:`mergeObjects` ignores ``null`` operands. If all the - operands to :expression:`mergeObjects` resolves to null, - :expression:`mergeObjects` returns an empty document ``{ }``. +- :expression:`$mergeObjects` ignores ``null`` operands. If all the + operands to :expression:`$mergeObjects` resolves to null, + :expression:`$mergeObjects` returns an empty document ``{ }``. -- :expression:`mergeObjects` overwrites the field values as it merges +- :expression:`$mergeObjects` overwrites the field values as it merges the documents. If documents to merge include the same field name, the field, in the resulting document, has the value from the last document merged for the field. diff --git a/source/reference/operator/aggregation/min.txt b/source/reference/operator/aggregation/min.txt index 67d55231522..db5c426383d 100644 --- a/source/reference/operator/aggregation/min.txt +++ b/source/reference/operator/aggregation/min.txt @@ -21,7 +21,7 @@ Definition .. include:: /includes/extracts/fact-aggregation-accumulator-min.rst - When used in the :pipeline:`$group` stage, :expression:`$min` has the + When used in the :pipeline:`$group` stage, :group:`$min` has the following syntax and returns the minimum value that results from applying an expression to each document in a group of documents that share the same group by key: @@ -31,16 +31,16 @@ Definition { $min: } When used in the other supported stages, - :expression:`$min` returns the minimum of the specified expression + :group:`$min` returns the minimum of the specified expression or list of expressions for each document and has one of two syntaxes: - - :expression:`$min` has one specified expression as its operand: + - :group:`$min` has one specified expression as its operand: .. code-block:: javascript { $min: } - - :expression:`$min` has a list of specified expressions as its + - :group:`$min` has a list of specified expressions as its operand: .. code-block:: javascript diff --git a/source/reference/operator/aggregation/push.txt b/source/reference/operator/aggregation/push.txt index 0aad20780d0..1488c00d787 100644 --- a/source/reference/operator/aggregation/push.txt +++ b/source/reference/operator/aggregation/push.txt @@ -21,7 +21,7 @@ Definition .. include:: /includes/extracts/fact-aggregation-accumulator-push.rst - :expression:`$push` has the following syntax: + :group:`$push` has the following syntax: .. code-block:: javascript @@ -45,7 +45,7 @@ Consider a ``sales`` collection with the following documents: { "_id" : 7, "item" : "xyz", "price" : 5, "quantity" : 10, "date" : ISODate("2014-02-15T14:12:12Z") } Grouping the documents by the day and the year of the ``date`` field, -the following operation uses the :expression:`$push` accumulator to +the following operation uses the :group:`$push` accumulator to compute the list of items and quantities sold for each group: .. code-block:: javascript diff --git a/source/reference/operator/aggregation/replaceWith.txt b/source/reference/operator/aggregation/replaceWith.txt index a00672c109f..1acf48b3a99 100644 --- a/source/reference/operator/aggregation/replaceWith.txt +++ b/source/reference/operator/aggregation/replaceWith.txt @@ -273,7 +273,7 @@ First stage: Second stage: The :pipeline:`$group` stage groups by the quarter and uses - :expression:`$push` to accumulate the ``obj`` fields into a new + :group:`$push` to accumulate the ``obj`` fields into a new ``items`` array field. For example: .. code-block:: javascript diff --git a/source/reference/operator/aggregation/stdDevPop.txt b/source/reference/operator/aggregation/stdDevPop.txt index 819d90275f7..8bcadc4d613 100644 --- a/source/reference/operator/aggregation/stdDevPop.txt +++ b/source/reference/operator/aggregation/stdDevPop.txt @@ -28,12 +28,12 @@ Definition .. include:: /includes/extracts/fact-aggregation-accumulator-stdDevPop.rst - When used in the :pipeline:`$group` stage, :expression:`$stdDevPop` returns + When used in the :pipeline:`$group` stage, :group:`$stdDevPop` returns the population standard deviation of the specified expression for a group of documents that share the same group by key and has the following syntax: - - :expression:`$stdDevPop` has one specified expression as its + - :group:`$stdDevPop` has one specified expression as its operand: .. code-block:: javascript @@ -41,24 +41,24 @@ Definition { $stdDevPop: } When used in the other supported stages, - :expression:`$stdDevPop` returns the standard deviation of the + :group:`$stdDevPop` returns the standard deviation of the specified expression or list of expressions for each document and has one of two syntaxes: - - :expression:`$stdDevPop` has one specified expression as its operand: + - :group:`$stdDevPop` has one specified expression as its operand: .. code-block:: javascript { $stdDevPop: } - - :expression:`$stdDevPop` has a list of specified expressions as its + - :group:`$stdDevPop` has a list of specified expressions as its operand: .. code-block:: javascript { $stdDevPop: [ , ... ] } - The argument for :expression:`$stdDevPop` can be any + The argument for :group:`$stdDevPop` can be any :ref:`expression ` as long as it resolves to an array. For more information on expressions, see :ref:`aggregation-expressions` diff --git a/source/reference/operator/aggregation/stdDevSamp.txt b/source/reference/operator/aggregation/stdDevSamp.txt index 81ce6967171..f5d1276eca0 100644 --- a/source/reference/operator/aggregation/stdDevSamp.txt +++ b/source/reference/operator/aggregation/stdDevSamp.txt @@ -28,7 +28,7 @@ Definition .. include:: /includes/extracts/fact-aggregation-accumulator-stdDevSamp.rst - When used in the :pipeline:`$group` stage, :expression:`$stdDevSamp` has the + When used in the :pipeline:`$group` stage, :group:`$stdDevSamp` has the following syntax and returns the sample standard deviation of the specified expression for a group of documents that share the same group by key: @@ -38,24 +38,24 @@ Definition { $stdDevSamp: } When used in the other supported stages, - :expression:`$stdDevSamp` returns the sample standard deviation of + :group:`$stdDevSamp` returns the sample standard deviation of the specified expression or list of expressions for each document and has one of two syntaxes: - - :expression:`$stdDevSamp` has one specified expression as its operand: + - :group:`$stdDevSamp` has one specified expression as its operand: .. code-block:: javascript { $stdDevSamp: } - - :expression:`$stdDevSamp` has a list of specified expressions as its + - :group:`$stdDevSamp` has a list of specified expressions as its operand: .. code-block:: javascript { $stdDevSamp: [ , ... ] } - The argument for :expression:`$stdDevSamp` can be any + The argument for :group:`$stdDevSamp` can be any :ref:`expression ` as long as it resolves to an array. For more information on expressions, see :ref:`aggregation-expressions`. diff --git a/source/reference/operator/aggregation/tan.txt b/source/reference/operator/aggregation/tan.txt index 4382aeadbdc..b88a37844aa 100644 --- a/source/reference/operator/aggregation/tan.txt +++ b/source/reference/operator/aggregation/tan.txt @@ -99,7 +99,7 @@ Example } The following aggregation operation uses the - :expression:`$tans` expression to calculate the side opposite + :expression:`$tan` expression to calculate the side opposite to ``angle_a`` and add it to the input document using the :pipeline:`$addFields` pipeline stage. diff --git a/source/reference/operator/aggregation/trunc.txt b/source/reference/operator/aggregation/trunc.txt index 3a9a2c0a685..d184f67647f 100644 --- a/source/reference/operator/aggregation/trunc.txt +++ b/source/reference/operator/aggregation/trunc.txt @@ -80,7 +80,7 @@ Definition fifth digit left of the decimal. This exceeds the number of digits left of the decimal and returns ``0``. - - If ```` resolves to ``0``, :expression:`trunc` + - If ```` resolves to ``0``, :expression:`$trunc` truncates all digits to the right of the decimal and returns the whole integer value. diff --git a/source/release-notes/3.4-compatibility.txt b/source/release-notes/3.4-compatibility.txt index 99301958ed3..d0b4d86bd3d 100644 --- a/source/release-notes/3.4-compatibility.txt +++ b/source/release-notes/3.4-compatibility.txt @@ -315,8 +315,8 @@ like an equality statement for upserts. If the query includes this condition on a field, the field value is set to the element. As a result of this behavior, certain upsert operations may fail in 3.4. In -example above, the :query:`$addToSet` upsert would fail because the ``a`` -field would be seeded with a single value, and :query:`$addToSet` cannot be +example above, the :update:`$addToSet` upsert would fail because the ``a`` +field would be seeded with a single value, and :update:`$addToSet` cannot be applied to a scalar field. To avoid this error, you must wrap the :query:`$in` expression in an :query:`$elemMatch` expression: diff --git a/source/tutorial/update-documents-with-aggregation-pipeline.txt b/source/tutorial/update-documents-with-aggregation-pipeline.txt index 7995c1abe04..2f9b8c2265b 100644 --- a/source/tutorial/update-documents-with-aggregation-pipeline.txt +++ b/source/tutorial/update-documents-with-aggregation-pipeline.txt @@ -196,7 +196,7 @@ Specifically, the pipeline consists of: - a :pipeline:`$set` stage to calculate the truncated average value of the ``tests`` array elements and to update the ``modified`` field to the current datetime. To calculate the truncated average, - the stage uses the :expression:`$avg` and :expression:`$trunc` + the stage uses the :group:`$avg` and :expression:`$trunc` expressions. For the current datetime, the operation uses the aggregation variable :variable:`NOW` for the (to access the variable, prefix with ``$$`` and enclose in quotes) From 83de68d5b7b21cd525ca0073d8059879dc8eeb41 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 16:49:15 -0400 Subject: [PATCH 20/96] fix some authaction links --- source/includes/access-change-password.rst | 2 +- source/includes/access-grant-roles.rst | 2 +- source/includes/access-update-user.rst | 2 +- .../reference/operator/aggregation/listLocalSessions.txt | 8 ++++---- source/reference/operator/aggregation/listSessions.txt | 8 ++++---- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/source/includes/access-change-password.rst b/source/includes/access-change-password.rst index ddb628cd88d..9002353fc05 100644 --- a/source/includes/access-change-password.rst +++ b/source/includes/access-change-password.rst @@ -1,3 +1,3 @@ To modify the password of another user on a database, you must have the -:authaction:`changeAnyPassword` :ref:`action ` +:authaction:`changePassword` :ref:`action ` on that database. diff --git a/source/includes/access-grant-roles.rst b/source/includes/access-grant-roles.rst index ef79ca970f1..4fe715756a9 100644 --- a/source/includes/access-grant-roles.rst +++ b/source/includes/access-grant-roles.rst @@ -1,2 +1,2 @@ -You must have the :authaction:`grantRole()` :ref:`action +You must have the :authaction:`grantRole` :ref:`action ` on a database to grant a role on that database. diff --git a/source/includes/access-update-user.rst b/source/includes/access-update-user.rst index db9c1cacbe7..19087221968 100644 --- a/source/includes/access-update-user.rst +++ b/source/includes/access-update-user.rst @@ -6,5 +6,5 @@ You must have the :authaction:`grantRole` :ref:`action ` on a role's database to add a role to a user. To change another user's ``pwd`` or ``customData`` field, you must have -the :authaction:`changeAnyPassword` and :authaction:`changeAnyCustomData` +the :authaction:`changePassword` and :authaction:`changeCustomData` :ref:`actions ` respectively on that user's database. diff --git a/source/reference/operator/aggregation/listLocalSessions.txt b/source/reference/operator/aggregation/listLocalSessions.txt index 6b021b6ec88..9f7920f336f 100644 --- a/source/reference/operator/aggregation/listLocalSessions.txt +++ b/source/reference/operator/aggregation/listLocalSessions.txt @@ -62,14 +62,14 @@ Definition - Returns all sessions for the specified users. If running with access control, the authenticated user must have privileges - with :authaction:`listSession` action on the cluster to list + with :authaction:`listSessions` action on the cluster to list sessions for other users. * - ``{ allUsers: true }`` - Returns all sessions for all users. If running with access control, the authenticated user must have privileges with - :authaction:`listSession` action on the cluster. + :authaction:`listSessions` action on the cluster. Restrictions ------------ @@ -89,7 +89,7 @@ all sessions: .. note:: If running with access control, the current user must have - privileges with :authaction:`listSession` action on the cluster. + privileges with :authaction:`listSessions` action on the cluster. .. code-block:: javascript @@ -106,7 +106,7 @@ sessions for the specified user ``myAppReader@test``: If running with access control and the current user is not the specified user, the current user must - have privileges with :authaction:`listSession` action on the cluster. + have privileges with :authaction:`listSessions` action on the cluster. .. code-block:: javascript diff --git a/source/reference/operator/aggregation/listSessions.txt b/source/reference/operator/aggregation/listSessions.txt index e3dd35f8b6e..a6ec5fada3a 100644 --- a/source/reference/operator/aggregation/listSessions.txt +++ b/source/reference/operator/aggregation/listSessions.txt @@ -60,14 +60,14 @@ Definition - Returns all sessions for the specified users. If running with access control, the authenticated user must have privileges - with :authaction:`listSession` action on the cluster to list + with :authaction:`listSessions` action on the cluster to list sessions for other users. * - ``{ allUsers: true }`` - Returns all sessions for all users. If running with access control, the authenticated user must have privileges with - :authaction:`listSession` action on the cluster. + :authaction:`listSessions` action on the cluster. Restrictions ------------ @@ -86,7 +86,7 @@ the following aggregation operation lists all sessions: .. note:: If running with access control, the current user must have - privileges with :authaction:`listSession` action on the cluster. + privileges with :authaction:`listSessions` action on the cluster. .. code-block:: javascript @@ -105,7 +105,7 @@ specified user ``myAppReader@test``: If running with access control and the current user is not the specified user, the current user must - have privileges with :authaction:`listSession` action on the cluster. + have privileges with :authaction:`listSessions` action on the cluster. .. code-block:: javascript From 2702bfa28f69ec77f5e7f15ae64c3042fd9988f6 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 17:04:06 -0400 Subject: [PATCH 21/96] remove link attempt to PyMongo for general Python method re.compile --- source/reference/operator/query/not.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/operator/query/not.txt b/source/reference/operator/query/not.txt index e03a3371c4b..5d86f33ffad 100644 --- a/source/reference/operator/query/not.txt +++ b/source/reference/operator/query/not.txt @@ -79,7 +79,7 @@ data types like arrays. - driver language's regular expression objects For example, the following PyMongo query uses Python's - :py:meth:`re.compile()` method to compile a regular + ``re.compile()`` method to compile a regular expression: .. code-block:: python From a5555dacfd14f7793aa6a64d01539f3f625dda56 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 17:36:55 -0400 Subject: [PATCH 22/96] fix most :setting: links --- source/core/security-ldap-external.txt | 2 +- source/includes/fact-log-slow-queries.rst | 6 +++--- source/reference/configuration-options.txt | 6 +++--- source/reference/program/mongod.txt | 4 ++-- source/reference/program/mongos.txt | 4 ++-- source/reference/replica-configuration.txt | 2 +- source/reference/ulimit.txt | 2 +- source/release-notes/2.2.txt | 2 +- source/release-notes/2.6-changelog.txt | 4 ++-- source/release-notes/2.6.txt | 3 +-- source/release-notes/3.0-compatibility.txt | 6 +++--- source/release-notes/3.0.txt | 2 +- source/release-notes/3.4.txt | 4 ++-- source/tutorial/manage-the-database-profiler.txt | 2 +- 14 files changed, 24 insertions(+), 25 deletions(-) diff --git a/source/core/security-ldap-external.txt b/source/core/security-ldap-external.txt index 013edc85cff..fcdcb0d15d6 100644 --- a/source/core/security-ldap-external.txt +++ b/source/core/security-ldap-external.txt @@ -495,7 +495,7 @@ privileges to the user. After authenticating a user ``alice@dba.example.com`` against the ``$external`` database, the MongoDB server performs a query derived from the configured :setting:`query template - ` to retrieve the groups which include + ` to retrieve the groups which include the authenticated user as a member. In this example, the MongoDB server retrieves the following group DNs for the user: diff --git a/source/includes/fact-log-slow-queries.rst b/source/includes/fact-log-slow-queries.rst index ddec121c616..1514b50f1e7 100644 --- a/source/includes/fact-log-slow-queries.rst +++ b/source/includes/fact-log-slow-queries.rst @@ -1,16 +1,16 @@ .. COMMENT: When included as part of options/settings, this is used by mongod and configuration file and not mongos. For mongos, see options-mongos.yaml. This file is however included in other files where distinction between mongod/mongos is sufficient. -When :setting:`~param.logLevel` is set to ``0``, MongoDB records *slow* +When :parameter:`logLevel` is set to ``0``, MongoDB records *slow* operations to the diagnostic log at a rate determined by :setting:`~operationProfiling.slowOpSampleRate`. Starting in MongoDB 4.2, the secondaries of replica sets log :ref:`all oplog entry messages that take longer than the slow operation threshold to apply ` regardless of the sample rate. -At higher :setting:`~param.logLevel` settings, all operations appear in +At higher :parameter:`logLevel` settings, all operations appear in the diagnostic log regardless of their latency with the following exception: the logging of :ref:`slow oplog entry messages by the secondaries `. The secondaries log only the slow oplog -entries; increasing the :setting:`~param.logLevel` does not log all +entries; increasing the :parameter:`logLevel` does not log all oplog entries. \ No newline at end of file diff --git a/source/reference/configuration-options.txt b/source/reference/configuration-options.txt index 13efc773d31..bf1bc72cd7f 100644 --- a/source/reference/configuration-options.txt +++ b/source/reference/configuration-options.txt @@ -1232,7 +1232,7 @@ Core Options The password to de-crypt the certificate-key file (i.e. :setting:`~net.tls.certificateKeyFile`). Use the - :setting:`net.tls.certificateKeyPassword` option only if the + :setting:`net.tls.certificateKeyFilePassword` option only if the certificate-key file is encrypted. In all cases, the :binary:`~bin.mongos` or :binary:`~bin.mongod` will redact the password from all logging and reporting output. @@ -1241,7 +1241,7 @@ Core Options - On Linux/BSD, if the private key in the PEM file is encrypted and you do not specify the - :setting:`net.tls.certificateKeyFukePassword` option, MongoDB will + :setting:`net.tls.certificateKeyFilePassword` option, MongoDB will prompt for a passphrase. See :ref:`ssl-certificate-password`. - On macOS, if the private key in the PEM file is encrypted, you must @@ -4066,7 +4066,7 @@ LDAP Parameters Starting in MongoDB 4.0: - The setting :setting:`replication.replSetName` cannot be used in conjunction with - :setting:`storage.indexBuildRetry`. + ``storage.indexBuildRetry``. - For the WiredTiger storage engine, :setting:`storage.journal.enabled: false diff --git a/source/reference/program/mongod.txt b/source/reference/program/mongod.txt index 7dba59c6c04..97dd15bb99c 100644 --- a/source/reference/program/mongod.txt +++ b/source/reference/program/mongod.txt @@ -3145,7 +3145,7 @@ Encryption Key Management Options The keyfile can contain only a single key. The key is either a 16 or 32 character string. - Requires :setting:`enableEncryption` to be ``true``. + Requires :setting:`security.enableEncryption` to be ``true``. .. include:: /includes/fact-enterprise-only-admonition.rst @@ -3160,7 +3160,7 @@ Encryption Key Management Options Include to use the key associated with the identifier as the system key. You can only use the setting the first time you enable encryption for the :binary:`~bin.mongod` instance. Requires - :setting:`enableEncryption` to be true. + :setting:`security.enableEncryption` to be true. If unspecified, MongoDB will request that the KMIP server create a new key to utilize as the system key. diff --git a/source/reference/program/mongos.txt b/source/reference/program/mongos.txt index 954bab66ef0..2bf6fa06ea8 100644 --- a/source/reference/program/mongos.txt +++ b/source/reference/program/mongos.txt @@ -1601,11 +1601,11 @@ Profiler Options The *slow* operation time threshold, in milliseconds. Operations that run for longer than this threshold are considered *slow*. - When :setting:`~param.logLevel` is set to ``0``, MongoDB records *slow* + When :parameter:`logLevel` is set to ``0``, MongoDB records *slow* operations to the diagnostic log at a rate determined by :setting:`~operationProfiling.slowOpSampleRate`. - At higher :setting:`~param.logLevel` settings, all operations appear + At higher :parameter:`logLevel` settings, all operations appear in the diagnostic log regardless of their latency. For :binary:`~bin.mongos` instances, affects the diagnostic diff --git a/source/reference/replica-configuration.txt b/source/reference/replica-configuration.txt index f11bd680803..5e8c480de76 100644 --- a/source/reference/replica-configuration.txt +++ b/source/reference/replica-configuration.txt @@ -653,4 +653,4 @@ Replica Set Configuration Fields The ObjectId associated with the replica set and automatically created during :method:`rs.initiate()` or :dbcommand:`replSetInitate`. You cannot change the - :setting:`~settings.replicaSetId`. + :rsconf:`~settings.replicaSetId`. diff --git a/source/reference/ulimit.txt b/source/reference/ulimit.txt index c1385a6d594..8e805398965 100644 --- a/source/reference/ulimit.txt +++ b/source/reference/ulimit.txt @@ -133,7 +133,7 @@ grows too high. For this reason, it is extremely important to set *both* ``ulimit`` values to the recommended values. ``ulimit`` will modify both "hard" and "soft" values unless the -:setting:`-H` or :setting:`-S` modifiers are specified when +``-H`` or ``-S`` modifiers are specified when modifying limit values. For many distributions of Linux you can change values by substituting diff --git a/source/release-notes/2.2.txt b/source/release-notes/2.2.txt index 20f3984091d..c3c809c8a9a 100644 --- a/source/release-notes/2.2.txt +++ b/source/release-notes/2.2.txt @@ -680,7 +680,7 @@ New Option To Configure Index Pre-Fetching during Replication By default, when replicating options, :term:`secondaries ` will pre-fetch :ref:`indexes` associated with a query to improve replication -throughput in most cases. The :setting:`replication.secondaryIndexPrefetch` setting and +throughput in most cases. The ``replication.secondaryIndexPrefetch`` setting and ```--replIndexPrefetch`` option allow administrators to disable this feature or allow the :binary:`~bin.mongod` to pre-fetch only the index on the ``_id`` field. See :issue:`SERVER-6718` for more information. diff --git a/source/release-notes/2.6-changelog.txt b/source/release-notes/2.6-changelog.txt index ab0b480da33..33bd8adf958 100644 --- a/source/release-notes/2.6-changelog.txt +++ b/source/release-notes/2.6-changelog.txt @@ -149,7 +149,7 @@ Testing Security ~~~~~~~~ -:issue:`SERVER-16073` Create hidden :setting:`net.ssl.sslCipherConfig` flag +:issue:`SERVER-16073` Create hidden ``net.ssl.sslCipherConfig`` flag Querying ~~~~~~~~ @@ -245,7 +245,7 @@ Build and Packaging Usability ~~~~~~~~~ -:issue:`SERVER-14756` The YAML :setting:`storage.quota.enforced` option is not found +:issue:`SERVER-14756` The YAML ``storage.quota.enforced`` option is not found Testing ~~~~~~~ diff --git a/source/release-notes/2.6.txt b/source/release-notes/2.6.txt index 30da8c09b4c..0af8870abb0 100644 --- a/source/release-notes/2.6.txt +++ b/source/release-notes/2.6.txt @@ -403,8 +403,7 @@ Specifically these changes include: an old or malicious client from forcing use of a weak cipher. - MongoDB disables the http interface by default, limiting - :doc:`network exposure `. To enable the - interface, see :setting:`~net.http.enabled`. + :doc:`network exposure `. .. seealso:: :ref:`authentication-incompatibility`, :ref:`ssl-hostname-validation`, diff --git a/source/release-notes/3.0-compatibility.txt b/source/release-notes/3.0-compatibility.txt index 90969282d9b..f84da7c86ef 100644 --- a/source/release-notes/3.0-compatibility.txt +++ b/source/release-notes/3.0-compatibility.txt @@ -234,7 +234,7 @@ The ``FATAL`` replica set state does not exist as of 3.0.0. HTTP Interface ~~~~~~~~~~~~~~ -The HTTP Interface (i.e. :setting:`net.http.enabled`) no longer +The HTTP Interface (i.e. ``net.http.enabled``) no longer reports replication data. .. _3.0-compatibility-tools: @@ -350,7 +350,7 @@ TLS/SSL Configuration Option Changes MongoDB 3.0 introduced new :setting:`net.ssl.allowConnectionsWithoutCertificates` configuration file setting and ``--sslAllowConnectionsWithoutCertificates`` command line option for :binary:`~bin.mongod` and :binary:`~bin.mongos`. These -options replace previous :setting:`net.ssl.weakCertificateValidation` and +options replace previous ``net.ssl.weakCertificateValidation`` and ``--sslWeakCertificateValidation`` options, which became aliases. Update your configuration to ensure future compatibility. @@ -360,7 +360,7 @@ TLS/SSL Certificates Validation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ By default, when running in SSL mode, MongoDB instances will *only* -start if its certificate (i.e. :setting:`net.ssl.PemKeyFile`) is valid. +start if its certificate (i.e. :setting:`net.ssl.PEMKeyFile`) is valid. You can disable this behavior with the :setting:`net.ssl.allowInvalidCertificates` setting or the ``--sslAllowInvalidCertificates`` command line option. diff --git a/source/release-notes/3.0.txt b/source/release-notes/3.0.txt index 7710d616ced..d1f10c7cb49 100644 --- a/source/release-notes/3.0.txt +++ b/source/release-notes/3.0.txt @@ -362,7 +362,7 @@ WiredTiger Configuration ```````````````````````` To configure the behavior and properties of the WiredTiger storage -engine, see :setting:`storage.wiredTiger` configuration options. You +engine, see ``storage.wiredTiger`` configuration options. You can set :ref:`WiredTiger options on the command line `. diff --git a/source/release-notes/3.4.txt b/source/release-notes/3.4.txt index 9387957cf6f..d4179e3f076 100644 --- a/source/release-notes/3.4.txt +++ b/source/release-notes/3.4.txt @@ -583,10 +583,10 @@ change: - MongoDB 3.4 removes the following configuration options from the :binary:`~bin.mongos`: - - :setting:`sharding.chunkSize` configuration file setting and + - ``sharding.chunkSize`` configuration file setting and ``--chunkSize`` command-line option - - :setting:`sharding.autoSplit` configuration file setting and + - ``sharding.autoSplit`` configuration file setting and ``--noAutoSplit`` command-line option Faster Balancing diff --git a/source/tutorial/manage-the-database-profiler.txt b/source/tutorial/manage-the-database-profiler.txt index b72979296d7..dbd0be8ba05 100644 --- a/source/tutorial/manage-the-database-profiler.txt +++ b/source/tutorial/manage-the-database-profiler.txt @@ -263,7 +263,7 @@ that last longer than ``15`` milliseconds, and specifies that only 50% of *slow* operations should be profiled. [#slow-oplogs]_ The ``slowms`` and ``slowOpSampleRate`` also affect which operations -are recorded to the diagnostic log when :setting:`~param.logLevel` is +are recorded to the diagnostic log when :parameter:`logLevel` is set to ``0``. The ``slowms`` and ``slowOpSampleRate`` are also available to configure diagnostic logging for :binary:`~bin.mongos`. [#slow-oplogs]_ From 076b2dd3c3815ecffcfebc9c9c22fbf2c8e1f8e4 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 17:46:50 -0400 Subject: [PATCH 23/96] mongooplog removed in v3.6 --- source/release-notes/2.2.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/2.2.txt b/source/release-notes/2.2.txt index c3c809c8a9a..4b7a616aa7b 100644 --- a/source/release-notes/2.2.txt +++ b/source/release-notes/2.2.txt @@ -522,7 +522,7 @@ MongoDB extended JSON now includes a new ``Timestamp()`` type to represent the Timestamp type that MongoDB uses for timestamps in the :term:`oplog` among other contexts. -This permits tools like :binary:`~bin.mongooplog` and :binary:`~bin.mongodump` +This permits tools like ``mongooplog`` and :binary:`~bin.mongodump` to query for specific timestamps. Consider the following :binary:`~bin.mongodump` operation: From 8664ef438ee65d16371e89d5444e3dac01478206 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Thu, 8 Oct 2020 17:52:45 -0400 Subject: [PATCH 24/96] fix BSON binary type links --- source/core/security-client-side-encryption.txt | 4 ++-- source/reference/method/ClientEncryption.encrypt.txt | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/core/security-client-side-encryption.txt b/source/core/security-client-side-encryption.txt index 4aab7490ba3..276a01f51da 100644 --- a/source/core/security-client-side-encryption.txt +++ b/source/core/security-client-side-encryption.txt @@ -66,7 +66,7 @@ Consider the following document: With client-side field level encryption, the application can specifically encrypt sensitive information like the ``ssn`` and ``phone``. Encrypted fields are stored as -:bsontype:`binary data ` with +:bsontype:`binary data ` with `subtype 6 `_: .. code-block:: json @@ -300,7 +300,7 @@ collection. Use the :ref:`automatic encryption rule keywords ` with the :query:`$jsonSchema` validation object to indicate which fields require encryption. The server rejects any write operations to that collection -where the specified fields are not :bsontype:`Binary (BinData) ` +where the specified fields are not :bsontype:`Binary (BinData) ` subtype 6 objects. For example, the following :dbcommand:`collMod` command modifies diff --git a/source/reference/method/ClientEncryption.encrypt.txt b/source/reference/method/ClientEncryption.encrypt.txt index e9e8bb6794d..57595b7d422 100644 --- a/source/reference/method/ClientEncryption.encrypt.txt +++ b/source/reference/method/ClientEncryption.encrypt.txt @@ -48,8 +48,8 @@ ClientEncryption.encrypt() - The data encryption key to use for encrypting the ``value``. The :abbr:`UUID (Universally unique identifier)` is a BSON - :bsontype:`binary data` object with subtype ``4`` that - identifies a specific data encryption key. If the data + :bsontype:`binary data ` object with subtype ``4`` + that identifies a specific data encryption key. If the data encryption key does not exist in the key vault configured for the database connection, :method:`~ClientEncryption.encrypt()` returns an error. See :ref:`field-level-encryption-keyvault` From 74a96bee3ce41ec653066397f72807fa13adc0c1 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 12:24:23 -0400 Subject: [PATCH 25/96] correct sh.status.active-mongoses ambig reference --- source/reference/method/sh.status.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/method/sh.status.txt b/source/reference/method/sh.status.txt index 309313c0c1a..eea74648abf 100644 --- a/source/reference/method/sh.status.txt +++ b/source/reference/method/sh.status.txt @@ -241,9 +241,9 @@ Active ``mongos`` Instances Autosplit ~~~~~~~~~ -.. data:: sh.status.active-mongoses +.. data:: sh.status.autosplit - :data:`sh.status.active-mongoses` indicates whether autosplit is + :data:`sh.status.autosplit` indicates whether autosplit is currently enabled. .. note:: From 60b059bfb4166f3e9bff98831ddcb1bb6bc2b5ad Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 12:25:04 -0400 Subject: [PATCH 26/96] fix output example indentation --- .../merge-chunks-in-sharded-cluster.txt | 58 +++++++++---------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/source/tutorial/merge-chunks-in-sharded-cluster.txt b/source/tutorial/merge-chunks-in-sharded-cluster.txt index aedacfcf5f4..18a1c5d465c 100644 --- a/source/tutorial/merge-chunks-in-sharded-cluster.txt +++ b/source/tutorial/merge-chunks-in-sharded-cluster.txt @@ -202,35 +202,35 @@ The output of :method:`sh.status()` should resemble: Failed balancer rounds in last 5 attempts: 0 Migration Results for the last 24 hours: 519 : Success - databases: - { "_id" : "config", "primary" : "config", "partitioned" : true } - config.system.sessions - shard key: { "_id" : 1 } - unique: false - balancing: true - chunks: - shardA 512 - shardB 512 - too many chunks to print, use verbose if you want to force print - { "_id" : "test", "primary" : "shardA", "partitioned" : true, "version" : { "uuid" : UUID("22c042fc-7e3d-4c6d-992d-f3d714759781"), "lastMod" : 1 } } - test.members - shard key: { "username" : 1 } - unique: false - balancing: true - chunks: - shardA 5 - shardB 6 - { "username" : { "$minKey" : 1 } } -->> { "username" : "user16643" } on : shardA Timestamp(22, 0) - { "username" : "user16643" } -->> { "username" : "user2329" } on : shardB Timestamp(22, 1) - { "username" : "user2329" } -->> { "username" : "user29937" } on : shardB Timestamp(17, 0) - { "username" : "user29937" } -->> { "username" : "user36583" } on : shardB Timestamp(18, 0) - { "username" : "user36583" } -->> { "username" : "user43229" } on : shardB Timestamp(19, 0) - { "username" : "user43229" } -->> { "username" : "user49877" } on : shardB Timestamp(20, 0) - { "username" : "user49877" } -->> { "username" : "user56522" } on : shardB Timestamp(21, 0) - { "username" : "user56522" } -->> { "username" : "user63169" } on : shardA Timestamp(21, 1) - { "username" : "user63169" } -->> { "username" : "user69816" } on : shardA Timestamp(10, 1) - { "username" : "user69816" } -->> { "username" : "user96401" } on : shardA Timestamp(21, 2) - { "username" : "user96401" } -->> { "username" : { "$maxKey" : 1 } } on : shardA Timestamp(15, 2) + databases: + { "_id" : "config", "primary" : "config", "partitioned" : true } + config.system.sessions + shard key: { "_id" : 1 } + unique: false + balancing: true + chunks: + shardA 512 + shardB 512 + too many chunks to print, use verbose if you want to force print + { "_id" : "test", "primary" : "shardA", "partitioned" : true, "version" : { "uuid" : UUID("22c042fc-7e3d-4c6d-992d-f3d714759781"), "lastMod" : 1 } } + test.members + shard key: { "username" : 1 } + unique: false + balancing: true + chunks: + shardA 5 + shardB 6 + { "username" : { "$minKey" : 1 } } -->> { "username" : "user16643" } on : shardA Timestamp(22, 0) + { "username" : "user16643" } -->> { "username" : "user2329" } on : shardB Timestamp(22, 1) + { "username" : "user2329" } -->> { "username" : "user29937" } on : shardB Timestamp(17, 0) + { "username" : "user29937" } -->> { "username" : "user36583" } on : shardB Timestamp(18, 0) + { "username" : "user36583" } -->> { "username" : "user43229" } on : shardB Timestamp(19, 0) + { "username" : "user43229" } -->> { "username" : "user49877" } on : shardB Timestamp(20, 0) + { "username" : "user49877" } -->> { "username" : "user56522" } on : shardB Timestamp(21, 0) + { "username" : "user56522" } -->> { "username" : "user63169" } on : shardA Timestamp(21, 1) + { "username" : "user63169" } -->> { "username" : "user69816" } on : shardA Timestamp(10, 1) + { "username" : "user69816" } -->> { "username" : "user96401" } on : shardA Timestamp(21, 2) + { "username" : "user96401" } -->> { "username" : { "$maxKey" : 1 } } on : shardA Timestamp(15, 2) After the merge, the :ref:`balancer ` may migrate chunks across shards to ensure a more even distribution of chunks. From fe9d94db76f67020c2e8066bceeb73d28ae7330c Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 12:34:11 -0400 Subject: [PATCH 27/96] fix currentOp ambig targets --- source/reference/command/currentOp.txt | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/source/reference/command/currentOp.txt b/source/reference/command/currentOp.txt index 20dfbecb722..3275c267be0 100644 --- a/source/reference/command/currentOp.txt +++ b/source/reference/command/currentOp.txt @@ -250,8 +250,7 @@ Output Fields .. data:: currentOp.appName - A string with information about the type of client which made the - request. + .. include:: /includes/fact-client-appname.rst .. data:: currentOp.clientMetadata @@ -892,17 +891,6 @@ Output Fields Only present if the cursor is not idle. -.. data:: currentOp.client - - The IP address (or hostname) and the ephemeral port of the client - connection where the operation originates. If your ``inprog`` - array has operations from many different clients, use this string - to relate operations to clients. - -.. data:: currentOp.appName - - .. include:: /includes/fact-client-appname.rst - .. data:: currentOp.waitingForLatch The :data:`~currentOp.waitingForLatch` document is only From 6c9a523f85e5b1ff57d52b30673612219c958f22 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 12:44:57 -0400 Subject: [PATCH 28/96] unlink removed cmd authSchemaUpgrade --- source/includes/steps-2.6-upgrade-authorization.yaml | 8 ++++---- .../includes/steps-3.0-upgrade-mongodb-cr-to-scram.yaml | 6 +++--- source/reference/privilege-actions.txt | 2 +- source/release-notes/3.0-changelog.txt | 2 +- source/release-notes/3.0-downgrade.txt | 2 +- source/release-notes/3.0-scram.txt | 2 +- source/release-notes/3.0-upgrade.txt | 4 ++-- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/source/includes/steps-2.6-upgrade-authorization.yaml b/source/includes/steps-2.6-upgrade-authorization.yaml index 253328c0c69..73d2bd347f4 100644 --- a/source/includes/steps-2.6-upgrade-authorization.yaml +++ b/source/includes/steps-2.6-upgrade-authorization.yaml @@ -15,7 +15,7 @@ title: ref: upgrade-authz-schema stepnum: 2 pre: | - Use the :dbcommand:`authSchemaUpgrade` command in the ``admin`` + Use the ``authSchemaUpgrade`` command in the ``admin`` database to update the user data using the :binary:`~bin.mongo` shell. action: - heading: @@ -26,12 +26,12 @@ action: db.adminCommand({authSchemaUpgrade: 1 }); post: | In case of error, you may safely rerun the - :dbcommand:`authSchemaUpgrade` command. + ``authSchemaUpgrade`` command. - heading: text: Sharded cluster ``authSchemaUpgrade`` consideration. character: "'" pre: | - For a sharded cluster, :dbcommand:`authSchemaUpgrade` will + For a sharded cluster, ``authSchemaUpgrade`` will upgrade the authorization data of the shards as well and the upgrade is complete. You can, however, override this behavior by including ``upgradeShards: false`` in the command, as in the @@ -42,7 +42,7 @@ action: upgradeShards: false }); post: | If you override the behavior, after running - :dbcommand:`authSchemaUpgrade` on a :binary:`~bin.mongos` instance, + ``authSchemaUpgrade`` on a :binary:`~bin.mongos` instance, you will need to connect to the primary for each shard and repeat the upgrade process after upgrading on the :binary:`~bin.mongos`. diff --git a/source/includes/steps-3.0-upgrade-mongodb-cr-to-scram.yaml b/source/includes/steps-3.0-upgrade-mongodb-cr-to-scram.yaml index ed176b719a1..b0f6bab0e3e 100644 --- a/source/includes/steps-3.0-upgrade-mongodb-cr-to-scram.yaml +++ b/source/includes/steps-3.0-upgrade-mongodb-cr-to-scram.yaml @@ -28,11 +28,11 @@ action: db.adminCommand({authSchemaUpgrade: 1}); post: | In case of error, you may safely rerun the - :dbcommand:`authSchemaUpgrade` command. + ``authSchemaUpgrade`` command. - heading: Sharded cluster ``authSchemaUpgrade`` consideration. pre: | For a sharded cluster *without* :ref:`shard local users - `, :dbcommand:`authSchemaUpgrade` will, by + `, ``authSchemaUpgrade`` will, by default, upgrade the authorization data of the shards as well, completing the upgrade. @@ -46,7 +46,7 @@ action: ); post: | If you override the default behavior or your cluster has shard - local users, after running :dbcommand:`authSchemaUpgrade` on a + local users, after running ``authSchemaUpgrade`` on a :binary:`~bin.mongos` instance, you will need to connect to the primary for each shard and repeat the upgrade process after upgrading on the :binary:`~bin.mongos`. diff --git a/source/reference/privilege-actions.txt b/source/reference/privilege-actions.txt index 46dbf729082..42c3c714142 100644 --- a/source/reference/privilege-actions.txt +++ b/source/reference/privilege-actions.txt @@ -322,7 +322,7 @@ Deployment Management Actions .. authaction:: authSchemaUpgrade - User can perform the :dbcommand:`authSchemaUpgrade` command. Apply this + User can perform the ``authSchemaUpgrade`` command. Apply this action to the ``cluster`` resource. .. authaction:: cleanupOrphaned diff --git a/source/release-notes/3.0-changelog.txt b/source/release-notes/3.0-changelog.txt index 9bcd906ee3f..3e5e9e585b5 100644 --- a/source/release-notes/3.0-changelog.txt +++ b/source/release-notes/3.0-changelog.txt @@ -216,7 +216,7 @@ Internal Code and Testing Security ~~~~~~~~ -- :issue:`SERVER-18475` \ :dbcommand:`authSchemaUpgrade` fails when the :data:`system.users ` contains non ``MONGODB-CR`` users +- :issue:`SERVER-18475` \ ``authSchemaUpgrade`` fails when the :data:`system.users ` contains non ``MONGODB-CR`` users - :issue:`SERVER-18312` Upgrade PCRE to latest Querying diff --git a/source/release-notes/3.0-downgrade.txt b/source/release-notes/3.0-downgrade.txt index bf3c35bbce3..7022381b20c 100644 --- a/source/release-notes/3.0-downgrade.txt +++ b/source/release-notes/3.0-downgrade.txt @@ -30,7 +30,7 @@ Downgrade Path .. important:: If you upgrade to MongoDB 3.0 and have run - :dbcommand:`authSchemaUpgrade`, you **cannot** downgrade to the 2.6 + ``authSchemaUpgrade``, you **cannot** downgrade to the 2.6 series without disabling ``--auth``. Procedures diff --git a/source/release-notes/3.0-scram.txt b/source/release-notes/3.0-scram.txt index 4183ffea526..52c9d2a408b 100644 --- a/source/release-notes/3.0-scram.txt +++ b/source/release-notes/3.0-scram.txt @@ -76,7 +76,7 @@ upgrade procedure to upgrade the cluster's authentication data. By default, the procedure will upgrade the authentication data of the shards as well. -To override this behavior, run :dbcommand:`authSchemaUpgrade` with the +To override this behavior, run ``authSchemaUpgrade`` with the ``upgradeShards: false`` option. If you choose to override, you must run the upgrade procedure on the :binary:`~bin.mongos` first, and then run the procedure on the :term:`primary` members of diff --git a/source/release-notes/3.0-upgrade.txt b/source/release-notes/3.0-upgrade.txt index 5eaa5efeeb3..e6a35abb796 100644 --- a/source/release-notes/3.0-upgrade.txt +++ b/source/release-notes/3.0-upgrade.txt @@ -64,9 +64,9 @@ Downgrade Limitations .. include:: /includes/fact-3.0-downgrade-path.rst -If you upgrade to 3.0 and have run :dbcommand:`authSchemaUpgrade`, you +If you upgrade to 3.0 and have run ``authSchemaUpgrade``, you **cannot** downgrade to 2.6 without disabling ``--auth`` or -restoring a pre-upgrade backup, as :dbcommand:`authSchemaUpgrade` +restoring a pre-upgrade backup, as ``authSchemaUpgrade`` discards the ``MONGODB-CR`` credentials used in 2.6. See :ref:`3.0-upgrade-auth-schema`. From a738002b78ec803c3531519d7f587c6a216eac12 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 12:46:06 -0400 Subject: [PATCH 29/96] unlink removed cmd cloneCollection --- source/release-notes/4.2-compatibility.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/4.2-compatibility.txt b/source/release-notes/4.2-compatibility.txt index 401b5a65d11..77e3dd26fb6 100644 --- a/source/release-notes/4.2-compatibility.txt +++ b/source/release-notes/4.2-compatibility.txt @@ -210,7 +210,7 @@ Starting in version 4.2, MongoDB removes the deprecated Deprecate Support for ``cloneCollection`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -MongoDB deprecates the :dbcommand:`cloneCollection` command and its +MongoDB deprecates the ``cloneCollection`` command and its :binary:`~bin.mongo` shell helper :method:`db.cloneCollection()` As alternatives, From b927b4eb38b0aecfbc3577eb6a64725edb41027c Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 12:47:22 -0400 Subject: [PATCH 30/96] unlink removed cmd closeAllDatabases --- source/reference/privilege-actions.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/privilege-actions.txt b/source/reference/privilege-actions.txt index 42c3c714142..496b913c6f0 100644 --- a/source/reference/privilege-actions.txt +++ b/source/reference/privilege-actions.txt @@ -578,7 +578,7 @@ Server Administration Actions .. authaction:: closeAllDatabases - User can perform the :dbcommand:`closeAllDatabases` command. Apply this + User can perform the deprecated ``closeAllDatabases`` command. Apply this action to the ``cluster`` resource. .. authaction:: collMod From a1490b9f29a78e3ca5b6e8be905a52d9baf6f4d3 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 12:49:03 -0400 Subject: [PATCH 31/96] unlink removed cmd copydb --- source/release-notes/4.0-compatibility.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/4.0-compatibility.txt b/source/release-notes/4.0-compatibility.txt index 87bd02565b2..0cf02c650d4 100644 --- a/source/release-notes/4.0-compatibility.txt +++ b/source/release-notes/4.0-compatibility.txt @@ -52,7 +52,7 @@ The method :method:`db.copyDatabase()` cannot copy from a :binary:`~bin.mongod` instance that enforces ``MONGODB-CR`` authentication. -The command :dbcommand:`copydb` cannot copy from a +The command ``copydb`` cannot copy from a :binary:`~bin.mongod` instance that enforces ``MONGODB-CR`` authentication. In conjunction with this change, MongoDB 4.0 removes the ``copydbgetnonce`` command. From 8217baf58e5cfbdd52c2facb96fcad13aadd36db Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 12:59:11 -0400 Subject: [PATCH 32/96] unlink removed cmd createIndex .. which isn't createIndexes --- source/release-notes/2.6-changelog.txt | 2 +- source/release-notes/2.6.txt | 4 ++-- source/release-notes/3.0-changelog.txt | 2 +- source/release-notes/3.2.txt | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/source/release-notes/2.6-changelog.txt b/source/release-notes/2.6-changelog.txt index 33bd8adf958..5b3ca25d87e 100644 --- a/source/release-notes/2.6-changelog.txt +++ b/source/release-notes/2.6-changelog.txt @@ -45,7 +45,7 @@ Indexing - :issue:`SERVER-19559` Document growth of "key too large" document makes it disappear from the index - :issue:`SERVER-16348` ``Assertion failure n >= 0 && n < static_cast(_files.size()) src/mongo/db/storage/extent_manager.cpp 109`` -- :issue:`SERVER-13875` \ :method:`~db.collection.ensureIndex()` of ``2dsphere`` index breaks after upgrading to 2.6 (with the new :dbcommand:`createIndex` command) +- :issue:`SERVER-13875` \ :method:`~db.collection.ensureIndex()` of ``2dsphere`` index breaks after upgrading to 2.6 (with the new ``createIndex`` command) Networking ~~~~~~~~~~ diff --git a/source/release-notes/2.6.txt b/source/release-notes/2.6.txt index 0af8870abb0..7e0f1402ad7 100644 --- a/source/release-notes/2.6.txt +++ b/source/release-notes/2.6.txt @@ -472,10 +472,10 @@ Index Build Enhancements command-line option. - :method:`~db.collection.ensureIndex()` now wraps a new - :dbcommand:`createIndex` command. + ``createIndex`` command. - The ``dropDups`` option to :method:`~db.collection.ensureIndex()` - and :dbcommand:`createIndex` is deprecated. + and ``createIndex`` is deprecated. .. seealso:: :ref:`2.6-index-key-length-incompatibility` diff --git a/source/release-notes/3.0-changelog.txt b/source/release-notes/3.0-changelog.txt index 3e5e9e585b5..331726fac43 100644 --- a/source/release-notes/3.0-changelog.txt +++ b/source/release-notes/3.0-changelog.txt @@ -225,7 +225,7 @@ Querying - :issue:`SERVER-18364` Ensure non-negation predicates get chosen over negation predicates for multikey index bounds construction - :issue:`SERVER-16265` Add query details to getmore entry in profiler and :method:`db.currentOp()` - :issue:`SERVER-15225` ``CachedPlanStage`` should execute for trial period and re-plan if query performs poorly -- :issue:`SERVER-13875` \ :method:`~db.collection.ensureIndex()` of ``2dsphere`` index breaks after upgrading to 2.6 (with the new :dbcommand:`createIndex` command) +- :issue:`SERVER-13875` \ :method:`~db.collection.ensureIndex()` of ``2dsphere`` index breaks after upgrading to 2.6 (with the new ``createIndex`` command) Replication ~~~~~~~~~~~ diff --git a/source/release-notes/3.2.txt b/source/release-notes/3.2.txt index 509e1d08a8e..243882896ea 100644 --- a/source/release-notes/3.2.txt +++ b/source/release-notes/3.2.txt @@ -209,7 +209,7 @@ Issues fixed: if they can see a healthy primary of equal or greater priority to the candidate. -- :issue:`SERVER-25012`: :dbcommand:`createIndex` blocks for duration +- :issue:`SERVER-25012`: ``createIndex`` blocks for duration of checkpoint while holding locks. - :issue:`SERVER-25865`: :pipeline:`$group` operation is slow on From dcf60430bc6f4d7b22e93a31223e474cd77d9bc9 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:00:48 -0400 Subject: [PATCH 33/96] fix cmd getLastError --- source/reference/command/getLastError.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/command/getLastError.txt b/source/reference/command/getLastError.txt index 120fcf26855..f913160d29a 100644 --- a/source/reference/command/getLastError.txt +++ b/source/reference/command/getLastError.txt @@ -96,7 +96,7 @@ Definition Output ------ -Each :dbcommand:`~db.collection.getLastError()` command returns a document containing a +Each :dbcommand:`getLastError` command returns a document containing a subset of the fields listed below. .. data:: getLastError.ok From b58d2d7d4457b83ad8c7ba91033cb899ceda1fee Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:01:39 -0400 Subject: [PATCH 34/96] fix cmd dbHash capitalization --- source/release-notes/2.4.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/2.4.txt b/source/release-notes/2.4.txt index 6a01cc23b61..c374763abfe 100644 --- a/source/release-notes/2.4.txt +++ b/source/release-notes/2.4.txt @@ -113,7 +113,7 @@ Minor Releases - Increase future compatibility for 2.6 authorization features :issue:`SERVER-11478`. -- Fix :dbcommand:`dbhash` cache issue for config servers +- Fix :dbcommand:`dbHash` cache issue for config servers :issue:`SERVER-11421`. - `All 2.4.8 improvements `_. From 9b0dac3e1446b9cb005730def64276b7d81d7357 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:04:47 -0400 Subject: [PATCH 35/96] unlink removed cmd eval --- source/release-notes/2.4.txt | 2 +- source/release-notes/3.0-compatibility.txt | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/release-notes/2.4.txt b/source/release-notes/2.4.txt index c374763abfe..83ff75d7fdd 100644 --- a/source/release-notes/2.4.txt +++ b/source/release-notes/2.4.txt @@ -330,7 +330,7 @@ provides improved concurrency for JavaScript operations, modernized JavaScript implementation, and the removal of non-standard SpiderMonkey features, and affects all JavaScript behavior including the commands :dbcommand:`mapReduce`, :v2.4:`group `, and -:dbcommand:`eval` and the query operator :query:`$where`. +``eval`` and the query operator :query:`$where`. See :doc:`/release-notes/2.4-javascript` for more information about all changes . diff --git a/source/release-notes/3.0-compatibility.txt b/source/release-notes/3.0-compatibility.txt index f84da7c86ef..02d18777648 100644 --- a/source/release-notes/3.0-compatibility.txt +++ b/source/release-notes/3.0-compatibility.txt @@ -539,11 +539,11 @@ The following commands and methods are deprecated in MongoDB 3.0: - :dbcommand:`diagLogging` -- :dbcommand:`eval`, :method:`db.eval()` +- ``eval``, :method:`db.eval()` - :method:`db.collection.copyTo()` -In addition, you cannot use the now deprecated :dbcommand:`eval` +In addition, you cannot use the now deprecated ``eval`` command or the :method:`db.eval()` method to invoke :dbcommand:`mapReduce` or :method:`db.collection.mapReduce()`. From 77121767b4ba5520ff3825a8b4cb72ac61527299 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:06:08 -0400 Subject: [PATCH 36/96] fix cmd findAndModify capitalization --- source/reference/command/currentOp.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/command/currentOp.txt b/source/reference/command/currentOp.txt index 3275c267be0..336f4cca5c6 100644 --- a/source/reference/command/currentOp.txt +++ b/source/reference/command/currentOp.txt @@ -732,7 +732,7 @@ Output Fields ``"command"`` operations include most :doc:`commands ` such as the - :dbcommand:`createIndexes` and :dbcommand:`findandmodify`. + :dbcommand:`createIndexes` and :dbcommand:`findAndModify`. .. data:: currentOp.ns From f016ca453669e20f07eb6ba03a0adafdaa0a1a12 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:06:36 -0400 Subject: [PATCH 37/96] fix cmd findAndModify capitalization - another instance --- source/reference/operator/aggregation/currentOp.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/operator/aggregation/currentOp.txt b/source/reference/operator/aggregation/currentOp.txt index 86ecbe49fe8..fa0cc5297b2 100644 --- a/source/reference/operator/aggregation/currentOp.txt +++ b/source/reference/operator/aggregation/currentOp.txt @@ -1200,7 +1200,7 @@ relevant for the operation: ``"command"`` operations include most :doc:`commands ` such as the - :dbcommand:`createIndexes`, :dbcommand:`aggregate`, and :dbcommand:`findandmodify`. + :dbcommand:`createIndexes`, :dbcommand:`aggregate`, and :dbcommand:`findAndModify`. ``"query"`` operations include :dbcommand:`find` operations and OP_QUERY operations. From 71bfbc265f3f708995b3c539dd803636bd81b195 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:08:10 -0400 Subject: [PATCH 38/96] fix cmd getCollectionInfos to method --- source/reference/method/db.getCollectionInfos.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/method/db.getCollectionInfos.txt b/source/reference/method/db.getCollectionInfos.txt index d7808639117..ca8cb11b17e 100644 --- a/source/reference/method/db.getCollectionInfos.txt +++ b/source/reference/method/db.getCollectionInfos.txt @@ -296,7 +296,7 @@ collection information for the ``employees`` collection in the ] You can specify a filter on any of the fields returned by -:dbcommand:`getCollectionInfos`. +:method:`db.getCollectionInfos()`. For example, the following command returns information for all collections in the ``example`` database where ``info.readOnly`` is From e0396a644b66aaf0d9e84b90d08a278e572b5255 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:09:12 -0400 Subject: [PATCH 39/96] fix cmd getLastError.waited to data --- source/reference/command/getLastError.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/command/getLastError.txt b/source/reference/command/getLastError.txt index f913160d29a..0efeb6f7a91 100644 --- a/source/reference/command/getLastError.txt +++ b/source/reference/command/getLastError.txt @@ -227,7 +227,7 @@ subset of the fields listed below. :data:`getLastError.wtime` is the number of milliseconds spent waiting for the preceding operation to complete. If :dbcommand:`getLastError` timed out, :data:`~getLastError.wtime` and - :dbcommand:`getLastError.waited` are equal. + :data:`~getLastError.waited` are equal. .. data:: getLastError.writtenTo From 17a46d424bb3fb39a9c2cba308ef1c7e8a1df07d Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:10:07 -0400 Subject: [PATCH 40/96] fix cmd getParameters to singular --- source/reference/command/getParameter.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/command/getParameter.txt b/source/reference/command/getParameter.txt index 71828d9ed35..59c50203793 100644 --- a/source/reference/command/getParameter.txt +++ b/source/reference/command/getParameter.txt @@ -47,7 +47,7 @@ getParameter - Specify a value of: - ``'*'`` to return all parameters available to - :dbcommand:`getParameters`, ignoring the ```` field. + :dbcommand:`getParameter`, ignoring the ```` field. - any numerical value to return the value for the specified ````. From 7a73ffde8cac68108264636429ed63eed62978fe Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:11:01 -0400 Subject: [PATCH 41/96] unlink removed cmd indexStats --- source/reference/privilege-actions.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/privilege-actions.txt b/source/reference/privilege-actions.txt index 496b913c6f0..c48b23dd4c8 100644 --- a/source/reference/privilege-actions.txt +++ b/source/reference/privilege-actions.txt @@ -783,11 +783,11 @@ Diagnostic Actions .. authaction:: indexStats - User can perform the :dbcommand:`indexStats` command. Apply this action + User can perform the ``indexStats`` command. Apply this action to database or collection resources. .. versionchanged:: 3.0 - MongoDB 3.0 removes the :dbcommand:`indexStats` command. + MongoDB 3.0 removes the ``indexStats`` command. .. authaction:: listDatabases From cf72029e7268c9c9b822d9451982402e76ec6e46 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:12:25 -0400 Subject: [PATCH 42/96] fix cmd isSelf to include underscore --- source/reference/command.txt | 2 +- source/reference/command/nav-diagnostic.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/command.txt b/source/reference/command.txt index 7a5e9ca2e17..a4088485a70 100644 --- a/source/reference/command.txt +++ b/source/reference/command.txt @@ -772,7 +772,7 @@ Diagnostic Commands - Returns data that reflects the underlying host system. - * - :dbcommand:`isSelf` + * - :dbcommand:`_isSelf` - Internal command to support testing. diff --git a/source/reference/command/nav-diagnostic.txt b/source/reference/command/nav-diagnostic.txt index 8c70ff8ca6e..cedce19eb18 100644 --- a/source/reference/command/nav-diagnostic.txt +++ b/source/reference/command/nav-diagnostic.txt @@ -81,7 +81,7 @@ Diagnostic Commands - Returns data that reflects the underlying host system. - * - :dbcommand:`isSelf` + * - :dbcommand:`_isSelf` - Internal command to support testing. From 106331b07ffb36f4bc6f1ec85cc3ac573a038a29 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:14:51 -0400 Subject: [PATCH 43/96] fix cmd listCollection to plural --- source/includes/extracts-listCollections-auth.yaml | 4 ++-- source/reference/command/listCollections.txt | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/includes/extracts-listCollections-auth.yaml b/source/includes/extracts-listCollections-auth.yaml index 4416c708e73..570f5364df6 100644 --- a/source/includes/extracts-listCollections-auth.yaml +++ b/source/includes/extracts-listCollections-auth.yaml @@ -12,7 +12,7 @@ content: | { resource: { db: "test", collection: "" }, actions: [ "listCollections" ] } The built-in role :authrole:`read` provides the privilege to run - :dbcommand:`listCollection` for a specific database. + :dbcommand:`listCollections` for a specific database. Starting in version 4.0, however, user without the required privilege can run the command with **both** ``authorizedCollections`` and @@ -68,7 +68,7 @@ content: | ``authorizedCollections`` and ``nameOnly`` options, - A user must have the required access to run - :dbcommand:`listCollection`. + :dbcommand:`listCollections`. - If a user does not have required access and runs ``show collections``, MongoDB uses the diff --git a/source/reference/command/listCollections.txt b/source/reference/command/listCollections.txt index 0c33897087d..cda79cd5d00 100644 --- a/source/reference/command/listCollections.txt +++ b/source/reference/command/listCollections.txt @@ -135,7 +135,7 @@ Locks .. versionchanged:: 4.0 -The :dbcommand:`listCollection` command takes Intent Shared lock on the +The :dbcommand:`listCollections` command takes Intent Shared lock on the database. In previous versions, the command takes Shared lock on the database. From ad487d8d0e4aa94a36f108367ed7ea10ca2e3c54 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:15:28 -0400 Subject: [PATCH 44/96] fix cmd listDatabase to plural --- source/core/sharded-cluster-shards.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/core/sharded-cluster-shards.txt b/source/core/sharded-cluster-shards.txt index 0056198af27..c4d852e3253 100644 --- a/source/core/sharded-cluster-shards.txt +++ b/source/core/sharded-cluster-shards.txt @@ -42,7 +42,7 @@ replica set. The :binary:`~bin.mongos` selects the primary shard when creating a new database by picking the shard in the cluster that has the least amount of data. :binary:`~bin.mongos` uses the ``totalSize`` field returned by the -:dbcommand:`listDatabase` command as a part of the selection criteria. +:dbcommand:`listDatabases` command as a part of the selection criteria. .. include:: /images/sharded-cluster-primary-shard.rst From 347b47fc7fbaa5c379d2724dfc2fbf5407e829f9 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:16:29 -0400 Subject: [PATCH 45/96] fix cmd mongod to binary --- source/release-notes/2.6-changelog.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/2.6-changelog.txt b/source/release-notes/2.6-changelog.txt index 5b3ca25d87e..a661df478de 100644 --- a/source/release-notes/2.6-changelog.txt +++ b/source/release-notes/2.6-changelog.txt @@ -326,7 +326,7 @@ Querying Replication ~~~~~~~~~~~ -- :issue:`SERVER-16107` 2.6 :dbcommand:`mongod` crashes with segfault when added to a 2.8 replica set with >= 12 nodes. +- :issue:`SERVER-16107` 2.6 :binary:`~bin.mongod` crashes with segfault when added to a 2.8 replica set with >= 12 nodes. - :issue:`SERVER-15994` ``listIndexes`` and ``listCollections`` can be run on secondaries without slaveOk bit - :issue:`SERVER-15849` do not forward replication progress for nodes that are no longer part of a replica set - :issue:`SERVER-15491` ``SyncSourceFeedback`` can crash due to a ``SocketException`` in ``authenticateInternalUser`` From f0d53fa480713a1d30ec2ee257e482288c4e613a Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:18:04 -0400 Subject: [PATCH 46/96] unlink removed cmd planCacheListPlans --- source/core/query-plans.txt | 2 +- source/includes/extracts-4.2-changes.yaml | 2 +- source/release-notes/3.6.txt | 2 +- source/release-notes/4.2-compatibility.txt | 2 +- source/release-notes/4.2.txt | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/source/core/query-plans.txt b/source/core/query-plans.txt index 5b78756cd38..3096a26d6d1 100644 --- a/source/core/query-plans.txt +++ b/source/core/query-plans.txt @@ -205,7 +205,7 @@ The ``queryHash`` and ``planCacheKey`` are available in: method/:dbcommand:`planCacheListQueryShapes` command - :method:`PlanCache.getPlansByQuery()` - method/:dbcommand:`planCacheListPlans` command + method/``planCacheListPlans`` command .. _index-filters: diff --git a/source/includes/extracts-4.2-changes.yaml b/source/includes/extracts-4.2-changes.yaml index bb13f3e80d5..18b69ebdf3b 100644 --- a/source/includes/extracts-4.2-changes.yaml +++ b/source/includes/extracts-4.2-changes.yaml @@ -190,7 +190,7 @@ content: | the following methods and commands, which have been deprecated in 4.2: - :method:`PlanCache.getPlansByQuery()` - method/:dbcommand:`planCacheListPlans` command, and + method/``planCacheListPlans`` command, and - :method:`PlanCache.listQueryShapes()` diff --git a/source/release-notes/3.6.txt b/source/release-notes/3.6.txt index 430a33ee458..497075155a2 100644 --- a/source/release-notes/3.6.txt +++ b/source/release-notes/3.6.txt @@ -1114,7 +1114,7 @@ MongoDB 3.6 includes the following enhancements: of a database, which indicates the maximum number of write operations permitted in a write batch, raises from ``1,000`` to ``100,000``. -- The :dbcommand:`planCacheListPlans` database command produces the same +- The ``planCacheListPlans`` database command produces the same output as the :method:`PlanCache.getPlansByQuery()` shell method. The output from both operations now includes a timestamp for when the plans were generated. diff --git a/source/release-notes/4.2-compatibility.txt b/source/release-notes/4.2-compatibility.txt index 77e3dd26fb6..67cc64edea2 100644 --- a/source/release-notes/4.2-compatibility.txt +++ b/source/release-notes/4.2-compatibility.txt @@ -232,7 +232,7 @@ Deprecated Plan Cache Commands/Methods MongoDB deprecates the following: - :method:`PlanCache.getPlansByQuery()` - method/:dbcommand:`planCacheListPlans` command. + method/``planCacheListPlans`` command. | To get the cached query plans for a shape, use the :pipeline:`$planCacheStats` aggregation stage instead. See diff --git a/source/release-notes/4.2.txt b/source/release-notes/4.2.txt index 519473aec5d..ee9dec23b44 100644 --- a/source/release-notes/4.2.txt +++ b/source/release-notes/4.2.txt @@ -1702,7 +1702,7 @@ about the query plan cache: method/:dbcommand:`planCacheListQueryShapes` command (*Deprecated in MongoDB 4.2*) - :method:`PlanCache.getPlansByQuery()` - method/:dbcommand:`planCacheListPlans` command (*Deprecated in MongoDB 4.2*) + method/``planCacheListPlans`` command (*Deprecated in MongoDB 4.2*) .. seealso:: :ref:`4.2-deprecated-plan-cache` From 37d511292fb4b83ffa4ffbf1ddeabbca308562fb Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:19:24 -0400 Subject: [PATCH 47/96] unlink removed cmd planCacheListQueryShapes --- source/core/query-plans.txt | 2 +- source/includes/extracts-4.2-changes.yaml | 2 +- source/release-notes/4.2-compatibility.txt | 2 +- source/release-notes/4.2.txt | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/core/query-plans.txt b/source/core/query-plans.txt index 3096a26d6d1..03e68291713 100644 --- a/source/core/query-plans.txt +++ b/source/core/query-plans.txt @@ -202,7 +202,7 @@ The ``queryHash`` and ``planCacheKey`` are available in: - :pipeline:`$planCacheStats` aggregation stage (*New in MongoDB 4.2*) - :method:`PlanCache.listQueryShapes()` - method/:dbcommand:`planCacheListQueryShapes` command + method/``planCacheListQueryShapes`` command - :method:`PlanCache.getPlansByQuery()` method/``planCacheListPlans`` command diff --git a/source/includes/extracts-4.2-changes.yaml b/source/includes/extracts-4.2-changes.yaml index 18b69ebdf3b..7be4f8533e3 100644 --- a/source/includes/extracts-4.2-changes.yaml +++ b/source/includes/extracts-4.2-changes.yaml @@ -194,7 +194,7 @@ content: | - :method:`PlanCache.listQueryShapes()` - method/:dbcommand:`planCacheListQueryShapes` command. + method/``planCacheListQueryShapes`` command. --- ref: 4.2-changes-options-tls-ssl diff --git a/source/release-notes/4.2-compatibility.txt b/source/release-notes/4.2-compatibility.txt index 67cc64edea2..8c4001ad788 100644 --- a/source/release-notes/4.2-compatibility.txt +++ b/source/release-notes/4.2-compatibility.txt @@ -239,7 +239,7 @@ MongoDB deprecates the following: :ref:`planCacheStats-cache-entry-for-query-shape`. - :method:`PlanCache.listQueryShapes()` - method/:dbcommand:`planCacheListQueryShapes` command. + method/``planCacheListQueryShapes`` command. | To list the cached query shapes, use the :pipeline:`$planCacheStats` aggregation stage instead. See diff --git a/source/release-notes/4.2.txt b/source/release-notes/4.2.txt index ee9dec23b44..667a6edb998 100644 --- a/source/release-notes/4.2.txt +++ b/source/release-notes/4.2.txt @@ -1699,7 +1699,7 @@ about the query plan cache: - :pipeline:`$planCacheStats` aggregation stage (*New in MongoDB 4.2*) - :method:`PlanCache.listQueryShapes()` - method/:dbcommand:`planCacheListQueryShapes` command (*Deprecated in MongoDB 4.2*) + method/``planCacheListQueryShapes`` command (*Deprecated in MongoDB 4.2*) - :method:`PlanCache.getPlansByQuery()` method/``planCacheListPlans`` command (*Deprecated in MongoDB 4.2*) From 53523af5f6cb51f014f4172e6a3f71a0eeaf1e03 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:28:36 -0400 Subject: [PATCH 48/96] unlink removed cmd repairDatabase --- source/release-notes/2.6-compatibility.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/release-notes/2.6-compatibility.txt b/source/release-notes/2.6-compatibility.txt index 4e0f35699e4..d3c8ab25eed 100644 --- a/source/release-notes/2.6-compatibility.txt +++ b/source/release-notes/2.6-compatibility.txt @@ -36,11 +36,11 @@ Description such documents. - Because :method:`db.collection.reIndex()`, :dbcommand:`compact`, - and :dbcommand:`repairDatabase` drop *all* the indexes from a + and ``repairDatabase`` drop *all* the indexes from a collection and then recreate them sequentially, the error from the index key limit prevents these operations from rebuilding any remaining indexes for the collection and, in the case of the - :dbcommand:`repairDatabase` command, from continuing with the + ``repairDatabase`` command, from continuing with the remainder of the process. Inserts will error: @@ -118,7 +118,7 @@ Description with an invalid or empty key name. - :method:`db.collection.reIndex()`, :dbcommand:`compact`, and - :dbcommand:`repairDatabase` will error if an index exists with an + ``repairDatabase`` will error if an index exists with an invalid or empty key name. - Chunk migration will fail if an index exists with an From 5cc6c1d19239054f907f0bfa8f86ba9593801768 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:30:49 -0400 Subject: [PATCH 49/96] unlink removed cmd replSetHeartbeat --- source/reference/privilege-actions.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/privilege-actions.txt b/source/reference/privilege-actions.txt index c48b23dd4c8..97fc5855a4d 100644 --- a/source/reference/privilege-actions.txt +++ b/source/reference/privilege-actions.txt @@ -419,7 +419,7 @@ Replication Actions .. authaction:: replSetHeartbeat - User can perform the :dbcommand:`replSetHeartbeat` command. Apply this + User can perform the deprecated ``replSetHeartbeat`` command. Apply this action to the ``cluster`` resource. .. authaction:: replSetStateChange From 0afdda49f6176c4068f13e150bab67d5813c5fcf Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:32:22 -0400 Subject: [PATCH 50/96] fix typo cmd replSetInitiate --- source/reference/replica-configuration.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/replica-configuration.txt b/source/reference/replica-configuration.txt index 5e8c480de76..2010eb56edc 100644 --- a/source/reference/replica-configuration.txt +++ b/source/reference/replica-configuration.txt @@ -652,5 +652,5 @@ Replica Set Configuration Fields The ObjectId associated with the replica set and automatically created during :method:`rs.initiate()` or - :dbcommand:`replSetInitate`. You cannot change the + :dbcommand:`replSetInitiate`. You cannot change the :rsconf:`~settings.replicaSetId`. From 45152781b58b674f2d8c9e6d3ec43afc72c3aeb9 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:35:07 -0400 Subject: [PATCH 51/96] unlink removed cmd restoreDatabase --- source/release-notes/2.6.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/2.6.txt b/source/release-notes/2.6.txt index 7e0f1402ad7..083f496bd2a 100644 --- a/source/release-notes/2.6.txt +++ b/source/release-notes/2.6.txt @@ -527,7 +527,7 @@ To use the previous *exact-fit allocation strategy*: created by the :binary:`~bin.mongorestore` and :binary:`~bin.mongoimport` tools, by running :binary:`~bin.mongod` with the :option:`--repair ` option, as well as the - :dbcommand:`restoreDatabase` command. + deprecated ``restoreDatabase`` command. See :v2.6:`/core/storage` for more information about MongoDB's storage system. From 6fa8bc9994648d1ed3632d3aa750e3f8aaa7f1c9 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:46:12 -0400 Subject: [PATCH 52/96] unlink removed cmd resync --- source/reference/privilege-actions.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/privilege-actions.txt b/source/reference/privilege-actions.txt index 97fc5855a4d..72bc8ab0e41 100644 --- a/source/reference/privilege-actions.txt +++ b/source/reference/privilege-actions.txt @@ -431,7 +431,7 @@ Replication Actions .. authaction:: resync - User can perform the :dbcommand:`resync` command. Apply this action to + User can perform the deprecated ``resync`` command. Apply this action to the ``cluster`` resource. Sharding Actions From b4113463ce5e84aab5202138c5266301cd56497f Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:47:07 -0400 Subject: [PATCH 53/96] fix cmd setParameters to singular --- source/release-notes/3.0-changelog.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/3.0-changelog.txt b/source/release-notes/3.0-changelog.txt index 331726fac43..5ec7b562d2f 100644 --- a/source/release-notes/3.0-changelog.txt +++ b/source/release-notes/3.0-changelog.txt @@ -403,7 +403,7 @@ Build and Packaging - :issue:`SERVER-18082` Change ``smoke.py`` buildlogger command line options to environment variables - :issue:`SERVER-17730` Parsing of Variables on Windows doesn't respect windows conventions - :issue:`SERVER-17694` support ``RPATH=value`` in top-level ``SConstruct`` -- :issue:`SERVER-17465` ``--use-system-tcmalloc`` does not support ``tcmalloc`` :dbcommand:`setParameters` and extension +- :issue:`SERVER-17465` ``--use-system-tcmalloc`` does not support ``tcmalloc`` :dbcommand:`setParameter` and extension - :issue:`SERVER-17961` ``THIRD-PARTY-NOTICES.windows`` needs to be updated - :issue:`SERVER-17780` Init script sets process ulimit to different value compared to documentation From f4abf8a9b80b393acbc8bbbd4730e161ef46acfc Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:49:26 -0400 Subject: [PATCH 54/96] fix cmd splitAt to method --- source/reference/command/split.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/command/split.txt b/source/reference/command/split.txt index 58c8e2ee8bf..9980811e0af 100644 --- a/source/reference/command/split.txt +++ b/source/reference/command/split.txt @@ -105,7 +105,7 @@ the command cannot use the ``find`` or the ``bounds`` option to split an empty chunk since an empty chunk has no median. To create splits in empty chunks, use either the ``middle`` option with -the :dbcommand:`split` command or use the :dbcommand:`splitAt` command. +the :dbcommand:`split` command or use the :method:`sh.splitAt()` command. Command Formats --------------- From e3c6f79d47adc1586c1622739f3bad1b1c6fbf27 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:50:51 -0400 Subject: [PATCH 55/96] fix cmd stats to method --- source/reference/command/replSetResizeOplog.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/command/replSetResizeOplog.txt b/source/reference/command/replSetResizeOplog.txt index 450c81025ce..4ecbef857cd 100644 --- a/source/reference/command/replSetResizeOplog.txt +++ b/source/reference/command/replSetResizeOplog.txt @@ -252,7 +252,7 @@ oplog size of this member to 16384 megabytes: db.adminCommand({ "replSetResizeOplog": 1, size: 16384}) -To verify the new oplog size, rerun the :dbcommand:`stats` command: +To verify the new oplog size, rerun the :method:`db.collection.stats()` method: .. code-block:: javascript From 243ae04198904e30a20ad3568102293d05bc8a2e Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:51:48 -0400 Subject: [PATCH 56/96] unlink removed cmd storageDetails --- source/reference/privilege-actions.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/privilege-actions.txt b/source/reference/privilege-actions.txt index 72bc8ab0e41..6f9cac52ed8 100644 --- a/source/reference/privilege-actions.txt +++ b/source/reference/privilege-actions.txt @@ -378,7 +378,7 @@ Deployment Management Actions .. authaction:: storageDetails - User can perform the :dbcommand:`storageDetails` command. Apply this + User can perform the deprecated ``storageDetails`` command. Apply this action to database or collection resources. Change Stream Actions From 5ef6027412126678b43d37c1b7e247f03ed5f050 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:52:20 -0400 Subject: [PATCH 57/96] unlink removed cmd text --- source/release-notes/2.6.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/2.6.txt b/source/release-notes/2.6.txt index 083f496bd2a..63f4df822be 100644 --- a/source/release-notes/2.6.txt +++ b/source/release-notes/2.6.txt @@ -298,7 +298,7 @@ the aggregation pipeline :pipeline:`$match` stage, includes the :query:`$text` operator, which resolves text-search queries. MongoDB 2.6 includes an updated :doc:`text index -` format and deprecates the :dbcommand:`text` +` format and deprecates the ``text`` command. .. _rel-notes-data-modification: From 4b6590bd242461ca33c2243b7c9fe387a6d3e737 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 13:54:41 -0400 Subject: [PATCH 58/96] unlink removed cmd touch --- source/reference/privilege-actions.txt | 2 +- source/release-notes/2.2.txt | 4 ++-- source/release-notes/3.0-compatibility.txt | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/source/reference/privilege-actions.txt b/source/reference/privilege-actions.txt index 6f9cac52ed8..d7dbb5c6955 100644 --- a/source/reference/privilege-actions.txt +++ b/source/reference/privilege-actions.txt @@ -689,7 +689,7 @@ Server Administration Actions .. authaction:: touch - User can perform the :dbcommand:`touch` command. Apply this action to + User can perform the deprecated ``touch`` command. Apply this action to the ``cluster`` resource. Session Actions diff --git a/source/release-notes/2.2.txt b/source/release-notes/2.2.txt index 4b7a616aa7b..9fb66706c0e 100644 --- a/source/release-notes/2.2.txt +++ b/source/release-notes/2.2.txt @@ -582,9 +582,9 @@ and :option:`mongos --syslog` command line-options. ``touch`` Command ````````````````` -Added the :dbcommand:`touch` command to read the data and/or indexes +Added the ``touch`` command to read the data and/or indexes from a collection into memory. See: :issue:`SERVER-2023` and -:dbcommand:`touch` for more information. +``touch`` for more information. ``indexCounters`` No Longer Report Sampled Data ``````````````````````````````````````````````` diff --git a/source/release-notes/3.0-compatibility.txt b/source/release-notes/3.0-compatibility.txt index 02d18777648..ee2ab85e6b4 100644 --- a/source/release-notes/3.0-compatibility.txt +++ b/source/release-notes/3.0-compatibility.txt @@ -107,13 +107,13 @@ consistency for the purposes of creating backups. Support for ``touch`` Command ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If a storage engine does not support the :dbcommand:`touch`, then the -:dbcommand:`touch` command will return an error. +If a storage engine does not support the ``touch``, then the +``touch`` command will return an error. -- The MMAPv1 storage engine supports :dbcommand:`touch`. +- The MMAPv1 storage engine supports ``touch``. - The WiredTiger storage engine *does not* support - :dbcommand:`touch`. + ``touch``. .. _3.0-compatiblity-record-alloc: From 19377f286d3db881c7a577781b5433b754011981 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:11:55 -0400 Subject: [PATCH 59/96] fix method Bulk.find.upsert() --- source/reference/method/Bulk.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/method/Bulk.txt b/source/reference/method/Bulk.txt index 32d641080c6..f8dbf7b629d 100644 --- a/source/reference/method/Bulk.txt +++ b/source/reference/method/Bulk.txt @@ -69,7 +69,7 @@ Transactions For :method:`Bulk.insert()` operations, the collection must already exist. -For :method:`Bulk.upsert()`, if the operation results in an +For :method:`Bulk.find.upsert()`, if the operation results in an upsert, the collection must already exist. .. include:: /includes/extracts/transactions-operations-write-concern.rst From 867e4879aaf010fc6d992a2125246b459eb1ebc9 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:16:22 -0400 Subject: [PATCH 60/96] fix method getKeyVault() malformed link --- source/reference/method/KeyVault.createKey.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/method/KeyVault.createKey.txt b/source/reference/method/KeyVault.createKey.txt index d52c7af87c8..7a744a5f3bf 100644 --- a/source/reference/method/KeyVault.createKey.txt +++ b/source/reference/method/KeyVault.createKey.txt @@ -121,7 +121,7 @@ appropriate for development and production environments, see .. include:: /includes/extracts/csfle-connection-boilerplate.rst -Retrieve the :method:`keyVault ` object and +Retrieve the :method:`keyVault ` object and use the :method:`KeyVault.createKey()` method to create a new data encryption key using the locally managed key: From f045ec70ab2a581b41d2a9688595bae6d7db03f6 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:17:52 -0400 Subject: [PATCH 61/96] unlink removed method PlanCache.getPlansByQuery() --- source/core/query-plans.txt | 2 +- source/includes/extracts-4.2-changes.yaml | 2 +- source/release-notes/3.6.txt | 2 +- source/release-notes/4.2-compatibility.txt | 2 +- source/release-notes/4.2.txt | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/source/core/query-plans.txt b/source/core/query-plans.txt index 03e68291713..e001d295979 100644 --- a/source/core/query-plans.txt +++ b/source/core/query-plans.txt @@ -204,7 +204,7 @@ The ``queryHash`` and ``planCacheKey`` are available in: - :method:`PlanCache.listQueryShapes()` method/``planCacheListQueryShapes`` command -- :method:`PlanCache.getPlansByQuery()` +- ``PlanCache.getPlansByQuery()`` method/``planCacheListPlans`` command .. _index-filters: diff --git a/source/includes/extracts-4.2-changes.yaml b/source/includes/extracts-4.2-changes.yaml index 7be4f8533e3..ea7bb6aea12 100644 --- a/source/includes/extracts-4.2-changes.yaml +++ b/source/includes/extracts-4.2-changes.yaml @@ -189,7 +189,7 @@ content: | The :pipeline:`$planCacheStats` aggregation stage is preferred over the following methods and commands, which have been deprecated in 4.2: - - :method:`PlanCache.getPlansByQuery()` + - ``PlanCache.getPlansByQuery()`` method/``planCacheListPlans`` command, and diff --git a/source/release-notes/3.6.txt b/source/release-notes/3.6.txt index 497075155a2..0f7e45a4820 100644 --- a/source/release-notes/3.6.txt +++ b/source/release-notes/3.6.txt @@ -1115,7 +1115,7 @@ MongoDB 3.6 includes the following enhancements: permitted in a write batch, raises from ``1,000`` to ``100,000``. - The ``planCacheListPlans`` database command produces the same - output as the :method:`PlanCache.getPlansByQuery()` shell method. The + output as the ``PlanCache.getPlansByQuery()`` shell method. The output from both operations now includes a timestamp for when the plans were generated. diff --git a/source/release-notes/4.2-compatibility.txt b/source/release-notes/4.2-compatibility.txt index 8c4001ad788..42297ccb567 100644 --- a/source/release-notes/4.2-compatibility.txt +++ b/source/release-notes/4.2-compatibility.txt @@ -231,7 +231,7 @@ Deprecated Plan Cache Commands/Methods MongoDB deprecates the following: -- :method:`PlanCache.getPlansByQuery()` +- ``PlanCache.getPlansByQuery()`` method/``planCacheListPlans`` command. | To get the cached query plans for a shape, use the diff --git a/source/release-notes/4.2.txt b/source/release-notes/4.2.txt index 667a6edb998..7e013d81d3b 100644 --- a/source/release-notes/4.2.txt +++ b/source/release-notes/4.2.txt @@ -1701,7 +1701,7 @@ about the query plan cache: - :method:`PlanCache.listQueryShapes()` method/``planCacheListQueryShapes`` command (*Deprecated in MongoDB 4.2*) -- :method:`PlanCache.getPlansByQuery()` +- ``PlanCache.getPlansByQuery()`` method/``planCacheListPlans`` command (*Deprecated in MongoDB 4.2*) .. seealso:: :ref:`4.2-deprecated-plan-cache` From 58ce5e6cd9bb361289f11aeb0394c2d9d732579e Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:18:25 -0400 Subject: [PATCH 62/96] unlink removed method PlanCache.listQueryShapes() --- source/core/query-plans.txt | 2 +- source/includes/extracts-4.2-changes.yaml | 2 +- source/reference/method/PlanCache.clearPlansByQuery.txt | 2 +- source/release-notes/4.2-compatibility.txt | 2 +- source/release-notes/4.2.txt | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/source/core/query-plans.txt b/source/core/query-plans.txt index e001d295979..424ea19a53e 100644 --- a/source/core/query-plans.txt +++ b/source/core/query-plans.txt @@ -201,7 +201,7 @@ The ``queryHash`` and ``planCacheKey`` are available in: - :pipeline:`$planCacheStats` aggregation stage (*New in MongoDB 4.2*) -- :method:`PlanCache.listQueryShapes()` +- ``PlanCache.listQueryShapes()`` method/``planCacheListQueryShapes`` command - ``PlanCache.getPlansByQuery()`` diff --git a/source/includes/extracts-4.2-changes.yaml b/source/includes/extracts-4.2-changes.yaml index ea7bb6aea12..56c7c257c51 100644 --- a/source/includes/extracts-4.2-changes.yaml +++ b/source/includes/extracts-4.2-changes.yaml @@ -193,7 +193,7 @@ content: | method/``planCacheListPlans`` command, and - - :method:`PlanCache.listQueryShapes()` + - ``PlanCache.listQueryShapes()`` method/``planCacheListQueryShapes`` command. --- diff --git a/source/reference/method/PlanCache.clearPlansByQuery.txt b/source/reference/method/PlanCache.clearPlansByQuery.txt index 49c7beedd14..dfbaa9d62c7 100644 --- a/source/reference/method/PlanCache.clearPlansByQuery.txt +++ b/source/reference/method/PlanCache.clearPlansByQuery.txt @@ -103,5 +103,5 @@ The following operation removes the query plan cached for the shape: .. seealso:: - :method:`db.collection.getPlanCache()` - - :method:`PlanCache.listQueryShapes()` + - ``PlanCache.listQueryShapes()`` - :method:`PlanCache.clear()` diff --git a/source/release-notes/4.2-compatibility.txt b/source/release-notes/4.2-compatibility.txt index 42297ccb567..11d8e459500 100644 --- a/source/release-notes/4.2-compatibility.txt +++ b/source/release-notes/4.2-compatibility.txt @@ -238,7 +238,7 @@ MongoDB deprecates the following: :pipeline:`$planCacheStats` aggregation stage instead. See :ref:`planCacheStats-cache-entry-for-query-shape`. -- :method:`PlanCache.listQueryShapes()` +- ``PlanCache.listQueryShapes()`` method/``planCacheListQueryShapes`` command. | To list the cached query shapes, use the diff --git a/source/release-notes/4.2.txt b/source/release-notes/4.2.txt index 7e013d81d3b..37b23ac09c9 100644 --- a/source/release-notes/4.2.txt +++ b/source/release-notes/4.2.txt @@ -1698,7 +1698,7 @@ about the query plan cache: - :pipeline:`$planCacheStats` aggregation stage (*New in MongoDB 4.2*) -- :method:`PlanCache.listQueryShapes()` +- ``PlanCache.listQueryShapes()`` method/``planCacheListQueryShapes`` command (*Deprecated in MongoDB 4.2*) - ``PlanCache.getPlansByQuery()`` From 7a79f96779561be59c0247276fa5ded004f56334 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:23:02 -0400 Subject: [PATCH 63/96] fix method Session.getOptions() malformed link --- source/reference/method/Mongo.startSession.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/reference/method/Mongo.startSession.txt b/source/reference/method/Mongo.startSession.txt index 4fdc9eb5d54..d4d06c2fc10 100644 --- a/source/reference/method/Mongo.startSession.txt +++ b/source/reference/method/Mongo.startSession.txt @@ -54,8 +54,8 @@ Definition - Document. Specifies the :ref:`read concern `. To modify the setting after starting a session, see - :method:`Sessions.getOptions().setReadConcern() - `. + :method:`Session.getOptions().setReadConcern() + `. * - readPreference @@ -69,8 +69,8 @@ Definition { mode: , tags: } To modify the setting after starting a session, see - :method:`Sessions.getOptions().setReadPreference() - `. + :method:`Session.getOptions().setReadPreference() + `. * - retryWrites @@ -89,8 +89,8 @@ Definition - Document. Specifies the :ref:`write concern `. To modify the setting after starting a session, see - :method:`Sessions.getOptions().setWriteConcern() - `. + :method:`Session.getOptions().setWriteConcern() + `. Examples -------- From b9ffbfb0718726ac2bd13990daa43da5ed0f9ac8 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:25:04 -0400 Subject: [PATCH 64/96] fix method db.collection.watch() malformed link --- source/changeStreams.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/changeStreams.txt b/source/changeStreams.txt index a91dc4ab805..52e0626e1a4 100644 --- a/source/changeStreams.txt +++ b/source/changeStreams.txt @@ -567,7 +567,7 @@ document. To return the most current majority-committed version of the updated document, pass ``"FullDocument = ChangeStreamFullDocumentOption.UpdateLookup"`` to the - ``collection.Watch()`` method. + :method:`db.collection.watch()` method. In the example below, all update operations notifications include a ``FullDocument`` field that represents the *current* @@ -585,7 +585,7 @@ document. To return the most current majority-committed version of the updated document, pass ``{ fullDocument: 'updateLookup' }`` to the - :method:`collection.watch()` method. + :method:`db.collection.watch()` method. In the example below, all update operations notifications include a ``fullDocument`` field that represents the *current* From c4a3931d73d1995ecf800a4aecca9ad1c17df494 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:26:22 -0400 Subject: [PATCH 65/96] fix method db.copyDatabase() malformed link --- source/reference/method/db.copyDatabase.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/method/db.copyDatabase.txt b/source/reference/method/db.copyDatabase.txt index 49a9e160664..9d61021122b 100644 --- a/source/reference/method/db.copyDatabase.txt +++ b/source/reference/method/db.copyDatabase.txt @@ -105,7 +105,7 @@ Definition .. versionchanged:: 4.0 - :method:`copyDatabase()` no longer supports ``MONGODB-CR`` to + :method:`db.copyDatabase()` no longer supports ``MONGODB-CR`` to authenticate to the ``fromhost``. From 07df4eaa475a9f48da2e812363c9bf5f4ccee3b7 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:30:14 -0400 Subject: [PATCH 66/96] fix method cursor.readPref() malformed link - setReadPref is for a Mongo connection obj --- source/reference/method/cursor.readPref.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/method/cursor.readPref.txt b/source/reference/method/cursor.readPref.txt index 0c3018a96b6..bf143f2698e 100644 --- a/source/reference/method/cursor.readPref.txt +++ b/source/reference/method/cursor.readPref.txt @@ -92,7 +92,7 @@ Parameters .. versionadded:: 4.4 -:method:`cursor.setReadPref()` does not support the +:method:`~cursor.readPref()` does not support the :ref:`replica-set-read-preference-max-staleness` option for read preference. From 70d6048523b893c8e9c4db8300aec1757d012036 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:31:12 -0400 Subject: [PATCH 67/96] unlink removed method cursor.showDiskLoc() --- source/reference/operator/meta/showDiskLoc.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/operator/meta/showDiskLoc.txt b/source/reference/operator/meta/showDiskLoc.txt index 05a2e5eee63..8c798921139 100644 --- a/source/reference/operator/meta/showDiskLoc.txt +++ b/source/reference/operator/meta/showDiskLoc.txt @@ -26,7 +26,7 @@ $showDiskLoc } The :binary:`~bin.mongo` shell provides the - :method:`cursor.showDiskLoc()` method for :operator:`$showDiskLoc`: + ``cursor.showDiskLoc()`` method for :operator:`$showDiskLoc`: .. code-block:: javascript From 6bccb31f86e5c277d5032fa292c125db102c74e0 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:32:12 -0400 Subject: [PATCH 68/96] unlink removed method db.addUser() --- source/release-notes/2.6-upgrade.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/2.6-upgrade.txt b/source/release-notes/2.6-upgrade.txt index 66bf528c4c6..671007a93ac 100644 --- a/source/release-notes/2.6-upgrade.txt +++ b/source/release-notes/2.6-upgrade.txt @@ -90,7 +90,7 @@ authentication and authorization: - If your application performs CRUD operations on the :data:`.system.users` collection or uses a - :method:`db.addUser()`\ -like method, then you **must** + ``db.addUser()``\ -like method, then you **must** upgrade those drivers (i.e. client libraries) **before** :binary:`~bin.mongod` or :binary:`~bin.mongos` instances. From f754cf2ebb5ce4b8b0eeb7b424dfab381acea32c Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:33:20 -0400 Subject: [PATCH 69/96] unlink removed method db.cloneCollection() --- source/release-notes/4.2-compatibility.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/4.2-compatibility.txt b/source/release-notes/4.2-compatibility.txt index 11d8e459500..1c6045a407e 100644 --- a/source/release-notes/4.2-compatibility.txt +++ b/source/release-notes/4.2-compatibility.txt @@ -211,7 +211,7 @@ Deprecate Support for ``cloneCollection`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ MongoDB deprecates the ``cloneCollection`` command and its -:binary:`~bin.mongo` shell helper :method:`db.cloneCollection()` +:binary:`~bin.mongo` shell helper ``db.cloneCollection()`` As alternatives, From 34850ad7b2b4be757ad462e3f418aea4f7f74749 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:37:36 -0400 Subject: [PATCH 70/96] fix method db.collection.explain() malformed link --- source/includes/fact-explain-methods-differences.rst | 6 +++--- source/reference/method/db.collection.explain.txt | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/source/includes/fact-explain-methods-differences.rst b/source/includes/fact-explain-methods-differences.rst index cfd8fd9a85a..669bcedf2f7 100644 --- a/source/includes/fact-explain-methods-differences.rst +++ b/source/includes/fact-explain-methods-differences.rst @@ -1,12 +1,12 @@ -:method:`db.collection.explain().find()` is similar to +:method:`db.collection.explain().find() ` is similar to :method:`db.collection.find().explain() ` with the following key differences: -- The :method:`db.collection.explain().find()` construct allows for the +- The :method:`db.collection.explain().find() ` construct allows for the additional chaining of query modifiers. For list of query modifiers, see :ref:`db.collection.explain().find().help() `. -- The :method:`db.collection.explain().find()` returns a cursor, which +- The :method:`db.collection.explain().find() ` returns a cursor, which requires a call to ``.next()``, or its alias ``.finish()``, to return the ``explain()`` results. If run interactively in the :binary:`~bin.mongo` shell, the diff --git a/source/reference/method/db.collection.explain.txt b/source/reference/method/db.collection.explain.txt index f98547bd8ce..843d482b984 100644 --- a/source/reference/method/db.collection.explain.txt +++ b/source/reference/method/db.collection.explain.txt @@ -160,7 +160,7 @@ The :method:`db.collection.explain()` method wraps the .. include:: /includes/fact-explain-methods-differences.rst -:method:`db.collection.explain().aggregate()` is equivalent to passing +:method:`db.collection.explain().aggregate() ` is equivalent to passing the :ref:`explain ` option to the :method:`db.collection.aggregate()` method. @@ -176,7 +176,7 @@ To see the list of operations supported by db.collection.explain().help() -:method:`db.collection.explain().find()` returns a cursor, which allows +:method:`db.collection.explain().find() ` returns a cursor, which allows for the chaining of query modifiers. To see the list of query modifiers supported by :method:`db.collection.explain().find() ` as well as cursor-related methods, run: @@ -250,7 +250,7 @@ all considered plans for the specified Explain ``find()`` with Modifiers ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:method:`db.collection.explain().find()` construct allows for the +:method:`db.collection.explain().find() ` construct allows for the chaining of query modifiers. For example, the following operation provides information on the :method:`~db.collection.find()` method with :method:`~cursor.sort()` and :method:`~cursor.hint()` query modifiers. @@ -271,7 +271,7 @@ shell: Iterate the ``explain().find()`` Return Cursor ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:method:`db.collection.explain().find()` returns a cursor to the +:method:`db.collection.explain().find() ` returns a cursor to the explain results. If run interactively in the :binary:`~bin.mongo` shell, the :binary:`~bin.mongo` shell automatically iterates the cursor using the ``.next()`` method. For scripts, however, you must explicitly call From 4391e57ff5bd7f00f74e606900f40d1614a7cb97 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:39:24 -0400 Subject: [PATCH 71/96] fix method db.help() malformed link --- source/reference/mongo-shell.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/mongo-shell.txt b/source/reference/mongo-shell.txt index eb269e68311..195ddd727f3 100644 --- a/source/reference/mongo-shell.txt +++ b/source/reference/mongo-shell.txt @@ -77,7 +77,7 @@ displays some common help methods and commands: - Show help for database methods. - * - :method:`db.\.help() ` + * - :method:`db.\.help() ` - Show help on collection methods. The ```` can be the name of an existing collection or a non-existing collection. From 78c8c3267100ba8cb6350062d9ee59adce03c6a1 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:44:14 -0400 Subject: [PATCH 72/96] fix methods db.createRole, db.createUser, db.dropAllUsers malformed definitions, breaking all links --- source/reference/method/db.createRole.txt | 2 +- source/reference/method/db.createUser.txt | 2 +- source/reference/method/db.dropAllUsers.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/reference/method/db.createRole.txt b/source/reference/method/db.createRole.txt index e94f6dee855..cb8343140b3 100644 --- a/source/reference/method/db.createRole.txt +++ b/source/reference/method/db.createRole.txt @@ -13,7 +13,7 @@ db.createRole() Definition ---------- -.. method:: db.createRole ( role, writeConcern ) +.. method:: db.createRole(role, writeConcern) Creates a role in a database. You can specify privileges for the role by explicitly listing the privileges or by having the role diff --git a/source/reference/method/db.createUser.txt b/source/reference/method/db.createUser.txt index 6297a82821f..bfe49b7bdfa 100644 --- a/source/reference/method/db.createUser.txt +++ b/source/reference/method/db.createUser.txt @@ -13,7 +13,7 @@ db.createUser() Definition ---------- -.. method:: db.createUser ( user, writeConcern ) +.. method:: db.createUser(user, writeConcern) Creates a new user for the database on which the method is run. :method:`db.createUser()` returns a *duplicate user* error if the diff --git a/source/reference/method/db.dropAllUsers.txt b/source/reference/method/db.dropAllUsers.txt index ff23a9c2eba..a58ffe8f3b2 100644 --- a/source/reference/method/db.dropAllUsers.txt +++ b/source/reference/method/db.dropAllUsers.txt @@ -13,7 +13,7 @@ db.dropAllUsers() Definition ---------- -.. method:: db.dropAllUsers ( writeConcern ) +.. method:: db.dropAllUsers(writeConcern) Removes all users from the current database. From 5624695f40baacc2031b89f5d3958ebb591c8a45 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:44:54 -0400 Subject: [PATCH 73/96] fix method db.dropUser malformed definition, breaking all links --- source/reference/method/db.dropUser.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/method/db.dropUser.txt b/source/reference/method/db.dropUser.txt index 22c3110f387..59d64530748 100644 --- a/source/reference/method/db.dropUser.txt +++ b/source/reference/method/db.dropUser.txt @@ -13,7 +13,7 @@ db.dropUser() Definition ---------- -.. method:: db.dropUser ( username, writeConcern ) +.. method:: db.dropUser(username, writeConcern) Removes the user from the current database. From 9a8b4c324a3cce2e5d15b2c8aaee5865024fc702 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:51:11 -0400 Subject: [PATCH 74/96] fix method db.getMongo() malformed link --- source/release-notes/3.4-downgrade-sharded-cluster.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/3.4-downgrade-sharded-cluster.txt b/source/release-notes/3.4-downgrade-sharded-cluster.txt index b5e2d8538d2..1b82be3fe3c 100644 --- a/source/release-notes/3.4-downgrade-sharded-cluster.txt +++ b/source/release-notes/3.4-downgrade-sharded-cluster.txt @@ -97,7 +97,7 @@ servers: .. tip:: If connecting a :binary:`~bin.mongo` shell to a secondary member, - set use :method:`db.getMongo().setReadPref('secondary')` to allow reads + set use :method:`db.getMongo().setReadPref('secondary') ` to allow reads from secondaries. #. Repeat the process on each member of the config server replica set. From 9bcd81f145fa0fcd9d3edb20901f5dde0365fb15 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 14:52:09 -0400 Subject: [PATCH 75/96] fix method db.serverStatus() malformed link --- source/release-notes/4.0.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/4.0.txt b/source/release-notes/4.0.txt index 41e07b03db2..cceb498669c 100644 --- a/source/release-notes/4.0.txt +++ b/source/release-notes/4.0.txt @@ -1152,7 +1152,7 @@ following command and shell helper: - :dbcommand:`getFreeMonitoringStatus` The :dbcommand:`serverStatus` and the helper -:method:`db.getServerStatus()` also includes free monitoring statistics +:method:`db.ServerStatus()` also includes free monitoring statistics in the :serverstatus:`freeMonitoring` field. Access Control From 059168b862ebca98020643d4765cbed2698e4720 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:01:22 -0400 Subject: [PATCH 76/96] fix methods db.grantPrivilegesToRole, db.grantRolesToRole, db.revokePrivilegesFromRole, db.revokeRolesFromRole, db.revokeRolesFromUser malformed definitions, breaking all links --- source/reference/method/db.grantPrivilegesToRole.txt | 2 +- source/reference/method/db.grantRolesToRole.txt | 2 +- source/reference/method/db.revokePrivilegesFromRole.txt | 2 +- source/reference/method/db.revokeRolesFromRole.txt | 2 +- source/reference/method/db.revokeRolesFromUser.txt | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/source/reference/method/db.grantPrivilegesToRole.txt b/source/reference/method/db.grantPrivilegesToRole.txt index b0cd0ebd788..d92097926ef 100644 --- a/source/reference/method/db.grantPrivilegesToRole.txt +++ b/source/reference/method/db.grantPrivilegesToRole.txt @@ -13,7 +13,7 @@ db.grantPrivilegesToRole() Definition ---------- -.. method:: db.grantPrivilegesToRole ( rolename, privileges, writeConcern ) +.. method:: db.grantPrivilegesToRole(rolename, privileges, writeConcern) Grants additional :ref:`privileges ` to a :ref:`user-defined ` role. diff --git a/source/reference/method/db.grantRolesToRole.txt b/source/reference/method/db.grantRolesToRole.txt index f1340d5a906..49775970783 100644 --- a/source/reference/method/db.grantRolesToRole.txt +++ b/source/reference/method/db.grantRolesToRole.txt @@ -13,7 +13,7 @@ db.grantRolesToRole() Definition ---------- -.. method:: db.grantRolesToRole ( rolename, roles, writeConcern ) +.. method:: db.grantRolesToRole(rolename, roles, writeConcern) Grants roles to a :ref:`user-defined role `. diff --git a/source/reference/method/db.revokePrivilegesFromRole.txt b/source/reference/method/db.revokePrivilegesFromRole.txt index 96e780bb8db..a3fb6f017e0 100644 --- a/source/reference/method/db.revokePrivilegesFromRole.txt +++ b/source/reference/method/db.revokePrivilegesFromRole.txt @@ -13,7 +13,7 @@ db.revokePrivilegesFromRole() Definition ---------- -.. method:: db.revokePrivilegesFromRole ( rolename, privileges, writeConcern ) +.. method:: db.revokePrivilegesFromRole(rolename, privileges, writeConcern) Removes the specified privileges from the :ref:`user-defined ` role on the database where the method runs. The diff --git a/source/reference/method/db.revokeRolesFromRole.txt b/source/reference/method/db.revokeRolesFromRole.txt index 1b74d3166ef..465c9ed97cf 100644 --- a/source/reference/method/db.revokeRolesFromRole.txt +++ b/source/reference/method/db.revokeRolesFromRole.txt @@ -13,7 +13,7 @@ db.revokeRolesFromRole() Definition ---------- -.. method:: db.revokeRolesFromRole ( rolename, roles, writeConcern ) +.. method:: db.revokeRolesFromRole(rolename, roles, writeConcern) Removes the specified inherited roles from a role. diff --git a/source/reference/method/db.revokeRolesFromUser.txt b/source/reference/method/db.revokeRolesFromUser.txt index aa15b3891d4..7616906b087 100644 --- a/source/reference/method/db.revokeRolesFromUser.txt +++ b/source/reference/method/db.revokeRolesFromUser.txt @@ -13,7 +13,7 @@ db.revokeRolesFromUser() Definition ---------- -.. method:: db.revokeRolesFromUser ( ) +.. method:: db.revokeRolesFromUser() Removes a one or more roles from a user on the current database. The :method:`db.revokeRolesFromUser()` method uses the From ea69540977bc4611cc3d0c6c57c67bc3ceb5df88 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:04:09 -0400 Subject: [PATCH 77/96] fix method db.dropAllRoles() malformed link --- source/reference/method/db.dropAllRoles.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/method/db.dropAllRoles.txt b/source/reference/method/db.dropAllRoles.txt index 80cd48099a2..034327f8c7e 100644 --- a/source/reference/method/db.dropAllRoles.txt +++ b/source/reference/method/db.dropAllRoles.txt @@ -20,10 +20,10 @@ Definition .. warning:: - The :method:`dropAllRoles()` method removes *all* + The :method:`db.dropAllRoles()` method removes *all* :ref:`user-defined ` roles from the database. - The :method:`dropAllRoles()` method takes the following argument: + The :method:`db.dropAllRoles()` method takes the following argument: .. list-table:: From 7f96592fabd098786b8661b2eefbc46c8dfc34e5 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:05:45 -0400 Subject: [PATCH 78/96] fix method db.grantPrivilegesToRole() malformed link --- source/reference/method/db.grantPrivilegesToRole.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/reference/method/db.grantPrivilegesToRole.txt b/source/reference/method/db.grantPrivilegesToRole.txt index d92097926ef..53794ccd3fc 100644 --- a/source/reference/method/db.grantPrivilegesToRole.txt +++ b/source/reference/method/db.grantPrivilegesToRole.txt @@ -18,7 +18,7 @@ Definition Grants additional :ref:`privileges ` to a :ref:`user-defined ` role. - The :method:`grantPrivilegesToRole()` method uses the following syntax: + The :method:`db.grantPrivilegesToRole()` method uses the following syntax: .. code-block:: javascript @@ -31,7 +31,7 @@ Definition { < writeConcern > } ) - The :method:`grantPrivilegesToRole()` method takes the following arguments: + The :method:`db.grantPrivilegesToRole()` method takes the following arguments: .. list-table:: @@ -73,7 +73,7 @@ Definition - The :method:`grantPrivilegesToRole()` method can grant one or more + The :method:`db.grantPrivilegesToRole()` method can grant one or more privileges. Each ```` has the following syntax: .. code-block:: javascript From 6168cb1c4d54c7c12372dec8d9f5fe613612144a Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:06:50 -0400 Subject: [PATCH 79/96] fix method db.grantRolesToRole() malformed link --- source/reference/method/db.grantRolesToRole.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/reference/method/db.grantRolesToRole.txt b/source/reference/method/db.grantRolesToRole.txt index 49775970783..1b3382319ef 100644 --- a/source/reference/method/db.grantRolesToRole.txt +++ b/source/reference/method/db.grantRolesToRole.txt @@ -17,13 +17,13 @@ Definition Grants roles to a :ref:`user-defined role `. - The :method:`grantRolesToRole()` method uses the following syntax: + The :method:`db.grantRolesToRole()` method uses the following syntax: .. code-block:: javascript db.grantRolesToRole( "", [ ], { } ) - The :method:`grantRolesToRole()` method takes the following + The :method:`db.grantRolesToRole()` method takes the following arguments: @@ -98,7 +98,7 @@ Example .. TODO Update this example -The following :method:`grantRolesToRole()` operation updates the +The following :method:`db.grantRolesToRole()` operation updates the ``productsReaderWriter`` role in the ``products`` database to :ref:`inherit ` the :ref:`privileges ` of ``productsReader`` role: From 9e46be73e25c30b9c9836460ae110b4803769e1a Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:08:35 -0400 Subject: [PATCH 80/96] fix method db.grantRolesToUser() malformed definitions, breaking all links, and fix malformed link --- source/reference/method/db.grantRolesToUser.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/method/db.grantRolesToUser.txt b/source/reference/method/db.grantRolesToUser.txt index 09603ce1251..14ff3325598 100644 --- a/source/reference/method/db.grantRolesToUser.txt +++ b/source/reference/method/db.grantRolesToUser.txt @@ -13,7 +13,7 @@ db.grantRolesToUser() Definition ---------- -.. method:: db.grantRolesToUser ( username, roles, writeConcern ) +.. method:: db.grantRolesToUser(username, roles, writeConcern) Grants additional roles to a user. @@ -99,7 +99,7 @@ roles: } ] -The following :method:`grantRolesToUser()` operation gives ``accountUser01`` +The following :method:`db.grantRolesToUser()` operation gives ``accountUser01`` the :authrole:`readWrite` role on the ``products`` database and the :authrole:`read` role on the ``stock`` database. From a397455351490718484a2baa48f207f9e3987c8d Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:10:20 -0400 Subject: [PATCH 81/96] fix method db.revokeRolesFromRole() malformed link --- source/reference/method/db.revokeRolesFromRole.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/method/db.revokeRolesFromRole.txt b/source/reference/method/db.revokeRolesFromRole.txt index 465c9ed97cf..7d5aad0feeb 100644 --- a/source/reference/method/db.revokeRolesFromRole.txt +++ b/source/reference/method/db.revokeRolesFromRole.txt @@ -17,13 +17,13 @@ Definition Removes the specified inherited roles from a role. - The :method:`revokeRolesFromRole` method uses the following syntax: + The :method:`db.revokeRolesFromRole()` method uses the following syntax: .. code-block:: javascript db.revokeRolesFromRole( "", [ ], { } ) - The :method:`revokeRolesFromRole` method takes the following arguments: + The :method:`db.revokeRolesFromRole()` method takes the following arguments: .. list-table:: From 3ee877cf65bce54ab95bc541e39c08a3d6f6ba95 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:13:05 -0400 Subject: [PATCH 82/96] unlink removed method db.loadServerScripts() --- source/release-notes/2.2.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/2.2.txt b/source/release-notes/2.2.txt index 9fb66706c0e..503fc9ef0ab 100644 --- a/source/release-notes/2.2.txt +++ b/source/release-notes/2.2.txt @@ -555,7 +555,7 @@ consistency of the user interface for the :binary:`~bin.mongo` shell: Helper to load Server-Side Functions ```````````````````````````````````` -The :method:`db.loadServerScripts()` loads the contents of the current +The ``db.loadServerScripts()`` method loads the contents of the current database's ``system.js`` collection into the current :binary:`~bin.mongo` shell session. See :issue:`SERVER-1651` for more information. From e6a6fd56557127b11ce5c941cf39ce1c895f52db Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:13:49 -0400 Subject: [PATCH 83/96] unlink removed method db.serverShutdown() --- source/release-notes/3.0-changelog.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/3.0-changelog.txt b/source/release-notes/3.0-changelog.txt index 5ec7b562d2f..737fa9f5264 100644 --- a/source/release-notes/3.0-changelog.txt +++ b/source/release-notes/3.0-changelog.txt @@ -504,7 +504,7 @@ HTTP Console Admin ~~~~~ -- :issue:`SERVER-17570` MongoDB 3.0 NT Service shutdown race condition with :method:`db.serverShutdown()` +- :issue:`SERVER-17570` MongoDB 3.0 NT Service shutdown race condition with ``serverShutdown()`` - :issue:`SERVER-17699` "locks" section empty in diagnostic log and profiler output for some operations - :issue:`SERVER-17337` RPM Init script breaks with quotes in ``yaml`` config file - :issue:`SERVER-16731` Remove unused DBPATH init script variable From f84ce7ff608f011a51765e036211179718093a9d Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:17:55 -0400 Subject: [PATCH 84/96] Revert "unlink removed method db.serverShutdown()" This reverts commit e6a6fd56557127b11ce5c941cf39ce1c895f52db. --- source/release-notes/3.0-changelog.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/3.0-changelog.txt b/source/release-notes/3.0-changelog.txt index 737fa9f5264..5ec7b562d2f 100644 --- a/source/release-notes/3.0-changelog.txt +++ b/source/release-notes/3.0-changelog.txt @@ -504,7 +504,7 @@ HTTP Console Admin ~~~~~ -- :issue:`SERVER-17570` MongoDB 3.0 NT Service shutdown race condition with ``serverShutdown()`` +- :issue:`SERVER-17570` MongoDB 3.0 NT Service shutdown race condition with :method:`db.serverShutdown()` - :issue:`SERVER-17699` "locks" section empty in diagnostic log and profiler output for some operations - :issue:`SERVER-17337` RPM Init script breaks with quotes in ``yaml`` config file - :issue:`SERVER-16731` Remove unused DBPATH init script variable From 7867308c16a0530df054c7ca44a82c13ebdff10b Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:18:56 -0400 Subject: [PATCH 85/96] fix method db.shutdownServer() - wrong in SERVER ticket name --- source/release-notes/3.0-changelog.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/3.0-changelog.txt b/source/release-notes/3.0-changelog.txt index 5ec7b562d2f..940378c1cfc 100644 --- a/source/release-notes/3.0-changelog.txt +++ b/source/release-notes/3.0-changelog.txt @@ -504,7 +504,7 @@ HTTP Console Admin ~~~~~ -- :issue:`SERVER-17570` MongoDB 3.0 NT Service shutdown race condition with :method:`db.serverShutdown()` +- :issue:`SERVER-17570` MongoDB 3.0 NT Service shutdown race condition with :method:`db.shutdownServer()` - :issue:`SERVER-17699` "locks" section empty in diagnostic log and profiler output for some operations - :issue:`SERVER-17337` RPM Init script breaks with quotes in ``yaml`` config file - :issue:`SERVER-16731` Remove unused DBPATH init script variable From d9b61d0c83291b58a98863af97064675c1719269 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:21:21 -0400 Subject: [PATCH 86/96] fix method rs.stepDown() capitalization --- source/release-notes/3.0-changelog.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/3.0-changelog.txt b/source/release-notes/3.0-changelog.txt index 940378c1cfc..9a6b0078a64 100644 --- a/source/release-notes/3.0-changelog.txt +++ b/source/release-notes/3.0-changelog.txt @@ -322,7 +322,7 @@ Replication ~~~~~~~~~~~ - :issue:`SERVER-18211` MongoDB fails to correctly roll back collection creation -- :issue:`SERVER-17273` Add support for ``secondaryCatchupPeriodSecs`` to :method:`rs.stepdown()` shell helper +- :issue:`SERVER-17273` Add support for ``secondaryCatchupPeriodSecs`` to :method:`rs.stepDown()` shell helper Sharding ~~~~~~~~ From 3f8ec1a2c893fcb98ada02dd55277737204a8c7d Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:23:27 -0400 Subject: [PATCH 87/96] unlink removed method sh.getRecentMigrations --- source/release-notes/3.0-changelog.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/release-notes/3.0-changelog.txt b/source/release-notes/3.0-changelog.txt index 9a6b0078a64..e0d4c5c5729 100644 --- a/source/release-notes/3.0-changelog.txt +++ b/source/release-notes/3.0-changelog.txt @@ -329,7 +329,7 @@ Sharding - :issue:`SERVER-17812` LockPinger has audit-related GLE failure - :issue:`SERVER-17749` :dbcommand:`collMod` :collflag:`usePowerOf2Sizes` fails on :binary:`~bin.mongos` -- :issue:`SERVER-16987` :method:`sh.getRecentMigrations()` shows aborted migration as success +- :issue:`SERVER-16987` ``sh.getRecentMigrations`` shows aborted migration as success Storage ~~~~~~~ @@ -417,7 +417,7 @@ Shell - :issue:`SERVER-17951` db.currentOp() fails with read preference set - :issue:`SERVER-17273` Add support for secondaryCatchupPeriodSecs to rs.stepdown shell helper -- :issue:`SERVER-16987` sh.getRecentMigrations shows aborted migration as success +- :issue:`SERVER-16987` ``sh.getRecentMigrations`` shows aborted migration as success Testing ~~~~~~~ From dc3ff2e0853632da092f3096c21ecc8a5a3629cb Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:25:49 -0400 Subject: [PATCH 88/96] fix method db.updateRole() malformed link --- source/reference/method/db.updateRole.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/method/db.updateRole.txt b/source/reference/method/db.updateRole.txt index f5ff2bbb31a..01f959c7313 100644 --- a/source/reference/method/db.updateRole.txt +++ b/source/reference/method/db.updateRole.txt @@ -32,7 +32,7 @@ Definition An update to the ``privileges`` or ``roles`` array completely replaces the previous array's values. - The :method:`updateRole()` method uses the following syntax: + The :method:`db.updateRole()` method uses the following syntax: .. code-block:: javascript From ee6de877f5911aa30b154ec86f1b498ea082d499 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:31:33 -0400 Subject: [PATCH 89/96] fix method db.watch() malformed link --- source/changeStreams.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/changeStreams.txt b/source/changeStreams.txt index 52e0626e1a4..91ff60c6918 100644 --- a/source/changeStreams.txt +++ b/source/changeStreams.txt @@ -613,7 +613,7 @@ document. To return the most current majority-committed version of the updated document, pass ``"fullDocument' => \MongoDB\Operation\ChangeStreamCommand::FULL_DOCUMENT_UPDATE_LOOKUP"`` - to the :method:`watch()` method. + to the :method:`db.watch()` method. In the example below, all update operations notifications include a ``fullDocument`` field that represents the *current* @@ -629,7 +629,7 @@ document. content: | To return the most current majority-committed version of the updated document, pass ``full_document: 'updateLookup'`` to the - :method:`watch()` method. + :method:`db.watch()` method. In the example below, all update operations notifications include a ``full_document`` field that represents the *current* From 569a34743f87f54ad1e7c317aa2db75dfbc58395 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:41:49 -0400 Subject: [PATCH 90/96] fix method db.serverStatus() capitalization --- source/release-notes/4.0.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/4.0.txt b/source/release-notes/4.0.txt index cceb498669c..eac7205b551 100644 --- a/source/release-notes/4.0.txt +++ b/source/release-notes/4.0.txt @@ -1152,7 +1152,7 @@ following command and shell helper: - :dbcommand:`getFreeMonitoringStatus` The :dbcommand:`serverStatus` and the helper -:method:`db.ServerStatus()` also includes free monitoring statistics +:method:`db.serverStatus()` also includes free monitoring statistics in the :serverstatus:`freeMonitoring` field. Access Control From 4df56eaa6a017af452233244327debd0e2617af3 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:44:08 -0400 Subject: [PATCH 91/96] fix method db.getMongo() malformed link --- source/release-notes/3.4-downgrade-replica-set.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/3.4-downgrade-replica-set.txt b/source/release-notes/3.4-downgrade-replica-set.txt index 8b0c2bcb35c..869c55d2976 100644 --- a/source/release-notes/3.4-downgrade-replica-set.txt +++ b/source/release-notes/3.4-downgrade-replica-set.txt @@ -94,7 +94,7 @@ reindex operation does not propagate to the secondaries. .. tip:: If connecting a :binary:`~bin.mongo` shell to a secondary member, - set use :method:`db.getMongo().setReadPref('secondary')` to allow reads + set use :method:`db.getMongo().setReadPref('secondary') ` to allow reads from secondaries. Procedure From 78352d15410d5b55732ae24283fe72d6fd07008a Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 15:45:48 -0400 Subject: [PATCH 92/96] fix methods db.grantRolesToUser() and db.revokeRolesFromUser() malformed links --- source/reference/method/db.grantRolesToUser.txt | 4 ++-- source/reference/method/db.revokeRolesFromUser.txt | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/reference/method/db.grantRolesToUser.txt b/source/reference/method/db.grantRolesToUser.txt index 14ff3325598..666ffc88c7d 100644 --- a/source/reference/method/db.grantRolesToUser.txt +++ b/source/reference/method/db.grantRolesToUser.txt @@ -17,13 +17,13 @@ Definition Grants additional roles to a user. - The :method:`grantRolesToUser` method uses the following syntax: + The :method:`db.grantRolesToUser()` method uses the following syntax: .. code-block:: javascript db.grantRolesToUser( "", [ ], { } ) - The :method:`grantRolesToUser` method takes the following arguments: + The :method:`db.grantRolesToUser()` method takes the following arguments: .. list-table:: diff --git a/source/reference/method/db.revokeRolesFromUser.txt b/source/reference/method/db.revokeRolesFromUser.txt index 7616906b087..b87f4af3bfe 100644 --- a/source/reference/method/db.revokeRolesFromUser.txt +++ b/source/reference/method/db.revokeRolesFromUser.txt @@ -23,7 +23,7 @@ Definition db.revokeRolesFromUser( "", [ ], { } ) - The :method:`revokeRolesFromUser` method takes the following arguments: + The :method:`db.revokeRolesFromUser()` method takes the following arguments: .. list-table:: From fd093a935be464e1273bc00a075dc694614f7139 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 16:00:41 -0400 Subject: [PATCH 93/96] unlink undocumented disableLogicalSessionCacheRefresh param --- source/tutorial/build-indexes-on-replica-sets.txt | 2 +- source/tutorial/build-indexes-on-sharded-clusters.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/tutorial/build-indexes-on-replica-sets.txt b/source/tutorial/build-indexes-on-replica-sets.txt index 12239722f5e..64cb88bccaa 100644 --- a/source/tutorial/build-indexes-on-replica-sets.txt +++ b/source/tutorial/build-indexes-on-replica-sets.txt @@ -202,7 +202,7 @@ For example, to restart your replica set member: - Uncomment the :setting:`replication.replSetName`. - - Remove parameter :parameter:`disableLogicalSessionCacheRefresh` + - Remove parameter ``disableLogicalSessionCacheRefresh`` in the :setting:`setParameter` section. For example: diff --git a/source/tutorial/build-indexes-on-sharded-clusters.txt b/source/tutorial/build-indexes-on-sharded-clusters.txt index 35b9803b162..77aa4ccd96e 100644 --- a/source/tutorial/build-indexes-on-sharded-clusters.txt +++ b/source/tutorial/build-indexes-on-sharded-clusters.txt @@ -324,7 +324,7 @@ For example, to restart your replica set shard member: - Remove parameter :parameter:`skipShardingConfigurationChecks` in the :setting:`setParameter` section. - - Remove parameter :parameter:`disableLogicalSessionCacheRefresh` + - Remove parameter ``disableLogicalSessionCacheRefresh`` in the :setting:`setParameter` section. .. code-block:: yaml From 982519d096090852805640e658a5920659355b0e Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 16:03:26 -0400 Subject: [PATCH 94/96] unlink removed logicalSessionRefreshMinutes param, update ref to Millis where appropriate --- source/reference/command/serverStatus.txt | 3 +-- source/release-notes/3.6.txt | 3 ++- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/reference/command/serverStatus.txt b/source/reference/command/serverStatus.txt index cc77761e7ed..b29090a2ac0 100644 --- a/source/reference/command/serverStatus.txt +++ b/source/reference/command/serverStatus.txt @@ -1086,14 +1086,13 @@ logicalSessionRecordCache - :pipeline:`$listLocalSessions` - :parameter:`logicalSessionRefreshMillis` - - :parameter:`logicalSessionRefreshMinutes` .. serverstatus:: logicalSessionRecordCache.sessionsCollectionJobCount The number that tracks the number of times the refresh process has run on the :data:`config.system.sessions` collection. - .. seealso:: :parameter:`logicalSessionRefreshMinutes` + .. seealso:: :parameter:`logicalSessionRefreshMillis` .. serverstatus:: logicalSessionRecordCache.lastSessionsCollectionJobDurationMillis diff --git a/source/release-notes/3.6.txt b/source/release-notes/3.6.txt index 0f7e45a4820..d905b0864e9 100644 --- a/source/release-notes/3.6.txt +++ b/source/release-notes/3.6.txt @@ -812,7 +812,8 @@ Parameters The following new parameters are available for server sessions: -- :parameter:`logicalSessionRefreshMinutes` +- ``logicalSessionRefreshMinutes`` (replaced with + :parameter:`logicalSessionRefreshMillis` in 3.6.9) - :parameter:`localLogicalSessionTimeoutMinutes` From dfbcb64b8658678cb7265bbfbdfd2b482c336f09 Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 16:04:41 -0400 Subject: [PATCH 95/96] unlink removed newCollectionsUsePowerOf2Sizes param --- source/release-notes/2.6.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/release-notes/2.6.txt b/source/release-notes/2.6.txt index 63f4df822be..b74b1b4da53 100644 --- a/source/release-notes/2.6.txt +++ b/source/release-notes/2.6.txt @@ -520,7 +520,7 @@ To use the previous *exact-fit allocation strategy*: :collflag:`usePowerOf2Sizes` set to ``false``. - For all new collections on an entire :binary:`~bin.mongod` instance, - set :parameter:`newCollectionsUsePowerOf2Sizes` to ``false``. + set ``newCollectionsUsePowerOf2Sizes`` to ``false``. New collections include those: created during :ref:`initial sync `, as well as those From 42307a10ce02fac8648f4facf3d50c836ff4460f Mon Sep 17 00:00:00 2001 From: Andrew Feierabend Date: Tue, 13 Oct 2020 17:10:24 -0400 Subject: [PATCH 96/96] remove test bump --- README.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.rst b/README.rst index c18f685a377..8463101c180 100644 --- a/README.rst +++ b/README.rst @@ -2,8 +2,6 @@ MongoDB Documentation ===================== -bump - This repository contains a major revision of the MongoDB documentation, currently accessible at http://docs.mongodb.com/manual/. You can build the documentation locally if you have `giza