HHH-10782 Add a comment about what clearing the query plan cache means

This commit is contained in:
Guillaume Smet 2018-08-08 16:21:25 +02:00
parent 3c5a82bf7c
commit 20c6f15af2
1 changed files with 7 additions and 1 deletions

View File

@ -220,7 +220,13 @@ public class QueryPlanCache implements Serializable {
}
/**
* clean up QueryPlanCache when SessionFactory is closed
* Clean up the caches when the SessionFactory is closed.
* <p>
* Note that depending on the cache strategy implementation chosen, clearing the cache might not reclaim all the
* memory.
* <p>
* Typically, when using LIRS, clearing the cache only invalidates the entries but the outdated entries are kept in
* memory until they are replaced by others. It is not considered a memory leak as the cache is bounded.
*/
public void cleanup() {
LOG.trace( "Cleaning QueryPlan Cache" );