asterixdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From buyin...@apache.org
Subject asterixdb git commit: Add documentation for IN [...] and add links.
Date Wed, 05 Oct 2016 17:15:14 GMT
Repository: asterixdb
Updated Branches:
  refs/heads/master d97fa75fe -> e3ad31540


Add documentation for IN [...] and add links.

Change-Id: Ifdab278567e8e89d5c8f7a1916fdd8f9131808f3
Reviewed-on: https://asterix-gerrit.ics.uci.edu/1254
Sonar-Qube: Jenkins <jenkins@fulliautomatix.ics.uci.edu>
Tested-by: Jenkins <jenkins@fulliautomatix.ics.uci.edu>
Integration-Tests: Jenkins <jenkins@fulliautomatix.ics.uci.edu>
Reviewed-by: Till Westmann <tillw@apache.org>


Project: http://git-wip-us.apache.org/repos/asf/asterixdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/asterixdb/commit/e3ad3154
Tree: http://git-wip-us.apache.org/repos/asf/asterixdb/tree/e3ad3154
Diff: http://git-wip-us.apache.org/repos/asf/asterixdb/diff/e3ad3154

Branch: refs/heads/master
Commit: e3ad31540499add0e5949971d1bceee1f9cc352d
Parents: d97fa75
Author: Yingyi Bu <yingyi@couchbase.com>
Authored: Tue Oct 4 23:33:23 2016 -0700
Committer: Yingyi Bu <buyingyi@gmail.com>
Committed: Wed Oct 5 10:14:43 2016 -0700

----------------------------------------------------------------------
 .../src/main/markdown/sqlpp/1_intro.md          |   8 +-
 .../src/main/markdown/sqlpp/3_query.md          |   7 +-
 .../src/site/markdown/aql/datamodel.md          | 398 -------------------
 .../asterix-doc/src/site/markdown/datamodel.md  | 398 +++++++++++++++++++
 asterixdb/asterix-doc/src/site/site.xml         |   3 +-
 5 files changed, 407 insertions(+), 407 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/asterixdb/blob/e3ad3154/asterixdb/asterix-doc/src/main/markdown/sqlpp/1_intro.md
----------------------------------------------------------------------
diff --git a/asterixdb/asterix-doc/src/main/markdown/sqlpp/1_intro.md b/asterixdb/asterix-doc/src/main/markdown/sqlpp/1_intro.md
index fdc04cb..f7df33f 100644
--- a/asterixdb/asterix-doc/src/main/markdown/sqlpp/1_intro.md
+++ b/asterixdb/asterix-doc/src/main/markdown/sqlpp/1_intro.md
@@ -27,11 +27,11 @@ SQL was designed in the 1970's for interacting with the flat, schema-ified
world
 relational databases, while SQL++ is much newer and targets the nested, schema-optional
 (or even schema-less) world of modern NoSQL systems.
 
-In the context of Apache AsterixDB, SQL++ is intended for working with the Asterix Data Model
(ADM),
-a data model based on a superset of JSON with an enriched and flexible type system.
+In the context of Apache AsterixDB, SQL++ is intended for working with the Asterix Data Model
+([ADM](../datamodel.html)),a data model based on a superset of JSON with an enriched and
flexible type system.
 New AsterixDB users are encouraged to read and work through the (much friendlier) guide
-"AsterixDB 101: An ADM and SQL++ Primer" before attempting to make use of this document.
-In addition, readers are advised to read through the Asterix Data Model (ADM) reference guide
+"[AsterixDB 101: An ADM and SQL++ Primer](primer-sqlpp.html)" before attempting to make use
of this document.
+In addition, readers are advised to read through the [Asterix Data Model (ADM) reference
guide](../datamodel.html)
 first as well, as an understanding of the data model is a prerequisite to understanding SQL++.
 
 In what follows, we detail the features of the SQL++ language in a grammar-guided manner.

http://git-wip-us.apache.org/repos/asf/asterixdb/blob/e3ad3154/asterixdb/asterix-doc/src/main/markdown/sqlpp/3_query.md
----------------------------------------------------------------------
diff --git a/asterixdb/asterix-doc/src/main/markdown/sqlpp/3_query.md b/asterixdb/asterix-doc/src/main/markdown/sqlpp/3_query.md
index bfe4f0e..68573e2 100644
--- a/asterixdb/asterix-doc/src/main/markdown/sqlpp/3_query.md
+++ b/asterixdb/asterix-doc/src/main/markdown/sqlpp/3_query.md
@@ -874,14 +874,15 @@ Note that a subquery, like a top-level `SELECT` statment, always returns
a colle
 within a query the subquery occurs -- and again, its result is never automatically cast into
a scalar.
 
 ## <a id="Vs_SQL-92">SQL++ vs. SQL-92</a>
-The following matrix is a quick "key differences cheat sheet" for SQL++ and SQL-92.
+The following matrix is a quick "SQL-92 compatibility cheat sheet" for SQL++.
 
 | Feature |  SQL++ | SQL-92 |
 |----------|--------|--------|
 | SELECT * | Returns nested records | Returns flattened concatenated records |
 | Subquery | Returns a collection  | The returned collection is cast into a scalar value
