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

Documentation to cover XATTRs in server reference

    XMLWordPrintable

Details

    • New Feature
    • Resolution: Fixed
    • Blocker
    • spock
    • None
    • memcached
    • None
    • DOC-S1, DOC-S2-Nov03, DOC-S3-Nov17

    Description

      Starting in 5.0, XATTRs is a public feature of the system. While SDKs will cover the API and usage and how errors are returned, the details on those errors and the limitations of XATTRs itself needs to be centralized.

      This issue would be done when Couchbase Server documentation has a section that covers:

      • Error codes including the hex value, text returned, and a description of the error condition
      • A description of limitations in the implementation (e.g., XATTR mutations must come before non-XATTR mutations always), as this is not generally enforced in the API
      • A description of what the interface stability is for these features if there are any that are not committed interface

      This may be tracked somewhere already by Chin Hong's team (maybe Tyler Mitchell?).

      On that last bullet item, there are some things like retrieving XATTRs from deleted documents which are considered "Internal". See (https://developer.couchbase.com/documentation/server/current/sdk/java/compatibility-versions-features.html#topic_bhl_2cv_xv__d298e17) for a definition of interface stability. I don't think anything Internal should be covered in these docs, but anything Volatile or Uncommitted should, if there is such a thing.

      Attachments

        Issue Links

          Activity

            People

              richard.smedley Richard Smedley
              ingenthr Matt Ingenthron
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                PagerDuty