forked from ebean-orm/ebean-orm.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy patharraytype.html
More file actions
265 lines (244 loc) · 11.9 KB
/
arraytype.html
File metadata and controls
265 lines (244 loc) · 11.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
<!doctype html>
<html lang="en">
<head>
<title>Postgres Array | Ebean ORM</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/database">Database platforms</a><span class="sep"> / </span><a href="/docs/database/postgres">Postgres</a><span class="sep"> / </span><span class="last">Array type</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 ">
<a href="/docs/query">Query</a>
</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 active">
<a class="active" href="/docs/database">Database platforms</a>
<ul class="nav">
<li class="active">
<a class="active" href="/docs/database/postgres">Postgres</a>
</li>
<li >
<a href="/docs/database/h2">H2</a>
</li>
<li >
<a href="/docs/database/mysql">MySql</a>
</li>
<li >
<a href="/docs/database/mariadb">MariaDB</a>
</li>
<li >
<a href="/docs/database/sqlserver">SQL Server</a>
</li>
<li >
<a href="/docs/database/oracle">Oracle</a>
</li>
<li >
<a href="/docs/database/db2">DB2</a>
</li>
<li >
<a href="/docs/database/hana">SAP Hana</a>
</li>
<li >
<a href="/docs/database/sqlite">Sqlite</a>
</li>
<li >
<a href="/docs/database/clickhouse">ClickHouse</a>
</li>
<li >
<a href="/docs/database/cockroach">Cockroach</a>
</li>
<li >
<a href="/docs/database/nuodb">NuoDB</a>
</li>
<li >
<a href="/docs/database/elasticsearch">ElasticSearch</a>
</li>
<li >
<a href="/docs/database/redis">Redis</a>
</li>
</ul>
</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>Array type</h2>
<p>
We can use <code>@DbArray</code> to map a Set or List of String, UUID, Integer or Long.
</p>
<ul class="code nav nav-tabs mytabs">
<li role="presentation" class="javaActive active"><a onclick="setLang('java');">java</a></li>
<li role="presentation" class="kotlinActive"><a onclick="setLang('kt');">kotlin</a></li>
</ul>
<div class="code-java">
<div class="syntax java"><div class="highlight"><pre><span></span><span class="nd">@Entity</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Customer</span> <span class="o">{</span>
<span class="nd">@Id</span>
<span class="kd">private</span> <span class="kt">long</span> <span class="n">id</span><span class="o">;</span>
<span class="kd">private</span> <span class="n">String</span> <span class="n">name</span><span class="o">;</span>
<span class="nd">@DbArray</span>
<span class="kd">private</span> <span class="n">Set</span><span class="o"><</span><span class="n">String</span><span class="o">></span> <span class="n">tags</span> <span class="o">=</span> <span class="k">new</span> <span class="n">LinkedHashSet</span><span class="o"><>();</span>
<span class="c1">// getters and setters</span>
<span class="o">}</span>
</pre></div>
</div>
</div>
<div class="code-kt">
<div class="syntax kotlin"><div class="highlight"><pre><span></span><span class="nd">@Entity</span>
<span class="k">class</span> <span class="nc">Customer</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="n">String</span><span class="p">)</span> <span class="p">{</span>
<span class="nd">@Id</span>
<span class="k">var</span> <span class="py">id</span><span class="p">:</span> <span class="n">Long</span> <span class="p">=</span> <span class="m">0</span>
<span class="k">var</span> <span class="py">name</span><span class="p">:</span> <span class="n">String</span> <span class="p">=</span> <span class="n">name</span>
<span class="nd">@DbArray</span>
<span class="k">var</span> <span class="py">tags</span> <span class="p">=</span> <span class="n">emptyMutableSet</span><span class="p"><>();</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<h3>DDL for Array types</h3>
<p>
In the above example the <em>tags</em> property maps to a <em>varchar[]</em>.
</p>
<div class="syntax sql"><div class="highlight"><pre><span></span><span class="k">create</span> <span class="k">table</span> <span class="n">customer</span> <span class="p">(</span>
<span class="n">id</span> <span class="n">bigserial</span> <span class="k">not</span> <span class="k">null</span><span class="p">,</span>
<span class="n">name</span> <span class="nb">varchar</span><span class="p">(</span><span class="mi">255</span><span class="p">)</span> <span class="k">not</span> <span class="k">null</span><span class="p">,</span>
<span class="n">registered</span> <span class="nb">date</span><span class="p">,</span>
<span class="n">tags</span> <span class="nb">varchar</span><span class="p">[],</span>
<span class="k">version</span> <span class="nb">bigint</span> <span class="k">not</span> <span class="k">null</span><span class="p">,</span>
<span class="n">when_created</span> <span class="n">timestamptz</span> <span class="k">not</span> <span class="k">null</span><span class="p">,</span>
<span class="n">when_modified</span> <span class="n">timestamptz</span> <span class="k">not</span> <span class="k">null</span><span class="p">,</span>
<span class="k">constraint</span> <span class="n">pk_customer</span> <span class="k">primary</span> <span class="k">key</span> <span class="p">(</span><span class="n">id</span><span class="p">)</span>
<span class="p">);</span>
</pre></div>
</div>
<h3>Array contains expression</h3>
<p>
Commonly we want to use the <em>contains</em> expression.
</p>
<ul class="code nav nav-tabs mytabs">
<li role="presentation" class="javaActive active"><a onclick="setLang('java');">java</a></li>
<li role="presentation" class="kotlinActive"><a onclick="setLang('kt');">kotlin</a></li>
</ul>
<div class="code-java">
<div class="syntax java"><div class="highlight"><pre><span></span><span class="kd">final</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">tags</span><span class="o">.</span><span class="na">contains</span><span class="o">(</span><span class="s">"BLUE"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
</pre></div>
</div>
</div>
<div class="code-kt">
<div class="syntax kotlin"><div class="highlight"><pre><span></span><span class="k">val</span> <span class="py">customers</span>
<span class="p">=</span> <span class="n">QCustomer</span><span class="p">()</span>
<span class="p">.</span><span class="n field">tags</span><span class="p">.</span><span class="n">contains</span><span class="p">(</span><span class="s">"BLUE"</span><span class="p">)</span>
<span class="p">.</span><span class="n">findList</span><span class="p">()</span>
</pre></div>
</div>
</div>
<p>
The SQL for the above query is:
</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">name</span><span class="p">,</span> <span class="n">t0</span><span class="p">.</span><span class="n">registered</span><span class="p">,</span> <span class="n">t0</span><span class="p">.</span><span class="n">tags</span><span class="p">,</span> <span class="n">t0</span><span class="p">.</span><span class="k">version</span><span class="p">,</span> <span class="n">t0</span><span class="p">.</span><span class="n">when_created</span><span class="p">,</span> <span class="n">t0</span><span class="p">.</span><span class="n">when_modified</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">tags</span> <span class="o">@></span> <span class="nb">array</span><span class="p">[</span><span class="o">?</span><span class="p">];</span> <span class="c1">--bind(BLUE)</span>
</pre></div>
</div>
</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>