forked from ebean-orm/ebean-orm.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsqlupdate.html
More file actions
373 lines (333 loc) · 21.7 KB
/
Copy pathsqlupdate.html
File metadata and controls
373 lines (333 loc) · 21.7 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
<!doctype html>
<html lang="en">
<head>
<title>SqlUpdate | 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">SqlUpdate</span>
</h1>
<ul>
<li><a href="https://github.com/ebean-orm/ebean" title="github source"><i class="fab fa-github"></i></a></li>
<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/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 >
<a href="/docs/query/where">Where</a>
</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 class="active">
<a class="active" 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/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><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/12">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="/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>SqlUpdate</h2>
<p>
<em>SqlUpdate</em> allows us to execute <em>sql insert</em>, <em>sql update</em> or <em>sql delete</em> statements.
</p>
<p> </p>
<h5>Example: simple update</h5>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">String</span> <span class="n">sql</span> <span class="o">=</span> <span class="s">"update audit_log set description = description where id = ?"</span><span class="o">;</span>
<span class="kt">int</span> <span class="n">row</span> <span class="o">=</span> <span class="n">DB</span><span class="o">.</span><span class="na">sqlUpdate</span><span class="o">(</span><span class="n">sql</span><span class="o">)</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="mi">1</span><span class="o">,</span> <span class="mi">42</span><span class="o">)</span>
<span class="o">.</span><span class="na">execute</span><span class="o">();</span>
</pre></div>
</div>
<p> </p>
<h5>Example: insert with getGeneratedKeys</h5>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">String</span> <span class="n">sql</span> <span class="o">=</span> <span class="s">"insert into e_person_online (email, online_status, when_updated) "</span> <span class="o">+</span>
<span class="s">"values (:email, :online, current_time)"</span><span class="o">;</span>
<span class="n">SqlUpdate</span> <span class="n">sqlUpdate</span> <span class="o">=</span> <span class="n">DB</span><span class="o">.</span><span class="na">sqlUpdate</span><span class="o">(</span><span class="n">sql</span><span class="o">)</span>
<span class="o">.</span><span class="na">setGetGeneratedKeys</span><span class="o">(</span><span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="s">"email"</span><span class="o">,</span> <span class="n">email</span><span class="o">)</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="s">"online"</span><span class="o">,</span> <span class="kc">false</span><span class="o">);</span>
<span class="n">sqlUpdate</span><span class="o">.</span><span class="na">execute</span><span class="o">();</span>
<span class="n">Object</span> <span class="n">key</span> <span class="o">=</span> <span class="n">sqlUpdate</span><span class="o">.</span><span class="na">getGeneratedKey</span><span class="o">();</span>
</pre></div>
</div>
<p> </p>
<h2 id="collections" class="art">Binding collections</h2>
<p>
To bind collections/arrays of values into an IN clause we need to use
indexed positioned parameters like <code>?1, ?2, ?3</code> etc or
named parameters like <code>:ids, :names</code> etc.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// using ?1 index positioned parameter</span>
<span class="n">String</span> <span class="n">sql</span> <span class="o">=</span> <span class="s">"delete from customer where ref_id in (?1)"</span><span class="o">;</span>
<span class="kt">int</span> <span class="n">rows</span> <span class="o">=</span> <span class="n">DB</span><span class="o">.</span><span class="na">sqlUpdate</span><span class="o">(</span><span class="n">sql</span><span class="o">)</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="n">asList</span><span class="o">(</span><span class="mi">9991</span><span class="o">,</span> <span class="mi">9992</span><span class="o">,</span> <span class="mi">9993</span><span class="o">))</span>
<span class="o">.</span><span class="na">execute</span><span class="o">();</span>
</pre></div>
</div>
<div class="syntax sql"><div class="highlight"><pre><span></span><span class="k">delete</span> <span class="k">from</span> <span class="n">customer</span> <span class="k">where</span> <span class="n">ref_id</span> <span class="k">in</span> <span class="p">(</span><span class="o">?</span><span class="p">,</span><span class="o">?</span><span class="p">,</span><span class="o">?</span><span class="p">)</span>
</pre></div>
</div>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// using :ids named parameter</span>
<span class="n">String</span> <span class="n">sql</span> <span class="o">=</span> <span class="s">"delete from customer where ref_id in (:ids)"</span><span class="o">;</span>
<span class="kt">int</span> <span class="n">rows</span> <span class="o">=</span> <span class="n">DB</span><span class="o">.</span><span class="na">sqlUpdate</span><span class="o">(</span><span class="n">sql</span><span class="o">)</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="s">"ids"</span><span class="o">,</span> <span class="n">asList</span><span class="o">(</span><span class="mi">9991</span><span class="o">,</span> <span class="mi">9992</span><span class="o">,</span> <span class="mi">9993</span><span class="o">))</span>
<span class="o">.</span><span class="na">execute</span><span class="o">();</span>
</pre></div>
</div>
<div class="syntax sql"><div class="highlight"><pre><span></span><span class="k">delete</span> <span class="k">from</span> <span class="n">customer</span> <span class="k">where</span> <span class="n">ref_id</span> <span class="k">in</span> <span class="p">(</span><span class="o">?</span><span class="p">,</span><span class="o">?</span><span class="p">,</span><span class="o">?</span><span class="p">)</span>
</pre></div>
</div>
<p> </p>
<h5>Example: binding multiple lists</h5>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">String</span> <span class="n">sql</span> <span class="o">=</span> <span class="s">"delete from customer where ref_id in (:ids) and name in (:names)"</span><span class="o">;</span>
<span class="kt">int</span> <span class="n">rows</span> <span class="o">=</span> <span class="n">DB</span><span class="o">.</span><span class="na">sqlUpdate</span><span class="o">(</span><span class="n">sql</span><span class="o">)</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="s">"ids"</span><span class="o">,</span> <span class="n">asList</span><span class="o">(</span><span class="mi">9991</span><span class="o">,</span> <span class="mi">9992</span><span class="o">,</span> <span class="mi">9993</span><span class="o">))</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="s">"names"</span><span class="o">,</span> <span class="n">asList</span><span class="o">(</span><span class="s">"rob"</span><span class="o">,</span> <span class="s">"jim"</span><span class="o">))</span>
<span class="o">.</span><span class="na">execute</span><span class="o">();</span>
</pre></div>
</div>
<div class="syntax sql"><div class="highlight"><pre><span></span><span class="k">delete</span> <span class="k">from</span> <span class="n">customer</span> <span class="k">where</span> <span class="n">ref_id</span> <span class="k">in</span> <span class="p">(</span><span class="o">?</span><span class="p">,</span><span class="o">?</span><span class="p">,</span><span class="o">?</span><span class="p">)</span> <span class="k">and</span> <span class="n">name</span> <span class="k">in</span> <span class="p">(</span><span class="o">?</span><span class="p">,</span><span class="o">?</span><span class="p">)</span>
</pre></div>
</div>
<h2 id="cte" class="art">CTE - Common table expression</h2>
<p>
When we want to perform a bulk update using a <em>common table expression</em> this is
easiest done using SqlUpdate.
</p>
<h5>CTE Example</h5>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">String</span> <span class="n">sql</span> <span class="o">=</span> <span class="s">"""</span>
<span class="s">WITH t AS (</span>
<span class="s"> SELECT s.id AS _id</span>
<span class="s"> FROM store_price s</span>
<span class="s"> JOIN promotion_vw p ...</span>
<span class="s"> WHERE ...</span>
<span class="s">)</span>
<span class="s">UPDATE store_price</span>
<span class="s">SET promotion_price = null, price = active_price, price_reason = ?,</span>
<span class="s"> version = version+1, when_modified = current_timestamp</span>
<span class="s">FROM t</span>
<span class="s">WHERE id = t._id</span>
<span class="s">"""</span>
<span class="kt">int</span> <span class="n">rows</span> <span class="o">=</span> <span class="n">DB</span><span class="o">.</span><span class="na">sqlUpdate</span><span class="o">(</span><span class="n">sql</span><span class="o">)</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="mi">1</span><span class="o">,</span> <span class="s">"Expired promotions"</span><span class="o">)</span>
<span class="o">.</span><span class="na">execute</span><span class="o">();</span>
</pre></div>
</div>
<h2 id="addBatch" class="art">AddBatch and ExecuteBatch</h2>
<p>
We use <em>addBatch()</em> and <em>executeBatch()</em> to explicitly use JDBC batching.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">String</span> <span class="n">sql</span> <span class="o">=</span> <span class="s">"insert into audit_log (id, description, modified_description) values (?,?,?)"</span><span class="o">;</span>
<span class="n">SqlUpdate</span> <span class="n">insert</span> <span class="o">=</span> <span class="n">DB</span><span class="o">.</span><span class="na">sqlUpdate</span><span class="o">(</span><span class="n">sql</span><span class="o">);</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">DB</span><span class="o">.</span><span class="na">beginTransaction</span><span class="o">())</span> <span class="o">{</span>
<span class="n">insert</span><span class="o">.</span><span class="na">setNextParameter</span><span class="o">(</span><span class="mi">10000</span><span class="o">);</span>
<span class="n">insert</span><span class="o">.</span><span class="na">setNextParameter</span><span class="o">(</span><span class="s">"hello"</span><span class="o">);</span>
<span class="n">insert</span><span class="o">.</span><span class="na">setNextParameter</span><span class="o">(</span><span class="s">"foo"</span><span class="o">);</span>
<span class="n">insert</span><span class="o">.</span><span class="na">addBatch</span><span class="o">();</span>
<span class="n">insert</span><span class="o">.</span><span class="na">setNextParameter</span><span class="o">(</span><span class="mi">10001</span><span class="o">);</span>
<span class="n">insert</span><span class="o">.</span><span class="na">setNextParameter</span><span class="o">(</span><span class="s">"goodbye"</span><span class="o">);</span>
<span class="n">insert</span><span class="o">.</span><span class="na">setNextParameter</span><span class="o">(</span><span class="s">"bar"</span><span class="o">);</span>
<span class="n">insert</span><span class="o">.</span><span class="na">addBatch</span><span class="o">();</span>
<span class="n">insert</span><span class="o">.</span><span class="na">setNextParameter</span><span class="o">(</span><span class="mi">10002</span><span class="o">);</span>
<span class="n">insert</span><span class="o">.</span><span class="na">setNextParameter</span><span class="o">(</span><span class="s">"chow"</span><span class="o">);</span>
<span class="n">insert</span><span class="o">.</span><span class="na">setNextParameter</span><span class="o">(</span><span class="s">"baz"</span><span class="o">);</span>
<span class="n">insert</span><span class="o">.</span><span class="na">addBatch</span><span class="o">();</span>
<span class="kt">int</span><span class="o">[]</span> <span class="n">rows</span> <span class="o">=</span> <span class="n">insert</span><span class="o">.</span><span class="na">executeBatch</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="upsert" class="art">Upsert</h2>
<p>
We can execute upsert sql which is generally database specific.
</p>
<h4>Upsert - Postgres</h4>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">String</span> <span class="n">sql</span> <span class="o">=</span>
<span class="s">"insert into e_person_online (email, online_status, when_updated) values (?, ?, now()) "</span> <span class="o">+</span>
<span class="s">"on conflict (email) do update set when_updated=now(), online_status = ?"</span><span class="o">;</span>
<span class="n">String</span> <span class="n">email</span> <span class="o">=</span> <span class="s">"foo@one.com"</span><span class="o">;</span>
<span class="n">Object</span> <span class="n">key</span> <span class="o">=</span> <span class="n">DB</span><span class="o">.</span><span class="na">sqlUpdate</span><span class="o">(</span><span class="n">sql</span><span class="o">)</span>
<span class="o">.</span><span class="na">setGetGeneratedKeys</span><span class="o">(</span><span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="mi">1</span><span class="o">,</span> <span class="n">email</span><span class="o">)</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="mi">2</span><span class="o">,</span> <span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">executeGetKey</span><span class="o">();</span>
</pre></div>
</div>
<p> </p>
<h4>Upsert - MySql</h4>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">String</span> <span class="n">email</span> <span class="o">=</span> <span class="s">"bar@one.com"</span><span class="o">;</span>
<span class="n">String</span> <span class="n">sql</span> <span class="o">=</span>
<span class="s">"insert into e_person_online (email, online_status, when_updated) values (?, ?, current_time) "</span> <span class="o">+</span>
<span class="s">"on duplicate key update when_updated=current_time, online_status = ?"</span><span class="o">;</span>
<span class="n">Object</span> <span class="n">key</span> <span class="o">=</span> <span class="n">DB</span><span class="o">.</span><span class="na">sqlUpdate</span><span class="o">(</span><span class="n">sql</span><span class="o">)</span>
<span class="o">.</span><span class="na">setGetGeneratedKeys</span><span class="o">(</span><span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="mi">1</span><span class="o">,</span> <span class="n">email</span><span class="o">)</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="mi">2</span><span class="o">,</span> <span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">setParameter</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">executeGetKey</span><span class="o">();</span>
</pre></div>
</div>
<h2 id="l2cache" class="art">L2 cache</h2>
<p>
If L2 caching is being used Ebean will by default automatically try and determine what
table modifications are performed and use this to invalidate appropriate parts of the L2 cache.
</p>
<p>
Use <code>setAutoTableMod(false)</code> to turn this off.
</p>
<nav class="next">
<p class="edit-page">
<a href="https://github.com/ebean-orm/website-source/blob/master/docs/query/sqlupdate.html"><i class="fab fa-github"></i> Edit Page</a>
</p>
<p class="next">
<a href="/docs/query/callablesql" class="btn btn-info">Next: CallableSql</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>
</body>
</html>