-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathserverconfig.html
More file actions
275 lines (241 loc) · 11.7 KB
/
serverconfig.html
File metadata and controls
275 lines (241 loc) · 11.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
<!DOCTYPE html>
<html lang="en">
<head>
<title>Ebean ORM Setup</title>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script async defer src="https://buttons.github.io/buttons.js"></script>
<link rel="shortcut icon" href="/images/favicon.ico" >
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
<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/pygments.css" type="text/css" />
<link rel="stylesheet" href="/css/site.css">
</head>
<body>
<div id="wrap">
<div id="header">
<div class="navbar" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".mobile-nav">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">
<img src="/images/lg5-21x100.png" height="35">
</a>
</div>
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav pull-right nav-btn-rhs">
<li ><a href="/"><span class="fas fa-home"></span> Home</a></li>
<li class="active"><a href="/docs">Docs</a></li>
<li ><a href="/docs/getting-started">Get Started</a></li>
<li ><a href="/support">Help</a></li>
<li ><a href="/videos">Videos</a></li>
<li ><a target="_blank" href="/apidoc/13">ApiDocs</a></li>
<li ><a href="/releases">Releases</a></li>
<li><a target="_blank" href="https://github.com/ebean-orm/ebean"> <i class="fab fa-github"></i></a></li>
</ul>
</div>
<div class="mobile-nav">
<ul class="nav navbar-nav pull-right nav-btn-rhs">
<li ><a href="/"><span class="fas fa-home"></span> Home</a></li>
<li class="active"><a href="/docs">Docs</a></li>
<li ><a href="/docs/getting-started">Get Started</a></li>
<li ><a href="/support">Help</a></li>
<li ><a href="/videos">Videos</a></li>
<li ><a target="_blank" href="/apidoc/13">ApiDocs</a></li>
<li ><a href="/releases">Releases</a></li>
<li><a target="_blank" href="https://github.com/ebean-orm/ebean"> <i class="fab fa-github"></i></a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="main">
<div class="jumbotron mini">
<div class="container">
<h1><a href="/docs">Documentation</a> / <a href="/docs/setup">Setup</a> / DatabaseBuilder </h1>
</div>
</div>
<div class="container doc-index bs-docs-container">
<div class="row">
<div class="col-md-9" role="main">
<div class="bs-docs-section">
<h2 id="overview">Overview</h2>
<p>
The preferred way to programmatically configure Ebean is via <code>Database.builder()</code>
and <code>DatabaseBuilder</code>.
</p>
<p>
This keeps database creation explicit, works naturally with dependency injection,
and avoids relying on implicit bootstrap through the <code>DB</code> singleton.
For new applications, prefer injecting <code>Database</code> and calling methods on
that instance directly.
</p>
<h2 id="builder">Database.builder()</h2>
<p>
Build the <code>Database</code> explicitly and keep the instance returned from
<code>build()</code>.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="k">var</span> <span class="n">dataSource</span> <span class="o">=</span> <span class="n">DataSourceBuilder</span><span class="o">.</span><span class="na">create</span><span class="o">()</span>
<span class="o">.</span><span class="na">username</span><span class="o">(</span><span class="s">"my_app"</span><span class="o">)</span>
<span class="o">.</span><span class="na">password</span><span class="o">(</span><span class="s">"secret"</span><span class="o">)</span>
<span class="o">.</span><span class="na">url</span><span class="o">(</span><span class="s">"jdbc:postgresql://localhost:5432/my_app"</span><span class="o">);</span>
<span class="n">Database</span> <span class="n">database</span> <span class="o">=</span> <span class="n">Database</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">name</span><span class="o">(</span><span class="s">"db"</span><span class="o">)</span>
<span class="o">.</span><span class="na">dataSourceBuilder</span><span class="o">(</span><span class="n">dataSource</span><span class="o">)</span>
<span class="o">.</span><span class="na">build</span><span class="o">();</span>
</pre></div>
</div>
<h2 id="properties">Load from properties</h2>
<p>
If some configuration lives in <code>application.yaml</code> or <code>application.properties</code>,
load it explicitly with the builder rather than relying on automatic bootstrap.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">Database</span> <span class="n">database</span> <span class="o">=</span> <span class="n">Database</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">name</span><span class="o">(</span><span class="s">"pg"</span><span class="o">)</span>
<span class="o">.</span><span class="na">loadFromProperties</span><span class="o">()</span>
<span class="o">.</span><span class="na">build</span><span class="o">();</span>
</pre></div>
</div>
<p>
For named databases, set the name before <code>loadFromProperties()</code> so the
matching datasource configuration is loaded.
</p>
<h2 id="register">Register</h2>
<p>
By default a built <code>Database</code> is registered with the <code>DB</code> registry,
and that is generally the right choice. Query beans, Model and other default-database-based
APIs resolve the database through that registry under the hood.
</p>
<p>
Only disable registration for isolated or one-off databases that are never referenced that way.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">Database</span> <span class="n">database</span> <span class="o">=</span> <span class="n">Database</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">name</span><span class="o">(</span><span class="s">"reporting"</span><span class="o">)</span>
<span class="o">.</span><span class="na">loadFromProperties</span><span class="o">()</span>
<span class="o">.</span><span class="na">register</span><span class="o">(</span><span class="kc">false</span><span class="o">)</span>
<span class="o">.</span><span class="na">defaultDatabase</span><span class="o">(</span><span class="kc">false</span><span class="o">)</span>
<span class="o">.</span><span class="na">build</span><span class="o">();</span>
</pre></div>
</div>
<h2 id="default">Default database</h2>
<p>
One registered <code>Database</code> is typically left as the default database. Query beans,
Model and older convenience APIs commonly resolve against that default registration.
Even so, for new code prefer using the injected <code>Database</code> directly rather than
calling <code>DB</code> convenience methods in application code.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">Database</span> <span class="n">database</span> <span class="o">=</span> <span class="n">Database</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">name</span><span class="o">(</span><span class="s">"db"</span><span class="o">)</span>
<span class="o">.</span><span class="na">loadFromProperties</span><span class="o">()</span>
<span class="o">.</span><span class="na">defaultDatabase</span><span class="o">(</span><span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">build</span><span class="o">();</span>
</pre></div>
</div>
<h2 id="di">Dependency injection</h2>
<p>
With Guice, Spring, Avaje Inject and similar DI frameworks, create the
<code>Database</code> in a provider or bean factory and inject the resulting
instance where needed.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="nd">@Bean</span>
<span class="n">Database</span> <span class="nf">database</span><span class="o">()</span> <span class="o">{</span>
<span class="k">return</span> <span class="n">Database</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">name</span><span class="o">(</span><span class="s">"db"</span><span class="o">)</span>
<span class="o">.</span><span class="na">loadFromProperties</span><span class="o">()</span>
<span class="o">.</span><span class="na">build</span><span class="o">();</span>
<span class="o">}</span>
</pre></div>
</div>
<p>
Older versions referred to <code>ServerConfig</code> / <code>EbeanServerFactory</code>.
If you are migrating older setup code, see <a href="/docs/upgrading">docs / upgrading</a>.
</p>
</div>
</div>
<div class="col-md-3" role="complementary">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm">
<ul class="nav bs-docs-sidenav">
<li >
<a href="/docs/setup/enhancement">Enhancement</a>
</li>
<li >
<a href="/docs/setup/eclipse-apt">Eclipse IDE - APT</a>
</li>
<li >
<a href="/docs/setup/logging">Logging</a>
</li>
<li class="active">
<a href="/docs/setup/serverconfig">DatabaseBuilder</a>
<ul class="nav">
<li><a href="#overview">Overview</a></li>
<li><a href="#builder">Database.builder()</a></li>
<li><a href="#properties">Load from properties</a></li>
<li><a href="#register">Register</a></li>
<li><a href="#default">Default database</a></li>
<li><a href="#di">Dependency injection</a></li>
</ul>
</li>
<li >
<a href="/docs/setup/guice">Guice</a>
</li>
<li >
<a href="/docs/setup/spring">Spring</a>
</li>
<li >
<a href="/docs/setup/activerecord">Active Record</a>
</li>
<li >
<a href="/docs/setup/ddl-create-all">DDL - Create All</a>
</li>
<li >
<a href="/docs/setup/dbmigration">DDL - DB Migration</a>
</li>
<li >
<a href="/docs/setup/test-properties"> Test properties</a>
</li>
<li >
<a href="/docs/setup/testing">Testing</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<!-- /.row -->
</div> <!-- /.container -->
</div>
</div>
<footer id="footer">
<div class="doc-footer">
<ul class="doc-footer-links">
<li><a href="/">Ebean ORM</a></li>
<li> | </li>
<li><a href="http://avaje-metric.github.io">Metrics</a></li>
</ul>
</div>
</footer>
<script type="text/javascript">
var categoryNames = {};
</script>
<script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
<script src="/js/bootstrap.min.js"></script>
<script src="/js/jquery.easing.min.js"></script>
<script src="/js/jquery.storageapi.min.js"></script>
<script src="/js/ebean-site.js"></script>
<script src="/js/extra.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-75181644-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>