Skip to content

(DOCS-9990, -10826): Updated flushRouterConfig. #3262

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 18, 2018
Merged

(DOCS-9990, -10826): Updated flushRouterConfig. #3262

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
746e6ce
(DOCS-9990, -10826): Updated flushRouterConfig.
Mar 14, 2018
9087044
Updated per @kaloianm review.
Mar 16, 2018
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
20 changes: 14 additions & 6 deletions source/reference/command/flushRouterConfig.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ flushRouterConfig

.. dbcommand:: flushRouterConfig

:dbcommand:`flushRouterConfig` clears the current cluster
information cached by a :binary:`~bin.mongos` instance and reloads all
:term:`sharded cluster` metadata from the :term:`config database`.
:dbcommand:`flushRouterConfig` clears the cached routing table in a
:binary:`~bin.mongos` instance. Subsequent :binary:`~bin.mongos`
commands update the routing table as routes are needed.
Copy link
Member

Choose a reason for hiding this comment

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

Subsequent commands against that :binary:~bin.mongos will repopulate the routing table cache from the config server as they execute.


This forces an update when the configuration database holds data
that is newer than the data cached in the :binary:`~bin.mongos`
process.
When this command is called, it forces an update when the
configuration database holds data that is more recent than the data
cached in the :binary:`~bin.mongos` process.
Copy link
Member

Choose a reason for hiding this comment

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

This sounds a little awkward. How about:

Use this command to force the routing table cache to be refreshed from the config server when there is possibility that it contains a more recent data. In almost all cases, this happens automatically, so it typically only needs to be done after a movePrimary as per instructions.


.. warning::

Expand All @@ -29,4 +29,12 @@ flushRouterConfig
:dbcommand:`flushRouterConfig` is an administrative command that is
only available for :binary:`~bin.mongos` instances.

Call this command using the following form:

.. example::

.. code-block:: javascript

db.adminCommand("flushRouterConfig")

.. versionadded:: 1.8.2