Gitiles
Code Review Sign In
asterix-gerrit.ics.uci.edu / incubator-asterixdb-site / a7f7c6d17255879c60e531f0c137b5fade7a0cf2 / . / content / docs / 0.9.0 / datamodel.html
blob: cf3b2bf302d49731942207d9f93d2c821d7c7c23 [file] [log] [blame]
Ian Maxonbf2c56b2017-01-24 14:14:49 -0800[diff] [blame]1<!DOCTYPE html>
2<!--
Ian Maxond5b11d82017-01-25 10:48:05 -0800[diff] [blame]3 | Generated by Apache Maven Doxia at 2017-01-25
Ian Maxonbf2c56b2017-01-24 14:14:49 -0800[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 Maxond5b11d82017-01-25 10:48:05 -0800[diff] [blame]10 <meta name="Date-Revision-yyyymmdd" content="20170125" />
Ian Maxonbf2c56b2017-01-24 14:14:49 -0800[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
22<script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
23 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
24 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
25 })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
26
27 ga('create', 'UA-41536543-1', 'uci.edu');
28 ga('send', 'pageview');</script>
29
30 </head>
31 <body class="topBarDisabled">
32
33
34
35
36 <div class="container-fluid">
37 <div id="banner">
38 <div class="pull-left">
39 <a href="./" id="bannerLeft">
40 <img src="images/asterixlogo.png" alt="AsterixDB"/>
41 </a>
42 </div>
43 <div class="pull-right"> </div>
44 <div class="clear"><hr/></div>
45 </div>
46
47 <div id="breadcrumbs">
48 <ul class="breadcrumb">
49
50
Ian Maxond5b11d82017-01-25 10:48:05 -0800[diff] [blame]51 <li id="publishDate">Last Published: 2017-01-25</li>
Ian Maxonbf2c56b2017-01-24 14:14:49 -0800[diff] [blame]52
53
54
55 <li id="projectVersion" class="pull-right">Version: 0.9.0</li>
56
57 <li class="divider pull-right">|</li>
58
59 <li class="pull-right"> <a href="index.html" title="Documentation Home">
60 Documentation Home</a>
61 </li>
62
63 </ul>
64 </div>
65
66
67 <div class="row-fluid">
68 <div id="leftColumn" class="span3">
69 <div class="well sidebar-nav">
70
71
72 <ul class="nav nav-list">
73 <li class="nav-header">Get Started - Installation</li>
74
75 <li>
76
77 <a href="ncservice.html" title="Option 1: using NCService">
78 <i class="none"></i>
79 Option 1: using NCService</a>
80 </li>
81
82 <li>
83
84 <a href="install.html" title="Option 2: using Managix">
85 <i class="none"></i>
86 Option 2: using Managix</a>
87 </li>
88
89 <li>
90
91 <a href="yarn.html" title="Option 3: using YARN">
92 <i class="none"></i>
93 Option 3: using YARN</a>
94 </li>
95 <li class="nav-header">AsterixDB Primer</li>
96
97 <li>
98
99 <a href="sqlpp/primer-sqlpp.html" title="Option 1: using SQL++">
100 <i class="none"></i>
101 Option 1: using SQL++</a>
102 </li>
103
104 <li>
105
106 <a href="aql/primer.html" title="Option 2: using AQL">
107 <i class="none"></i>
108 Option 2: using AQL</a>
109 </li>
110 <li class="nav-header">Data Model</li>
111
112 <li class="active">
113
114 <a href="#"><i class="none"></i>The Asterix Data Model</a>
115 </li>
116 <li class="nav-header">Queries - SQL++</li>
117
118 <li>
119
120 <a href="sqlpp/manual.html" title="The SQL++ Query Language">
121 <i class="none"></i>
122 The SQL++ Query Language</a>
123 </li>
124
125 <li>
126
127 <a href="sqlpp/builtins.html" title="Builtin Functions">
128 <i class="none"></i>
129 Builtin Functions</a>
130 </li>
131 <li class="nav-header">Queries - AQL</li>
132
133 <li>
134
135 <a href="aql/manual.html" title="The Asterix Query Language (AQL)">
136 <i class="none"></i>
137 The Asterix Query Language (AQL)</a>
138 </li>
139
140 <li>
141
142 <a href="aql/builtins.html" title="Builtin Functions">
143 <i class="none"></i>
144 Builtin Functions</a>
145 </li>
146 <li class="nav-header">Advanced Features</li>
147
148 <li>
149
150 <a href="aql/similarity.html" title="Support of Similarity Queries">
151 <i class="none"></i>
152 Support of Similarity Queries</a>
153 </li>
154
155 <li>
156
157 <a href="aql/fulltext.html" title="Support of Full-text Queries">
158 <i class="none"></i>
159 Support of Full-text Queries</a>
160 </li>
161
162 <li>
163
164 <a href="aql/externaldata.html" title="Accessing External Data">
165 <i class="none"></i>
166 Accessing External Data</a>
167 </li>
168
169 <li>
170
171 <a href="feeds/tutorial.html" title="Support for Data Ingestion">
172 <i class="none"></i>
173 Support for Data Ingestion</a>
174 </li>
175
176 <li>
177
178 <a href="udf.html" title="User Defined Functions">
179 <i class="none"></i>
180 User Defined Functions</a>
181 </li>
182
183 <li>
184
185 <a href="aql/filters.html" title="Filter-Based LSM Index Acceleration">
186 <i class="none"></i>
187 Filter-Based LSM Index Acceleration</a>
188 </li>
189 <li class="nav-header">API/SDK</li>
190
191 <li>
192
193 <a href="api.html" title="HTTP API">
194 <i class="none"></i>
195 HTTP API</a>
196 </li>
197 </ul>
198
199
200
201 <hr class="divider" />
202
203 <div id="poweredBy">
204 <div class="clear"></div>
205 <div class="clear"></div>
206 <div class="clear"></div>
207 <a href="./" title="AsterixDB" class="builtBy">
208 <img class="builtBy" alt="AsterixDB" src="images/asterixlogo.png" />
209 </a>
210 </div>
211 </div>
212 </div>
213
214
215 <div id="bodyColumn" class="span9" >
216
217 <!-- ! Licensed to the Apache Software Foundation (ASF) under one
218 ! or more contributor license agreements. See the NOTICE file
219 ! distributed with this work for additional information
220 ! regarding copyright ownership. The ASF licenses this file
221 ! to you under the Apache License, Version 2.0 (the
222 ! "License"); you may not use this file except in compliance
223 ! with the License. You may obtain a copy of the License at
224 !
225 ! http://www.apache.org/licenses/LICENSE-2.0
226 !
227 ! Unless required by applicable law or agreed to in writing,
228 ! software distributed under the License is distributed on an
229 ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
230 ! KIND, either express or implied. See the License for the
231 ! specific language governing permissions and limitations
232 ! under the License.
233 ! --><h1>The Asterix Data Model (ADM)</h1>
234<div class="section">
235<h2><a name="Table_of_Contents"></a><a name="toc" id="toc">Table of Contents</a></h2>
236
237<ul>
238
239<li><a href="#PrimitiveTypes">Primitive Types</a>
240
241<ul>
242
243<li><a href="#PrimitiveTypesBoolean">Boolean</a></li>
244
245<li><a href="#PrimitiveTypesInt">Tinyint / Smallint / Integer (Int) / Bigint</a></li>
246
247<li><a href="#PrimitiveTypesFloat">Float</a></li>
248
249<li><a href="#PrimitiveTypesDouble">Double (Double Precision)</a></li>
250
251<li><a href="#PrimitiveTypesString">String</a></li>
252
253<li><a href="#PrimitiveTypesBinary">Binary</a></li>
254
255<li><a href="#PrimitiveTypesPoint">Point</a></li>
256
257<li><a href="#PrimitiveTypesLine">Line</a></li>
258
259<li><a href="#PrimitiveTypesRectangle">Rectangle</a></li>
260
261<li><a href="#PrimitiveTypesCircle">Circle</a></li>
262
263<li><a href="#PrimitiveTypesPolygon">Polygon</a></li>
264
265<li><a href="#PrimitiveTypesDate">Date</a></li>
266
267<li><a href="#PrimitiveTypesTime">Time</a></li>
268
269<li><a href="#PrimitiveTypesDateTime">Datetime (Timestamp)</a></li>
270
271<li><a href="#PrimitiveTypesDuration">Duration/Year_month_duration/Day_time_duration</a></li>
272
273<li><a href="#PrimitiveTypesInterval">Interval</a></li>
274
275<li><a href="#PrimitiveTypesUUID">UUID</a></li>
276 </ul></li>
277
278<li><a href="#IncompleteInformationTypesTypes">Incomplete Information Types</a>
279
280<ul>
281
282<li><a href="#IncompleteInformationTypesNull">Null</a></li>
283
284<li><a href="#IncompleteInformationTypesMissing">Missing</a></li>
285 </ul></li>
286
287<li><a href="#DerivedTypes">Derived Types</a>
288
289<ul>
290
291<li><a href="#DerivedTypesObject">Object</a></li>
292
293<li><a href="#DerivedTypesArray">Array</a></li>
294
295<li><a href="#DerivedTypesMultiset">Multiset</a></li>
296 </ul></li>
297</ul>
298<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>
299<p>The type names are case-insensitive, e.g., both <tt>BIGINT</tt> and <tt>bigint</tt> are acceptable.</p></div>
300<div class="section">
301<h2><a name="Primitive_Types"></a><a name="PrimitiveTypes" id="PrimitiveTypes">Primitive Types</a></h2>
302<div class="section">
303<h3><a name="Boolean"></a><a name="PrimitiveTypesBoolean" id="PrimitiveTypesBoolean">Boolean</a></h3>
304<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>
305
306<ul>
307
308<li>
309<p>Example:</p>
310
311<div class="source">
312<div class="source">
313<pre>{ &quot;true&quot;: true, &quot;false&quot;: false };
314</pre></div></div></li>
315</ul>
316
317<ul>
318
319<li>
320<p>The expected result is:</p>
321
322<div class="source">
323<div class="source">
324<pre>{ &quot;true&quot;: true, &quot;false&quot;: false }
325</pre></div></div></li>
326</ul></div>
327<div class="section">
328<h3><a name="Tinyint__Smallint__Integer_Int__Bigint"></a><a name="PrimitiveTypesInt" id="PrimitiveTypesInt">Tinyint / Smallint / Integer (Int) / Bigint</a></h3>
329<p>Integer types using 8, 16, 32, or 64 bits. The ranges of these types are:</p>
330
331<ul>
332
333<li><tt>tinyint</tt>: -127 to 127</li>
334
335<li><tt>smallint</tt>: -32767 to 32767</li>
336
337<li><tt>integer</tt>: -2147483647 to 2147483647</li>
338
339<li><tt>bigint</tt>: -9223372036854775808 to 9223372036854775807</li>
340</ul>
341<p><tt>int</tt> is an abbreviated alias for integer.</p>
342
343<ul>
344
345<li>
346<p>Example:</p>
347
348<div class="source">
349<div class="source">
350<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;)};
351</pre></div></div></li>
352</ul>
353
354<ul>
355
356<li>
357<p>The expected result is:</p>
358
359<div class="source">
360<div class="source">
361<pre>{ &quot;tinyint&quot;: 125, &quot;smallint&quot;: 32765, &quot;integer&quot;: 294967295, &quot;bigint&quot;: 17000000 }
362</pre></div></div></li>
363</ul></div>
364<div class="section">
365<h3><a name="Float"></a><a name="PrimitiveTypesFloat" id="PrimitiveTypesFloat">Float</a></h3>
366<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>
367
368<ul>
369
370<li>
371<p>Example:</p>
372
373<div class="source">
374<div class="source">
375<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;) };
376</pre></div></div></li>
377</ul>
378
379<ul>
380
381<li>
382<p>The expected result is:</p>
383
384<div class="source">
385<div class="source">
386<pre>{ &quot;v1&quot;: NaN, &quot;v2&quot;: Infinity, &quot;v3&quot;: -Infinity, &quot;v4&quot;: -2013.5 }
387</pre></div></div></li>
388</ul></div>
389<div class="section">
390<h3><a name="Double_double_precision"></a><a name="PrimitiveTypesDouble" id="PrimitiveTypesDouble">Double (double precision)</a></h3>
391<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>
392
393<ul>
394
395<li>
396<p>Example:</p>
397
398<div class="source">
399<div class="source">
400<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; };
401</pre></div></div></li>
402</ul>
403
404<ul>
405
406<li>
407<p>The expected result is:</p>
408
409<div class="source">
410<div class="source">
411<pre>{ &quot;v1&quot;: NaN, &quot;v2&quot;: Infinity, &quot;v3&quot;: -Infinity, &quot;v4&quot;: -2013.5938237483274 }
412</pre></div></div></li>
413</ul>
414<p><tt>Double precision</tt> is an alias of <tt>double</tt>.</p></div>
415<div class="section">
416<h3><a name="String"></a><a name="PrimitiveTypesString" id="PrimitiveTypesString">String</a></h3>
417<p><tt>string</tt> represents a sequence of characters. The total length of the sequence can be up to 2,147,483,648.</p>
418
419<ul>
420
421<li>
422<p>Example:</p>
423
424<div class="source">
425<div class="source">
426<pre>{ &quot;v1&quot;: string(&quot;This is a string.&quot;), &quot;v2&quot;: string(&quot;\&quot;This is a quoted string\&quot;&quot;) };
427</pre></div></div></li>
428</ul>
429
430<ul>
431
432<li>
433<p>The expected result is:</p>
434
435<div class="source">
436<div class="source">
437<pre>{ &quot;v1&quot;: &quot;This is a string.&quot;, &quot;v2&quot;: &quot;\&quot;This is a quoted string\&quot;&quot; }
438</pre></div></div></li>
439</ul></div>
440<div class="section">
441<h3><a name="Binary"></a><a name="PrimitiveTypesBinary" id="PrimitiveTypesBinary">Binary</a></h3>
442<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>
443
444<ul>
445
446<li>
447<p>Example:</p>
448
449<div class="source">
450<div class="source">
451<pre>{
452 &quot;hex1&quot; : hex(&quot;ABCDEF0123456789&quot;),
453 &quot;hex2&quot;: hex(&quot;abcdef0123456789&quot;),
454 &quot;base64_1&quot; : base64(&quot;0123456789qwertyui+/&quot;),
455 &quot;base64_2&quot; : base64('QXN0ZXJpeA==')
456};
457</pre></div></div></li>
458
459<li>
460<p>The default output format is in <tt>hex</tt> format. Thus, the expected result is:</p>
461
462<div class="source">
463<div class="source">
464<pre>{
465 &quot;hex1&quot;: hex(&quot;ABCDEF0123456789&quot;),
466 &quot;hex2&quot;: hex(&quot;ABCDEF0123456789&quot;),
467 &quot;base64_1&quot;: hex(&quot;D35DB7E39EBBF3DAB07ABB72BA2FBF&quot;),
468 &quot;base64_2&quot;: hex(&quot;41737465726978&quot;)
469}
470</pre></div></div></li>
471</ul></div>
472<div class="section">
473<h3><a name="Point"></a><a name="PrimitiveTypesPoint" id="PrimitiveTypesPoint">Point</a></h3>
474<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>
475
476<ul>
477
478<li>
479<p>Example:</p>
480
481<div class="source">
482<div class="source">
483<pre>{ &quot;v1&quot;: point(&quot;80.10d, -10E5&quot;), &quot;v2&quot;: point(&quot;5.10E-10d, -10E5&quot;) };
484</pre></div></div></li>
485</ul>
486
487<ul>
488
489<li>
490<p>The expected result is:</p>
491
492<div class="source">
493<div class="source">
494<pre>{ &quot;v1&quot;: point(&quot;80.1,-1000000.0&quot;), &quot;v2&quot;: point(&quot;5.1E-10,-1000000.0&quot;) }
495</pre></div></div></li>
496</ul></div>
497<div class="section">
498<h3><a name="Line"></a><a name="PrimitiveTypesLine" id="PrimitiveTypesLine">Line</a></h3>
499<p><tt>line</tt> consists of two points that represent the start and the end points of a line segment.</p>
500
501<ul>
502
503<li>
504<p>Example:</p>
505
506<div class="source">
507<div class="source">
508<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;) };
509</pre></div></div></li>
510</ul>
511
512<ul>
513
514<li>
515<p>The expected result is:</p>
516
517<div class="source">
518<div class="source">
519<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;) }
520</pre></div></div></li>
521</ul></div>
522<div class="section">
523<h3><a name="Rectangle"></a><a name="PrimitiveTypesRectangle" id="PrimitiveTypesRectangle">Rectangle</a></h3>
524<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>
525
526<ul>
527
528<li>
529<p>Example:</p>
530
531<div class="source">
532<div class="source">
533<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;) };
534</pre></div></div></li>
535</ul>
536
537<ul>
538
539<li>
540<p>The expected result is:</p>
541
542<div class="source">
543<div class="source">
544<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;) }
545</pre></div></div></li>
546</ul></div>
547<div class="section">
548<h3><a name="Circle"></a><a name="PrimitiveTypesCircle" id="PrimitiveTypesCircle">Circle</a></h3>
549<p><tt>circle</tt> consists of one point that represents the center of the circle and a radius of type <tt>double</tt>.</p>
550
551<ul>
552
553<li>
554<p>Example:</p>
555
556<div class="source">
557<div class="source">
558<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;) };
559</pre></div></div></li>
560</ul>
561
562<ul>
563
564<li>
565<p>The expected result is:</p>
566
567<div class="source">
568<div class="source">
569<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;) }
570</pre></div></div></li>
571</ul></div>
572<div class="section">
573<h3><a name="Polygon"></a><a name="PrimitiveTypesPolygon" id="PrimitiveTypesPolygon">Polygon</a></h3>
574<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>
575
576<ul>
577
578<li>
579<p>Example:</p>
580
581<div class="source">
582<div class="source">
583<pre>{
584 &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;),
585 &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;)
586};
587</pre></div></div></li>
588</ul>
589
590<ul>
591
592<li>
593<p>The expected result is:</p>
594
595<div class="source">
596<div class="source">
597<pre>{
598 &quot;v1&quot;: polygon(&quot;-1.2,130.0 -214000.0,2.15 -350.0,3.6 -0.0046,4.81&quot;),
599 &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;) }
600}
601</pre></div></div></li>
602</ul></div>
603<div class="section">
604<h3><a name="Date"></a><a name="PrimitiveTypesDate" id="PrimitiveTypesDate">Date</a></h3>
605<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>
606<p>A date value can be represented in two formats, extended format and basic format.</p>
607
608<ul>
609
610<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>
611
612<li>Basic format is in the format of <tt>[-]yyyymmdd</tt>.</li>
613
614<li>
615<p>Example:</p>
616
617<div class="source">
618<div class="source">
619<pre>{ &quot;v1&quot;: date(&quot;2013-01-01&quot;), &quot;v2&quot;: date(&quot;-19700101&quot;) };
620</pre></div></div></li>
621</ul>
622
623<ul>
624
625<li>
626<p>The expected result is:</p>
627
628<div class="source">
629<div class="source">
630<pre>{ &quot;v1&quot;: date(&quot;2013-01-01&quot;), &quot;v2&quot;: date(&quot;-1970-01-01&quot;) }
631</pre></div></div></li>
632</ul></div>
633<div class="section">
634<h3><a name="Time"></a><a name="PrimitiveTypesTime" id="PrimitiveTypesTime">Time</a></h3>
635<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>
636<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>
637
638<ul>
639
640<li>
641<p>Example:</p>
642
643<div class="source">
644<div class="source">
645<pre>{ &quot;v1&quot;: time(&quot;12:12:12.039Z&quot;), &quot;v2&quot;: time(&quot;000000000-0800&quot;) };
646</pre></div></div></li>
647</ul>
648
649<ul>
650
651<li>
652<p>The expected result is:</p>
653
654<div class="source">
655<div class="source">
656<pre>{ &quot;v1&quot;: time(&quot;12:12:12.039Z&quot;), &quot;v2&quot;: time(&quot;08:00:00.000Z&quot;) }
657</pre></div></div></li>
658</ul></div>
659<div class="section">
660<h3><a name="Datetime_Timestamp"></a><a name="PrimitiveTypesDateTime" id="PrimitiveTypesDateTime">Datetime (Timestamp)</a></h3>
661<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>
662<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>
663<p>Millisecond field and timezone field are optional, as specified in the <tt>time</tt> type.</p>
664
665<ul>
666
667<li>
668<p>Example:</p>
669
670<div class="source">
671<div class="source">
672<pre>{ &quot;v1&quot;: datetime(&quot;2013-01-01T12:12:12.039Z&quot;), &quot;v2&quot;: datetime(&quot;-19700101T000000000-0800&quot;) };
673</pre></div></div></li>
674</ul>
675
676<ul>
677
678<li>
679<p>The expected result is:</p>
680
681<div class="source">
682<div class="source">
683<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;) }
684</pre></div></div></li>
685</ul>
686<p><tt>timestamp</tt> is an alias of <tt>datetime</tt>.</p></div>
687<div class="section">
688<h3><a name="DurationYear_month_durationDay_time_duration"></a><a name="PrimitiveTypesDuration" id="PrimitiveTypesDuration">Duration/Year_month_duration/Day_time_duration</a></h3>
689<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>
690<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>
691<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>
692<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>
693<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>
694
695<ul>
696
697<li>
698<p>Example:</p>
699
700<div class="source">
701<div class="source">
702<pre>{ &quot;v1&quot;: duration(&quot;P100Y12MT12M&quot;), &quot;v2&quot;: duration(&quot;-PT20.943S&quot;) };
703</pre></div></div></li>
704</ul>
705
706<ul>
707
708<li>
709<p>The expected result is:</p>
710
711<div class="source">
712<div class="source">
713<pre>{ &quot;v1&quot;: duration(&quot;P101YT12M&quot;), &quot;v2&quot;: duration(&quot;-PT20.943S&quot;) }
714</pre></div></div></li>
715</ul></div>
716<div class="section">
717<h3><a name="Interval"></a><a name="PrimitiveTypesInterval" id="PrimitiveTypesInterval">Interval</a></h3>
718<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>
719
720<ul>
721
722<li>
723<p>Example:</p>
724
725<div class="source">
726<div class="source">
727<pre>{
728 &quot;v1&quot;: interval(date(&quot;2013-01-01&quot;), date(&quot;20130505&quot;)),
729 &quot;v2&quot;: interval(time(&quot;00:01:01&quot;), time(&quot;213901049+0800&quot;)),
730 &quot;v3&quot;: interval(datetime(&quot;2013-01-01T00:01:01&quot;), datetime(&quot;20130505T213901049+0800&quot;))
731};
732</pre></div></div></li>
733</ul>
734
735<ul>
736
737<li>
738<p>The expected result is:</p>
739
740<div class="source">
741<div class="source">
742<pre>{
743 &quot;v1&quot;: interval(date(&quot;2013-01-01&quot;), date(&quot;2013-05-05&quot;)),
744 &quot;v2&quot;: interval(time(&quot;00:01:01.000Z&quot;), time(&quot;13:39:01.049Z&quot;)),
745 &quot;v3&quot;: interval(datetime(&quot;2013-01-01T00:01:01.000Z&quot;), datetime(&quot;2013-05-05T13:39:01.049Z&quot;))
746}
747</pre></div></div></li>
748</ul></div>
749<div class="section">
750<h3><a name="UUID"></a><a name="PrimitiveTypesUUID" id="PrimitiveTypesUUID">UUID</a></h3>
751<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>
752
753<ul>
754
755<li>
756<p>Example:</p>
757
758<div class="source">
759<div class="source">
760<pre>return { &quot;v1&quot;:uuid(&quot;5c848e5c-6b6a-498f-8452-8847a2957421&quot;) }
761</pre></div></div></li>
762</ul>
763
764<ul>
765
766<li>
767<p>The expected result is:</p>
768
769<div class="source">
770<div class="source">
771<pre>{ &quot;v1&quot;: uuid(&quot;5c848e5c-6b6a-498f-8452-8847a2957421&quot;) }
772</pre></div></div></li>
773</ul></div></div>
774<div class="section">
775<h2><a name="Incomplete_Information_Types"></a><a name="IncompleteInformationTypes" id="IncompleteInformationTypes">Incomplete Information Types</a></h2>
776<div class="section">
777<h3><a name="Null"></a><a name="IncompleteInformationTypesNull" id="IncompleteInformationTypesNull">Null</a></h3>
778<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>
779
780<ul>
781
782<li>
783<p>Example:</p>
784
785<div class="source">
786<div class="source">
787<pre>{ &quot;field&quot;: null };
788</pre></div></div></li>
789</ul>
790
791<ul>
792
793<li>
794<p>The expected result is:</p>
795
796<div class="source">
797<div class="source">
798<pre>{ &quot;field&quot;: null }
799</pre></div></div></li>
800</ul></div>
801<div class="section">
802<h3><a name="Missing"></a><a name="IncompleteInformationTypesMissing" id="IncompleteInformationTypesMissing">Missing</a></h3>
803<p><tt>missing</tt> represents a missing name-value pair in a object. If the referenced field does not exist, an empty result value is returned by the query.</p>
804<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>
805
806<ul>
807
808<li>
809<p>Example:</p>
810
811<div class="source">
812<div class="source">
813<pre>{ &quot;field&quot;: missing };
814</pre></div></div></li>
815</ul>
816
817<ul>
818
819<li>
820<p>The expected result is:</p>
821
822<div class="source">
823<div class="source">
824<pre>{ }
825</pre></div></div></li>
826</ul>
827<p>Since a field with value <tt>missing</tt> means the field is absent, we get an empty object.</p></div></div>
828<div class="section">
829<h2><a name="Derived_Types"></a><a name="DerivedTypes" id="DerivedTypes">Derived Types</a></h2>
830<div class="section">
831<h3><a name="Object"></a><a name="DerivedTypesObject" id="DerivedTypesObject">Object</a></h3>
832<p>A <tt>object</tt> contains a set of &#xfb01;elds, where each &#xfb01;eld is described by its name and type. A object type is either open or closed. Open objects can contain &#xfb01;elds that are not part of the type de&#xfb01;nition, while closed objects cannot. Syntactically, object constructors are surrounded by curly braces &#x201c;{&#x2026;}&#x201d;.</p>
833<p>An example would be</p>
834
835<div class="source">
836<div class="source">
837<pre> { &quot;id&quot;: 213508, &quot;name&quot;: &quot;Alice Bob&quot; }
838</pre></div></div></div>
839<div class="section">
840<h3><a name="Array"></a><a name="DerivedTypesArray" id="DerivedTypesArray">Array</a></h3>
841<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>
842<p>An example would be</p>
843
844<div class="source">
845<div class="source">
846<pre> [&quot;alice&quot;, 123, &quot;bob&quot;, null]
847</pre></div></div></div>
848<div class="section">
849<h3><a name="Multiset"></a><a name="DerivedTypesMultiset" id="DerivedTypesMultiset">Multiset</a></h3>
850<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>
851<p>An example would be</p>
852
853<div class="source">
854<div class="source">
855<pre> {{&quot;hello&quot;, 9328, &quot;world&quot;, [1, 2, null]}}
856</pre></div></div></div></div>
857 </div>
858 </div>
859 </div>
860
861 <hr/>
862
863 <footer>
864 <div class="container-fluid">
865 <div class="row span12">Copyright &copy; 2017
866 <a href="https://www.apache.org/">The Apache Software Foundation</a>.
867 All Rights Reserved.
868
869 </div>
870
871 <?xml version="1.0" encoding="UTF-8"?>
872<div class="row-fluid">Apache AsterixDB, AsterixDB, Apache, the Apache
873 feather logo, and the Apache AsterixDB project logo are either
874 registered trademarks or trademarks of The Apache Software
875 Foundation in the United States and other countries.
876 All other marks mentioned may be trademarks or registered
877 trademarks of their respective owners.</div>
878
879
880 </div>
881 </footer>
882 </body>
883</html>