-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathoption.html
More file actions
433 lines (383 loc) · 21.9 KB
/
option.html
File metadata and controls
433 lines (383 loc) · 21.9 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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
<!doctype html>
<html lang="en">
<head>
<title>Options | Query | Ebean</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/query/">Query</a><span class="sep"> / </span><span class="last">Option</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 active">
<a class="active" href="/docs/query">Query</a>
<ul class="nav nav-scroll">
<li >
<a href="#alias">alias</a>
</li>
<li >
<a href="#asDraft">asDraft</a>
</li>
<li >
<a href="#asOf">asOf timestamp</a>
</li>
<li >
<a href="#autotune">autotune</a>
</li>
<li >
<a href="#bufferFetchSizeHint">bufferFetchSizeHint</a>
</li>
<li >
<a href="#disableLazyLoading">disableLazyLoading</a>
</li>
<li >
<a href="#disableReadAuditing">disableReadAuditing</a>
</li>
<li >
<a href="#distinct">distinct</a>
</li>
<li >
<a href="#forUpdate">forUpdate</a>
</li>
<li >
<a href="#includeSoftDeletes">includeSoftDeletes</a>
</li>
<li >
<a href="#lazyLoadBatchSize">lazyLoadBatchSize</a>
</li>
<li >
<a href="#persistenceContextScope">persistenceContextScope</a>
</li>
<li >
<a href="#readOnly">readOnly</a>
</li>
<li >
<a href="#unmodifiable">unmodifiable</a>
</li>
</ul>
</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 ">
<a href="/docs/features">Features</a>
</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 id="alias">Alias</h2>
<p>
Sets the table alias to use on the base table.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">List</span><span class="o"><</span><span class="n">Customer</span><span class="o">></span> <span class="n">customers</span> <span class="o">=</span>
<span class="k">new</span> <span class="n">QCustomer</span><span class="o">()</span>
<span class="o">.</span><span class="na">alias</span><span class="o">(</span><span class="s">"cust"</span><span class="o">)</span>
<span class="o">.</span><span class="na field">name</span><span class="o">.</span><span class="na">istartsWith</span><span class="o">(</span><span class="s">"Rob"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
<div class="syntax sql"><div class="highlight"><pre><span></span><span class="k">select</span> <span class="n">cust</span><span class="p">.</span><span class="n">id</span><span class="p">,</span> <span class="n">cust</span><span class="p">.</span><span class="n">inactive</span><span class="p">,</span> <span class="n">cust</span><span class="p">.</span><span class="n">name</span><span class="p">,</span> <span class="n">cust</span><span class="p">.</span><span class="n">registered</span><span class="p">,</span> <span class="p">...</span>
<span class="k">from</span> <span class="n">customer</span> <span class="n">cust</span>
<span class="k">where</span> <span class="k">lower</span><span class="p">(</span><span class="n">cust</span><span class="p">.</span><span class="n">name</span><span class="p">)</span> <span class="k">like</span> <span class="o">?</span> <span class="k">escape</span><span class="s1">'|'</span> <span class="p">;</span> <span class="c1">--bind(rob%)</span>
</pre></div>
</div>
<p>
The typically use of alias is when used as a subquery.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">Query</span><span class="o"><</span><span class="n">Order</span><span class="o">></span> <span class="n">subQuery</span> <span class="o">=</span> <span class="k">new</span> <span class="n">QOrder</span><span class="o">()</span>
<span class="o">.</span><span class="na">alias</span><span class="o">(</span><span class="s">"sub"</span><span class="o">)</span>
<span class="o">.</span><span class="na">select</span><span class="o">(</span><span class="s">"id"</span><span class="o">).</span><span class="na">where</span><span class="o">().</span><span class="na">raw</span><span class="o">(</span><span class="s">"sub.customer_id = main.id"</span><span class="o">)</span>
<span class="o">.</span><span class="na">query</span><span class="o">();</span>
<span class="n">List</span><span class="o"><</span><span class="n">Customer</span><span class="o">></span> <span class="n">customers</span> <span class="o">=</span> <span class="k">new</span> <span class="n">QCustomer</span><span class="o">()</span>
<span class="o">.</span><span class="na">alias</span><span class="o">(</span><span class="s">"main"</span><span class="o">)</span>
<span class="o">.</span><span class="na">query</span><span class="o">().</span><span class="na">where</span><span class="o">().</span><span class="na">exists</span><span class="o">(</span><span class="n">subQuery</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
<div class="syntax sql"><div class="highlight"><pre><span></span><span class="k">select</span> <span class="n">main</span><span class="p">.</span><span class="n">id</span><span class="p">,</span> <span class="n">main</span><span class="p">.</span><span class="n">inactive</span><span class="p">,</span> <span class="n">main</span><span class="p">.</span><span class="n">name</span><span class="p">,</span> <span class="n">main</span><span class="p">.</span><span class="n">registered</span><span class="p">,</span> <span class="p">...</span>
<span class="k">from</span> <span class="n">customer</span> <span class="n">main</span>
<span class="k">where</span> <span class="k">exists</span> <span class="p">(</span><span class="k">select</span> <span class="n">sub</span><span class="p">.</span><span class="n">id</span> <span class="k">from</span> <span class="n">orders</span> <span class="n">sub</span> <span class="k">where</span> <span class="n">sub</span><span class="p">.</span><span class="n">customer_id</span> <span class="o">=</span> <span class="n">main</span><span class="p">.</span><span class="n">id</span><span class="p">)</span>
</pre></div>
</div>
<h2 id="asDraft" class="art">asDraft</h2>
<p>
Used to fetch a <a href="/docs/features/draftable"><code>@Draftable</code></a> entities from their <em>draft</em> table(s)
rather than the <em>published</em> tables.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">Document</span> <span class="n">documentDraft</span> <span class="o">=</span>
<span class="k">new</span> <span class="n">QDocument</span><span class="o">()</span>
<span class="o">.</span><span class="na">asDraft</span><span class="o">()</span>
<span class="o">.</span><span class="na field">id</span><span class="o">.</span><span class="na">equalTo</span><span class="o">(</span><span class="mi">42</span><span class="o">)</span>
<span class="o">.</span><span class="na">findOne</span><span class="o">();</span>
</pre></div>
</div>
<h2 id="asOf">As of timestamp</h2>
<p>
For entities with <a href="/docs/features/history">@History</a> fetch the entities <code>AS OF</code> the
given timestamp.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">Timestamp</span> <span class="n">timeInPast</span> <span class="o">=</span> <span class="o">...;</span>
<span class="n">List</span><span class="o"><</span><span class="n">Customer</span><span class="o">></span> <span class="n">customers</span>
<span class="o">=</span> <span class="k">new</span> <span class="n">QCustomer</span><span class="o">()</span>
<span class="o">.</span><span class="na">asOf</span><span class="o">(</span><span class="n">timeInPast</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
<h2 id="autotune" class="art">Autotune</h2>
<p>
Turn on or off automatic query tuning.
</p>
List<|Customer> customers
= new QCustomer()
.setAutoTune(true) // automatically tune the query
.status.equalTo(Status.NEW)
.findList();
<h2 id="bufferFetchSizeHint" class="art">bufferFetchSizeHint</h2>
<p>
A hint which for JDBC translates to the Statement.fetchSize().
</p>
<p>
Gives the JDBC driver a hint as to the number of rows that should be
fetched from the database when more rows are needed for ResultSet.
</p>
<h2 id="disableLazyLoading" class="art">disableLazyLoading</h2>
<p>
Disables any lazy loading that would otherwise occur. Instead unloaded properties would return null.
</p>
<h2 id="disableReadAuditing" class="art">disableReadAuditing</h2>
<p>
Disable read auditing for this query. Refer to <a href="/docs/features/readauditing">Read Auditing</a>.
</p>
<p>
This is intended to be used when the query is not a user initiated query and instead
part of the internal processing in an application to load a cache or document store etc.
In these cases we don't want the query to be part of read auditing.
</p>
<h2 id="distinct" class="art">distinct</h2>
<p>
Make the query use <code>sql distinct</code>.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">List</span><span class="o"><</span><span class="n">String</span><span class="o">></span> <span class="n">lastNames</span> <span class="o">=</span>
<span class="k">new</span> <span class="n">QContact</span><span class="o">()</span>
<span class="o">.</span><span class="na">setDistinct</span><span class="o">(</span><span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">select</span><span class="o">(</span><span class="s">"lastName"</span><span class="o">)</span>
<span class="o">.</span><span class="na field">email</span><span class="o">.</span><span class="na">isNull</span><span class="o">()</span>
<span class="o">.</span><span class="na">findSingleAttributeList</span><span class="o">();</span>
</pre></div>
</div>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="kt">int</span> <span class="n">count</span> <span class="o">=</span>
<span class="k">new</span> <span class="n">QCustomer</span><span class="o">()</span>
<span class="o">.</span><span class="na">setDistinct</span><span class="o">(</span><span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">select</span><span class="o">(</span><span class="s">"anniversary"</span><span class="o">)</span>
<span class="o">.</span><span class="na field">status</span><span class="o">.</span><span class="na">equalTo</span><span class="o">(</span><span class="n">Customer</span><span class="o">.</span><span class="na field">Status</span><span class="o">.</span><span class="na">NEW</span><span class="o">)</span>
<span class="o">.</span><span class="na">findCount</span><span class="o">();</span>
</pre></div>
</div>
<div class="syntax sql"><div class="highlight"><pre><span></span><span class="k">select</span> <span class="k">count</span><span class="p">(</span><span class="k">distinct</span> <span class="n">t0</span><span class="p">.</span><span class="n">anniversary</span><span class="p">)</span> <span class="k">from</span> <span class="n">customer</span> <span class="n">t0</span> <span class="k">where</span> <span class="n">t0</span><span class="p">.</span><span class="n">status</span> <span class="o">=</span> <span class="o">?</span>
</pre></div>
</div>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// partially loaded beans without Id properties</span>
<span class="c1">// ... not persistable, no lazy loading etc</span>
<span class="n">List</span><span class="o"><</span><span class="n">Customer</span><span class="o">></span> <span class="n">beans</span> <span class="o">=</span>
<span class="k">new</span> <span class="n">QContact</span><span class="o">()</span>
<span class="o">.</span><span class="na">setDistinct</span><span class="o">(</span><span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">select</span><span class="o">(</span><span class="s">"lastName, dateOfBirth"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
<h2 id="forUpdate" class="art">forUpdate</h2>
<p>
Execute the query with <code>FOR UPDATE</code> that will hold a lock on the rows fetched.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="k">try</span> <span class="o">(</span><span class="n">Transaction</span> <span class="n">txn</span> <span class="o">=</span> <span class="n">database</span><span class="o">.</span><span class="na">beginTransaction</span><span class="o">())</span> <span class="o">{</span>
<span class="n">Customer</span> <span class="n">customer</span> <span class="o">=</span>
<span class="k">new</span> <span class="n">QContact</span><span class="o">()</span>
<span class="o">.</span><span class="na">forUpdate</span><span class="o">()</span>
<span class="o">.</span><span class="na field">email</span><span class="o">.</span><span class="na">equalTo</span><span class="o">(</span><span class="s">"rob@foo.com"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findOne</span><span class="o">();</span>
<span class="n">customer</span><span class="o">.</span><span class="na">setName</span><span class="o">(</span><span class="s">"a better name"</span><span class="o">);</span>
<span class="n">customer</span><span class="o">.</span><span class="na">save</span><span class="o">();</span>
<span class="n">txn</span><span class="o">.</span><span class="na">commit</span><span class="o">();</span>
<span class="o">}</span>
</pre></div>
</div>
<h2 id="includeSoftDeletes" class="art">includeSoftDeletes</h2>
<p>
Set to true to include soft deleted rows. Refer to <a href="/docs/features/softdelete">Soft Delete</a>.
</p>
<h2 id="lazyLoadBatchSize" class="art">lazyLoadBatchSize</h2>
<p>
Set this to tune the lazy loading batch size which by default is set to <code>10</code>.
</p>
<h2 id="persistenceContextScope" class="art">persistenceContextScope</h2>
<p>
Generally queries run with <code>transaction scoped persistence context</code>. With this we can set
to <code>QUERY</code> the object graph built will be fresh data from the database ignoring any existing
bean that is in the [transaction] persistence context.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="k">try</span> <span class="o">(</span><span class="n">Transaction</span> <span class="n">txn</span> <span class="o">=</span> <span class="n">database</span><span class="o">.</span><span class="na">beginTransaction</span><span class="o">())</span> <span class="o">{</span>
<span class="c1">// when customer is loaded it then is referenced in the</span>
<span class="c1">// transaction scoped persistence context (aka L1 cache)</span>
<span class="n">Customer</span> <span class="n">loaded</span> <span class="o">=</span> <span class="n">Customer</span><span class="o">.</span><span class="na field">find</span><span class="o">.</span><span class="na">byId</span><span class="o">(</span><span class="mi">42</span><span class="o">)</span>
<span class="c1">// fetch this same customer but we want to ignore the L1 cache</span>
<span class="c1">// such that we get a "fresh" version of its data</span>
<span class="n">Customer</span> <span class="n">customer</span> <span class="o">=</span>
<span class="k">new</span> <span class="n">QCustomer</span><span class="o">()</span>
<span class="o">.</span><span class="na field">id</span><span class="o">.</span><span class="na">equalTo</span><span class="o">(</span><span class="mi">42</span><span class="o">)</span>
<span class="o">.</span><span class="na">setUseCache</span><span class="o">(</span><span class="kc">false</span><span class="o">)</span> <span class="c1">// ignore L2 cache</span>
<span class="o">.</span><span class="na">setPersistenceContextScope</span><span class="o">(</span><span class="n">QUERY</span><span class="o">)</span> <span class="c1">// ignore L1 cache</span>
<span class="o">.</span><span class="na">findOne</span><span class="o">();</span>
<span class="o">...</span>
<span class="n">txn</span><span class="o">.</span><span class="na">commit</span><span class="o">();</span>
<span class="o">}</span>
</pre></div>
</div>
<h2 id="readOnly" class="art">readOnly [Removed]</h2>
<p>
This option has been REMOVED and replaced by <a href="#unmodifiable">Unmodifiable</a>
</p>
<p>
Query returns beans that are deemed to be <code>READ ONLY</code> and calling setter methods will
throw an exception.
</p>
<h2 id="unmodifiable" class="art">Unmodifiable</h2>
<p>
When set to true the query returns beans that are unmodifiable read only.
When a <code>Query.setUseQueryCache()</code> is enabled the query will
automatically use Unmodifiable mode (and return unmodifiable beans).
</p>
<p>
This means that the returning graph can't be mutated via setters, all the collections
are unmodifiable collections, lazy loading is disabled and that the query uses
<code>PersistenceContextScope#QUERY</code>.
</p>
<p>
Attempting to mutate an unmodifiable bean will throw a <code>UnmodifiableEntityException</code>.
Attempting to load an unloaded property will throw a <code>LazyInitialisationException</code>.
</p>
<p>
Use this when we want to ensure that the returned object graph can't be mutated in any way,
such as if we want to hold the result in an application cache or otherwise want to ensure
that no lazy loading is performed.
</p>
<nav class="next">
<p class="edit-page">
<a href="https://github.com/ebean-orm/website-source/blob/master/docs/query/option.html"><i class="fab fa-github"></i> Edit Page</a>
</p>
<p class="next">
<a href="/docs/query/" class="btn btn-info">Next: Queries</a>
</p>
</nav>
</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>