diff --git a/source/reference/command/flushRouterConfig.txt b/source/reference/command/flushRouterConfig.txt index 3a8ff90597b..66442e44325 100644 --- a/source/reference/command/flushRouterConfig.txt +++ b/source/reference/command/flushRouterConfig.txt @@ -12,21 +12,36 @@ 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 commands against that + :binary:`~bin.mongos` will repopulate the routing table cache from + the :term:`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. + Use this command to force the routing table cache to be refreshed + from the :term:`config server` if it contains more recent data. In + most cases, this happens automatically. You should need to run + :dbcommand:`flushRouterConfig` only after :dbcommand:`movePrimary` + has been run. + + .. seealso:: + + For when and why :dbcommand:`flushRouterConfig` is run, see + **Considerations** on the :dbcommand:`movePrimary` page. .. warning:: - Do not modify the config data, except as explicitly - documented. A config database cannot typically tolerate manual - manipulation. + Do not modify the routing table data except when it is + explicitly documented. :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