Skip to content

Commit 518ca97

Browse files
author
Sam Kleinman
committed
meta: stubs and index reference clean up
1 parent 63db371 commit 518ca97

File tree

8 files changed

+140
-6
lines changed

8 files changed

+140
-6
lines changed

source/applications.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Application Development
99
:maxdepth: 3
1010

1111
applications/schema-design
12+
applications/simple-aggregation
1213
core/map-reduce
1314
applications/optimization
1415
applications/drivers
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
=============================
2+
Simple Aggregation Operations
3+
=============================

source/contents.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ MongoDB Manual Contents
1010
sharding
1111
administration
1212
applications
13-
core/indexes
13+
core/indexing
1414
mongo
1515
reference
1616

File renamed without changes.

source/core/replication.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -554,9 +554,9 @@ accepted write operations that have replicated to the
554554
rare and typically occurs as a result of a network partition with
555555
replication lag. When this node (the former primary) rejoins the
556556
:term:`replica set` and attempts to continue replication as a
557-
secondary those operations that were not replicated have to be
558-
removed, or "rolled back," to maintain database consistency across the
559-
replica set.
557+
secondary those operations the former primary must revert these
558+
operations or "rolled back" these operations to maintain database
559+
consistency across the replica set.
560560

561561
MongoDB writes the rollback data to a :term:`BSON` file in the
562562
database's :setting:`dbpath` directory. Use :doc:`bsondump
@@ -565,7 +565,8 @@ and then manually apply the changes to the new primary. There is no
565565
way for MongoDB to appropriately and fairly handle rollback situations
566566
without manual intervention. Since rollback situations require an
567567
administrator's direct intervention, users should strive to avoid
568-
rollbacks as much as possible.
568+
rollbacks as much as possible. Until an administrator applies this
569+
rollback data, the former primary remains in a "rollback" status.
569570

570571
The best strategy for avoiding all rollbacks is to ensure :ref:`write
571572
propagation <replica-set-write-propagation>` to all or some of the
@@ -578,6 +579,13 @@ that might create rollbacks.
578579
megabytes of data. If your system needs to rollback more than 300
579580
MB, you will need to manually intervene to recover this data.
580581

582+
.. note::
583+
584+
After a rollback occurs, the former primary will remain in a
585+
"rollback" mode until the administrator deals with the rolled back
586+
data and restarts the :option:`mongod` instance. Only then can the
587+
node becomes a normal :term:`secondary` terms.
588+
581589
.. _replica-set-write-propagation:
582590

583591
Write Propagation

source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Core Concepts and Functionality
4949
core/map-reduce
5050
core/journaling
5151
core/capped-collections
52-
core/indexes
52+
core/indexing
5353

5454
Administration and Deployment
5555
-----------------------------

source/reference.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Statuses and Errors
3030
reference/server-status
3131
reference/database-statistics
3232
reference/collection-statistics
33+
reference/collection-validation
3334
reference/replica-status
3435
reference/replica-configuration
3536
reference/replication-info
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
================================
2+
Collection Validation Statistics
3+
================================
4+
5+
.. default-domain:: mongodb
6+
7+
Synopsis
8+
--------
9+
10+
The collection validation command checks all of the structures within
11+
a name space for correctness and returns a :term:`JSON Document`
12+
containing information
13+
14+
Run the validation command in the :option:`mongo` shell using the
15+
following form to validate a collection named "``people``":
16+
17+
.. code-block:: javascript
18+
19+
db.people.validate()
20+
21+
Alternatively you can use the command prototype and the
22+
:js.func:`runCommand()` shell method in the following form:
23+
24+
.. code-block:: javascript
25+
26+
db.runCommand( { validate: "people", full: true } )
27+
db.people.validate(true)
28+
29+
.. seealso:: ":dbcommand:`validate`" and ":js:func:`validate()`."
30+
31+
Values
32+
------
33+
34+
.. js:data:: ns
35+
36+
.. js:data:: firstExtent
37+
38+
.. js:data:: lastExtent
39+
40+
.. js:data:: extentCount
41+
42+
.. js::data:: extents
43+
44+
.. note::
45+
46+
This sub-document is only returned when you specify the "``full``" option.
47+
48+
.. js::data:: extents.loc
49+
50+
.. js::data:: extents.xnext
51+
52+
.. js::data:: extents.xprev
53+
54+
.. js::data:: extents.nsdaig
55+
56+
.. js::data:: extents.size
57+
58+
.. js::data:: extents.firstRecord
59+
60+
.. js::data:: extents.lastRecord
61+
62+
.. js:data:: datasize
63+
64+
.. js:data:: nsrecords
65+
66+
.. js:data:: lastExtentSize
67+
68+
.. js:data:: padding
69+
70+
.. js:data:: firstExtentDetails
71+
72+
.. js:data:: firstExtentDetails.loc
73+
74+
.. js:data:: firstExtentDetails.xnext
75+
76+
.. js:data:: firstExtentDetails.xprev
77+
78+
.. js:data:: firstExtentDetails.nsdiag
79+
80+
.. js:data:: firstExtentDetails.size
81+
82+
.. js:data:: firstExtentDetails.firstRecord
83+
84+
.. js:data:: firstExtentDetails.lastRecord
85+
86+
.. js:data:: objectsFound
87+
88+
.. js:data:: invalidObjects
89+
90+
.. note::
91+
92+
This field is only included in the validation output when you
93+
specify the "``full``" option.
94+
95+
.. js:data:: byteswWithHeaders
96+
97+
.. note::
98+
99+
This field is only included in the validation output when you
100+
specify the "``full``" option.
101+
102+
.. js:data:: bytesWithoutHeaders
103+
104+
.. note::
105+
106+
This field is only included in the validation output when you
107+
specify the "``full``" option.
108+
109+
.. js:data:: deletedCount
110+
111+
.. js:data:: deletedSize
112+
113+
.. js:data:: nIndexes
114+
115+
.. js:data:: keysPerIndex
116+
117+
.. js:data:: valid
118+
119+
.. js:data:: errors
120+
121+
.. js:data:: ok

0 commit comments

Comments
 (0)