You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by "AndreyBozhko (via GitHub)" <gi...@apache.org> on 2024/05/21 21:53:54 UTC

[PR] Clarify the cache behavior in the Ref Guide [solr]

AndreyBozhko opened a new pull request, #2472:
URL: https://github.com/apache/solr/pull/2472

   # Description
   
   Clarify that only the filter cache, and not any other caches, can be disabled by the `cache` local parameter.
   
   # Checklist
   
   Please review the following and check all that apply:
   
   - [x] I have reviewed the guidelines for [How to Contribute](https://github.com/apache/solr/blob/main/CONTRIBUTING.md) and my code conforms to the standards described there to the best of my ability.
   - [ ] I have created a Jira issue and added the issue ID to my pull request title.
   - [x] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
   - [x] I have developed this patch against the `main` branch.
   - [ ] I have run `./gradlew check`.
   - [ ] I have added tests for my changes.
   - [x] I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide)
   


-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org


Re: [PR] Clarify the cache behavior in the Ref Guide [solr]

Posted by "AndreyBozhko (via GitHub)" <gi...@apache.org>.
AndreyBozhko commented on code in PR #2472:
URL: https://github.com/apache/solr/pull/2472#discussion_r1610122730


##########
solr/solr-ref-guide/modules/configuration-guide/pages/caches-warming.adoc:
##########
@@ -86,7 +86,6 @@ The async cache provides most significant improvement with many concurrent queri
 However, the async cache will not prevent data races for time-limited queries, since those are expected to provide partial results.
 
 All caches can be disabled using the parameter `enabled` with a value of `false`.
-Caches can also be disabled on a query-by-query basis with the `cache` parameter, as described in the section xref:query-guide:common-query-parameters.adoc#cache-local-parameter[cache Local Parameter].

Review Comment:
   @epugh The doc does say that caches can be toggled in solrconfig.xml:
   ```
   All caches can be disabled using the parameter `enabled` with a value of `false`.
   ```
   
   But the **`cache` local parameter** only works with the filter cache, - so I removed all mentions of that parameter from the doc, and only kept one mention in the `Filter Cache` section (which redirects to Common Query Parameters).



-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org


Re: [PR] Clarify the cache behavior in the Ref Guide [solr]

Posted by "epugh (via GitHub)" <gi...@apache.org>.
epugh commented on PR #2472:
URL: https://github.com/apache/solr/pull/2472#issuecomment-2125731069

   Okay, I added just a tweak after building the ref guide site and reading through it!  thank you!


-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org


Re: [PR] Clarify the cache behavior in the Ref Guide [solr]

Posted by "epugh (via GitHub)" <gi...@apache.org>.
epugh commented on code in PR #2472:
URL: https://github.com/apache/solr/pull/2472#discussion_r1609814674


##########
solr/solr-ref-guide/modules/configuration-guide/pages/caches-warming.adoc:
##########
@@ -86,7 +86,6 @@ The async cache provides most significant improvement with many concurrent queri
 However, the async cache will not prevent data races for time-limited queries, since those are expected to provide partial results.
 
 All caches can be disabled using the parameter `enabled` with a value of `false`.
-Caches can also be disabled on a query-by-query basis with the `cache` parameter, as described in the section xref:query-guide:common-query-parameters.adoc#cache-local-parameter[cache Local Parameter].

Review Comment:
   wow...    so, i notice you removed the line.   Do we cover elsewhere in the docs that the filter cache can be dsiable on a query-by-query basis?  I wonder if this deleted line should be incoproated into the `[TIP]` to highligh the query-by-query basis which is very different that the other settings...?



-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org


Re: [PR] Clarify the cache behavior in the Ref Guide [solr]

Posted by "AndreyBozhko (via GitHub)" <gi...@apache.org>.
AndreyBozhko commented on code in PR #2472:
URL: https://github.com/apache/solr/pull/2472#discussion_r1609010867


##########
solr/solr-ref-guide/modules/configuration-guide/pages/caches-warming.adoc:
##########
@@ -86,7 +86,6 @@ The async cache provides most significant improvement with many concurrent queri
 However, the async cache will not prevent data races for time-limited queries, since those are expected to provide partial results.
 
 All caches can be disabled using the parameter `enabled` with a value of `false`.
-Caches can also be disabled on a query-by-query basis with the `cache` parameter, as described in the section xref:query-guide:common-query-parameters.adoc#cache-local-parameter[cache Local Parameter].

Review Comment:
   This sentence is misleading, as only the filter cache inserts/lookups are affected by cache=false query parameter



-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org


Re: [PR] Clarify the cache behavior in the Ref Guide [solr]

Posted by "epugh (via GitHub)" <gi...@apache.org>.
epugh merged PR #2472:
URL: https://github.com/apache/solr/pull/2472


-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org