Skip to content

DOCS-529 consistency edit for references to admin database/ administrative commands #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions source/core/sharding.txt
Original file line number Diff line number Diff line change
Expand Up @@ -531,14 +531,14 @@ setting:`keyFile` configuration option for all :program:`mongos`,
configuration instances, and shard :program:`mongod` instances.

There are two classes of security credentials in a shard cluster:
credentials for "admin" users (i.e. for the "admin" database) and
credentials for "admin" users (i.e. for the :term:`admin database`) and
credentials for all other databases. These credentials reside in
different locations within the shard cluster and have different roles:

#. Admin database credentials reside on the config servers, to receive
admin access to the cluster you *must* authenticate a session while
connected to a :program:`mongos` instance using the "admin"
database.
connected to a :program:`mongos` instance using the
:term:`admin database`.

#. Other database credentials reside on the *primary* shard for the
database.
Expand All @@ -552,6 +552,6 @@ the database should use a :program:`mongos` instance.

Individual shards can store administrative credentials to their
instance, which only permit access to a single shard. MongoDB
stores these credentials in the shards "admin" databases and these
stores these credentials in the shards' :term:`admin database`\s and these
credentials are *completely* distinct from the cluster-wide
administrative credentials.
25 changes: 25 additions & 0 deletions source/reference/command/buildInfo.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
=========
buildInfo
=========

.. default-domain:: mongodb

.. dbcommand:: buildInfo

The :dbcommand:`buildInfo` command is an administrative command which
returns a build summary for the current :program:`mongod`.

.. code-block:: javascript

{ buildInfo: 1 }

The information provided includes the following:

- The version of MongoDB currently running.

- The information about the system that built the
":program:`mongod`" binary, including a timestamp for the build.

- The architecture of the binary (i.e. 64 or 32 bits.)

- The maximum allowable :term:`BSON` object size in bytes (in the field ``maxBsonObjectSize``.)
5 changes: 4 additions & 1 deletion source/reference/command/getParameter.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ getParameter

:dbcommand:`getParameter` is an administrative command for
retrieving the value of options normally set on the command
line. Issue commands against the ``admin`` database as follows:
line.
You must issue the
:dbcommand:`getParameter`
command against the :term:`admin database` in the form:

.. code-block:: javascript

Expand Down
12 changes: 7 additions & 5 deletions source/reference/command/journalLatencyTest.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,16 @@ journalLatencyTest

.. dbcommand:: journalLatencyTest

:dbcommand:`journalLatencyTest` is an admin command that tests the
:dbcommand:`journalLatencyTest` is an administrative command that tests the
length of time required to write and perform a file system sync
(e.g. :term:`fsync`) for a file in the journal directory. The
command syntax is:

(e.g. :term:`fsync`) for a file in the journal directory.
You must issue the
:dbcommand:`journalLatencyTest`
command against the :term:`admin database` in the form:

.. code-block:: javascript

{ journalLatencyTest: 1 }

The value (i.e. ``1`` above), does not affect the operation of the
command.
command.
8 changes: 6 additions & 2 deletions source/reference/command/logRotate.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@ logRotate

.. dbcommand:: logRotate

:dbcommand:`logRotate` is an admin only command that allows you to rotate
The :dbcommand:`logRotate` command is an administrative command that
allows you to rotate
the MongoDB logs to prevent a single logfile from consuming too
much disk space. Use the following syntax: ::
much disk space.
You must issue the
:dbcommand:`logRotate`
command against the :term:`admin database` in the form:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

code-block

{ logRotate: 1 }

Expand Down
6 changes: 4 additions & 2 deletions source/reference/command/moveChunk.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ moveChunk
.. dbcommand:: moveChunk

:dbcommand:`moveChunk` is an internal administrative command that
moves :term:`chunks <chunk>` between :term:`shards <shard>`. The
command has the following prototype form:
moves :term:`chunks <chunk>` between :term:`shards <shard>`.
You must issue the
:dbcommand:`moveChunk`
command against the :term:`admin database` in the form:

.. code-block:: javascript

