Uploaded image for project: 'Couchbase Documentation'
  1. Couchbase Documentation
  2. DOC-105

Doc : Improve the documentation to explain durability options

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: tech-debt
    • Component/s: dev guide and SDKs
    • Labels:
      None
    • Sprint:
      TP Sprint 5 Nov - 19 Nov 2013, TP Sprint 20 Nov - 3 Dec 2013, TP Sprint 4 Dec - 17 2013, TP Sprint 18 Dec - 31 Dec 2013, TP Sprint Jan 1 - 14 2014

      Description

      We have been asked from the community to clarify the "durability" options values and impact:

      • differences between PersistTo and ReplicateTo
      • impact of each value on the application code/behavior.

      This is raised by our community users here:
      http://www.couchbase.com/communities/q-and-a/difference-between-peristto-and-replicateto

      Would be good to add description equivalent to the one made by househippo user, coming from:
      http://www.couchbase.com/autodocs/couchbase-java-client-1.1.8/net/spy/memcached/PersistTo.html

      No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

        Hide
        bdw429s Brad Wood added a comment -

        The specific doc page I'd like to see clarified is the Java API docs for the set commends:
        http://www.couchbase.com/docs/couchbase-sdk-java-1.1/couchbase-sdk-java-set-durability.html#table-couchbase-sdk_java_set-persist-replicate

        enum persistto Specify the number of nodes on which the document must be persisted to before returning.
        enum replicateto Specify the number of nodes on which the document must be replicated to before returning

        Perhaps some verbiage that specifies that persistence doesn't mean just stored, but stored on disk. Also, another thing that had confused me originally was that it seemed replication and persistence were mutually independent actions, but now I believe that you cannot persist without replicating first. In other words, if I require persistence on 3 nodes, that automatically implies that replication to 3 nodes will also occur. If that is true, it might be useful to clarify.

        Also, while just now re-reading that page, the word "requirment" is spelled wrong right above the last code block.

        Show
        bdw429s Brad Wood added a comment - The specific doc page I'd like to see clarified is the Java API docs for the set commends: http://www.couchbase.com/docs/couchbase-sdk-java-1.1/couchbase-sdk-java-set-durability.html#table-couchbase-sdk_java_set-persist-replicate enum persistto Specify the number of nodes on which the document must be persisted to before returning. enum replicateto Specify the number of nodes on which the document must be replicated to before returning Perhaps some verbiage that specifies that persistence doesn't mean just stored, but stored on disk. Also, another thing that had confused me originally was that it seemed replication and persistence were mutually independent actions, but now I believe that you cannot persist without replicating first. In other words, if I require persistence on 3 nodes, that automatically implies that replication to 3 nodes will also occur. If that is true, it might be useful to clarify. Also, while just now re-reading that page, the word "requirment" is spelled wrong right above the last code block.
        Hide
        akurtzman Amy Kurtzman added a comment -

        See Michael N. for info.

        Show
        akurtzman Amy Kurtzman added a comment - See Michael N. for info.
        Hide
        bdw429s Brad Wood added a comment -

        It's been 15 months since this ticket was created for a simple verbiage update. Is there anything I can do to help with it?

        Show
        bdw429s Brad Wood added a comment - It's been 15 months since this ticket was created for a simple verbiage update. Is there anything I can do to help with it?
        Hide
        akurtzman Amy Kurtzman added a comment -

        Brad, The specific page you said you'd like to see clarified is no longer included in current documentation; i.e., it is in the docs for Java SDK 1.1, but was removed in Java SDK 1.2. So, that page will not be updated.

        This issue needs to be addressed in the general documentation rather than in the documentation for one specific SDK.

        Show
        akurtzman Amy Kurtzman added a comment - Brad, The specific page you said you'd like to see clarified is no longer included in current documentation; i.e., it is in the docs for Java SDK 1.1, but was removed in Java SDK 1.2. So, that page will not be updated. This issue needs to be addressed in the general documentation rather than in the documentation for one specific SDK.
        Hide
        bdw429s Brad Wood added a comment -

        Yeah, that's fine. It just didn't seem a like a change that would require over a year to complete. JIRA E-mails me every time the sprint is changed and I'm pretty sure more effort has been put into updating this ticket than would have taken to just do the work :/

        Show
        bdw429s Brad Wood added a comment - Yeah, that's fine. It just didn't seem a like a change that would require over a year to complete. JIRA E-mails me every time the sprint is changed and I'm pretty sure more effort has been put into updating this ticket than would have taken to just do the work :/
        Hide
        akurtzman Amy Kurtzman added a comment -

        If you remove your name from the watch list, you won't be bothered with JIRA emails. If you can't do that yourself, please let me know and I can remove your name from the watch list for you.

        Show
        akurtzman Amy Kurtzman added a comment - If you remove your name from the watch list, you won't be bothered with JIRA emails. If you can't do that yourself, please let me know and I can remove your name from the watch list for you.
        Hide
        bdw429s Brad Wood added a comment -

        Yes, I know how JIRA works-- my desired outcome is that it would be fixed That's why I offered to help. For instance, Adobe has moved ColdFusion's docs to a public wiki. When I see something that need clarification there, I can just edit it myself and it's done.

        Show
        bdw429s Brad Wood added a comment - Yes, I know how JIRA works-- my desired outcome is that it would be fixed That's why I offered to help. For instance, Adobe has moved ColdFusion's docs to a public wiki. When I see something that need clarification there, I can just edit it myself and it's done.

          People

          • Assignee:
            marija Marija Jovanovic
            Reporter:
            akurtzman Amy Kurtzman
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:

              Agile

                Gerrit Reviews

                There are no open Gerrit changes