[CSHARP-856] please update description of 'fsync' write concern flag Created: 30/Oct/13  Updated: 02/Apr/15  Resolved: 24/Feb/14

Status: Closed
Project: C# Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 1.9

Type: Improvement Priority: Major - P3
Reporter: Duraid Madina Assignee: Robert Stam
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to DRIVERS-125 update description of 'fsync' write c... Closed

 Description   

Since your driver's documentation (e.g. here) describes the 'fsync' write concern flag, can you please update its description so that it accurately describes the current behavior, which is:

  1. 'fsync' is identical to 'j' if mongod is running with a journal (today, 99% of users should be here)
  2. 'fsync' requests that the write be sync()'d to disk only if mongod is not running with a journal
  3. 'fsync' cannot be used simultaneously with the 'j' flag

The point is that:

  • 'j' means 'sync via the journal if present, or error if not, or if 'fsync' is also set'
  • 'fsync' means 'sync via the journal if present, or sync via msync() if there is no journal, and error if 'j' is also set'

Additionally, could you please mark the 'fsync' flag as "Deprecated; do not use", following this commit here

Please see SERVER-11399 for background.

Thanks!



 Comments   
Comment by Robert Stam [ 20/Feb/14 ]

In the .NET driver the online documentation is by our own choice almost always just a sentence long.

I've altered the documentation for FSync and Journal to clarify that what these options do is specify the details of the WriteConcern to use.

Comment by Githook User [ 20/Feb/14 ]

Author:

{u'username': u'rstam', u'name': u'rstam', u'email': u'robert@10gen.com'}

Message: CSHARP-856: Reword online documentation for WriteConcern FSync and Journal properties.
Branch: master
https://github.com/mongodb/mongo-csharp-driver/commit/895c75170d08df59eac85644368184a27a2533d7

Generated at Wed Feb 07 21:38:01 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.