You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by tf...@apache.org on 2016/10/15 23:55:24 UTC
[12/24] lucene-solr:jira/solr-8396: LUCENE-7492: Fix LRUQueryCache
javadocs.
LUCENE-7492: Fix LRUQueryCache javadocs.
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/175370f2
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/175370f2
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/175370f2
Branch: refs/heads/jira/solr-8396
Commit: 175370f232503644d176461253b8d604ae7cde97
Parents: 1b7a88f
Author: Adrien Grand <jp...@gmail.com>
Authored: Wed Oct 12 16:27:58 2016 +0200
Committer: Adrien Grand <jp...@gmail.com>
Committed: Wed Oct 12 16:40:48 2016 +0200
----------------------------------------------------------------------
.../java/org/apache/lucene/search/LRUQueryCache.java | 14 ++++----------
1 file changed, 4 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/175370f2/lucene/core/src/java/org/apache/lucene/search/LRUQueryCache.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/search/LRUQueryCache.java b/lucene/core/src/java/org/apache/lucene/search/LRUQueryCache.java
index 0943cc3..fcdf2a5 100644
--- a/lucene/core/src/java/org/apache/lucene/search/LRUQueryCache.java
+++ b/lucene/core/src/java/org/apache/lucene/search/LRUQueryCache.java
@@ -56,7 +56,8 @@ import org.apache.lucene.util.RoaringDocIdSet;
* {@link QueryCachingPolicy caching policies} that only cache on "large"
* segments, and it is advised to not share this cache across too many indices.
*
- * Typical usage looks like this:
+ * A default query cache and policy instance is used in IndexSearcher. If you want to replace those defaults
+ * it is typically done like this:
* <pre class="prettyprint">
* final int maxNumberOfCachedQueries = 256;
* final long maxRamBytesUsed = 50 * 1024L * 1024L; // 50MB
@@ -64,15 +65,8 @@ import org.apache.lucene.util.RoaringDocIdSet;
* // it is fine to eg. store them into static variables
* final QueryCache queryCache = new LRUQueryCache(maxNumberOfCachedQueries, maxRamBytesUsed);
* final QueryCachingPolicy defaultCachingPolicy = new UsageTrackingQueryCachingPolicy();
- *
- * // ...
- *
- * // Then at search time
- * Query myQuery = ...;
- * Query myCacheQuery = queryCache.doCache(myQuery, defaultCachingPolicy);
- * // myCacheQuery is now a wrapper around the original query that will interact with the cache
- * IndexSearcher searcher = ...;
- * TopDocs topDocs = searcher.search(new ConstantScoreQuery(myCacheQuery), 10);
+ * indexSearcher.setQueryCache(queryCache);
+ * indexSearcher.setQueryCachingPolicy(defaultCachingPolicy);
* </pre>
*
* This cache exposes some global statistics ({@link #getHitCount() hit count},