Expand Down
2 changes: 1 addition & 1 deletion source/reference/command/renameCollection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ renameCollection

{ renameCollection: "store.things", to: "store.events" }

You must run this command against the admin database. and thus
You must run this command against the :term:`admin database`. and thus
requires you to specify the complete namespace (i.e., database name
and collection name.)

Expand Down
2 changes: 1 addition & 1 deletion source/reference/command/replSetFreeze.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ replSetFreeze
set member.

:dbcommand:`replSetFreeze` is an administrative command, and you
must issue the it against the ``admin`` database.
must issue the it against the :term:`admin database`.

.. slave-ok, admin-only
2 changes: 1 addition & 1 deletion source/reference/command/replSetGetStatus.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ replSetGetStatus

The ``replSetGetStatus`` command returns the status of the replica
set from the point of view of the current server. You must run the
command against the admin database. The command has the following
command against the :term:`admin database`. The command has the following
prototype format:

.. code-block:: javascript
Expand Down
2 changes: 1 addition & 1 deletion source/reference/command/replSetReconfig.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ replSetReconfig

Be aware of the following :dbcommand:`replSetReconfig` behaviors:

- You must issue this command against the admin database of the current
- You must issue this command against the :term:`admin database` of the current
primary member of the replica set.

- You can optionally force the replica set to accept the new
Expand Down
4 changes: 2 additions & 2 deletions source/reference/command/setParameter.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ setParameter

:dbcommand:`setParameter` is an administrative command for
modifying options normally set on the command line. You must issue
the :dbcommand:`setParameter` command against the ``admin``
database in the form:
the :dbcommand:`setParameter` command against the :term:`admin database`
in the form:

.. code-block:: javascript

Expand Down
7 changes: 4 additions & 3 deletions source/reference/command/shutdown.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,17 @@ shutdown
.. dbcommand:: shutdown

The :dbcommand:`shutdown` command cleans up all database resources
and then terminates the process. The command has the following
form:
and then terminates the process. You must issue
the :dbcommand:`shutdown` command against the :term:`admin database`
in the form:

.. code-block:: javascript

{ shutdown: 1 }

.. note::

Run the :dbcommand:`shutdown` against the admin database. When
When
using :dbcommand:`shutdown`, the connection must originate from
localhost **or** use an authenticated connection.

Expand Down
34 changes: 7 additions & 27 deletions source/reference/command/top.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ top

.. dbcommand:: top

The :dbcommand:`top` command returns raw usage of each database,
The :dbcommand:`top` command is an administrative command which
returns raw usage of each database,
and provides amount of time, in microseconds, used and a count of
operations for the following event types:

Expand All @@ -20,31 +21,10 @@ top
- remove
- commands

The command takes the following form:

.. code-block:: javascript

{ top: 1 }

.. dbcommand:: buildInfo

The :dbcommand:`buildInfo` command returns a build summary for the current
:program:`mongod`:

You must issue the
:dbcommand:`top`
command against the :term:`admin database` in the form:

.. code-block:: javascript

{ buildInfo: 1 }

The information provided includes the following:

- The version of MongoDB currently running.

- The information about the system that built the
":program:`mongod`" binary, including a timestamp for the build.

- The architecture of the binary (i.e. 64 or 32 bits.)

- The maximum allowable :term:`BSON` object size in bytes (in the field ``maxBsonObjectSize``.)

You must issue the :dbcommand:`buildInfo` command against the
``admin`` database.
{ top: 1 }
9 changes: 8 additions & 1 deletion source/reference/commands.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ Many commands have their own shell helpers:

db.isMaster();

You must run some commands on the ``admin`` database. Normally, that
.. _admin-command::

You must run some commands on the :term:`admin database`. Normally, that
looks like this:

.. code-block:: javascript
Expand Down Expand Up @@ -192,6 +194,8 @@ Collections
.. include:: command/collMod.txt
:start-after: mongodb

.. _admin-commands::

Administration
~~~~~~~~~~~~~~

Expand Down Expand Up @@ -237,6 +241,9 @@ Administration
Diagnostics
~~~~~~~~~~~

.. include:: command/buildInfo.txt
:start-after: mongodb

.. include:: command/dbStats.txt
:start-after: mongodb

Expand Down
4 changes: 3 additions & 1 deletion source/reference/glossary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,9 @@ Glossary
admin database
A privileged database named ``admin``. Users must have access
to this database to run certain administrative commands.
See :doc:`commands` for more information on these commands.
See :ref:`administrative commands <admin-command>`
for more information
and :ref:`admin-commands` for a list of these commands.

replica set
A cluster of MongoDB servers that implements master-slave
Expand Down
2 changes: 1 addition & 1 deletion source/reference/method/db.shutdownServer.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ db.shutdownServer()
process cleanly and safely.

This operation fails when the current database *is not* the
admin database.
:term:`admin database`.

This command provides a wrapper around the :dbcommand:`shutdown`.
2 changes: 1 addition & 1 deletion source/reference/mongo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Options
mongo admin

The above command will connect the :program:`mongo` shell to the
administrative database on the local machine. You may specify a
:term:`admin database` on the local machine. You may specify a
remote database instance, with the resolvable hostname or IP
address. Separate the database name from the hostname using a
``/`` character. See the following examples: ::
Expand Down
2 changes: 1 addition & 1 deletion source/reference/replica-status.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Replica Status Reference

The :dbcommand:`replSetGetStatus` provides an overview of the
current status of a :term:`replica set`. Issue the following command against
the ``admin`` database, in the :program:`mongo` shell:
the :term:`admin database`, in the :program:`mongo` shell:

.. code-block:: javascript

Expand Down
22 changes: 11 additions & 11 deletions source/reference/server-status.txt
Original file line number Diff line number Diff line change
Expand Up @@ -144,41 +144,41 @@ locks
.. status:: locks.admin

The :status:`locks.admin` document contains two sub-documents that
reports data regarding lock use in the ``admin`` database.
reports data regarding lock use in the :term:`admin database`.

.. status:: locks.admin.timeLockedMicros

The :status:`locks.admin.timeLockedMicros` document reports the amount of
time in microseconds that locks have existed in the context of the
``admin`` database.
:term:`admin database`.

.. status:: locks.admin.timeLockedMicros.r

The ``r`` field reports the amount of time in microseconds that the
``admin`` database has held the read lock.
:term:`admin database` has held the read lock.

.. status:: locks.admin.timeLockedMicros.w

The ``w`` field reports the amount of time in microseconds that the
``admin`` database has held the write lock.
:term:`admin database` has held the write lock.

.. status:: locks.admin.timeAcquiringMicros

The :status:`locks.admin.timeAcquiringMicros` document reports on the
amount of field time in microseconds that operations have spent
waiting to acquire a lock for the ``admin`` database.
waiting to acquire a lock for the :term:`admin database`.

.. status:: locks.admin.timeAcquiringMicros.r

The ``r`` field reports the amount of time in microseconds that
operations have spent waiting a read lock on the ``admin``
database.
operations have spent waiting a read lock on the
:term:`admin database`.

.. status:: locks.admin.timeAcquiringMicros.w

The ``w`` field reports the amount of time in microseconds that
operations have spent waiting a write lock on the ``admin``
database.
operations have spent waiting a write lock on the
:term:`admin database`.

.. status:: locks.local

Expand Down Expand Up @@ -1133,13 +1133,13 @@ recordStats

:status:`recordStats.admin.accessNotInMemory` reflects the number of
times :program:`mongod` needed to access a memory page that was
*not* resident in memory for the ``admin`` database.
*not* resident in memory for the :term:`admin database`.

.. status:: recordStats.admin.pageFaultExceptionsThrown

:status:`recordStats.admin.pageFaultExceptionsThrown` reflects the
number of page fault exceptions thrown by :program:`mongod` when
accessing data for the ``admin`` database.
accessing data for the :term:`admin database`.

.. status:: recordStats.<database>.accessNotInMemory

Expand Down