Skip to content

Commit 3e3814d

Browse files
author
Bob Grabar
committed
DOCS-303 review edits
1 parent a53e0b1 commit 3e3814d

File tree

1 file changed

+41
-23
lines changed

1 file changed

+41
-23
lines changed

source/core/sharding-internals.txt

Lines changed: 41 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -487,13 +487,13 @@ All chunk migrations use the following procedure:
487487
the source shard for the chunk. In this operation the balancer
488488
passes the name of the destination shard to the source shard.
489489

490-
#. The source initaties the move with an internal
490+
#. The source initiaties the move with an internal
491491
:dbcommand:`moveChunk` command with the destination shard.
492492

493493
#. The destination shard begins requesting documents in the chunk, and
494494
begins receiving these chunks.
495495

496-
#. After receving the final document in the chunk, the destination
496+
#. After receiving the final document in the chunk, the destination
497497
shard initiates a synchronization process to ensure that all
498498
changes to the documents in the chunk on the source shard during
499499
the migration process exist on the destination shard.
@@ -513,7 +513,7 @@ Config Database
513513

514514
The ``config`` database contains information about your sharding
515515
configuration and stores the information in a set of collections
516-
specific to sharding.
516+
used by sharding.
517517

518518
.. important:: Back up the ``config`` database before performing
519519
any maintenance on the config server.
@@ -525,13 +525,14 @@ To start the ``config`` database, issue the following command from the
525525

526526
use config
527527

528-
The config database includes the following collections specific to sharding:
528+
The ``config`` database holds the following collections that support
529+
sharded cluster operations:
529530

530-
.. data:: chunks
531+
.. data:: chunks
531532

532-
This collection lists the chunks in the sharded cluster. Each chunk
533-
is listed as a separate document. The following is the document for a
534-
chunk with the ``_id`` ``mydb.foo-animal_\"cat\"``. Among other
533+
The :data:`chunks` collection represents each chunk in the sharded cluster
534+
in a separate document. The following is a document for a
535+
chunk with an ``_id`` value of ``mydb.foo-animal_\"cat\"``. Among other
535536
information, the document shows the chunk's minimum and maximum
536537
values (in the ``min`` and ``max`` fields) and the name of the shard
537538
to which the chunk belongs (in the ``shard`` field):
@@ -554,9 +555,10 @@ The config database includes the following collections specific to sharding:
554555

555556
.. data:: collections
556557

557-
This lists the collections in the sharded cluster. Each collection is
558-
listed as a separate document. The following is the document for the
559-
``foo`` collection in the ``mydb`` database:
558+
The :data:`collections` collection represents each sharded collection
559+
in the cluster in a separate document. Given a collection named ``foo``
560+
in the ``mydb`` database, the document in the :data:`collections`
561+
collection would resemble:
560562

561563
.. code-block:: javascript
562564

@@ -573,7 +575,7 @@ The config database includes the following collections specific to sharding:
573575

574576
.. data:: databases
575577

576-
This collection lists the databases in the sharded cluster and whether
578+
The :data:`databases` collection holds the databases in the sharded cluster and whether
577579
or not each is partitioned. Each database is listed as a separate
578580
document. If a database is partitioned, the ``primary`` key gives the
579581
name of the :term:`primary shard`.
@@ -583,17 +585,28 @@ The config database includes the following collections specific to sharding:
583585
{ "_id" : "admin", "partitioned" : false, "primary" : "config" }
584586
{ "_id" : "mydb", "partitioned" : true, "primary" : "shard0000" }
585587

586-
.. TODO Is data:: lockpings a shard-specific collection?
588+
.. data:: lockpings
587589

588-
.. TODO Is data:: locks a shard-specific collection?
590+
The :data:`lockpings` collection keeps track of the active components
591+
in the sharded cluster. Given a cluster with a :program:`mongos`
592+
running on ``example.com:30000``, the document in the
593+
:data:`lockpings` collection would resemble:
594+
595+
.. code-block:: javascript
596+
597+
{ "_id" : "example.com:30000:1350047994:16807", "ping" : ISODate("2012-10-12T18:32:54.892Z") }
598+
599+
.. data:: locks
600+
601+
The :data:`locks` collection is used for distributed locking between
602+
:program:`mongos` instances and shards.
589603

590604
.. data:: mongos
591605

592-
This collection lists all the :program:`mongos` sharding routers
593-
affiliated with the sharded cluster. Each :program:`mongos` is
594-
listed as a separate document. A :program:`mongos` pings the cluster
606+
The :data:`mongos` collection represents each :program:`mongos`
607+
affiliated with the sharded cluster. A :program:`mongos` sends pings to all members of the cluster
595608
every 30 seconds to verify to the cluster the :program:`mongos` is
596-
active. This collection is used for reporting.
609+
active. The ``ping`` field shows the time of the last ping. This collection is used for reporting.
597610

598611
The following document shows the status of the :program:`mongos`
599612
running on ``example.com:30000``.
@@ -604,7 +617,7 @@ The config database includes the following collections specific to sharding:
604617

605618
.. data:: settings
606619

607-
This collection lists the following sharding configuration settings:
620+
The :data:`settings` collection holds the following sharding configuration settings:
608621

609622
- Chunk size. To change chunk size, see :ref:`sharding-balancing-modify-chunk-size`.
610623

@@ -619,21 +632,26 @@ The config database includes the following collections specific to sharding:
619632

620633
.. data:: shards
621634

622-
This collection lists the shards you have created. Each shard is
623-
listed as a separate document. If the shard is a replica set, the
635+
The :data:`shards` collection represents each shard in the cluster
636+
in a separate document. If the shard is a replica set, the
624637
``host`` field displays the name of the replica set, then a slash, then
625638
the hostname, as shown here:
626639

627640
.. code-block:: javascript
628641

629642
{ "_id" : "shard0000", "host" : "shard1/localhost:30000" }
630643

644+
.. data:: system.indexes
645+
646+
The :data:`system.indexes` collection contains all the indexes in the
647+
shard. For more information on indexes, see :doc:`/indexes`.
648+
631649
.. data:: version
632650

633-
This collection contains the current metadata version number. This
651+
The :data:`version` collection holds the current metadata version number. This
634652
collection contains only one document:
635653

636-
To access the ``version`` collection you must use the
654+
To access the :data:`version` collection you must use the
637655
:method:`db.getCollection()` method. For example, to display the
638656
collection's document:
639657

0 commit comments

Comments
 (0)