Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-15975

[Server] Improve ChangeStream pre-and-post image page

    XMLWordPrintableJSON

Details

    Description

      Please add an example for enabling changeStreamPreAndPostImages into the documentation for Change Streams with Document Pre- and Post-Images.

      The current layout can be misread to believe that it would be necessary to run the setClusterParameter command which configures preAndPostImages.expireAfterSeconds.

      To improve this, we could change the third bullet point ("Enable changeStreamPreAndPostImages for a collection using ...") to provide an example of a createCollection or collMod command which would enable the setting necessary to enable pre-and-post images. This would break up the flow and make it clear that the later command is a separate concept entirely.

      Example / Proposed Language

      Document Pre-and-Post-Images on a collection can be enabled by enabling the option changeStreamPreAndPostImages using createCollection or collMod. For example:

      db.createCollection(<collection>, {  changeStreamPreAndPostImages:{{{}

      { enabled: true }

      {}}}

      })

      Other Thoughts

      There's a lot of good information in the expireAfterSeconds section, but I think a lot of it may be out of place. Most of this seems to be duplicated from the entry for this parameter in Cluster Parameters - so it may make this section easier to parse if we just link there instead.

      Attachments

        Activity

          People

            Unassigned Unassigned
            adam.harrison@mongodb.com Adam Harrison
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              44 weeks, 1 day ago