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

Edit "include_doc" to "include_docs" for correct usage

    XMLWordPrintable

Details

    • Bug
    • Status: Closed
    • Trivial
    • Resolution: Fixed
    • None
    • None
    • documentation
    • TP Sprint 14, TP Sprint 15

    Description

      In a couple of places I see reference to "include_docs=true" as "include_doc" , it is missing the 's'
      The resulting usage will not yield the expected result of including the docs on the query result.

      Reference : http://www.couchbase.com/docs//couchbase-manual-2.0/couchbase-views-expiration.html

      For example :
      http://127.0.0.1:9500/beer-sample/_design/beer/_view/brewery_beers?stale=update_after&connection_timeout=60000&limit=10&skip=0&include_doc=true

      {"total_rows":7302,"rows":[

      {"id":"21st_amendment_brewery_cafe","key":["21st_amendment_brewery_cafe"],"value":null}

      ,

      {"id":"21st_amendment_brewery_cafe-21a_ipa","key":["21st_amendment_brewery_cafe","21st_amendment_brewery_cafe-21a_ipa"],"value":null}

      ,

      Whereas the correct usage and expected result for this query should be

      http://127.0.0.1:9500/beer-sample/_design/beer/_view/brewery_beers?stale=update_after&connection_timeout=60000&limit=10&skip=0&include_docs=true

      {"total_rows":7302,"rows":[
      {"id":"21st_amendment_brewery_cafe","key":["21st_amendment_brewery_cafe"],"value":null,"doc":{"meta":

      {"id":"21st_amendment_brewery_cafe","rev":"1-00000001b0f188800000000000000000","expiration":0,"flags":0}

      ,"json":{"name":"21st Amendment Brewery Cafe","city":"San Francisco","state":"California","code":"94107","country":"United States","phone":"1-415-369-0900","website":"http://www.21st-amendment.com/","type":"brewery","updated":"2010-10-24 13:54:07","description":"The 21st Amendment Brewery offers a variety of award winning house made brews and American grilled cuisine in a comfortable loft like setting. Join us before and after Giants baseball games in our outdoor beer garden. A great location for functions and parties in our semi-private Brewers Loft. See you soon at the 21A!","address":["563 Second Street"],"geo":{"accuracy":"ROOFTOP","lat":37.7825,"lon":-122.393}}}},
      {"id":"21st_amendment_brewery_cafe-21a_ipa","key":["21st_amendment_brewery_cafe","21st_amendment_brewery_cafe-21a_ipa"],"value":null,"doc":{"meta":

      {"id":"21st_amendment_brewery_cafe-21a_ipa","rev":"1-00000001ae132e250000000000000000","expiration":0,"flags":0}

      ,"json":{"name":"21A IPA","abv":7.2,"ibu":0.0,"srm":0.0,"upc":0,"type":"beer","brewery_id":"21st_amendment_brewery_cafe","updated":"2010-07-22 20:00:20","description":"Deep golden color. Citrus and piney hop aromas. Assertive malt backbone supporting the overwhelming bitterness. Dry hopped in the fermenter with four types of hops giving an explosive hop aroma. Many refer to this IPA as Nectar of the Gods. Judge for yourself. Now Available in Cans!","style":"American-Style India Pale Ale","category":"North American

      Attachments

        Issue Links

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

          Activity

            Being deprecated in 3.0.

            ruth Ruth Harris (Inactive) added a comment - Being deprecated in 3.0.

            We have a whole section on Detecting Expired Documents in Result Sets that talk about using include_docs.
            What's the replacement?

            ruth Ruth Harris (Inactive) added a comment - We have a whole section on Detecting Expired Documents in Result Sets that talk about using include_docs. What's the replacement?

            Ruth, there's no replacement on the HTTP API level. You would need to use the SDKs for it, they still support include_docs.

            vmx Volker Mische added a comment - Ruth, there's no replacement on the HTTP API level. You would need to use the SDKs for it, they still support include_docs.

            Issues MB-10381 and MB-10183 seem to relate to the same thing.

            akurtzman Amy Kurtzman (Inactive) added a comment - Issues MB-10381 and MB-10183 seem to relate to the same thing.
            ruth Ruth Harris (Inactive) added a comment - - edited

            Removed the content in the Detecting Expired Documents in Result Sets section that references include_docs

            Fixed in 3.0

            Note: Updates are published to the Couchbase website within 24 hours.

            ruth Ruth Harris (Inactive) added a comment - - edited Removed the content in the Detecting Expired Documents in Result Sets section that references include_docs Fixed in 3.0 Note: Updates are published to the Couchbase website within 24 hours.

            People

              ruth Ruth Harris (Inactive)
              ketaki Ketaki Gangal (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty