From c464906bd593488e5bdb9a13ecfffe0fca372da5 Mon Sep 17 00:00:00 2001 From: "Kenneth P. J. Dyer" <93145796+kennethdyer@users.noreply.github.com> Date: Wed, 7 Feb 2024 11:24:26 -0600 Subject: [PATCH] DOCSP-36105 fsync Carification (#6255) (#6284) * DOCSP-36105 fsync clarification * Replaces versionadded text with fsycn-mongos * Fixes method text * Adds facets --- source/includes/fsync-mongos.rst | 3 +++ source/reference/command/fsync.txt | 9 ++++++--- source/reference/command/fsyncUnlock.txt | 8 ++++++-- source/reference/method/db.fsyncLock.txt | 8 ++++++-- source/reference/method/db.fsyncUnlock.txt | 8 ++++++-- 5 files changed, 27 insertions(+), 9 deletions(-) create mode 100644 source/includes/fsync-mongos.rst diff --git a/source/includes/fsync-mongos.rst b/source/includes/fsync-mongos.rst new file mode 100644 index 00000000000..8c2f82447a1 --- /dev/null +++ b/source/includes/fsync-mongos.rst @@ -0,0 +1,3 @@ + +When the |fsync| runs on :program:`mongos`, it performs the fysnc operation on the +primary config server as well as the primary members of each shard in the cluster. diff --git a/source/reference/command/fsync.txt b/source/reference/command/fsync.txt index b5b393ebb12..59c4c0d0d92 100644 --- a/source/reference/command/fsync.txt +++ b/source/reference/command/fsync.txt @@ -4,6 +4,10 @@ fsync .. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + .. contents:: On this page :local: :backlinks: none @@ -26,9 +30,8 @@ Definition .. versionadded:: 5.0.22 - When the ``fsync`` command runs on :program:`mongos`, it performs the - fsync operation on each shard in the cluster. - + .. |fsync| replace:: ``fsync`` command + .. include:: /includes/fsync-mongos As applications write data, MongoDB records the data in the storage layer and then writes the data to disk within the diff --git a/source/reference/command/fsyncUnlock.txt b/source/reference/command/fsyncUnlock.txt index aee6d696c32..863fe41f640 100644 --- a/source/reference/command/fsyncUnlock.txt +++ b/source/reference/command/fsyncUnlock.txt @@ -4,6 +4,10 @@ fsyncUnlock .. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + .. contents:: On this page :local: :backlinks: none @@ -25,8 +29,8 @@ Definition .. versionadded:: 5.0.22 - When the ``fsyncUnlock`` command runs on :program:`mongos`, it - reduces the lock count for each shard in the cluster. + .. |fsync| replace:: ``fsyncUnlock`` command + .. include:: /includes/fsync-mongos Use this command to unblock writes after you finish a backup operation. diff --git a/source/reference/method/db.fsyncLock.txt b/source/reference/method/db.fsyncLock.txt index 94e9a958a90..d6ca361a475 100644 --- a/source/reference/method/db.fsyncLock.txt +++ b/source/reference/method/db.fsyncLock.txt @@ -4,6 +4,10 @@ db.fsyncLock() .. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + .. contents:: On this page :local: :backlinks: none @@ -24,8 +28,8 @@ Definition .. versionadded:: 5.0.22 - When the ``db.fsyncLock`` method runs on :program:`mongos`, it applies an - fsync lock to each shard in the cluster. + .. |fsync| replace:: ``db.fsyncLock()`` method + .. include:: /includes/fsync-mongos .. |dbcommand| replace:: :dbcommand:`fsync` command .. include:: /includes/fact-mongosh-shell-method-alt.rst diff --git a/source/reference/method/db.fsyncUnlock.txt b/source/reference/method/db.fsyncUnlock.txt index d803fe1072c..e2baa0af6f7 100644 --- a/source/reference/method/db.fsyncUnlock.txt +++ b/source/reference/method/db.fsyncUnlock.txt @@ -4,6 +4,10 @@ db.fsyncUnlock() .. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + .. contents:: On this page :local: :backlinks: none @@ -23,8 +27,8 @@ Definition .. versionadded:: 5.0.22 - When the ``db.fsyncUnlock()`` method runs on :program:`mongos`, it - reduces the lock count for each shard in the cluster. + .. |fsync| replace:: ``db.fsyncUnlock()`` method + .. include:: /includes/fsync-mongos .. |dbcommand| replace:: :dbcommand:`fsyncUnlock` command .. include:: /includes/fact-mongosh-shell-method-alt.rst