if the subquery appears in a SELECT list or on one side of a comparison or as input to a function
|
-| LEFT OUTER JOIN |  Fills in `MISSING` for non-matches  |   Fills in `NULL`(s) for non-matches
   |
-| UNION ALL       | Allows heterogenous inputs and output | Input streams must be UNION-compatible
and output field names are drawn from the first input stream
+| LEFT OUTER JOIN |  Fills in `MISSING`(s) for non-matches  |   Fills in `NULL`(s) for non-matches
   |
+| UNION ALL       | Allows heterogeneous inputs and output | Input streams must be UNION-compatible
and output field names are drawn from the first input stream
+| IN constant_expr | The constant expression has to be an array or multiset, i.e., [..,..,...]
| The constant collection can be represented as comma-separated items in a paren pair |
 | String literal | Double quotes or single quotes | Single quotes only |
 | Delimited identifiers | Backticks | Double quotes |
 

http://git-wip-us.apache.org/repos/asf/asterixdb/blob/e3ad3154/asterixdb/asterix-doc/src/site/markdown/aql/datamodel.md
----------------------------------------------------------------------
diff --git a/asterixdb/asterix-doc/src/site/markdown/aql/datamodel.md b/asterixdb/asterix-doc/src/site/markdown/aql/datamodel.md
deleted file mode 100644
index 5a5aced..0000000
--- a/asterixdb/asterix-doc/src/site/markdown/aql/datamodel.md
+++ /dev/null
@@ -1,398 +0,0 @@
-<!--
- ! Licensed to the Apache Software Foundation (ASF) under one
- ! or more contributor license agreements.  See the NOTICE file
- ! distributed with this work for additional information
- ! regarding copyright ownership.  The ASF licenses this file
- ! to you under the Apache License, Version 2.0 (the
- ! "License"); you may not use this file except in compliance
- ! with the License.  You may obtain a copy of the License at
- !
- !   http://www.apache.org/licenses/LICENSE-2.0
- !
- ! Unless required by applicable law or agreed to in writing,
- ! software distributed under the License is distributed on an
- ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ! KIND, either express or implied.  See the License for the
- ! specific language governing permissions and limitations
- ! under the License.
- !-->
-
-# The Asterix Data Model (ADM) #
-
-## <a id="toc">Table of Contents</a> ##
-
-* [Primitive Types](#PrimitiveTypes)
-    * [Boolean](#PrimitiveTypesBoolean)
-    * [Tinyint / Smallint / Integer (Int) / Bigint](#PrimitiveTypesInt)
-    * [Float](#PrimitiveTypesFloat)
-    * [Double (Double Precision)](#PrimitiveTypesDouble)
-    * [String](#PrimitiveTypesString)
-    * [Binary](#PrimitiveTypesBinary)
-    * [Point](#PrimitiveTypesPoint)
-    * [Line](#PrimitiveTypesLine)
-    * [Rectangle](#PrimitiveTypesRectangle)
-    * [Circle](#PrimitiveTypesCircle)
-    * [Polygon](#PrimitiveTypesPolygon)
-    * [Date](#PrimitiveTypesDate)
-    * [Time](#PrimitiveTypesTime)
-    * [Datetime (Timestamp)](#PrimitiveTypesDateTime)
-    * [Duration/Year_month_duration/Day_time_duration](#PrimitiveTypesDuration)
-    * [Interval](#PrimitiveTypesInterval)
-    * [UUID](#PrimitiveTypesUUID)
-* [Incomplete Information Types] (#IncompleteInformationTypesTypes)
-    * [Null](#IncompleteInformationTypesNull)
-    * [Missing](#IncompleteInformationTypesMissing)
-* [Derived Types](#DerivedTypes)
-    * [Record](#DerivedTypesRecord)
-    * [Array](#DerivedTypesArray)
-    * [Multiset](#DerivedTypesMultiset)
-
-An instance of Asterix data model (ADM) can be a _*primitive type*_ (`boolean`,
-`tinyint`, `smallint`, `integer`, `bigint`, `string`, `float`, `double`, `date`,
-`time`, `datetime`, etc.), a _*special type*_ (`null` or `missing`), or a _*derived type*_.
-
-The type names are case-insensitive, e.g., both `BIGINT` and `bigint` are acceptable.
-
-## <a id="PrimitiveTypes">Primitive Types</a>##
-
-### <a id="PrimitiveTypesBoolean">Boolean</a> ###
-`boolean` data type can have one of the two values: _*true*_ or _*false*_.
-
- * Example:
-
-        { "true": true, "false": false };
-
-
- * The expected result is:
-
-        { "true": true, "false": false }
-
-
-
-### <a id="PrimitiveTypesInt">Tinyint / Smallint / Integer (Int) / Bigint</a>
###
-Integer types using 8, 16, 32, or 64 bits. The ranges of these types are:
-
-- `tinyint`: -127 to 127
-- `smallint`: -32767 to 32767
-- `integer`: -2147483647 to 2147483647
-- `bigint`: -9223372036854775808 to 9223372036854775807
-
-`int` is an abbreviated alias for integer.
-
- * Example:
-
-        { "tinyint": tiny("125"), "smallint": smallint("32765"), "integer": 294967295, "bigint":
bigint("1700000000000000000")};
-
-
- * The expected result is:
-
-        { "tinyint": 125, "smallint": 32765, "integer": 294967295, "bigint": 17000000 }
-
-
-### <a id="PrimitiveTypesFloat">Float</a> ###
-`float` represents approximate numeric data values using 4 bytes. The range of a float value
can be
-from 2^(-149) to (2-2^(-23)·2^(127) for both positive and negative. Beyond these ranges
will get `INF` or `-INF`.
-
- * Example:
-
-        { "v1": float("NaN"), "v2": float("INF"), "v3": float("-INF"), "v4": float("-2013.5")
};
-
-
- * The expected result is:
-
-        { "v1": NaN, "v2": Infinity, "v3": -Infinity, "v4": -2013.5 }
-
-
-### <a id="PrimitiveTypesDouble">Double (double precision)</a> ###
-`double` represents approximate numeric data values using 8 bytes. The range of a double
value can be from (2^(-1022)) to (2-2^(-52))·2^(1023)
-for both positive and negative. Beyond these ranges will get `INF` or `-INF`.
-
- * Example:
-
-        { "v1": double("NaN"), "v2": double("INF"), "v3": double("-INF"), "v4": "-2013.593823748327284"
};
-
-
- * The expected result is:
-
-        { "v1": NaN, "v2": Infinity, "v3": -Infinity, "v4": -2013.5938237483274 }
-
-`Double precision` is an alias of `double`.
-
-### <a id="PrimitiveTypesString">String</a> ###
-`string` represents a sequence of characters. The total length of the sequence can be up
to 2,147,483,648.
-
- * Example:
-
-        { "v1": string("This is a string."), "v2": string("\"This is a quoted string\"")
};
-
-
- * The expected result is:
-
-        { "v1": "This is a string.", "v2": "\"This is a quoted string\"" }
-
-
-### <a id="PrimitiveTypesBinary">Binary</a> ###
-`binary` represents a sequence of bytes. It can be constructed from a `hex` or a `base64`
string sequence.
-The total length of the byte sequence can be up to 2,147,483,648.
-
- * Example:
-
-        {
-          "hex1" : hex("ABCDEF0123456789"),
-          "hex2": hex("abcdef0123456789"),
-          "base64_1" : base64("0123456789qwertyui+/"),
-          "base64_2" : base64('QXN0ZXJpeA==')
-        };
-
- * The default output format is in `hex` format. Thus, the expected result is:
-
-        {
-          "hex1": hex("ABCDEF0123456789"),
-          "hex2": hex("ABCDEF0123456789"),
-          "base64_1": hex("D35DB7E39EBBF3DAB07ABB72BA2FBF"),
-          "base64_2": hex("41737465726978")
-        }
-
-
-### <a id="PrimitiveTypesPoint">Point</a> ###
-`point` is the fundamental two-dimensional building block for spatial types. It consists
of two `double` coordinates x and y.
-
- * Example:
-
-        { "v1": point("80.10d, -10E5"), "v2": point("5.10E-10d, -10E5") };
-
-
- * The expected result is:
-
-        { "v1": point("80.1,-1000000.0"), "v2": point("5.1E-10,-1000000.0") }
-
-
-### <a id="PrimitiveTypesLine">Line</a> ###
-`line` consists of two points that represent the start and the end points of a line segment.
-
- * Example:
-
-        { "v1": line("10.1234,11.1e-1 +10.2E-2,-11.22"), "v2": line("0.1234,-1.00e-10 +10.5E-2,-01.02")
};
-
-
- * The expected result is:
-
-        { "v1": line("10.1234,1.11 0.102,-11.22"), "v2": line("0.1234,-1.0E-10 0.105,-1.02")
}
-
-
-### <a id="PrimitiveTypesRectangle">Rectangle</a>###
-`rectangle` consists of two points that represent the _*bottom left*_ and _*upper right*_
corners of a rectangle.
-
- * Example:
-
-        { "v1": rectangle("5.1,11.8 87.6,15.6548"), "v2": rectangle("0.1234,-1.00e-10 5.5487,0.48765")
};
-
-
- * The expected result is:
-
-        { "v1": rectangle("5.1,11.8 87.6,15.6548"), "v2": rectangle("0.1234,-1.0E-10 5.5487,0.48765")
}
-
-
-### <a id="PrimitiveTypesCircle">Circle</a> ###
-`circle` consists of one point that represents the center of the circle and a radius of type
`double`.
-
- * Example:
-
-        { "v1": circle("10.1234,11.1e-1 +10.2E-2"), "v2": circle("0.1234,-1.00e-10 +10.5E-2")
};
-
-
- * The expected result is:
-
-        { "v1": circle("10.1234,1.11 0.102"), "v2": circle("0.1234,-1.0E-10 0.105") }
-
-
-### <a id="PrimitiveTypesPolygon">Polygon</a> ###
-`polygon` consists of _*n*_ points that represent the vertices of a _*simple closed*_ polygon.
-
- * Example:
-
-        {
-          "v1": polygon("-1.2,+1.3e2 -2.14E+5,2.15 -3.5e+2,03.6 -4.6E-3,+4.81"),
-          "v2": polygon("-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")
-        };
-
-
- * The expected result is:
-
-        {
-          "v1": polygon("-1.2,130.0 -214000.0,2.15 -350.0,3.6 -0.0046,4.81"),
-          "v2": polygon("-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") }
-        }
-
-
-### <a id="PrimitiveTypesDate">Date</a> ###
-`date` represents a time point along the Gregorian calendar system specified by the year,
month and day. ASTERIX supports the date from `-9999-01-01` to `9999-12-31`.
-
-A date value can be represented in two formats, extended format and basic format.
-
- * Extended format is represented as `[-]yyyy-mm-dd` for `year-month-day`. Each field should
be padded if there are less digits than the format specified.
- * Basic format is in the format of `[-]yyyymmdd`.
-
- * Example:
-
-        { "v1": date("2013-01-01"), "v2": date("-19700101") };
-
-
- * The expected result is:
-
-        { "v1": date("2013-01-01"), "v2": date("-1970-01-01") }
-
-
-### <a id="PrimitiveTypesTime">Time</a> ###
-`time` 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 `hh:mm:ss[.mmm]` and the basic format is `hhmmss[mmm]`. The value
domain is from `00:00:00.000` to `23:59:59.999`.
-
-Timezone field is optional for a time value. Timezone is represented as `[+|-]hh:mm` for
extended format or `[+|-]hhmm` for basic format. Note that the sign designators cannot be
omitted. `Z` can also be used to represent the UTC local time. If no timezone information
is given, it is UTC by default.
-
- * Example:
-
-        { "v1": time("12:12:12.039Z"), "v2": time("000000000-0800") };
-
-
- * The expected result is:
-
-        { "v1": time("12:12:12.039Z"), "v2": time("08:00:00.000Z") }
-
-
-### <a id="PrimitiveTypesDateTime">Datetime (Timestamp)</a> ###
-A `datetime` value is a combination of an `date` and `time`, representing a fixed time point
along the Gregorian calendar system. The value is among `-9999-01-01 00:00:00.000` and `9999-12-31
23:59:59.999`.
-
-A `datetime` value is represented as a combination of the representation of its `date` part
and `time` part, separated by a separator `T`. Either extended or basic format can be used,
and the two parts should be the same format.
-
-Millisecond field and timezone field are optional, as specified in the `time` type.
-
- * Example:
-
-        { "v1": datetime("2013-01-01T12:12:12.039Z"), "v2": datetime("-19700101T000000000-0800")
};
-
-
- * The expected result is:
-
-        { "v1": datetime("2013-01-01T12:12:12.039Z"), "v2": datetime("-1970-01-01T08:00:00.000Z")
}
-
-`timestamp` is an alias of `datetime`.
-
-### <a id="PrimitiveTypesDuration">Duration/Year_month_duration/Day_time_duration</a>
###
-`duration` 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.
-
-A duration value is in the format of `[-]PnYnMnDTnHnMn.mmmS`. 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.
-
-Negative durations are also supported for the arithmetic operations between time instance
types (`date`, `time` and `datetime`), and is used to roll the time back for the given duration.
For example `date("2012-01-01") + duration("-P3D")` will return `date("2011-12-29")`.
-
-There are also two sub-duration types, namely `year_month_duration` and `day_time_duration`.
-`year_month_duration` represents only the years and months of a duration,
-while `day_time_duration` represents only the day to millisecond fields.
-Different from the `duration` type, both these two subtypes are totally ordered, so they
can be used for comparison and
-index construction.
-
-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's input. More information
about canonical representation can be found from [XPath dayTimeDuration Canonical Representation](http://www.w3.org/TR/xpath-functions/#canonical-dayTimeDuration)
and [yearMonthDuration Canonical Representation](http://www.w3.org/TR/xpath-functions/#canonical-yearMonthDuration).
-
- * Example:
-
-        { "v1": duration("P100Y12MT12M"), "v2": duration("-PT20.943S") };
-
-
- * The expected result is:
-
-        { "v1": duration("P101YT12M"), "v2": duration("-PT20.943S") }
-
-
-### <a id="PrimitiveTypesInterval">Interval</a> ###
-`interval` represents inclusive-exclusive ranges of time. It is defined by two time point
values with the same temporal type(`date`, `time` or `datetime`).
-
- * Example:
-
-        {
-          "v1": interval(date("2013-01-01"), date("20130505")),
-          "v2": interval(time("00:01:01"), time("213901049+0800")),
-          "v3": interval(datetime("2013-01-01T00:01:01"), datetime("20130505T213901049+0800"))
-        };
-
-
- * The expected result is:
-
-        {
-          "v1": interval(date("2013-01-01"), date("2013-05-05")),
-          "v2": interval(time("00:01:01.000Z"), time("13:39:01.049Z")),
-          "v3": interval(datetime("2013-01-01T00:01:01.000Z"), datetime("2013-05-05T13:39:01.049Z"))
-        }
-
-### <a id="PrimitiveTypesUUID">UUID</a> ###
-`uuid` 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.
-
- * Example:
-
-        return { "v1":uuid("5c848e5c-6b6a-498f-8452-8847a2957421") }
-
-
- * The expected result is:
-
-        { "v1": uuid("5c848e5c-6b6a-498f-8452-8847a2957421") }
-
-## <a id="IncompleteInformationTypes">Incomplete Information Types</a>##
-
-### <a id="IncompleteInformationTypesNull">Null</a> ###
-`null` 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 `null`.
-
- * Example:
-
-        { "field": null };
-
-
- * The expected result is:
-
-        { "field": null }
-
-
-### <a id="IncompleteInformationTypesMissing">Missing</a> ###
-`missing` represents a missing name-value pair in a record.
-If the referenced field does not exist, an empty result value is returned by the query.
-
-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 record and `missing` in another.
-
- * Example:
-
-        { "field": missing };
-
-
- * The expected result is:
-
-        {  }
-
-Since a field with value `missing` means the field is absent, we get an empty record.
-
-## <a id="DerivedTypes">Derived Types</a> ##
-
-### <a id="DerivedTypesRecord">Record</a>###
-A `record` contains a set of fields, where each field is described by its name and type.
A record type is either open or closed. Open records can contain fields that are not part
of the type definition, while closed records cannot. Syntactically, record constructors are
surrounded by curly braces "{...}".
-
-An example would be
-
-
-        { "id": 213508, "name": "Alice Bob" }
-
-
-### <a id="DerivedTypesArray">Array</a>###
-An `array` is a container that holds a fixed number of values. Array constructors are denoted
by brackets: "[...]".
-
-An example would be
-
-
-        ["alice", 123, "bob", null]
-
-
-### <a id="DerivedTypesMultiset">Multiset</a>###
-A `multiset` is a generalization of the concept of a set that, unlike a set, allows multiple
instances of the multiset's elements.
- Multiset constructors are denoted by two opening curly braces followed by data and two closing
curly braces, like "{{...}}".
-
-An example would be
-
-
-        {{"hello", 9328, "world", [1, 2, null]}}

http://git-wip-us.apache.org/repos/asf/asterixdb/blob/e3ad3154/asterixdb/asterix-doc/src/site/markdown/datamodel.md
----------------------------------------------------------------------
diff --git a/asterixdb/asterix-doc/src/site/markdown/datamodel.md b/asterixdb/asterix-doc/src/site/markdown/datamodel.md
new file mode 100644
index 0000000..5a5aced
--- /dev/null
+++ b/asterixdb/asterix-doc/src/site/markdown/datamodel.md
@@ -0,0 +1,398 @@
+<!--
+ ! Licensed to the Apache Software Foundation (ASF) under one
+ ! or more contributor license agreements.  See the NOTICE file
+ ! distributed with this work for additional information
+ ! regarding copyright ownership.  The ASF licenses this file
+ ! to you under the Apache License, Version 2.0 (the
+ ! "License"); you may not use this file except in compliance
+ ! with the License.  You may obtain a copy of the License at
+ !
+ !   http://www.apache.org/licenses/LICENSE-2.0
+ !
+ ! Unless required by applicable law or agreed to in writing,
+ ! software distributed under the License is distributed on an
+ ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ! KIND, either express or implied.  See the License for the
+ ! specific language governing permissions and limitations
+ ! under the License.
+ !-->
+
+# The Asterix Data Model (ADM) #
+
+## <a id="toc">Table of Contents</a> ##
+
+* [Primitive Types](#PrimitiveTypes)
+    * [Boolean](#PrimitiveTypesBoolean)
+    * [Tinyint / Smallint / Integer (Int) / Bigint](#PrimitiveTypesInt)
+    * [Float](#PrimitiveTypesFloat)
+    * [Double (Double Precision)](#PrimitiveTypesDouble)
+    * [String](#PrimitiveTypesString)
+    * [Binary](#PrimitiveTypesBinary)
+    * [Point](#PrimitiveTypesPoint)
+    * [Line](#PrimitiveTypesLine)
+    * [Rectangle](#PrimitiveTypesRectangle)
+    * [Circle](#PrimitiveTypesCircle)
+    * [Polygon](#PrimitiveTypesPolygon)
+    * [Date](#PrimitiveTypesDate)
+    * [Time](#PrimitiveTypesTime)
+    * [Datetime (Timestamp)](#PrimitiveTypesDateTime)
+    * [Duration/Year_month_duration/Day_time_duration](#PrimitiveTypesDuration)
+    * [Interval](#PrimitiveTypesInterval)
+    * [UUID](#PrimitiveTypesUUID)
+* [Incomplete Information Types] (#IncompleteInformationTypesTypes)
+    * [Null](#IncompleteInformationTypesNull)
+    * [Missing](#IncompleteInformationTypesMissing)
+* [Derived Types](#DerivedTypes)
+    * [Record](#DerivedTypesRecord)
+    * [Array](#DerivedTypesArray)
+    * [Multiset](#DerivedTypesMultiset)
+
+An instance of Asterix data model (ADM) can be a _*primitive type*_ (`boolean`,
+`tinyint`, `smallint`, `integer`, `bigint`, `string`, `float`, `double`, `date`,
+`time`, `datetime`, etc.), a _*special type*_ (`null` or `missing`), or a _*derived type*_.
+
+The type names are case-insensitive, e.g., both `BIGINT` and `bigint` are acceptable.
+
+## <a id="PrimitiveTypes">Primitive Types</a>##
+
+### <a id="PrimitiveTypesBoolean">Boolean</a> ###
+`boolean` data type can have one of the two values: _*true*_ or _*false*_.
+
+ * Example:
+
+        { "true": true, "false": false };
+
+
+ * The expected result is:
+
+        { "true": true, "false": false }
+
+
+
+### <a id="PrimitiveTypesInt">Tinyint / Smallint / Integer (Int) / Bigint</a>
###
+Integer types using 8, 16, 32, or 64 bits. The ranges of these types are:
+
+- `tinyint`: -127 to 127
+- `smallint`: -32767 to 32767
+- `integer`: -2147483647 to 2147483647
+- `bigint`: -9223372036854775808 to 9223372036854775807
+
+`int` is an abbreviated alias for integer.
+
+ * Example:
+
+        { "tinyint": tiny("125"), "smallint": smallint("32765"), "integer": 294967295, "bigint":
bigint("1700000000000000000")};
+
+
+ * The expected result is:
+
+        { "tinyint": 125, "smallint": 32765, "integer": 294967295, "bigint": 17000000 }
+
+
+### <a id="PrimitiveTypesFloat">Float</a> ###
+`float` represents approximate numeric data values using 4 bytes. The range of a float value
can be
+from 2^(-149) to (2-2^(-23)·2^(127) for both positive and negative. Beyond these ranges
will get `INF` or `-INF`.
+
+ * Example:
+
+        { "v1": float("NaN"), "v2": float("INF"), "v3": float("-INF"), "v4": float("-2013.5")
};
+
+
+ * The expected result is:
+
+        { "v1": NaN, "v2": Infinity, "v3": -Infinity, "v4": -2013.5 }
+
+
+### <a id="PrimitiveTypesDouble">Double (double precision)</a> ###
+`double` represents approximate numeric data values using 8 bytes. The range of a double
value can be from (2^(-1022)) to (2-2^(-52))·2^(1023)
+for both positive and negative. Beyond these ranges will get `INF` or `-INF`.
+
+ * Example:
+
+        { "v1": double("NaN"), "v2": double("INF"), "v3": double("-INF"), "v4": "-2013.593823748327284"
};
+
+
+ * The expected result is:
+
+        { "v1": NaN, "v2": Infinity, "v3": -Infinity, "v4": -2013.5938237483274 }
+
+`Double precision` is an alias of `double`.
+
+### <a id="PrimitiveTypesString">String</a> ###
+`string` represents a sequence of characters. The total length of the sequence can be up
to 2,147,483,648.
+
+ * Example:
+
+        { "v1": string("This is a string."), "v2": string("\"This is a quoted string\"")
};
+
+
+ * The expected result is:
+
+        { "v1": "This is a string.", "v2": "\"This is a quoted string\"" }
+
+
+### <a id="PrimitiveTypesBinary">Binary</a> ###
+`binary` represents a sequence of bytes. It can be constructed from a `hex` or a `base64`
string sequence.
+The total length of the byte sequence can be up to 2,147,483,648.
+
+ * Example:
+
+        {
+          "hex1" : hex("ABCDEF0123456789"),
+          "hex2": hex("abcdef0123456789"),
+          "base64_1" : base64("0123456789qwertyui+/"),
+          "base64_2" : base64('QXN0ZXJpeA==')
+        };
+
+ * The default output format is in `hex` format. Thus, the expected result is:
+
+        {
+          "hex1": hex("ABCDEF0123456789"),
+          "hex2": hex("ABCDEF0123456789"),
+          "base64_1": hex("D35DB7E39EBBF3DAB07ABB72BA2FBF"),
+          "base64_2": hex("41737465726978")
+        }
+
+
+### <a id="PrimitiveTypesPoint">Point</a> ###
+`point` is the fundamental two-dimensional building block for spatial types. It consists
of two `double` coordinates x and y.
+
+ * Example:
+
+        { "v1": point("80.10d, -10E5"), "v2": point("5.10E-10d, -10E5") };
+
+
+ * The expected result is:
+
+        { "v1": point("80.1,-1000000.0"), "v2": point("5.1E-10,-1000000.0") }
+
+
+### <a id="PrimitiveTypesLine">Line</a> ###
+`line` consists of two points that represent the start and the end points of a line segment.
+
+ * Example:
+
+        { "v1": line("10.1234,11.1e-1 +10.2E-2,-11.22"), "v2": line("0.1234,-1.00e-10 +10.5E-2,-01.02")
};
+
+
+ * The expected result is:
+
+        { "v1": line("10.1234,1.11 0.102,-11.22"), "v2": line("0.1234,-1.0E-10 0.105,-1.02")
}
+
+
+### <a id="PrimitiveTypesRectangle">Rectangle</a>###
+`rectangle` consists of two points that represent the _*bottom left*_ and _*upper right*_
corners of a rectangle.
+
+ * Example:
+
+        { "v1": rectangle("5.1,11.8 87.6,15.6548"), "v2": rectangle("0.1234,-1.00e-10 5.5487,0.48765")
};
+
+
+ * The expected result is:
+
+        { "v1": rectangle("5.1,11.8 87.6,15.6548"), "v2": rectangle("0.1234,-1.0E-10 5.5487,0.48765")
}
+
+
+### <a id="PrimitiveTypesCircle">Circle</a> ###
+`circle` consists of one point that represents the center of the circle and a radius of type
`double`.
+
+ * Example:
+
+        { "v1": circle("10.1234,11.1e-1 +10.2E-2"), "v2": circle("0.1234,-1.00e-10 +10.5E-2")
};
+
+
+ * The expected result is:
+
+        { "v1": circle("10.1234,1.11 0.102"), "v2": circle("0.1234,-1.0E-10 0.105") }
+
+
+### <a id="PrimitiveTypesPolygon">Polygon</a> ###
+`polygon` consists of _*n*_ points that represent the vertices of a _*simple closed*_ polygon.
+
+ * Example:
+
+        {
+          "v1": polygon("-1.2,+1.3e2 -2.14E+5,2.15 -3.5e+2,03.6 -4.6E-3,+4.81"),
+          "v2": polygon("-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")
+        };
+
+
+ * The expected result is:
+
+        {
+          "v1": polygon("-1.2,130.0 -214000.0,2.15 -350.0,3.6 -0.0046,4.81"),
+          "v2": polygon("-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") }
+        }
+
+
+### <a id="PrimitiveTypesDate">Date</a> ###
+`date` represents a time point along the Gregorian calendar system specified by the year,
month and day. ASTERIX supports the date from `-9999-01-01` to `9999-12-31`.
+
+A date value can be represented in two formats, extended format and basic format.
+
+ * Extended format is represented as `[-]yyyy-mm-dd` for `year-month-day`. Each field should
be padded if there are less digits than the format specified.
+ * Basic format is in the format of `[-]yyyymmdd`.
+
+ * Example:
+
+        { "v1": date("2013-01-01"), "v2": date("-19700101") };
+
+
+ * The expected result is:
+
+        { "v1": date("2013-01-01"), "v2": date("-1970-01-01") }
+
+
+### <a id="PrimitiveTypesTime">Time</a> ###
+`time` 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 `hh:mm:ss[.mmm]` and the basic format is `hhmmss[mmm]`. The value
domain is from `00:00:00.000` to `23:59:59.999`.
+
+Timezone field is optional for a time value. Timezone is represented as `[+|-]hh:mm` for
extended format or `[+|-]hhmm` for basic format. Note that the sign designators cannot be
omitted. `Z` can also be used to represent the UTC local time. If no timezone information
is given, it is UTC by default.
+
+ * Example:
+
+        { "v1": time("12:12:12.039Z"), "v2": time("000000000-0800") };
+
+
+ * The expected result is:
+
+        { "v1": time("12:12:12.039Z"), "v2": time("08:00:00.000Z") }
+
+
+### <a id="PrimitiveTypesDateTime">Datetime (Timestamp)</a> ###
+A `datetime` value is a combination of an `date` and `time`, representing a fixed time point
along the Gregorian calendar system. The value is among `-9999-01-01 00:00:00.000` and `9999-12-31
23:59:59.999`.
+
+A `datetime` value is represented as a combination of the representation of its `date` part
and `time` part, separated by a separator `T`. Either extended or basic format can be used,
and the two parts should be the same format.
+
+Millisecond field and timezone field are optional, as specified in the `time` type.
+
+ * Example:
+
+        { "v1": datetime("2013-01-01T12:12:12.039Z"), "v2": datetime("-19700101T000000000-0800")
};
+
+
+ * The expected result is:
+
+        { "v1": datetime("2013-01-01T12:12:12.039Z"), "v2": datetime("-1970-01-01T08:00:00.000Z")
}
+
+`timestamp` is an alias of `datetime`.
+
+### <a id="PrimitiveTypesDuration">Duration/Year_month_duration/Day_time_duration</a>
###
+`duration` 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.
+
+A duration value is in the format of `[-]PnYnMnDTnHnMn.mmmS`. 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.
+
+Negative durations are also supported for the arithmetic operations between time instance
types (`date`, `time` and `datetime`), and is used to roll the time back for the given duration.
For example `date("2012-01-01") + duration("-P3D")` will return `date("2011-12-29")`.
+
+There are also two sub-duration types, namely `year_month_duration` and `day_time_duration`.
+`year_month_duration` represents only the years and months of a duration,
+while `day_time_duration` represents only the day to millisecond fields.
+Different from the `duration` type, both these two subtypes are totally ordered, so they
can be used for comparison and
+index construction.
+
+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's input. More information
about canonical representation can be found from [XPath dayTimeDuration Canonical Representation](http://www.w3.org/TR/xpath-functions/#canonical-dayTimeDuration)
and [yearMonthDuration Canonical Representation](http://www.w3.org/TR/xpath-functions/#canonical-yearMonthDuration).
+
+ * Example:
+
+        { "v1": duration("P100Y12MT12M"), "v2": duration("-PT20.943S") };
+
+
+ * The expected result is:
+
+        { "v1": duration("P101YT12M"), "v2": duration("-PT20.943S") }
+
+
+### <a id="PrimitiveTypesInterval">Interval</a> ###
+`interval` represents inclusive-exclusive ranges of time. It is defined by two time point
values with the same temporal type(`date`, `time` or `datetime`).
+
+ * Example:
+
+        {
+          "v1": interval(date("2013-01-01"), date("20130505")),
+          "v2": interval(time("00:01:01"), time("213901049+0800")),
+          "v3": interval(datetime("2013-01-01T00:01:01"), datetime("20130505T213901049+0800"))
+        };
+
+
+ * The expected result is:
+
+        {
+          "v1": interval(date("2013-01-01"), date("2013-05-05")),
+          "v2": interval(time("00:01:01.000Z"), time("13:39:01.049Z")),
+          "v3": interval(datetime("2013-01-01T00:01:01.000Z"), datetime("2013-05-05T13:39:01.049Z"))
+        }
+
+### <a id="PrimitiveTypesUUID">UUID</a> ###
+`uuid` 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.
+
+ * Example:
+
+        return { "v1":uuid("5c848e5c-6b6a-498f-8452-8847a2957421") }
+
+
+ * The expected result is:
+
+        { "v1": uuid("5c848e5c-6b6a-498f-8452-8847a2957421") }
+
+## <a id="IncompleteInformationTypes">Incomplete Information Types</a>##
+
+### <a id="IncompleteInformationTypesNull">Null</a> ###
+`null` 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 `null`.
+
+ * Example:
+
+        { "field": null };
+
+
+ * The expected result is:
+
+        { "field": null }
+
+
+### <a id="IncompleteInformationTypesMissing">Missing</a> ###
+`missing` represents a missing name-value pair in a record.
+If the referenced field does not exist, an empty result value is returned by the query.
+
+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 record and `missing` in another.
+
+ * Example:
+
+        { "field": missing };
+
+
+ * The expected result is:
+
+        {  }
+
+Since a field with value `missing` means the field is absent, we get an empty record.
+
+## <a id="DerivedTypes">Derived Types</a> ##
+
+### <a id="DerivedTypesRecord">Record</a>###
+A `record` contains a set of fields, where each field is described by its name and type.
A record type is either open or closed. Open records can contain fields that are not part
of the type definition, while closed records cannot. Syntactically, record constructors are
surrounded by curly braces "{...}".
+
+An example would be
+
+
+        { "id": 213508, "name": "Alice Bob" }
+
+
+### <a id="DerivedTypesArray">Array</a>###
+An `array` is a container that holds a fixed number of values. Array constructors are denoted
by brackets: "[...]".
+
+An example would be
+
+
+        ["alice", 123, "bob", null]
+
+
+### <a id="DerivedTypesMultiset">Multiset</a>###
+A `multiset` is a generalization of the concept of a set that, unlike a set, allows multiple
instances of the multiset's elements.
+ Multiset constructors are denoted by two opening curly braces followed by data and two closing
curly braces, like "{{...}}".
+
+An example would be
+
+
+        {{"hello", 9328, "world", [1, 2, null]}}

http://git-wip-us.apache.org/repos/asf/asterixdb/blob/e3ad3154/asterixdb/asterix-doc/src/site/site.xml
----------------------------------------------------------------------
diff --git a/asterixdb/asterix-doc/src/site/site.xml b/asterixdb/asterix-doc/src/site/site.xml
index 33ce7eb..4c0ba6e 100644
--- a/asterixdb/asterix-doc/src/site/site.xml
+++ b/asterixdb/asterix-doc/src/site/site.xml
@@ -85,7 +85,7 @@
     </menu>
 
     <menu name="Data Model">
-      <item name="The Asterix Data Model" href="aql/datamodel.html"/>
+      <item name="The Asterix Data Model" href="datamodel.html"/>
     </menu>
 
     <menu name="Queries - SQL++">
@@ -108,7 +108,6 @@
 
     <menu name="API/SDK">
       <item name="HTTP API" href="api.html"/>
-      <item name="Javascript SDK" href="aql/js-sdk.html"/>
     </menu>
 
     <menu ref="reports"/>


Mime
View raw message