-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathbatch.html
More file actions
432 lines (376 loc) · 21.2 KB
/
batch.html
File metadata and controls
432 lines (376 loc) · 21.2 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
<!doctype html>
<html lang="en">
<head>
<title>Batch | Transactions | 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/transactions">Transactions</a><span class="sep"> / </span><span class="last">Batch</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 active">
<a class="active" href="/docs/transactions">Transactions</a>
<ul class="nav">
<li class="nav1 ">
<a href="/docs/transactions/">Introduction</a>
</li>
<li class="nav1 active">
<a class="active" href="/docs/transactions/batch">Batch</a>
<ul class="nav nav-scroll">
<li><a href="#transactionalBatchSize">@Transactional(batchSize)</a></li>
<li><a href="#batchSize">Batch size</a></li>
<li><a href="#generatedKeys">GetGeneratedKeys()</a></li>
<li><a href="#flush">Flush</a></li>
<li><a href="#flushOnQuery">setFlushOnQuery()</a></li>
<li><a href="#flushOnMixed">setFlushOnMixed()</a></li>
<li><a href="#flushOnGetter">Flush on getter/setter</a></li>
<li><a href="#flushExplicit">Explicit flush()</a></li>
<li><a href="#serverConfig">Configuration via ServerConfig</a></li>
</ul>
</li>
<li class="nav1 ">
<a href="/docs/transactions/scopes">Scopes</a>
</li>
<li class="nav1 ">
<a href="/docs/transactions/savepoints">Savepoints</a>
</li>
<li class="nav1 ">
<a href="/docs/transactions/spring">Spring</a>
</li>
<li class="nav1 ">
<a href="/docs/transactions/jta">JTA</a>
</li>
</ul>
</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="batch">Batch</h2>
<p>
We can explicitly turn on the use of JDBC batch via <em>transaction.setBatchMode(true)</em>
</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">transaction</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">// use JDBC batch</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">setBatchMode</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="c1">// these go to batch buffer</span>
<span class="n">aBean</span><span class="o">.</span><span class="na">save</span><span class="o">();</span>
<span class="n">bBean</span><span class="o">.</span><span class="na">save</span><span class="o">();</span>
<span class="n">cBean</span><span class="o">.</span><span class="na">save</span><span class="o">();</span>
<span class="c1">// batched</span>
<span class="n">database</span><span class="o">.</span><span class="na">saveAll</span><span class="o">(</span><span class="n">someBeans</span><span class="o">);</span>
<span class="c1">// flush batch and commit</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">commit</span><span class="o">();</span>
<span class="o">}</span>
</pre></div>
</div>
<h2 id="transactionalBatchSize">@Transactional(batchSize)</h2>
<p>
When using <em>@Transactional</em> setting the <code>batchSize</code> attribute will turn on JDBC batch.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="nd">@Transactional</span><span class="o">(</span><span class="nx">batchSize</span> <span class="o">=</span> <span class="mi">50</span><span class="o">)</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">doGoodStuff</span><span class="o">()</span> <span class="o">{</span>
<span class="o">...</span>
<span class="o">}</span>
</pre></div>
</div>
<h2 id="batchSize">Batch size</h2>
<p>
The batch size controls the number of times Ebean will bind a JDBC prepared statement before executing it.
When persisting beans (e.g. customer.save()) it is effectively the number of beans persisted.
</p>
<p>
When the number of beans (or SqlUpdate or CallableSql) hits the batch size then the batch is flushed
and all the statements in the buffer are executed.
</p>
<p>
When persisting different types of beans, for example "order" and "order details" then when any of the buffers
hits the batch size all buffers are flushed. This allows Ebean to preserve the execution order, for example
persisting all the "orders" before persisting all the "order details".
</p>
<p>
The batch buffer size default value is set via <em>databaseConfig.persistBatchSize</em> which defaults to <code>20</code>.
We can set the buffer size on the transaction via <code>transaction.setBatchSize()</code> or <code>@Transactional(batchSize)</code>.
</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">transaction</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">// use JDBC batch</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">setBatchMode</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">setBatchSize</span><span class="o">(</span><span class="mi">50</span><span class="o">);</span>
<span class="c1">// these go to batch buffer</span>
<span class="n">aBean</span><span class="o">.</span><span class="na">save</span><span class="o">();</span>
<span class="o">...</span>
<span class="c1">// flush batch and commit</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">commit</span><span class="o">();</span>
<span class="o">}</span>
</pre></div>
</div>
<h2 id="generatedKeys">GetGeneratedKeys</h2>
<p>
By default Ebean will get the generated keys after beans are inserted. When we have processing that
is inserting a large number of rows/beans and we don't actually need the keys after the insert we
can turn off getting the generated keys for a performance benefit.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// don't bother getting back the generated keys</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">setGetGeneratedKeys</span><span class="o">(</span><span class="kc">false</span><span class="o">);</span>
</pre></div>
</div>
<p>
When we are performing a large bulk insert it is common to turn off <em>getGeneratedKeys</em>.
</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">transaction</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">transaction</span><span class="o">.</span><span class="na">setBatchMode</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">setBatchSize</span><span class="o">(</span><span class="mi">100</span><span class="o">);</span>
<span class="c1">// turn off GetGeneratedKeys as we don't need the keys</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">setGetGeneratedKeys</span><span class="o">(</span><span class="kc">false</span><span class="o">);</span>
<span class="c1">// maybe even turn off persist cascade ...</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">setPersistCascade</span><span class="o">(</span><span class="kc">false</span><span class="o">)</span>
<span class="c1">// perform lots of inserts ...</span>
<span class="o">...</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">commit</span><span class="o">();</span>
<span class="o">}</span>
</pre></div>
</div>
<h2 id="flush">Flush</h2>
<p>
The batch is flushed when:
</p>
<ul>
<li>A buffer hits the batch size</li>
<li>We execute a query - depending on setFlushOnQuery()</li>
<li>We mix SqlUpdate, CallableSql with bean persisting - depending on setFlushOnMixed()</li>
<li>We call a getter or setter on a bean property that is already batched e.g. bean.getId()</li>
<li>We explicitly call flush()</li>
</ul>
<h2 id="flushOnQuery">setFlushOnQuery()</h2>
<p>
Set <code>setFlushOnQuery(false)</code> on a transaction when we want to execute a query
but don't want that to trigger a flush.
</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">transaction</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">transaction</span><span class="o">.</span><span class="na">setBatchMode</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">setFlushOnQuery</span><span class="o">(</span><span class="kc">false</span><span class="o">);</span>
<span class="c1">// these go to batch buffer</span>
<span class="n">aBean</span><span class="o">.</span><span class="na">save</span><span class="o">();</span>
<span class="o">...</span>
<span class="c1">// execute this query but we don't</span>
<span class="c1">// want that to trigger flush</span>
<span class="n">SomeOtherBean</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="o">...</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">commit</span><span class="o">();</span>
<span class="o">}</span>
</pre></div>
</div>
<h2 id="flushOnMixed">setFlushOnMixed()</h2>
<p>
We set <em>setFlushOnMixed(false)</em> on a transaction when we want to execute a SqlUpdate
or CallableSql mixed with bean save(), delete() etc and don't want that to trigger a flush.
</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">transaction</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">transaction</span><span class="o">.</span><span class="na">setBatchMode</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">setFlushOnMixed</span><span class="o">(</span><span class="kc">false</span><span class="o">);</span>
<span class="c1">// these go to batch buffer</span>
<span class="n">aBean</span><span class="o">.</span><span class="na">save</span><span class="o">();</span>
<span class="o">...</span>
<span class="c1">// execute SqlUpdate but we don't</span>
<span class="c1">// want that to trigger flush</span>
<span class="n">SqlUpdate</span> <span class="n">update</span> <span class="o">=</span> <span class="o">...</span>
<span class="n">update</span><span class="o">.</span><span class="na">execute</span><span class="o">();</span>
<span class="o">...</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">commit</span><span class="o">();</span>
<span class="o">}</span>
</pre></div>
</div>
<h2 id="flushOnGetter">Flush on getter/setter</h2>
<p>
For beans that are in the batch buffer, if we call getters/setters on a generated property
or "unloaded" Id property this will trigger a flush.
</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">transaction</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">transaction</span><span class="o">.</span><span class="na">setBatchMode</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="c1">// bean goes to batch buffer</span>
<span class="n">myBean</span><span class="o">.</span><span class="na">save</span><span class="o">();</span>
<span class="o">...</span>
<span class="c1">// will trigger flush if id is an "unloaded" property</span>
<span class="c1">// and myBean is in the buffer (not flushed)</span>
<span class="kt">long</span> <span class="n">id</span> <span class="o">=</span> <span class="n">myBean</span><span class="o">.</span><span class="na">getId</span><span class="o">();</span>
<span class="c1">// will trigger flush if myBean is in the buffer (not flushed)</span>
<span class="n">Instant</span> <span class="n">whenCreated</span> <span class="o">=</span> <span class="n">myBean</span><span class="o">.</span><span class="na">getWhenCreated</span><span class="o">();</span>
<span class="o">...</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">commit</span><span class="o">();</span>
<span class="o">}</span>
</pre></div>
</div>
<h2 id="flushExplicit">Explicit flush()</h2>
<p>
We may wish to perform an explicit <code>transaction.flush()</code> when we want to ensure that any
batched statements have been executed. This typically means that we know that all SQL statements have
been executed and that all the DB constraints are tested at that point in the application logic.
</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">transaction</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">transaction</span><span class="o">.</span><span class="na">setBatchMode</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="c1">// bean goes to batch buffer</span>
<span class="n">myBean</span><span class="o">.</span><span class="na">save</span><span class="o">();</span>
<span class="o">...</span>
<span class="c1">// ensure all SQL statements are executed which means that</span>
<span class="c1">// all DB constraints (unique, foreign key etc) are tested</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">flush</span><span class="o">();</span>
<span class="c1">// carry on with stuff ...</span>
<span class="o">...</span>
<span class="n">transaction</span><span class="o">.</span><span class="na">commit</span><span class="o">();</span>
<span class="o">}</span>
</pre></div>
</div>
<h2 id="databaseConfig">Configuration via DatabaseBuilder</h2>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// use JDBC batch by default</span>
<span class="n">databaseBuilder</span><span class="o">.</span><span class="na">persistBatch</span><span class="o">(</span><span class="n">PersistBatch</span><span class="o">.</span><span class="na">ALL</span><span class="o">);</span>
</pre></div>
</div>
<p>
We can set <em>databaseBuilder.persistBatch(PersistBatch.ALL)</em> so that JDBC batch mode is the default
being used for all transactions.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// default batch size</span>
<span class="n">databaseBuilder</span><span class="o">.</span><span class="na">persistBatchSize</span><span class="o">(</span><span class="mi">50</span><span class="o">);</span>
</pre></div>
</div>
<p>
We can change the global default batch size via <em>databaseBuilder.persistBatchSize()</em>. The default is
otherwise set at 20.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// update all loaded properties or just dirty properties</span>
<span class="n">databaseBuilder</span><span class="o">.</span><span class="na">updateAllPropertiesInBatch</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
</pre></div>
</div>
<p>
When using batch update we have the option to include the dirty properties or all loaded properties in the
update. If we choose dirty properties we will include less properties in the update statement but we may
get more distinct update statements being executed (in the case where the application logic doesn't update
the same properties on all the beans being updated).
</p>
<nav class="next">
<p class="edit-page">
<a href="https://github.com/ebean-orm/website-source/blob/master/docs/transactions/batch.html"><i class="fab fa-github"></i> Edit Page</a>
</p>
<p class="next">
<a href="/docs/transactions/scopes" class="btn btn-info">Next: Scopes</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>