-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathwhere.html
More file actions
500 lines (472 loc) · 30.6 KB
/
where.html
File metadata and controls
500 lines (472 loc) · 30.6 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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
<!doctype html>
<html lang="en">
<head>
<title>Query Where | 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">Where</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">
<li >
<a href="/docs/query/query-beans">Query beans</a>
</li>
<li class="active">
<a class="active" href="/docs/query/where">Where</a>
<ul class="nav nav-scroll">
<li><a href="#and">AND</a></li>
<li><a href="#or">OR</a></li>
<li><a href="#raw">Raw expressions</a></li>
</ul>
</li>
<li >
<a href="/docs/query/expressions">Expressions</a>
</li>
<li >
<a href="/docs/query/orderBy">OrderBy</a>
</li>
<li >
<a href="/docs/query/select">Select</a>
</li>
<li >
<a href="/docs/query/fetch">Fetch</a>
</li>
<li >
<a href="/docs/query/fetchgroup">FetchGroup</a>
</li>
<li >
<a href="/docs/query/filterMany">FilterMany</a>
</li>
<li >
<a href="/docs/query/aggregation">Aggregation</a>
</li>
<li >
<a href="/docs/query/having">Having</a>
</li>
<li >
<a href="/docs/query/native-sql">Native Sql</a>
</li>
<li >
<a href="/docs/query/rawSql">RawSql</a>
</li>
<li >
<a href="/docs/query/update">Update query</a>
</li>
<li >
<a href="/docs/query/delete">Delete query</a>
</li>
<li >
<a href="/docs/query/dtoquery">DtoQuery</a>
</li>
<li >
<a href="/docs/query/sqlquery">SqlQuery</a>
</li>
<li >
<a href="/docs/query/sqlupdate">SqlUpdate</a>
</li>
<li >
<a href="/docs/query/callablesql">CallableSql</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="where">Where</h2>
<p>
Query bean properties provide a nice type safe way to add expressions to the <code>where</code> clause.
We get compile time validation of the query paths, expressions and bind value types.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// using query bean</span>
<span class="n">Customer</span> <span class="n">rob</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">name</span><span class="o">.</span><span class="na">equalTo</span><span class="o">(</span><span class="s">"Rob"</span><span class="o">)</span> <span class="c1">// type safe expression with IDE auto-completion</span>
<span class="o">.</span><span class="na">findOne</span><span class="o">();</span>
</pre></div>
</div>
<p>
The same query can be written without using query beans as:
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// using standard query</span>
<span class="n">Customer</span> <span class="n">rob</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">Customer</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
<span class="o">.</span><span class="na">where</span><span class="o">().</span><span class="na">eq</span><span class="o">(</span><span class="s">"name"</span><span class="o">,</span> <span class="s">"Rob"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findOne</span><span class="o">();</span>
</pre></div>
</div>
<p>
Both queries above produce the same sql:
</p>
<div class="syntax sql"><div class="highlight"><pre><span></span><span class="k">select</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">name</span> <span class="o">=</span> <span class="o">?</span>
</pre></div>
</div>
<p>
With the above the <code>name</code> property is of type String/varchar and so only valid String expressions
such as <em>like, startsWith, contains</em> etc are allowed and the bind value for the expression must be a String.
</p>
<p>
Developers get IDE assistance/auto-completion when creating queries using query beans as the properties and
expressions available based on their types are suggested by the IDE with auto-complete.
</p>
<p>
Additionally with query beans, if the property is renamed (e.g. "name" became "fullName") or if the property
changed it's type then the query would no longer compile.
</p>
<h2>Paths</h2>
<p>
With properties that are associated to beans (OneToOne, OneToMany, ManyToOne, ManyToMany)
we can 'navigate' these paths adding valid expressions.
</p>
<h5>e.g. path "billingAddress.city" for Customer</h5>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// using query beans</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 field">billingAddress</span><span class="o">.</span><span class="na field">city</span><span class="o">.</span><span class="na">equalTo</span><span class="o">(</span><span class="s">"Auckland"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// using standard query</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="n">DB</span><span class="o">.</span><span class="na">find</span><span class="o">(</span><span class="n">Customer</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
<span class="o">.</span><span class="na">where</span><span class="o">()</span>
<span class="o">.</span><span class="na">eq</span><span class="o">(</span><span class="s">"billingAddress.city"</span><span class="o">,</span> <span class="s">"Auckland"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
<p>
Ebean will automatically add appropriate SQL JOINS to support the expressions in the query.
</p>
<div class="syntax sql"><div class="highlight"><pre><span></span><span class="k">select</span> <span class="p">...</span>
<span class="k">from</span> <span class="n">customer</span> <span class="n">t0</span>
<span class="k">join</span> <span class="n">address</span> <span class="n">t1</span> <span class="k">on</span> <span class="n">t1</span><span class="p">.</span><span class="n">id</span> <span class="o">=</span> <span class="n">t0</span><span class="p">.</span><span class="n">billing_address_id</span>
<span class="k">where</span> <span class="n">t1</span><span class="p">.</span><span class="n">city</span> <span class="o">=</span> <span class="o">?</span>
</pre></div>
</div>
<p>
These property paths can be any depth. In the example below the path takes us from the
Order bean to the Customer bean to the Address bean via <em>customer.billingAddress</em>.
</p>
<h5>e.g. path "customer.billingAddress.city" for Order</h5>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">List</span><span class="o"><</span><span class="n">Order</span><span class="o">></span> <span class="n">orders</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 field">customer</span><span class="o">.</span><span class="na field">billingAddress</span><span class="o">.</span><span class="na field">city</span><span class="o">.</span><span class="na">equalTo</span><span class="o">(</span><span class="s">"Auckland"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
<h2 id="and" class="art">AND</h2>
<p>
By default multiple expressions are added via <code>AND</code>.
</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 field">status</span><span class="o">.</span><span class="na">equalTo</span><span class="o">(</span><span class="n">Status</span><span class="o">.</span><span class="na">NEW</span><span class="o">)</span>
<span class="o">.</span><span class="na field">whenCreated</span><span class="o">.</span><span class="na">greaterThan</span><span class="o">(</span><span class="n">lastWeek</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="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> <span class="k">and</span> <span class="n">t0</span><span class="p">.</span><span class="n">when_created</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">// using standard query</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="n">DB</span><span class="o">.</span><span class="na">find</span><span class="o">(</span><span class="n">Customer</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
<span class="o">.</span><span class="na">where</span><span class="o">()</span>
<span class="o">.</span><span class="na">eq</span><span class="o">(</span><span class="s">"status"</span><span class="o">,</span> <span class="n">Status</span><span class="o">.</span><span class="na">NEW</span><span class="o">)</span>
<span class="o">.</span><span class="na">gt</span><span class="o">(</span><span class="s">"whenCreated"</span><span class="o">,</span> <span class="n">lastWeek</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
<h5>e.g. multiple paths for Order</h5>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">List</span><span class="o"><</span><span class="n">Order</span><span class="o">></span> <span class="n">orders</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 field">orderDate</span><span class="o">.</span><span class="na">greaterThan</span><span class="o">(</span><span class="n">lastWeek</span><span class="o">)</span>
<span class="o">.</span><span class="na field">customer</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">Status</span><span class="o">.</span><span class="na">NEW</span><span class="o">)</span>
<span class="o">.</span><span class="na field">customer</span><span class="o">.</span><span class="na field">billingAddress</span><span class="o">.</span><span class="na field">city</span><span class="o">.</span><span class="na">equalTo</span><span class="o">(</span><span class="s">"Auckland"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
<p>
With the above query we have the additional paths of <em>customer</em> and <em>customer.billingAddress</em>.
Ebean will determine the joins that are needed to support the expressions.
</p>
<div class="syntax sql"><div class="highlight"><pre><span></span><span class="k">select</span> <span class="p">...</span>
<span class="k">from</span> <span class="n">orders</span> <span class="n">t0</span>
<span class="k">join</span> <span class="n">customer</span> <span class="n">t1</span> <span class="k">on</span> <span class="n">t1</span><span class="p">.</span><span class="n">id</span> <span class="o">=</span> <span class="n">t0</span><span class="p">.</span><span class="n">order_id</span>
<span class="k">join</span> <span class="n">address</span> <span class="n">t2</span> <span class="k">on</span> <span class="n">t2</span><span class="p">.</span><span class="n">id</span> <span class="o">=</span> <span class="n">t1</span><span class="p">.</span><span class="n">billing_address_id</span>
<span class="k">where</span> <span class="n">t0</span><span class="p">.</span><span class="n">order_date</span> <span class="o">>=</span> <span class="o">?</span> <span class="k">and</span> <span class="n">t1</span><span class="p">.</span><span class="n">status</span> <span class="o">=</span> <span class="o">?</span> <span class="k">and</span> <span class="n">t2</span><span class="p">.</span><span class="n">city</span> <span class="o">=</span> <span class="o">?</span>
</pre></div>
</div>
<p> </p>
<h5>Notes on join type</h5>
<p>
The type of join used (<code>left join</code> or <code>join</code>) is based on the cardinality and
optionality of the relationship. For example, if the customer foreign key on order was nullable then
that is an optional relationship and a <em>left join</em> is used.
</p>
<p>
For any path, if a "higher level" join is a <em>left join</em> then all "child joins" (for that path) must also
be a <em>left join</em> (i.e. "left joins cascade"). For example, in the example above - if the join from order
to customers is a left join then the join from customer to address must also be a left join.
</p>
<p>
The type of join to use for expression on a <em>ToMany</em> path depends on whether the expression
is contained in a <em>OR</em>. If the expression is contained inside an <em>OR</em> then a <em>left join</em>
is used.
</p>
<h2 id="or" class="art">OR</h2>
<p>
When we want to add multiple expressions via <em>OR</em> we use <code>or()</code> and <code>endOr()</code>
and all the expressions between them are joined by <em>OR</em>.
</p>
<p>
For example: (name is null OR name = 'Rob')
</p>
<div class="syntax java"><div class="highlight"><pre><span></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">or</span><span class="o">()</span>
<span class="o">.</span><span class="na field">name</span><span class="o">.</span><span class="na">isNull</span><span class="o">()</span>
<span class="o">.</span><span class="na field">name</span><span class="o">.</span><span class="na">equalTo</span><span class="o">(</span><span class="s">"Rob"</span><span class="o">)</span>
<span class="o">.</span><span class="na">endOr</span><span class="o">()</span>
<span class="o">.</span><span class="na">findOne</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="p">...</span>
<span class="k">from</span> <span class="n">customer</span> <span class="n">t0</span>
<span class="k">where</span> <span class="p">(</span><span class="n">t0</span><span class="p">.</span><span class="n">name</span> <span class="k">is</span> <span class="k">null</span> <span class="k">or</span> <span class="n">t0</span><span class="p">.</span><span class="n">name</span> <span class="o">=</span> <span class="o">?</span> <span class="p">)</span>
</pre></div>
</div>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">Customer</span> <span class="n">customer</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">Customer</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
<span class="o">.</span><span class="na">where</span><span class="o">()</span>
<span class="o">.</span><span class="na">or</span><span class="o">()</span>
<span class="o">.</span><span class="na">isNull</span><span class="o">(</span><span class="s">"name"</span><span class="o">)</span>
<span class="o">.</span><span class="na">eq</span><span class="o">(</span><span class="s">"name"</span><span class="o">,</span> <span class="s">"Rob"</span><span class="o">)</span>
<span class="o">.</span><span class="na">endOr</span><span class="o">()</span>
<span class="o">.</span><span class="na">findOne</span><span class="o">()</span>
</pre></div>
</div>
<h5>OR using raw expression</h5>
<p>
Rather than using the fluid style with <em>or()</em> and <em>endOr()</em> we can alternatively
use <code>raw()</code> expressions. For example:
</p>
<div class="syntax java"><div class="highlight"><pre><span></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">raw</span><span class="o">(</span><span class="s">"(name is null or name = ?)"</span><span class="o">,</span> <span class="s">"Rob"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findOne</span><span class="o">()</span>
</pre></div>
</div>
<h2 id="raw" class="art">Raw expressions</h2>
<p>
Sometimes we want to add raw expressions to the where clause.
We use <code>raw()</code> to include arbitrary SQL, functions and stored procedures
into the query <em>where clause</em>.
</p>
<h5>e.g. simple raw expression</h5>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">List</span><span class="o"><</span><span class="n">Order</span><span class="o">></span> <span class="n">orders</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">raw</span><span class="o">(</span><span class="s">"orderDate > shipDate "</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">()</span>
</pre></div>
</div>
<h5>e.g. use sql function</h5>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">List</span><span class="o"><</span><span class="n">Order</span><span class="o">></span> <span class="n">orders</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">raw</span><span class="o">(</span><span class="s">"add_days(orderDate, 10) < ?"</span><span class="o">,</span> <span class="n">someDate</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
<h5>e.g. sql subquery</h5>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">List</span><span class="o"><</span><span class="n">Order</span><span class="o">></span> <span class="n">orders</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 field">status</span><span class="o">.</span><span class="na">equalTo</span><span class="o">(</span><span class="n">Status</span><span class="o">.</span><span class="na">NEW</span><span class="o">)</span>
<span class="o">.</span><span class="na">raw</span><span class="o">(</span><span class="s">"t0.customer_id in (select customer_id from customer_group where group_id = any(?::uuid[]))"</span><span class="o">,</span> <span class="n">groupIds</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">()</span>
</pre></div>
</div>
<p> </p>
<h4>Property paths to sql joins</h4>
<p>
If we use property paths in raw() then Ebean will automatically add appropriate joins to support the expression.
For example:
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">List</span><span class="o"><</span><span class="n">Order</span><span class="o">></span> <span class="n">orders</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">raw</span><span class="o">(</span><span class="s">"(customer.name = ? or customer.billingAddress.city = ?)"</span><span class="o">,</span> <span class="s">"Rob"</span><span class="o">,</span> <span class="s">"Auckland"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
<p>
... produces the following SQL with joins added to the customer and address tables.
</p>
<div class="syntax sql"><div class="highlight"><pre><span></span><span class="k">select</span> <span class="n">t0</span><span class="p">.</span><span class="n">id</span><span class="p">,</span> <span class="n">t0</span><span class="p">.</span><span class="n">status</span><span class="p">,</span> <span class="n">t0</span><span class="p">.</span><span class="n">order_date</span><span class="p">,</span> <span class="n">t0</span><span class="p">.</span><span class="n">ship_date</span><span class="p">,</span> <span class="p">...</span>
<span class="k">from</span> <span class="n">orders</span> <span class="n">t0</span>
<span class="k">left</span> <span class="k">join</span> <span class="n">customer</span> <span class="n">t1</span> <span class="k">on</span> <span class="n">t1</span><span class="p">.</span><span class="n">id</span> <span class="o">=</span> <span class="n">t0</span><span class="p">.</span><span class="n">customer_id</span> <span class="c1">-- supports customer.name</span>
<span class="k">left</span> <span class="k">join</span> <span class="n">address</span> <span class="n">t2</span> <span class="k">on</span> <span class="n">t2</span><span class="p">.</span><span class="n">id</span> <span class="o">=</span> <span class="n">t1</span><span class="p">.</span><span class="n">billing_address_id</span> <span class="c1">-- supports customer.billingAddress.city</span>
<span class="k">where</span> <span class="p">(</span><span class="n">t1</span><span class="p">.</span><span class="n">name</span> <span class="o">=</span> <span class="o">?</span> <span class="k">or</span> <span class="n">t2</span><span class="p">.</span><span class="n">city</span> <span class="o">=</span> <span class="o">?</span><span class="p">);</span> <span class="c1">--bind(Rob,Auckland)</span>
</pre></div>
</div>
<p> </p>
<h4>Combing expressions</h4>
<p>
We can combine <em>raw()</em> expressions with other expressions. For example:
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">List</span><span class="o"><</span><span class="n">Order</span><span class="o">></span> <span class="n">orders</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 field">status</span><span class="o">.</span><span class="na">eq</span><span class="o">(</span><span class="n">Order</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="c1">// before raw()</span>
<span class="o">.</span><span class="na">raw</span><span class="o">(</span><span class="s">"(customer.name = ? or customer.billingAddress.city = ?)"</span><span class="o">,</span> <span class="s">"Rob"</span><span class="o">,</span> <span class="s">"Auckland"</span><span class="o">)</span>
<span class="o">.</span><span class="na field">orderDate</span><span class="o">.</span><span class="na">greaterThan</span><span class="o">(</span><span class="n">lastWeek</span><span class="o">)</span> <span class="c1">// after raw()</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="p">...</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> <span class="k">and</span> <span class="p">(</span><span class="n">t1</span><span class="p">.</span><span class="n">name</span> <span class="o">=</span> <span class="o">?</span> <span class="k">or</span> <span class="n">t2</span><span class="p">.</span><span class="n">city</span> <span class="o">=</span> <span class="o">?</span><span class="p">)</span> <span class="k">and</span> <span class="n">t0</span><span class="p">.</span><span class="n">order_date</span> <span class="o">></span> <span class="o">?</span>
<span class="c1">--bind(NEW,Rob,Auckland,2019-01-17)</span>
</pre></div>
</div>
<p> </p>
<h4>Ode to Raw expressions</h4>
<p>
If developer life was simple we would not need raw expressions. Many real world projects often have
a few queries where our nice ORM query gets us 90% there but there is that predicate needed that is
best expressed in SQL or uses a database specific function or feature.
</p>
<p>
<em>Raw expressions</em> is this nice little feature that allows us to put that arbitrary SQL
expression into the where clause. We could instead go to findNative etc and provide all the SQL
for the query but that is a bigger jump and raw expressions gives us that flexibility.
</p>
<p>
I'm not sure if I'm allowed a <em>favourite feature</em> but if I was I'd vote for raw expressions.
</p>
<nav class="next">
<p class="edit-page">
<a href="https://github.com/ebean-orm/website-source/blob/master/docs/query/where.html"><i class="fab fa-github"></i> Edit Page</a>
</p>
<p class="next">
<a href="/docs/query/expressions" class="btn btn-info">Next: Expressions</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>