Gitiles
Code Review Sign In
asterix-gerrit.ics.uci.edu / incubator-asterixdb-site / refs/heads/asf-site / . / docs / 0.9.2 / datamodel.html
blob: 4218eade61a733fdda10ce93eb98e420bc0b9263 [file] [log] [blame]
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]1<!DOCTYPE html>
2<!--
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]3 | Generated by Apache Maven Doxia at 2017-09-14
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]4 | Rendered using Apache Maven Fluido Skin 1.3.0
5-->
6<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8 <meta charset="UTF-8" />
9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]10 <meta name="Date-Revision-yyyymmdd" content="20170914" />
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]11 <meta http-equiv="Content-Language" content="en" />
12 <title>AsterixDB &#x2013; The Asterix Data Model (ADM)</title>
13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
14 <link rel="stylesheet" href="./css/site.css" />
15 <link rel="stylesheet" href="./css/print.css" media="print" />
16
17
18 <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
19
20
21
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]22
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]23
24 </head>
25 <body class="topBarDisabled">
26
27
28
29
30 <div class="container-fluid">
31 <div id="banner">
32 <div class="pull-left">
33 <a href="./" id="bannerLeft">
34 <img src="images/asterixlogo.png" alt="AsterixDB"/>
35 </a>
36 </div>
37 <div class="pull-right"> </div>
38 <div class="clear"><hr/></div>
39 </div>
40
41 <div id="breadcrumbs">
42 <ul class="breadcrumb">
43
44
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]45 <li id="publishDate">Last Published: 2017-09-14</li>
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]46
47
48
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]49 <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]50
51 <li class="divider pull-right">|</li>
52
53 <li class="pull-right"> <a href="index.html" title="Documentation Home">
54 Documentation Home</a>
55 </li>
56
57 </ul>
58 </div>
59
60
61 <div class="row-fluid">
62 <div id="leftColumn" class="span3">
63 <div class="well sidebar-nav">
64
65
66 <ul class="nav nav-list">
67 <li class="nav-header">Get Started - Installation</li>
68
69 <li>
70
71 <a href="ncservice.html" title="Option 1: using NCService">
72 <i class="none"></i>
73 Option 1: using NCService</a>
74 </li>
75
76 <li>
77
78 <a href="ansible.html" title="Option 2: using Ansible">
79 <i class="none"></i>
80 Option 2: using Ansible</a>
81 </li>
82
83 <li>
84
85 <a href="aws.html" title="Option 3: using Amazon Web Services">
86 <i class="none"></i>
87 Option 3: using Amazon Web Services</a>
88 </li>
89
90 <li>
91
92 <a href="yarn.html" title="Option 4: using YARN">
93 <i class="none"></i>
94 Option 4: using YARN</a>
95 </li>
96
97 <li>
98
99 <a href="install.html" title="Option 5: using Managix (deprecated)">
100 <i class="none"></i>
101 Option 5: using Managix (deprecated)</a>
102 </li>
103 <li class="nav-header">AsterixDB Primer</li>
104
105 <li>
106
107 <a href="sqlpp/primer-sqlpp.html" title="Option 1: using SQL++">
108 <i class="none"></i>
109 Option 1: using SQL++</a>
110 </li>
111
112 <li>
113
114 <a href="aql/primer.html" title="Option 2: using AQL">
115 <i class="none"></i>
116 Option 2: using AQL</a>
117 </li>
118 <li class="nav-header">Data Model</li>
119
120 <li class="active">
121
122 <a href="#"><i class="none"></i>The Asterix Data Model</a>
123 </li>
124 <li class="nav-header">Queries - SQL++</li>
125
126 <li>
127
128 <a href="sqlpp/manual.html" title="The SQL++ Query Language">
129 <i class="none"></i>
130 The SQL++ Query Language</a>
131 </li>
132
133 <li>
134
135 <a href="sqlpp/builtins.html" title="Builtin Functions">
136 <i class="none"></i>
137 Builtin Functions</a>
138 </li>
139 <li class="nav-header">Queries - AQL</li>
140
141 <li>
142
143 <a href="aql/manual.html" title="The Asterix Query Language (AQL)">
144 <i class="none"></i>
145 The Asterix Query Language (AQL)</a>
146 </li>
147
148 <li>
149
150 <a href="aql/builtins.html" title="Builtin Functions">
151 <i class="none"></i>
152 Builtin Functions</a>
153 </li>
154 <li class="nav-header">API/SDK</li>
155
156 <li>
157
158 <a href="api.html" title="HTTP API">
159 <i class="none"></i>
160 HTTP API</a>
161 </li>
162
163 <li>
164
165 <a href="csv.html" title="CSV Output">
166 <i class="none"></i>
167 CSV Output</a>
168 </li>
169 <li class="nav-header">Advanced Features</li>
170
171 <li>
172
173 <a href="aql/fulltext.html" title="Support of Full-text Queries">
174 <i class="none"></i>
175 Support of Full-text Queries</a>
176 </li>
177
178 <li>
179
180 <a href="aql/externaldata.html" title="Accessing External Data">
181 <i class="none"></i>
182 Accessing External Data</a>
183 </li>
184
185 <li>
186
187 <a href="feeds/tutorial.html" title="Support for Data Ingestion">
188 <i class="none"></i>
189 Support for Data Ingestion</a>
190 </li>
191
192 <li>
193
194 <a href="udf.html" title="User Defined Functions">
195 <i class="none"></i>
196 User Defined Functions</a>
197 </li>
198
199 <li>
200
201 <a href="aql/filters.html" title="Filter-Based LSM Index Acceleration">
202 <i class="none"></i>
203 Filter-Based LSM Index Acceleration</a>
204 </li>
205
206 <li>
207
208 <a href="aql/similarity.html" title="Support of Similarity Queries">
209 <i class="none"></i>
210 Support of Similarity Queries</a>
211 </li>
212 </ul>
213
214
215
216 <hr class="divider" />
217
218 <div id="poweredBy">
219 <div class="clear"></div>
220 <div class="clear"></div>
221 <div class="clear"></div>
222 <a href="./" title="AsterixDB" class="builtBy">
223 <img class="builtBy" alt="AsterixDB" src="images/asterixlogo.png" />
224 </a>
225 </div>
226 </div>
227 </div>
228
229
230 <div id="bodyColumn" class="span9" >
231
232 <!-- ! Licensed to the Apache Software Foundation (ASF) under one
233 ! or more contributor license agreements. See the NOTICE file
234 ! distributed with this work for additional information
235 ! regarding copyright ownership. The ASF licenses this file
236 ! to you under the Apache License, Version 2.0 (the
237 ! "License"); you may not use this file except in compliance
238 ! with the License. You may obtain a copy of the License at
239 !
240 ! http://www.apache.org/licenses/LICENSE-2.0
241 !
242 ! Unless required by applicable law or agreed to in writing,
243 ! software distributed under the License is distributed on an
244 ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
245 ! KIND, either express or implied. See the License for the
246 ! specific language governing permissions and limitations
247 ! under the License.
248 ! --><h1>The Asterix Data Model (ADM)</h1>
249<div class="section">
250<h2><a name="Table_of_Contents"></a><a name="toc" id="toc">Table of Contents</a></h2>
251
252<ul>
253
254<li><a href="#PrimitiveTypes">Primitive Types</a>
255
256<ul>
257
258<li><a href="#PrimitiveTypesBoolean">Boolean</a></li>
259
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]260<li><a href="#PrimitiveTypesString">String</a></li>
261
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]262<li><a href="#PrimitiveTypesInt">Tinyint / Smallint / Integer (Int) / Bigint</a></li>
263
264<li><a href="#PrimitiveTypesFloat">Float</a></li>
265
266<li><a href="#PrimitiveTypesDouble">Double (Double Precision)</a></li>
267
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]268<li><a href="#PrimitiveTypesBinary">Binary</a></li>
269
270<li><a href="#PrimitiveTypesPoint">Point</a></li>
271
272<li><a href="#PrimitiveTypesLine">Line</a></li>
273
274<li><a href="#PrimitiveTypesRectangle">Rectangle</a></li>
275
276<li><a href="#PrimitiveTypesCircle">Circle</a></li>
277
278<li><a href="#PrimitiveTypesPolygon">Polygon</a></li>
279
280<li><a href="#PrimitiveTypesDate">Date</a></li>
281
282<li><a href="#PrimitiveTypesTime">Time</a></li>
283
284<li><a href="#PrimitiveTypesDateTime">Datetime (Timestamp)</a></li>
285
286<li><a href="#PrimitiveTypesDuration">Duration/Year_month_duration/Day_time_duration</a></li>
287
288<li><a href="#PrimitiveTypesInterval">Interval</a></li>
289
290<li><a href="#PrimitiveTypesUUID">UUID</a></li>
291 </ul></li>
292
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]293<li><a href="#IncompleteInformationTypes">Incomplete Information Types</a>
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]294
295<ul>
296
297<li><a href="#IncompleteInformationTypesNull">Null</a></li>
298
299<li><a href="#IncompleteInformationTypesMissing">Missing</a></li>
300 </ul></li>
301
302<li><a href="#DerivedTypes">Derived Types</a>
303
304<ul>
305
306<li><a href="#DerivedTypesObject">Object</a></li>
307
308<li><a href="#DerivedTypesArray">Array</a></li>
309
310<li><a href="#DerivedTypesMultiset">Multiset</a></li>
311 </ul></li>
312</ul>
313<p>An instance of Asterix data model (ADM) can be a <i><i>primitive type</i></i> (<tt>boolean</tt>, <tt>tinyint</tt>, <tt>smallint</tt>, <tt>integer</tt>, <tt>bigint</tt>, <tt>string</tt>, <tt>float</tt>, <tt>double</tt>, <tt>date</tt>, <tt>time</tt>, <tt>datetime</tt>, etc.), a <i><i>special type</i></i> (<tt>null</tt> or <tt>missing</tt>), or a <i><i>derived type</i></i>.</p>
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]314<p>The type names are case-insensitive, e.g., both <tt>BIGINT</tt> and <tt>bigint</tt> are acceptable.</p>
315<!-- ! Licensed to the Apache Software Foundation (ASF) under one
316 ! or more contributor license agreements. See the NOTICE file
317 ! distributed with this work for additional information
318 ! regarding copyright ownership. The ASF licenses this file
319 ! to you under the Apache License, Version 2.0 (the
320 ! "License"); you may not use this file except in compliance
321 ! with the License. You may obtain a copy of the License at
322 !
323 ! http://www.apache.org/licenses/LICENSE-2.0
324 !
325 ! Unless required by applicable law or agreed to in writing,
326 ! software distributed under the License is distributed on an
327 ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
328 ! KIND, either express or implied. See the License for the
329 ! specific language governing permissions and limitations
330 ! under the License.
331 ! --></div>
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]332<div class="section">
333<h2><a name="Primitive_Types"></a><a name="PrimitiveTypes" id="PrimitiveTypes">Primitive Types</a></h2>
334<div class="section">
335<h3><a name="Boolean"></a><a name="PrimitiveTypesBoolean" id="PrimitiveTypesBoolean">Boolean</a></h3>
336<p><tt>boolean</tt> data type can have one of the two values: <i><i>true</i></i> or <i><i>false</i></i>.</p>
337
338<ul>
339
340<li>
341<p>Example:</p>
342
343<div class="source">
344<div class="source">
345<pre>{ &quot;true&quot;: true, &quot;false&quot;: false };
346</pre></div></div></li>
347</ul>
348
349<ul>
350
351<li>
352<p>The expected result is:</p>
353
354<div class="source">
355<div class="source">
356<pre>{ &quot;true&quot;: true, &quot;false&quot;: false }
357</pre></div></div></li>
358</ul></div>
359<div class="section">
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]360<h3><a name="String"></a><a name="PrimitiveTypesString" id="PrimitiveTypesString">String</a></h3>
361<p><tt>string</tt> represents a sequence of characters. The total length of the sequence can be up to 2,147,483,648.</p>
362
363<ul>
364
365<li>
366<p>Example:</p>
367
368<div class="source">
369<div class="source">
370<pre>{ &quot;v1&quot;: string(&quot;This is a string.&quot;), &quot;v2&quot;: string(&quot;\&quot;This is a quoted string\&quot;&quot;) };
371</pre></div></div></li>
372</ul>
373
374<ul>
375
376<li>
377<p>The expected result is:</p>
378
379<div class="source">
380<div class="source">
381<pre>{ &quot;v1&quot;: &quot;This is a string.&quot;, &quot;v2&quot;: &quot;\&quot;This is a quoted string\&quot;&quot; }
382</pre></div></div></li>
383</ul></div>
384<div class="section">
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]385<h3><a name="Tinyint__Smallint__Integer_Int__Bigint"></a><a name="PrimitiveTypesInt" id="PrimitiveTypesInt">Tinyint / Smallint / Integer (Int) / Bigint</a></h3>
386<p>Integer types using 8, 16, 32, or 64 bits. The ranges of these types are:</p>
387
388<ul>
389
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]390<li><tt>tinyint</tt>: -128 to 127</li>
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]391
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]392<li><tt>smallint</tt>: -32768 to 32767</li>
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]393
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]394<li><tt>integer</tt>: -2147483648 to 2147483647</li>
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]395
396<li><tt>bigint</tt>: -9223372036854775808 to 9223372036854775807</li>
397</ul>
398<p><tt>int</tt> is an abbreviated alias for integer.</p>
399
400<ul>
401
402<li>
403<p>Example:</p>
404
405<div class="source">
406<div class="source">
407<pre>{ &quot;tinyint&quot;: tiny(&quot;125&quot;), &quot;smallint&quot;: smallint(&quot;32765&quot;), &quot;integer&quot;: 294967295, &quot;bigint&quot;: bigint(&quot;1700000000000000000&quot;)};
408</pre></div></div></li>
409</ul>
410
411<ul>
412
413<li>
414<p>The expected result is:</p>
415
416<div class="source">
417<div class="source">
418<pre>{ &quot;tinyint&quot;: 125, &quot;smallint&quot;: 32765, &quot;integer&quot;: 294967295, &quot;bigint&quot;: 17000000 }
419</pre></div></div></li>
420</ul></div>
421<div class="section">
422<h3><a name="Float"></a><a name="PrimitiveTypesFloat" id="PrimitiveTypesFloat">Float</a></h3>
423<p><tt>float</tt> represents approximate numeric data values using 4 bytes. The range of a float value can be from 2^(-149) to (2-2^(-23)&#xb7;2^(127) for both positive and negative. Beyond these ranges will get <tt>INF</tt> or <tt>-INF</tt>.</p>
424
425<ul>
426
427<li>
428<p>Example:</p>
429
430<div class="source">
431<div class="source">
432<pre>{ &quot;v1&quot;: float(&quot;NaN&quot;), &quot;v2&quot;: float(&quot;INF&quot;), &quot;v3&quot;: float(&quot;-INF&quot;), &quot;v4&quot;: float(&quot;-2013.5&quot;) };
433</pre></div></div></li>
434</ul>
435
436<ul>
437
438<li>
439<p>The expected result is:</p>
440
441<div class="source">
442<div class="source">
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]443<pre>{ &quot;v1&quot;: &quot;NaN&quot;, &quot;v2&quot;: &quot;Infinity&quot;, &quot;v3&quot;: &quot;-Infinity&quot;, &quot;v4&quot;: -2013.5 }
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]444</pre></div></div></li>
445</ul></div>
446<div class="section">
447<h3><a name="Double_double_precision"></a><a name="PrimitiveTypesDouble" id="PrimitiveTypesDouble">Double (double precision)</a></h3>
448<p><tt>double</tt> represents approximate numeric data values using 8 bytes. The range of a double value can be from (2^(-1022)) to (2-2^(-52))&#xb7;2^(1023) for both positive and negative. Beyond these ranges will get <tt>INF</tt> or <tt>-INF</tt>.</p>
449
450<ul>
451
452<li>
453<p>Example:</p>
454
455<div class="source">
456<div class="source">
457<pre>{ &quot;v1&quot;: double(&quot;NaN&quot;), &quot;v2&quot;: double(&quot;INF&quot;), &quot;v3&quot;: double(&quot;-INF&quot;), &quot;v4&quot;: &quot;-2013.593823748327284&quot; };
458</pre></div></div></li>
459</ul>
460
461<ul>
462
463<li>
464<p>The expected result is:</p>
465
466<div class="source">
467<div class="source">
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]468<pre>{ &quot;v1&quot;: &quot;NaN&quot;, &quot;v2&quot;: &quot;Infinity&quot;, &quot;v3&quot;: &quot;-Infinity&quot;, &quot;v4&quot;: -2013.5938237483274 }
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]469</pre></div></div></li>
470</ul>
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]471<p><tt>Double precision</tt> is an alias of <tt>double</tt>.</p>
472<!-- ! Licensed to the Apache Software Foundation (ASF) under one
473 ! or more contributor license agreements. See the NOTICE file
474 ! distributed with this work for additional information
475 ! regarding copyright ownership. The ASF licenses this file
476 ! to you under the Apache License, Version 2.0 (the
477 ! "License"); you may not use this file except in compliance
478 ! with the License. You may obtain a copy of the License at
479 !
480 ! http://www.apache.org/licenses/LICENSE-2.0
481 !
482 ! Unless required by applicable law or agreed to in writing,
483 ! software distributed under the License is distributed on an
484 ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
485 ! KIND, either express or implied. See the License for the
486 ! specific language governing permissions and limitations
487 ! under the License.
488 ! --></div>
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]489<div class="section">
490<h3><a name="Binary"></a><a name="PrimitiveTypesBinary" id="PrimitiveTypesBinary">Binary</a></h3>
491<p><tt>binary</tt> represents a sequence of bytes. It can be constructed from a <tt>hex</tt> or a <tt>base64</tt> string sequence. The total length of the byte sequence can be up to 2,147,483,648.</p>
492
493<ul>
494
495<li>
496<p>Example:</p>
497
498<div class="source">
499<div class="source">
500<pre>{
501 &quot;hex1&quot; : hex(&quot;ABCDEF0123456789&quot;),
502 &quot;hex2&quot;: hex(&quot;abcdef0123456789&quot;),
503 &quot;base64_1&quot; : base64(&quot;0123456789qwertyui+/&quot;),
504 &quot;base64_2&quot; : base64('QXN0ZXJpeA==')
505};
506</pre></div></div></li>
507
508<li>
509<p>The default output format is in <tt>hex</tt> format. Thus, the expected result is:</p>
510
511<div class="source">
512<div class="source">
513<pre>{
514 &quot;hex1&quot;: hex(&quot;ABCDEF0123456789&quot;),
515 &quot;hex2&quot;: hex(&quot;ABCDEF0123456789&quot;),
516 &quot;base64_1&quot;: hex(&quot;D35DB7E39EBBF3DAB07ABB72BA2FBF&quot;),
517 &quot;base64_2&quot;: hex(&quot;41737465726978&quot;)
518}
519</pre></div></div></li>
520</ul></div>
521<div class="section">
522<h3><a name="Point"></a><a name="PrimitiveTypesPoint" id="PrimitiveTypesPoint">Point</a></h3>
523<p><tt>point</tt> is the fundamental two-dimensional building block for spatial types. It consists of two <tt>double</tt> coordinates x and y.</p>
524
525<ul>
526
527<li>
528<p>Example:</p>
529
530<div class="source">
531<div class="source">
532<pre>{ &quot;v1&quot;: point(&quot;80.10d, -10E5&quot;), &quot;v2&quot;: point(&quot;5.10E-10d, -10E5&quot;) };
533</pre></div></div></li>
534</ul>
535
536<ul>
537
538<li>
539<p>The expected result is:</p>
540
541<div class="source">
542<div class="source">
543<pre>{ &quot;v1&quot;: point(&quot;80.1,-1000000.0&quot;), &quot;v2&quot;: point(&quot;5.1E-10,-1000000.0&quot;) }
544</pre></div></div></li>
545</ul></div>
546<div class="section">
547<h3><a name="Line"></a><a name="PrimitiveTypesLine" id="PrimitiveTypesLine">Line</a></h3>
548<p><tt>line</tt> consists of two points that represent the start and the end points of a line segment.</p>
549
550<ul>
551
552<li>
553<p>Example:</p>
554
555<div class="source">
556<div class="source">
557<pre>{ &quot;v1&quot;: line(&quot;10.1234,11.1e-1 +10.2E-2,-11.22&quot;), &quot;v2&quot;: line(&quot;0.1234,-1.00e-10 +10.5E-2,-01.02&quot;) };
558</pre></div></div></li>
559</ul>
560
561<ul>
562
563<li>
564<p>The expected result is:</p>
565
566<div class="source">
567<div class="source">
568<pre>{ &quot;v1&quot;: line(&quot;10.1234,1.11 0.102,-11.22&quot;), &quot;v2&quot;: line(&quot;0.1234,-1.0E-10 0.105,-1.02&quot;) }
569</pre></div></div></li>
570</ul></div>
571<div class="section">
572<h3><a name="Rectangle"></a><a name="PrimitiveTypesRectangle" id="PrimitiveTypesRectangle">Rectangle</a></h3>
573<p><tt>rectangle</tt> consists of two points that represent the <i><i>bottom left</i></i> and <i><i>upper right</i></i> corners of a rectangle.</p>
574
575<ul>
576
577<li>
578<p>Example:</p>
579
580<div class="source">
581<div class="source">
582<pre>{ &quot;v1&quot;: rectangle(&quot;5.1,11.8 87.6,15.6548&quot;), &quot;v2&quot;: rectangle(&quot;0.1234,-1.00e-10 5.5487,0.48765&quot;) };
583</pre></div></div></li>
584</ul>
585
586<ul>
587
588<li>
589<p>The expected result is:</p>
590
591<div class="source">
592<div class="source">
593<pre>{ &quot;v1&quot;: rectangle(&quot;5.1,11.8 87.6,15.6548&quot;), &quot;v2&quot;: rectangle(&quot;0.1234,-1.0E-10 5.5487,0.48765&quot;) }
594</pre></div></div></li>
595</ul></div>
596<div class="section">
597<h3><a name="Circle"></a><a name="PrimitiveTypesCircle" id="PrimitiveTypesCircle">Circle</a></h3>
598<p><tt>circle</tt> consists of one point that represents the center of the circle and a radius of type <tt>double</tt>.</p>
599
600<ul>
601
602<li>
603<p>Example:</p>
604
605<div class="source">
606<div class="source">
607<pre>{ &quot;v1&quot;: circle(&quot;10.1234,11.1e-1 +10.2E-2&quot;), &quot;v2&quot;: circle(&quot;0.1234,-1.00e-10 +10.5E-2&quot;) };
608</pre></div></div></li>
609</ul>
610
611<ul>
612
613<li>
614<p>The expected result is:</p>
615
616<div class="source">
617<div class="source">
618<pre>{ &quot;v1&quot;: circle(&quot;10.1234,1.11 0.102&quot;), &quot;v2&quot;: circle(&quot;0.1234,-1.0E-10 0.105&quot;) }
619</pre></div></div></li>
620</ul></div>
621<div class="section">
622<h3><a name="Polygon"></a><a name="PrimitiveTypesPolygon" id="PrimitiveTypesPolygon">Polygon</a></h3>
623<p><tt>polygon</tt> consists of <i><i>n</i></i> points that represent the vertices of a <i><i>simple closed</i></i> polygon.</p>
624
625<ul>
626
627<li>
628<p>Example:</p>
629
630<div class="source">
631<div class="source">
632<pre>{
633 &quot;v1&quot;: polygon(&quot;-1.2,+1.3e2 -2.14E+5,2.15 -3.5e+2,03.6 -4.6E-3,+4.81&quot;),
634 &quot;v2&quot;: polygon(&quot;-1.0,+10.5e2 -02.15E+50,2.5 -1.0,+3.3e3 -2.50E+05,20.15 +3.5e+2,03.6 -4.60E-3,+4.75 -2,+1.0e2 -2.00E+5,20.10 30.5,03.25 -4.33E-3,+4.75&quot;)
635};
636</pre></div></div></li>
637</ul>
638
639<ul>
640
641<li>
642<p>The expected result is:</p>
643
644<div class="source">
645<div class="source">
646<pre>{
647 &quot;v1&quot;: polygon(&quot;-1.2,130.0 -214000.0,2.15 -350.0,3.6 -0.0046,4.81&quot;),
648 &quot;v2&quot;: polygon(&quot;-1.0,1050.0 -2.15E50,2.5 -1.0,3300.0 -250000.0,20.15 350.0,3.6 -0.0046,4.75 -2.0,100.0 -200000.0,20.1 30.5,3.25 -0.00433,4.75&quot;) }
649}
650</pre></div></div></li>
651</ul></div>
652<div class="section">
653<h3><a name="Date"></a><a name="PrimitiveTypesDate" id="PrimitiveTypesDate">Date</a></h3>
654<p><tt>date</tt> represents a time point along the Gregorian calendar system specified by the year, month and day. ASTERIX supports the date from <tt>-9999-01-01</tt> to <tt>9999-12-31</tt>.</p>
655<p>A date value can be represented in two formats, extended format and basic format.</p>
656
657<ul>
658
659<li>Extended format is represented as <tt>[-]yyyy-mm-dd</tt> for <tt>year-month-day</tt>. Each field should be padded if there are less digits than the format specified.</li>
660
661<li>Basic format is in the format of <tt>[-]yyyymmdd</tt>.</li>
662
663<li>
664<p>Example:</p>
665
666<div class="source">
667<div class="source">
668<pre>{ &quot;v1&quot;: date(&quot;2013-01-01&quot;), &quot;v2&quot;: date(&quot;-19700101&quot;) };
669</pre></div></div></li>
670</ul>
671
672<ul>
673
674<li>
675<p>The expected result is:</p>
676
677<div class="source">
678<div class="source">
679<pre>{ &quot;v1&quot;: date(&quot;2013-01-01&quot;), &quot;v2&quot;: date(&quot;-1970-01-01&quot;) }
680</pre></div></div></li>
681</ul></div>
682<div class="section">
683<h3><a name="Time"></a><a name="PrimitiveTypesTime" id="PrimitiveTypesTime">Time</a></h3>
684<p><tt>time</tt> type describes the time within the range of a day. It is represented by three fields: hour, minute and second. Millisecond field is optional as the fraction of the second field. Its extended format is as <tt>hh:mm:ss[.mmm]</tt> and the basic format is <tt>hhmmss[mmm]</tt>. The value domain is from <tt>00:00:00.000</tt> to <tt>23:59:59.999</tt>.</p>
685<p>Timezone field is optional for a time value. Timezone is represented as <tt>[+|-]hh:mm</tt> for extended format or <tt>[+|-]hhmm</tt> for basic format. Note that the sign designators cannot be omitted. <tt>Z</tt> can also be used to represent the UTC local time. If no timezone information is given, it is UTC by default.</p>
686
687<ul>
688
689<li>
690<p>Example:</p>
691
692<div class="source">
693<div class="source">
694<pre>{ &quot;v1&quot;: time(&quot;12:12:12.039Z&quot;), &quot;v2&quot;: time(&quot;000000000-0800&quot;) };
695</pre></div></div></li>
696</ul>
697
698<ul>
699
700<li>
701<p>The expected result is:</p>
702
703<div class="source">
704<div class="source">
705<pre>{ &quot;v1&quot;: time(&quot;12:12:12.039Z&quot;), &quot;v2&quot;: time(&quot;08:00:00.000Z&quot;) }
706</pre></div></div></li>
707</ul></div>
708<div class="section">
709<h3><a name="Datetime_Timestamp"></a><a name="PrimitiveTypesDateTime" id="PrimitiveTypesDateTime">Datetime (Timestamp)</a></h3>
710<p>A <tt>datetime</tt> value is a combination of an <tt>date</tt> and <tt>time</tt>, representing a fixed time point along the Gregorian calendar system. The value is among <tt>-9999-01-01 00:00:00.000</tt> and <tt>9999-12-31 23:59:59.999</tt>.</p>
711<p>A <tt>datetime</tt> value is represented as a combination of the representation of its <tt>date</tt> part and <tt>time</tt> part, separated by a separator <tt>T</tt>. Either extended or basic format can be used, and the two parts should be the same format.</p>
712<p>Millisecond field and timezone field are optional, as specified in the <tt>time</tt> type.</p>
713
714<ul>
715
716<li>
717<p>Example:</p>
718
719<div class="source">
720<div class="source">
721<pre>{ &quot;v1&quot;: datetime(&quot;2013-01-01T12:12:12.039Z&quot;), &quot;v2&quot;: datetime(&quot;-19700101T000000000-0800&quot;) };
722</pre></div></div></li>
723</ul>
724
725<ul>
726
727<li>
728<p>The expected result is:</p>
729
730<div class="source">
731<div class="source">
732<pre>{ &quot;v1&quot;: datetime(&quot;2013-01-01T12:12:12.039Z&quot;), &quot;v2&quot;: datetime(&quot;-1970-01-01T08:00:00.000Z&quot;) }
733</pre></div></div></li>
734</ul>
735<p><tt>timestamp</tt> is an alias of <tt>datetime</tt>.</p></div>
736<div class="section">
737<h3><a name="DurationYear_month_durationDay_time_duration"></a><a name="PrimitiveTypesDuration" id="PrimitiveTypesDuration">Duration/Year_month_duration/Day_time_duration</a></h3>
738<p><tt>duration</tt> represents a duration of time. A duration value is specified by integers on at least one of the following fields: year, month, day, hour, minute, second, and millisecond.</p>
739<p>A duration value is in the format of <tt>[-]PnYnMnDTnHnMn.mmmS</tt>. The millisecond part (as the fraction of the second field) is optional, and when no millisecond field is used, the decimal point should also be absent.</p>
740<p>Negative durations are also supported for the arithmetic operations between time instance types (<tt>date</tt>, <tt>time</tt> and <tt>datetime</tt>), and is used to roll the time back for the given duration. For example <tt>date(&quot;2012-01-01&quot;) + duration(&quot;-P3D&quot;)</tt> will return <tt>date(&quot;2011-12-29&quot;)</tt>.</p>
741<p>There are also two sub-duration types, namely <tt>year_month_duration</tt> and <tt>day_time_duration</tt>. <tt>year_month_duration</tt> represents only the years and months of a duration, while <tt>day_time_duration</tt> represents only the day to millisecond fields. Different from the <tt>duration</tt> type, both these two subtypes are totally ordered, so they can be used for comparison and index construction.</p>
742<p>Note that a canonical representation of the duration is always returned, regardless whether the duration is in the canonical representation or not from the user&#x2019;s input. More information about canonical representation can be found from <a class="externalLink" href="http://www.w3.org/TR/xpath-functions/#canonical-dayTimeDuration">XPath dayTimeDuration Canonical Representation</a> and <a class="externalLink" href="http://www.w3.org/TR/xpath-functions/#canonical-yearMonthDuration">yearMonthDuration Canonical Representation</a>.</p>
743
744<ul>
745
746<li>
747<p>Example:</p>
748
749<div class="source">
750<div class="source">
751<pre>{ &quot;v1&quot;: duration(&quot;P100Y12MT12M&quot;), &quot;v2&quot;: duration(&quot;-PT20.943S&quot;) };
752</pre></div></div></li>
753</ul>
754
755<ul>
756
757<li>
758<p>The expected result is:</p>
759
760<div class="source">
761<div class="source">
762<pre>{ &quot;v1&quot;: duration(&quot;P101YT12M&quot;), &quot;v2&quot;: duration(&quot;-PT20.943S&quot;) }
763</pre></div></div></li>
764</ul></div>
765<div class="section">
766<h3><a name="Interval"></a><a name="PrimitiveTypesInterval" id="PrimitiveTypesInterval">Interval</a></h3>
767<p><tt>interval</tt> represents inclusive-exclusive ranges of time. It is defined by two time point values with the same temporal type(<tt>date</tt>, <tt>time</tt> or <tt>datetime</tt>).</p>
768
769<ul>
770
771<li>
772<p>Example:</p>
773
774<div class="source">
775<div class="source">
776<pre>{
777 &quot;v1&quot;: interval(date(&quot;2013-01-01&quot;), date(&quot;20130505&quot;)),
778 &quot;v2&quot;: interval(time(&quot;00:01:01&quot;), time(&quot;213901049+0800&quot;)),
779 &quot;v3&quot;: interval(datetime(&quot;2013-01-01T00:01:01&quot;), datetime(&quot;20130505T213901049+0800&quot;))
780};
781</pre></div></div></li>
782</ul>
783
784<ul>
785
786<li>
787<p>The expected result is:</p>
788
789<div class="source">
790<div class="source">
791<pre>{
792 &quot;v1&quot;: interval(date(&quot;2013-01-01&quot;), date(&quot;2013-05-05&quot;)),
793 &quot;v2&quot;: interval(time(&quot;00:01:01.000Z&quot;), time(&quot;13:39:01.049Z&quot;)),
794 &quot;v3&quot;: interval(datetime(&quot;2013-01-01T00:01:01.000Z&quot;), datetime(&quot;2013-05-05T13:39:01.049Z&quot;))
795}
796</pre></div></div></li>
797</ul></div>
798<div class="section">
799<h3><a name="UUID"></a><a name="PrimitiveTypesUUID" id="PrimitiveTypesUUID">UUID</a></h3>
800<p><tt>uuid</tt> represents a UUID value, which stands for Universally unique identifier. It is defined by a canonical format using hexadecimal text with inserted hyphen characters. (E.g.: 5a28ce1e-6a74-4201-9e8f-683256e5706f). This type is generally used to store auto-generated primary key values.</p>
801
802<ul>
803
804<li>
805<p>Example:</p>
806
807<div class="source">
808<div class="source">
809<pre>return { &quot;v1&quot;:uuid(&quot;5c848e5c-6b6a-498f-8452-8847a2957421&quot;) }
810</pre></div></div></li>
811</ul>
812
813<ul>
814
815<li>
816<p>The expected result is:</p>
817
818<div class="source">
819<div class="source">
820<pre>{ &quot;v1&quot;: uuid(&quot;5c848e5c-6b6a-498f-8452-8847a2957421&quot;) }
821</pre></div></div></li>
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]822</ul>
823<!-- ! Licensed to the Apache Software Foundation (ASF) under one
824 ! or more contributor license agreements. See the NOTICE file
825 ! distributed with this work for additional information
826 ! regarding copyright ownership. The ASF licenses this file
827 ! to you under the Apache License, Version 2.0 (the
828 ! "License"); you may not use this file except in compliance
829 ! with the License. You may obtain a copy of the License at
830 !
831 ! http://www.apache.org/licenses/LICENSE-2.0
832 !
833 ! Unless required by applicable law or agreed to in writing,
834 ! software distributed under the License is distributed on an
835 ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
836 ! KIND, either express or implied. See the License for the
837 ! specific language governing permissions and limitations
838 ! under the License.
839 ! --></div></div>
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]840<div class="section">
841<h2><a name="Incomplete_Information_Types"></a><a name="IncompleteInformationTypes" id="IncompleteInformationTypes">Incomplete Information Types</a></h2>
842<div class="section">
843<h3><a name="Null"></a><a name="IncompleteInformationTypesNull" id="IncompleteInformationTypesNull">Null</a></h3>
844<p><tt>null</tt> is a special value that is often used to represent an unknown value. For example, a user might not be able to know the value of a field and let it be <tt>null</tt>.</p>
845
846<ul>
847
848<li>
849<p>Example:</p>
850
851<div class="source">
852<div class="source">
853<pre>{ &quot;field&quot;: null };
854</pre></div></div></li>
855</ul>
856
857<ul>
858
859<li>
860<p>The expected result is:</p>
861
862<div class="source">
863<div class="source">
864<pre>{ &quot;field&quot;: null }
865</pre></div></div></li>
866</ul></div>
867<div class="section">
868<h3><a name="Missing"></a><a name="IncompleteInformationTypesMissing" id="IncompleteInformationTypesMissing">Missing</a></h3>
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]869<p><tt>missing</tt> indicates that a name-value pair is missing from an object. If a missing name-value pair is accessed, an empty result value is returned by the query.</p>
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]870<p>As neither the data model nor the system enforces homogeneity for datasets or collections, items in a dataset or collection can be of heterogeneous types and so a field can be present in one object and <tt>missing</tt> in another.</p>
871
872<ul>
873
874<li>
875<p>Example:</p>
876
877<div class="source">
878<div class="source">
879<pre>{ &quot;field&quot;: missing };
880</pre></div></div></li>
881</ul>
882
883<ul>
884
885<li>
886<p>The expected result is:</p>
887
888<div class="source">
889<div class="source">
890<pre>{ }
891</pre></div></div></li>
892</ul>
Ian Maxonf9dfc032017-09-14 21:37:24 +0200[diff] [blame]893<p>Since a field with value <tt>missing</tt> means the field is absent, we get an empty object.</p>
894<!-- ! Licensed to the Apache Software Foundation (ASF) under one
895 ! or more contributor license agreements. See the NOTICE file
896 ! distributed with this work for additional information
897 ! regarding copyright ownership. The ASF licenses this file
898 ! to you under the Apache License, Version 2.0 (the
899 ! "License"); you may not use this file except in compliance
900 ! with the License. You may obtain a copy of the License at
901 !
902 ! http://www.apache.org/licenses/LICENSE-2.0
903 !
904 ! Unless required by applicable law or agreed to in writing,
905 ! software distributed under the License is distributed on an
906 ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
907 ! KIND, either express or implied. See the License for the
908 ! specific language governing permissions and limitations
909 ! under the License.
910 ! --></div></div>
Ian Maxon444ca1b2017-08-25 11:41:41 -0700[diff] [blame]911<div class="section">
912<h2><a name="Derived_Types"></a><a name="DerivedTypes" id="DerivedTypes">Derived Types</a></h2>
913<div class="section">
914<h3><a name="Object"></a><a name="DerivedTypesObject" id="DerivedTypesObject">Object</a></h3>
915<p>An <tt>object</tt> contains a set of &#xfb01;elds, where each &#xfb01;eld is described by its name and type. An object type may be defined as either open or closed. Open objects (instances of open object types) are permitted to contain &#xfb01;elds that are not part of the type de&#xfb01;nition, while closed objects do not permit their instances to carry extra fields. An example type definition for an object is:</p>
916
917<div class="source">
918<div class="source">
919<pre> create type SoldierType as open {
920 name: string?,
921 rank: string,
922 serialno: int
923 };
924</pre></div></div>
925<p>Syntactically, object constructors are surrounded by curly braces &#x201c;{&#x2026;}&#x201d;. Some examples of legitimate instances of the above type include:</p>
926
927<div class="source">
928<div class="source">
929<pre> { &quot;name&quot;: &quot;Joe Blow&quot;, &quot;rank&quot;: &quot;Sergeant&quot;, &quot;serialno&quot;: 1234567 }
930 { &quot;rank&quot;: &quot;Private&quot;, &quot;serialno&quot;: 9876543 }
931 { &quot;name&quot;: &quot;Sally Forth&quot;, &quot;rank&quot;: &quot;Major&quot;, &quot;serialno&quot;: 2345678, &quot;gender&quot;: &quot;F&quot; }
932</pre></div></div>
933<p>The first instance has all of the type&#x2019;s prescribed content. The second instance is missing the name field, which is fine because it is optional (due to the ?). The third instance has an extra field; that is fine because the type definition specifies that it is open (which is also true by default, if open is not specified). To more tightly control object content, specifying closed instead of open in the type definition for SoldierType would have made the third example instance an invalid instance of the type.</p></div>
934<div class="section">
935<h3><a name="Array"></a><a name="DerivedTypesArray" id="DerivedTypesArray">Array</a></h3>
936<p>An <tt>array</tt> is a container that holds a fixed number of values. Array constructors are denoted by brackets: &#x201c;[&#x2026;]&#x201d;.</p>
937<p>An example would be</p>
938
939<div class="source">
940<div class="source">
941<pre> [&quot;alice&quot;, 123, &quot;bob&quot;, null]
942</pre></div></div></div>
943<div class="section">
944<h3><a name="Multiset"></a><a name="DerivedTypesMultiset" id="DerivedTypesMultiset">Multiset</a></h3>
945<p>A <tt>multiset</tt> is a generalization of the concept of a set that, unlike a set, allows multiple instances of the multiset&#x2019;s elements. Multiset constructors are denoted by two opening curly braces followed by data and two closing curly braces, like &#x201c;{{&#x2026;}}&#x201d;.</p>
946<p>An example would be</p>
947
948<div class="source">
949<div class="source">
950<pre> {{&quot;hello&quot;, 9328, &quot;world&quot;, [1, 2, null]}}
951</pre></div></div></div></div>
952 </div>
953 </div>
954 </div>
955
956 <hr/>
957
958 <footer>
959 <div class="container-fluid">
960 <div class="row span12">Copyright &copy; 2017
961 <a href="https://www.apache.org/">The Apache Software Foundation</a>.
962 All Rights Reserved.
963
964 </div>
965
966 <?xml version="1.0" encoding="UTF-8"?>
967<div class="row-fluid">Apache AsterixDB, AsterixDB, Apache, the Apache
968 feather logo, and the Apache AsterixDB project logo are either
969 registered trademarks or trademarks of The Apache Software
970 Foundation in the United States and other countries.
971 All other marks mentioned may be trademarks or registered
972 trademarks of their respective owners.</div>
973
974
975 </div>
976 </footer>
977 </body>
978</html>