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

Improve documentation for Eventing/Sync Gateway interactions

    XMLWordPrintable

Details

    • Improvement
    • Status: Reopened
    • Major
    • Resolution: Unresolved
    • None
    • Mobile 2.8
    • eventing, sync-gateway
    • None
    • 1

    Description

      We should improve the documentation for utilising Eventing with Sync Gateway. At present, there is not much information present regarding this use case and the best practices/pit falls/known issues or limitations of such a deployment.

      One example of this is that there is no documentation regarding not being able to deploy a source mutating eventing function against a bucket that has Sync Gateway acting upon it. This makes sense since it would cause an infinitely recursive function, however knowing this relies on having detailed product knowledge and is not necessarily intuitive to the end user. Unfortunately, this is not documented anywhere and so if a user tries to do this they will see an error message on the UI, but then no reference as to why this was seen.

      Attachments

        Issue Links

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

          Activity

            tim.bradgate Tim Bradgate (Inactive) created issue -
            tim.bradgate Tim Bradgate (Inactive) made changes -
            Field Original Value New Value
            Link This issue blocks CBSE-8326 [ CBSE-8326 ]

            Jon Strabala Do you have docs covering this issue on the eventing side that sync gateway can reference ? Based on comments above, probably not.  Can you put together a paragraph describing the issue that we can include in sync gateway docs page? (probably need to cross-reference from both docs  )

            priya.rajagopal Priya Rajagopal added a comment - Jon Strabala  Do you have docs covering this issue on the eventing side that sync gateway can reference ? Based on comments above, probably not.  Can you put together a paragraph describing the issue that we can include in sync gateway docs page? (probably need to cross-reference from both docs  )
            priya.rajagopal Priya Rajagopal made changes -
            Link This issue is cloned by DOC-6754 [ DOC-6754 ]
            jon.strabala Jon Strabala added a comment -

            Priya Rajagopal please refer to the follwoing:

            It has a discussion and small example of using crc64() to work around the duplicate mutation issue.

            Hopefully as per my comment in MB-37374 for CC both the SG and the Transactions issues in CC might be fixed

            jon.strabala Jon Strabala added a comment - Priya Rajagopal  please refer to the follwoing: https://docs.couchbase.com/server/6.5/eventing/eventing-language-constructs.html#crc64_call It has a discussion and small example of using crc64() to work around the duplicate mutation issue. Hopefully as per my comment in MB-37374 for CC both the SG and the Transactions issues in CC might be fixed
            priya.rajagopal Priya Rajagopal made changes -
            Link This issue blocks DOC-7563 [ DOC-7563 ]
            Ian.bridge Ian Bridge made changes -
            Labels mobile, needs-triage
            Ian.bridge Ian Bridge made changes -
            Link This issue relates to DOC-7895 [ DOC-7895 ]
            Ian.bridge Ian Bridge made changes -
            Labels mobile, needs-triage mobile, mobsprintnext needs-triage
            Ian.bridge Ian Bridge added a comment -

            Admin closure

            This will be progressed under DOC-7895

            Ian.bridge Ian Bridge added a comment - Admin closure This will be progressed under DOC-7895
            Ian.bridge Ian Bridge made changes -
            Fix Version/s Mobile 2.8 [ 16740 ]
            Issue Type Task [ 3 ] Improvement [ 4 ]
            Resolution Duplicate [ 3 ]
            Status Open [ 1 ] Closed [ 6 ]
            Ian.bridge Ian Bridge made changes -
            Link This issue is cloned by DOC-6754 [ DOC-6754 ]
            Ian.bridge Ian Bridge added a comment -

            Remove labels

            Ian.bridge Ian Bridge added a comment - Remove labels
            Ian.bridge Ian Bridge made changes -
            Resolution Duplicate [ 3 ]
            Status Closed [ 6 ] Reopened [ 4 ]
            Ian.bridge Ian Bridge made changes -
            Labels mobile, mobsprintnext needs-triage
            Ian.bridge Ian Bridge made changes -
            Resolution Fixed [ 1 ]
            Status Reopened [ 4 ] Closed [ 6 ]
            Ian.bridge Ian Bridge made changes -
            Resolution Fixed [ 1 ]
            Status Closed [ 6 ] Reopened [ 4 ]
            Ian.bridge Ian Bridge made changes -
            Link This issue relates to DOC-8390 [ DOC-8390 ]

            People

              Ian.bridge Ian Bridge
              tim.bradgate Tim Bradgate (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty