-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathquery-cache.html
More file actions
261 lines (238 loc) · 9.16 KB
/
query-cache.html
File metadata and controls
261 lines (238 loc) · 9.16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<!doctype html>
<html lang="en">
<head>
<title>L2 Cache | Ebean ORM</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="shortcut icon" href="/images/favicon.ico">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto|Source+Sans+Pro|Ubuntu&display=swap">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous">
<link rel="stylesheet" href="/css/reset3.css">
<link rel="stylesheet" href="/css/site3.css">
<link rel="stylesheet" href="/css/pygments3.css">
</head>
<body>
<div id="main">
<div id="banner">
<header>
<nav id="top">
<h1 id="breadcrumb">
<a class="nav-logo" href="/"><img src="/images/logo-200.png" height="35"></a> <a href="/docs">Documentation</a><span class="sep"> / </span><a href="/docs/features/">Features</a><span class="sep"> / </span><a href="/docs/features/l2cache/">L2 Cache</a><span class="sep"> / </span><span class="last">Query cache</span>
</h1>
<ul>
<li><a onclick="toggleTheme();" title="switch dark light theme"><i class="fas fa-adjust"></i></a></li>
</ul>
</nav>
</header>
</div>
<div class="grid grid-docs">
<aside>
<nav class="side">
<ul>
<li class="nav0 ">
<a href="/docs/getting-started">Getting started</a>
</li>
<li class="nav0 ">
<a href="/docs/intro">Introduction</a>
</li>
<li class="nav0 active">
<a class="active" href="/docs">Documentation</a>
<ul>
<li class="nav1 ">
<a href="/docs/agents">AI Agents</a>
</li>
<li class="nav1 ">
<a href="/docs/best-practice">Best practice</a>
</li>
<li class="nav1 ">
<a href="/docs/query">Query</a>
</li>
<li class="nav1 ">
<a href="/docs/persist">Persist</a>
</li>
<li class="nav1 ">
<a href="/docs/transactions">Transactions</a>
</li>
<li class="nav1 ">
<a href="/docs/mapping">Mapping</a>
</li>
<li class="nav1 ">
<a href="/docs/ddl-generation">DDL & Migrations</a>
</li>
<li class="nav1 ">
<a href="/docs/logging">Logging</a>
</li>
<li class="nav1 ">
<a href="/docs/testing">Testing</a>
</li>
<li class="nav1 ">
<a href="/docs/read-replicas">Read Replicas</a>
</li>
<li class="nav1 ">
<a href="/docs/database">Database platforms</a>
</li>
<li class="nav1 ">
<a href="/docs/multi-database">Multiple databases</a>
</li>
<li class="nav1 ">
<a href="/docs/kotlin">Kotlin</a>
</li>
<li><a href="/docs/tuning">Tuning</a></li>
<li class="nav1 active">
<a class="active" href="/docs/features">Features</a>
<ul class="nav">
<li class="active">
<a class="active" href="/docs/features/l2cache">L2 Cache</a>
<ul class="nav">
<li >
<a href="/docs/features/l2cache">Overview</a>
</li>
<li >
<a href="/docs/features/l2cache/bean-cache">Bean caching</a>
</li>
<li class="active">
<a class="active" href="/docs/features/l2cache/query-cache">Query caching</a>
</li>
<li >
<a href="/docs/features/l2cache/invalidation">Invalidation</a>
</li>
<li >
<a href="/docs/features/l2cache/hazelcast">Hazelcast</a>
</li>
<li >
<a href="/docs/features/l2cache/apache-ignite">Apache Ignite</a>
</li>
</ul>
</li>
<li >
<a href="/docs/features/elasticsearch">Elasticsearch</a>
</li>
<li >
<a href="/docs/features/json-in-db">@DbJson</a>
</li>
<li >
<a href="/docs/features/softdelete">Soft Delete</a>
</li>
<li >
<a href="/docs/features/encryption">Encryption</a>
</li>
<li >
<a href="/docs/features/who">@WhoModified / @WhoCreated</a>
</li>
<li >
<a href="/docs/features/history">SQL2011 History</a>
</li>
<li >
<a href="/docs/features/changelog">ChangeLog</a>
</li>
<li >
<a href="/docs/features/readauditing">Read auditing</a>
</li>
<li >
<a href="/docs/features/eventlistening">Event Listening</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav0 ">
<a href="/support">Getting help</a>
</li>
<li class="nav0 ">
<a target="_blank" href="/apidoc/13">API Javadoc</a>
</li>
<li class="nav0 ">
<a href="/videos">Videos</a>
</li>
<li class="nav0 ">
<a href="/docs/upgrading">Upgrading</a>
</li>
<li class="nav0 ">
<a href="/docs/deprecated">Deprecated</a>
</li>
<li class="nav0 ">
<a href="/releases">Releases</a>
</li>
</ul>
</nav>
</aside>
<article>
<form action="https://www.google.com/search" method="get" class="inline-form">
<input type="hidden" name="as_sitesearch" value="ebean.io">
<div id="page-search">
<div class="input-group">
<input class="frm" name="q" id="searchinput" type="text" placeholder="Search... (press 's' to focus)" data-placeholder-focus="Search... (use '↑', '↓' and '⏎' to select results)" data-placeholder-blur="Search... (press 's' to focus)" autocomplete="off">
<div class="input-group-btn">
<button class="frm" type="submit"><i class="fas fa-search"></i></button>
</div>
</div>
<div id="page-search-results" style="display: none;">
<ul id="search-results-container" class="search-results"><li class=" active"><a href="/docs" title="Docs"><span style="color:#777;">Docs</span> Documentation </a></li><li class=""><small style="color:#999;">And 101 more...</small></li></ul>
</div>
</div>
</form>
<h2>Query cache</h2>
<p>
Query caching is not enabled by default. To use Query caching we need to explicitly enable it
on the <code>@Cache</code> mapping annotation for the entity bean types we want to use it.
</p>
<h3>Enabling query cache</h3>
<p>
The example below enables query caching on the Customer entity bean.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="nd">@Cache</span><span class="o">(</span><span class="nx">enableQueryCache</span><span class="o">=</span><span class="kc">true</span><span class="o">)</span>
<span class="nd">@Entity</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Customer</span> <span class="o">{</span>
<span class="o">...</span>
<span class="o">}</span>
</pre></div>
</div>
<h3 id="setUseQueryCache">setUseQueryCache(true)</h3>
<p>
To use the query cache you have to <code>explicitly</code> specify its use on a query.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// use the query cache</span>
<span class="n">List</span><span class="o"><</span><span class="n">Country</span><span class="o">></span> <span class="n">list</span> <span class="o">=</span> <span class="n">DB</span><span class="o">.</span><span class="na">find</span><span class="o">(</span><span class="n">Country</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
<span class="o">.</span><span class="na">setUseQueryCache</span><span class="o">(</span><span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">where</span><span class="o">().</span><span class="na">ilike</span><span class="o">(</span><span class="s">"name"</span><span class="o">,</span> <span class="s">"New%"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
<p>
The query cache is generally useful for returning lists that are very infrequently changed.
These lists would often be used to populate drop down lists / combo boxes in user interfaces.
</p>
<p>
If you are familiar with the term "Lookup Tables" or "Reference Tables" these are typical candidates
for using cached queries. Some examples of lookup/reference tables could be, countries, currencies
and order status.
</p>
<p>
Query cache lists are read only.
</p>
<h3 id="cacheQueryTuning">@CacheQueryTuning</h3>
<p>
All query caching implementations (including Hazelcast and Apache Ignite) uses near caches
and can be tuned using <code>@CacheQueryTuning</code>.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="nd">@Cache</span><span class="o">(</span><span class="nx">enableQueryCache</span><span class="o">=</span><span class="kc">true</span><span class="o">)</span>
<span class="nd">@CacheQueryTuning</span><span class="o">(</span><span class="nx">maxSecsToLive</span> <span class="o">=</span> <span class="mi">30</span><span class="o">)</span>
<span class="nd">@Entity</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Product</span> <span class="o">{</span>
</pre></div>
</div>
</article>
</div>
</div>
<script src="https://code.jquery.com/jquery-3.4.1.slim.min.js" integrity="sha384-J6qa4849blE2+poT4WnyKhv5vZF5SrPo0iEjwBvKU7imGFAV0wwj1yYfoRSJoZ+n" crossorigin="anonymous"></script>
<script src="/js/site3.js"></script>
<script src="/js/search3.js"></script>
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-75181644-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-75181644-1');
</script>
</body>
</html>