You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@couchdb.apache.org by GitBox <gi...@apache.org> on 2020/09/01 16:04:37 UTC

[GitHub] [couchdb-documentation] bessbd opened a new pull request #585: Fix stale options

bessbd opened a new pull request #585:
URL: https://github.com/apache/couchdb-documentation/pull/585


   ## Overview
   
   The docs for `stale` in views don't match the current behavior of the software.
   This PR fixes that issue by removing `false` from the available options from `stale` for views.
   
   Mind that, the "default value" (`false`) for `stale` can no longer be expressed explicitly.
   
   ## Testing recommendations
   ```python3
   print(requests.get(f"http://127.0.0.1:15984/{db_name}/_all_docs?stale=false", auth=('adm', 'pass')).json())
   ```
   results in
   `{'error': 'query_parse_error', 'reason': 'Invalid value for `stale`.'}`
   
   ## GitHub issue number
   
   
   ## Related Pull Requests
   
   This is a follow-up PR for https://github.com/apache/couchdb/pull/3120 .
   
   ## Checklist
   
   - [ ] Update [rebar.config.script](https://github.com/apache/couchdb/blob/master/rebar.config.script) with the commit hash once this PR is rebased and merged
   <!-- Before opening the PR, consider running `make check` locally for a faster turnaround time -->
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [couchdb-documentation] wohali commented on a change in pull request #585: Fix stale options

Posted by GitBox <gi...@apache.org>.
wohali commented on a change in pull request #585:
URL: https://github.com/apache/couchdb-documentation/pull/585#discussion_r482243925



##########
File path: src/maintenance/performance.rst
##########
@@ -268,7 +270,7 @@ that will occur giving you a quick response and when views will be updated
 which will take a long time. (A 10 million document database took about 10
 minutes to load into CouchDB but about 4 hours to do view generation).
 
-In a cluster, "stale" requests are serviced by a fixed set of shards in order
+In a cluster, "stable" requests are serviced by a fixed set of shards in order

Review comment:
       Hm. This is a good change (not talking about `stale`), but down in line 279 it talks about `stale=ok` and `stale=update_after` again.
   
   Similarly up in line 268 we talk about "stale" again.
   
   If you want to fully expunge the concept of stale requests, we should do it in this entire section. I'd be +1 on that work but don't have time to help today.
   
   Otherwise, I'd reverse the change and we can do that at a later date.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [couchdb-documentation] bessbd commented on pull request #585: Fix stale options

Posted by GitBox <gi...@apache.org>.
bessbd commented on pull request #585:
URL: https://github.com/apache/couchdb-documentation/pull/585#issuecomment-688270378


   Thank you for the review and merge, @rnewson !


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [couchdb-documentation] wohali commented on pull request #585: Fix stale options

Posted by GitBox <gi...@apache.org>.
wohali commented on pull request #585:
URL: https://github.com/apache/couchdb-documentation/pull/585#issuecomment-684999568


   @bessbd You also need to update this in `src/api/database/find.rst`.
   
   If you want you can link to the Views Generation section in `maintenance/performance.rst` to help people understand the difference between `stale`, `stable` and `update`, where it's explained in detail.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [couchdb-documentation] bessbd commented on pull request #585: Fix stale options

Posted by GitBox <gi...@apache.org>.
bessbd commented on pull request #585:
URL: https://github.com/apache/couchdb-documentation/pull/585#issuecomment-685462863


   > @bessbd You also need to update this in `src/api/database/find.rst`.
   > 
   > If you want you can link to the Views Generation section in `maintenance/performance.rst` to help people understand the difference between `stale`, `stable` and `update`, where it's explained in detail.
   
   Thank you for the review, @wohali . I've pushed a commit 7a9094e to address your requests.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [couchdb-documentation] rnewson merged pull request #585: Fix stale options

Posted by GitBox <gi...@apache.org>.
rnewson merged pull request #585:
URL: https://github.com/apache/couchdb-documentation/pull/585


   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [couchdb-documentation] bessbd commented on a change in pull request #585: Fix stale options

Posted by GitBox <gi...@apache.org>.
bessbd commented on a change in pull request #585:
URL: https://github.com/apache/couchdb-documentation/pull/585#discussion_r482938743



##########
File path: src/maintenance/performance.rst
##########
@@ -268,7 +270,7 @@ that will occur giving you a quick response and when views will be updated
 which will take a long time. (A 10 million document database took about 10
 minutes to load into CouchDB but about 4 hours to do view generation).
 
-In a cluster, "stale" requests are serviced by a fixed set of shards in order
+In a cluster, "stable" requests are serviced by a fixed set of shards in order

Review comment:
       > Hm. This is a good change (not talking about `stale`), but down in line 279 it talks about `stale=ok` and `stale=update_after` again.
   
   Those lines refer to a deprecated parameter, while 0526b9b was fixing a misleading typo (the meaning by this is exactly the opposite of the behavior).
   
   > 
   > Similarly up in line 268 we talk about "stale" again.
   > 
   > If you want to fully expunge the concept of stale requests, we should do it in this entire section. I'd be +1 on that work but don't have time to help today.
   > 
   > Otherwise, I'd reverse the change and we can do that at a later date.
   
   I only wanted to "leave the campground cleaner than I found it". To avoid scope creep in this PR, I've pushed 1fce16e to revert the fix for the misleading typo ( 0526b9b ).




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org