Skip to content

Commit 04d3895

Browse files
author
Ed Costello
committed
Various typos and link cleanup related to sharding/replication work
1 parent 5b09374 commit 04d3895

File tree

4 files changed

+40
-31
lines changed

4 files changed

+40
-31
lines changed

source/applications/replication.txt

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Write concern issues the :dbcommand:`getLastError` command after write
2525
operations to return an object with error information or confirmation
2626
that there are no errors.
2727

28-
The after the :doc:`driver write concern change </release-notes/drivers-write-concern>` all officially
28+
After the :doc:`driver write concern change </release-notes/drivers-write-concern>` all officially
2929
supported MongoDB drivers enable write concern by default.
3030

3131
When enabled by default, write concern confirms write operations only on the primary.
@@ -88,6 +88,11 @@ The :data:`~local.system.replset.settings.getLastErrorDefaults` setting affects
8888
<replica-set-failover>`. Always ensure that your operations have
8989
specified the required write concern for your application.
9090

91+
.. seealso::
92+
93+
* :ref:`write-operations-write-concern`
94+
* :ref:`connections-write-concern`
95+
9196
.. index:: read preference
9297
.. index:: slaveOk
9398

@@ -206,10 +211,10 @@ behavior <replica-set-read-preference-behavior>`. See also the
206211
This is the default. If the primary is unavailable,
207212
read operations produce an error or throw an exception.
208213

209-
:readmode:`primary` read preference modes are not compatible with
210-
read preferences mode that use :ref:`tag sets
214+
The :readmode:`primary` read preference mode is not compatible with
215+
read preference modes that use :ref:`tag sets
211216
<replica-set-read-preference-tag-sets>`. If you specify a tag set
212-
with :readmode:`primary`, the driver produces an error.
217+
with :readmode:`primary`, the driver will produce an error.
213218

214219
.. readmode:: primaryPreferred
215220

@@ -387,7 +392,7 @@ All interfaces use the same :ref:`member selection logic
387392
member to which to direct read operations, basing the choice on read
388393
preference mode and tag sets.
389394

390-
For more information on how read preferences :ref:`modes
395+
For more information on how read preference :ref:`modes
391396
<replica-set-read-preference-modes>` interact with tag sets, see the
392397
documentation for each read preference mode.
393398

@@ -422,7 +427,7 @@ As a result, MongoDB drivers and :program:`mongos`:
422427
connection is *pinned* to this :program:`mongod`.
423428

424429
- Attempt to reconnect to a new member, obeying existing :ref:`read
425-
preference modes <replica-set-read-preference-modes>`, if connection
430+
preference modes <replica-set-read-preference-modes>`, if the connection
426431
to :program:`mongod` is lost.
427432

428433
Reconnections are transparent to the application itself. If
@@ -498,8 +503,8 @@ Member Selection
498503
````````````````
499504

500505
Clients, by way of their drivers, and :program:`mongos` instances for
501-
sharded clusters periodically update their view of the set's state: which
502-
members are up or down, which is primary, and the latency to each
506+
sharded clusters periodically update their view of the replica set's state:
507+
which members are up or down, which member is primary, and the latency to each
503508
:program:`mongod` instance.
504509

505510
For any operation that targets a member *other* than the
@@ -605,10 +610,10 @@ preferences; clients send all commands to shards' primaries. See
605610
Uses for non-Primary Read Preferences
606611
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
607612

608-
You must exercise care when specifying read preference: modes other
613+
You must exercise care when specifying read preferences: modes other
609614
than :readmode:`primary` can *and will* return stale data. These
610615
secondary queries will not
611-
include most recent write operations to the replica set's
616+
include the most recent write operations to the replica set's
612617
:term:`primary`. Nevertheless, there are several common use cases for
613618
using non-:readmode:`primary` read preference modes:
614619

source/core/write-operations.txt

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -89,15 +89,15 @@ Consider the following levels of conceptual write concern:
8989
Before the releases outlined in :ref:`driver-write-concern-change`,
9090
this was the default write concern.
9191

92-
.. _write-concern-acknowledged:
92+
.. _write-concern-acknowledged:
9393

9494
- receipt *acknowledged*: The :program:`mongod` will confirm the
9595
receipt of the write operation, allowing the client to catch
9696
network, duplicate key, and other exceptions. After the releases
9797
outlined in :ref:`driver-write-concern-change`, this is the default
9898
write concern. [#default-write-concern]_
9999

100-
.. _write-concern-replica-journaled:
100+
.. _write-concern-replica-journaled:
101101

102102
- *journaled*: The :program:`mongod` will confirm the write
103103
operation only after it has written the operation to the
@@ -111,7 +111,7 @@ Consider the following levels of conceptual write concern:
111111
is not fully durable. Require *journaled* as part of the write
112112
concern to provide this durability guarantee.
113113

114-
.. _write-concern-replica-acknowledged:
114+
.. _write-concern-replica-acknowledged:
115115

116116
:term:`Replica sets <replica set>` present an additional layer of
117117
consideration for write concern. Basic write concern level affect the
@@ -132,8 +132,8 @@ of a replica set. See the :ref:`Write Concern for Replica Sets
132132
.. [#default-write-concern] The default write concern is to call
133133
:dbcommand:`getLastError` with no arguments. For replica sets, you
134134
can define the default write concern settings in the
135-
:data:`getLastErrorDefaults <settings.getLastErrorDefaults>`. If
136-
:data:`getLastErrorDefaults <settings.getLastErrorDefaults>` does
135+
:data:`~local.system.replset.settings.getLastErrorDefaults`
136+
If :data:`~local.system.replset.settings.getLastErrorDefaults` does
137137
not define a default write concern setting,
138138
:dbcommand:`getLastError` defaults to basic receipt acknowledgment.
139139

@@ -155,8 +155,9 @@ document's ``err`` field contains either:
155155

156156
The definition of a "successful write" depends on the arguments
157157
specified to :dbcommand:`getLastError`, or in replica sets, the
158-
configuration of :data:`getLastErrorDefaults
159-
<settings.getLastErrorDefaults>`. When deciding the level of write
158+
configuration of
159+
:data:`~local.system.replset.settings.getLastErrorDefaults`.
160+
When deciding the level of write
160161
concern for your application, become familiar with the
161162
:ref:`write-concern-considerations`.
162163

@@ -365,15 +366,15 @@ they do, adds a :data:`~collStats.paddingFactor` so that the documents have room
365366
to grow on subsequent writes. The :data:`~collStats.paddingFactor` indicates the
366367
padding for new inserts and moves.
367368

368-
.. versionadded:: 2.2
369+
.. versionadded:: 2.2
369370
You can use the :dbcommand:`collMod` command
370371
with the :collflag:`usePowerOf2Sizes` flag so that MongoDB
371372
allocates document space in sizes that are powers of 2. This helps
372373
ensure that MongoDB can efficiently reuse the space freed as a
373374
result of deletions or document relocations. As with all padding,
374375
using document space allocations with power of 2 sizes minimizes,
375376
but does not eliminate, document movements.
376-
377+
377378
To check the current :data:`~collStats.paddingFactor` on a collection, you can
378379
run the :dbcommand:`db.collection.stats()` command in the
379380
:program:`mongo` shell, as in the following example:
@@ -389,7 +390,7 @@ example:
389390

390391
.. code-block:: none
391392

392-
padding size = (paddingFactor - 1) * <document size>.
393+
padding size = (paddingFactor - 1) * <document size>.
393394

394395
For example, a :data:`~collStats.paddingFactor` of ``1.0`` specifies no padding
395396
whereas a paddingFactor of ``1.5`` specifies a padding size of ``0.5`` or 50
@@ -408,10 +409,10 @@ until you perform a :dbcommand:`compact` or a
408409

409410
.. note::
410411

411-
The following operations remove padding:
412-
412+
The following operations remove padding:
413+
413414
- :dbcommand:`compact`,
414-
- :dbcommand:`repairDatabase`, and
415+
- :dbcommand:`repairDatabase`, and
415416
- initial replica sync operations.
416417

417418
However, with the :dbcommand:`compact` command, you can run the
@@ -437,8 +438,8 @@ until you perform a :dbcommand:`compact` or a
437438
.. seealso::
438439

439440
- :ref:`faq-developers-manual-padding`
440-
441-
- `Fast Updates with MongoDB with in-place Updates <http://blog.mongodb.org/post/248614779/fast-updates-with-mongodb-update-in-place>`_ (blog post)
441+
442+
- `Fast Updates with MongoDB with in-place Updates <http://blog.mongodb.org/post/248614779/fast-updates-with-mongodb-update-in-place>`_ (blog post)
442443

443444
Architecture
444445
------------

source/reference/connection-string.txt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -208,13 +208,15 @@ connecting to the MongoDB deployment.
208208
connection to become available. For default values, see the
209209
:doc:`/applications/drivers` documentation.
210210

211+
.. _connections-write-concern:
212+
211213
Write Concern Options
212214
~~~~~~~~~~~~~~~~~~~~~
213215

214216
:ref:`Write concern <write-concern>` describes the kind of assurances
215-
:that the program:`mongod` and the driver provide to the application
216-
:regarding the success and durability of the write operation. For a
217-
:full explanation of write concern and write operations in general see
217+
that the program:`mongod` and the driver provide to the application
218+
regarding the success and durability of the write operation. For a
219+
full explanation of write concern and write operations in general see
218220
the: :doc:`/core/write-operations`:
219221

220222
.. data:: uri.w
@@ -243,7 +245,7 @@ the: :doc:`/core/write-operations`:
243245
Provides basic acknowledgment of write operations.
244246

245247
By specifying ``1``, you require that a standalone
246-
:program:`mongod` instance, or a the primary for :term:`replica
248+
:program:`mongod` instance, or the primary for :term:`replica
247249
sets <replica set>`, acknowledge all write operations. For drivers released
248250
after the :doc:`default write concern change
249251
</release-notes/drivers-write-concern>`, this is the default

source/release-notes/drivers-write-concern.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@ drivers:
4444
:dbcommand:`getLastError` without arguments, which is logically
4545
equivalent to the ``w: 1`` option; however, this operation allows
4646
:term:`replica set` users to override the default write concern
47-
with the :data:`getLastErrorDefaults
48-
<settings.getLastErrorDefaults>` setting in the
47+
with the
48+
:data:`getLastErrorDefaults <~local.system.replset.settings.getLastErrorDefaults>`
49+
setting in the
4950
:doc:`/reference/replica-configuration`.
5051

5152
.. _write-concern-change-releases:

0 commit comments

Comments
 (0)