Fix 0.9.2 docs
Change-Id: Ib852cde3e959f61fc2c96650535353c0b137c211
Reviewed-on: https://asterix-gerrit.ics.uci.edu/2008
Reviewed-by: Xikui Wang <xkkwww@gmail.com>
diff --git a/docs/0.9.2/ansible.html b/docs/0.9.2/ansible.html
new file mode 100644
index 0000000..3691363
--- /dev/null
+++ b/docs/0.9.2/ansible.html
@@ -0,0 +1,443 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2017-09-14
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>AsterixDB – </title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-41536543-1', 'uci.edu');
+ ga('send', 'pageview');</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="./" id="bannerLeft">
+ <img src="images/asterixlogo.png" alt="AsterixDB"/>
+ </a>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2017-09-14</li>
+
+
+
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="index.html" title="Documentation Home">
+ Documentation Home</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Get Started - Installation</li>
+
+ <li>
+
+ <a href="ncservice.html" title="Option 1: using NCService">
+ <i class="none"></i>
+ Option 1: using NCService</a>
+ </li>
+
+ <li class="active">
+
+ <a href="#"><i class="none"></i>Option 2: using Ansible</a>
+ </li>
+
+ <li>
+
+ <a href="aws.html" title="Option 3: using Amazon Web Services">
+ <i class="none"></i>
+ Option 3: using Amazon Web Services</a>
+ </li>
+
+ <li>
+
+ <a href="yarn.html" title="Option 4: using YARN">
+ <i class="none"></i>
+ Option 4: using YARN</a>
+ </li>
+
+ <li>
+
+ <a href="install.html" title="Option 5: using Managix (deprecated)">
+ <i class="none"></i>
+ Option 5: using Managix (deprecated)</a>
+ </li>
+ <li class="nav-header">AsterixDB Primer</li>
+
+ <li>
+
+ <a href="sqlpp/primer-sqlpp.html" title="Option 1: using SQL++">
+ <i class="none"></i>
+ Option 1: using SQL++</a>
+ </li>
+
+ <li>
+
+ <a href="aql/primer.html" title="Option 2: using AQL">
+ <i class="none"></i>
+ Option 2: using AQL</a>
+ </li>
+ <li class="nav-header">Data Model</li>
+
+ <li>
+
+ <a href="datamodel.html" title="The Asterix Data Model">
+ <i class="none"></i>
+ The Asterix Data Model</a>
+ </li>
+ <li class="nav-header">Queries - SQL++</li>
+
+ <li>
+
+ <a href="sqlpp/manual.html" title="The SQL++ Query Language">
+ <i class="none"></i>
+ The SQL++ Query Language</a>
+ </li>
+
+ <li>
+
+ <a href="sqlpp/builtins.html" title="Builtin Functions">
+ <i class="none"></i>
+ Builtin Functions</a>
+ </li>
+ <li class="nav-header">Queries - AQL</li>
+
+ <li>
+
+ <a href="aql/manual.html" title="The Asterix Query Language (AQL)">
+ <i class="none"></i>
+ The Asterix Query Language (AQL)</a>
+ </li>
+
+ <li>
+
+ <a href="aql/builtins.html" title="Builtin Functions">
+ <i class="none"></i>
+ Builtin Functions</a>
+ </li>
+ <li class="nav-header">API/SDK</li>
+
+ <li>
+
+ <a href="api.html" title="HTTP API">
+ <i class="none"></i>
+ HTTP API</a>
+ </li>
+
+ <li>
+
+ <a href="csv.html" title="CSV Output">
+ <i class="none"></i>
+ CSV Output</a>
+ </li>
+ <li class="nav-header">Advanced Features</li>
+
+ <li>
+
+ <a href="aql/fulltext.html" title="Support of Full-text Queries">
+ <i class="none"></i>
+ Support of Full-text Queries</a>
+ </li>
+
+ <li>
+
+ <a href="aql/externaldata.html" title="Accessing External Data">
+ <i class="none"></i>
+ Accessing External Data</a>
+ </li>
+
+ <li>
+
+ <a href="feeds/tutorial.html" title="Support for Data Ingestion">
+ <i class="none"></i>
+ Support for Data Ingestion</a>
+ </li>
+
+ <li>
+
+ <a href="udf.html" title="User Defined Functions">
+ <i class="none"></i>
+ User Defined Functions</a>
+ </li>
+
+ <li>
+
+ <a href="aql/filters.html" title="Filter-Based LSM Index Acceleration">
+ <i class="none"></i>
+ Filter-Based LSM Index Acceleration</a>
+ </li>
+
+ <li>
+
+ <a href="aql/similarity.html" title="Support of Similarity Queries">
+ <i class="none"></i>
+ Support of Similarity Queries</a>
+ </li>
+ </ul>
+
+
+
+ <hr class="divider" />
+
+ <div id="poweredBy">
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="./" title="AsterixDB" class="builtBy">
+ <img class="builtBy" alt="AsterixDB" src="images/asterixlogo.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <!-- ! 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.
+ ! -->
+<ul>
+
+<li><a href="#Introduction">Introduction</a></li>
+
+<li><a href="#Prerequisites">Prerequisites</a></li>
+
+<li><a href="#config">Cluster Configuration</a></li>
+
+<li><a href="#lifecycle">Cluster Lifecycle Management</a></li>
+</ul>
+<!-- ! 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.
+ ! -->
+<div class="section">
+<h2><a name="Introduction" id="Introduction">Introduction</a></h2>
+<p>This installation option provides several wrapped <a class="externalLink" href="https://www.ansible.com/">Ansible</a>-based scripts to deploy, start, stop, and erase an AsterixDB instance on a multi-node cluster without requiring users to interact with each individual node in the cluster.</p></div>
+<div class="section">
+<h2><a name="Prerequisites" id="Prerequisites">Prerequisites</a></h2>
+
+<ul>
+
+<li>
+<p>Supported operating systems: <b>Linux</b> and <b>MacOS</b></p></li>
+
+<li>
+<p>Install pip on your client machine:</p>
+<p>CentOS</p>
+
+<div class="source">
+<div class="source">
+<pre> $ sudo yum install python-pip
+</pre></div></div>
+<p>Ubuntu</p>
+
+<div class="source">
+<div class="source">
+<pre> $ sudo apt-get install python-pip
+</pre></div></div>
+<p>macOS</p>
+
+<div class="source">
+<div class="source">
+<pre> $ brew install pip
+</pre></div></div></li>
+
+<li>
+<p>Install Ansible, boto, and boto3 on your client machine:</p>
+
+<div class="source">
+<div class="source">
+<pre> $ pip install ansible
+ $ pip install boto
+ $ pip install boto3
+</pre></div></div>
+<p>Note that you might need <tt>sudo</tt> depending on your system configuration.</p>
+<p><b>Make sure that the version of Ansible is no less than 2.2.1.0</b>:</p>
+
+<div class="source">
+<div class="source">
+<pre> $ ansible --version
+ ansible 2.2.1.0
+</pre></div></div></li>
+
+<li>
+<p>Download the AsterixDB distribution package, unzip it, and navigate to <tt>opt/ansible/</tt></p>
+
+<div class="source">
+<div class="source">
+<pre> $ cd opt/ansible
+</pre></div></div>
+<p>The following files and directories are in the directory <tt>opt/ansible</tt>:</p>
+
+<div class="source">
+<div class="source">
+<pre> README bin conf yaml
+</pre></div></div>
+<p><tt>bin</tt> contains scripts that deploy, start, stop and erase a multi-node AsterixDB cluster, according to the configuration specified in files under <tt>conf</tt>, and <tt>yaml</tt> contains internal Ansible scripts that the shell scripts in <tt>bin</tt> use.</p></li>
+</ul></div>
+<div class="section">
+<h2><a name="Cluster_Configuration"></a><a name="config" id="config">Cluster Configuration</a></h2>
+
+<ul>
+
+<li>
+<p><b>Nodes and account</b>. Edit the inventory file <tt>conf/inventory</tt> when necessary. You mostly only need to specify the node DNS names (or IPs) for the cluster controller, i.e., the master node, in the <b>[cc]</b> section, and node controllers, i.e., slave nodes, in the <b>[ncs]</b> section. The following example configures a cluster with two slave nodes (172.0.1.11 and 172.0.1.12) and one master node (172.0.1.10).</p>
+
+<div class="source">
+<div class="source">
+<pre> [cc]
+ 172.0.1.10
+
+ [ncs]
+ 172.0.1.11
+ 172.0.1.12
+</pre></div></div>
+<p><b>Configure passwordless ssh from your current client that runs the scripts to all nodes listed in <tt>conf/inventory</tt> as well as <tt>localhost</tt>.</b> If the ssh user account for target machines is different from your current username, please uncomment and edit the following two lines:</p>
+
+<div class="source">
+<div class="source">
+<pre> ;[all:vars]
+ ;ansible_ssh_user=<fill with your ssh account username>
+</pre></div></div>
+<p>If you want to specify advanced Ansible builtin variables, please refer to the <a class="externalLink" href="http://docs.ansible.com/ansible/intro_inventory.html">Ansible documentation</a>.</p></li>
+
+<li>
+<p><b>Remote working directories</b>. Edit <tt>conf/instance_settings.yml</tt> to change the remote binary directory (the variable “binarydir”) when necessary. By default, the binary directory will be under the home directory (as the value of Ansible builtin variable ansible_env.HOME) of the ssh user account on each node.</p></li>
+</ul></div>
+<div class="section">
+<h2><a name="Cluster_Lifecycle_Management"></a><a name="lifecycle" id="lifecycle">Cluster Lifecycle Management</a></h2>
+
+<ul>
+
+<li>
+<p>Deploy the binary to all nodes:</p>
+
+<div class="source">
+<div class="source">
+<pre> $ bin/deploy.sh
+</pre></div></div></li>
+
+<li>
+<p>Every time before starting the AsterixDB cluster, you can edit the instance configuration file <tt>conf/instance/cc.conf</tt>, except that IP addresses/DNS names are generated and cannot be changed. All available parameters and their usage can be found <a href="ncservice.html#Parameters">here</a>.</p></li>
+
+<li>
+<p>Launch your AsterixDB cluster:</p>
+
+<div class="source">
+<div class="source">
+<pre> $ bin/start.sh
+</pre></div></div>
+<p>Now you can use the multi-node AsterixDB cluster by opening the master node listed in <tt>conf/inventory</tt> at port <tt>19001</tt> (which can be customized in <tt>conf/instance/cc.conf</tt>) in your browser.</p></li>
+
+<li>
+<p>If you want to stop the the multi-node AsterixDB cluster, run the following script:</p>
+
+<div class="source">
+<div class="source">
+<pre> $ bin/stop.sh
+</pre></div></div></li>
+
+<li>
+<p>If you want to remove the binary on all nodes, run the following script:</p>
+
+<div class="source">
+<div class="source">
+<pre> $ bin/erase.sh
+</pre></div></div></li>
+</ul></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row span12">Copyright © 2017
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<div class="row-fluid">Apache AsterixDB, AsterixDB, Apache, the Apache
+ feather logo, and the Apache AsterixDB project logo are either
+ registered trademarks or trademarks of The Apache Software
+ Foundation in the United States and other countries.
+ All other marks mentioned may be trademarks or registered
+ trademarks of their respective owners.</div>
+
+
+ </div>
+ </footer>
+ </body>
+</html>
diff --git a/docs/0.9.2/api.html b/docs/0.9.2/api.html
index c440c85..1c87fe8 100644
--- a/docs/0.9.2/api.html
+++ b/docs/0.9.2/api.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – HTTP API to AsterixDB</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/aql/builtins.html b/docs/0.9.2/aql/builtins.html
new file mode 100644
index 0000000..443298c
--- /dev/null
+++ b/docs/0.9.2/aql/builtins.html
@@ -0,0 +1,9070 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2017-09-14
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>AsterixDB – Builtin Functions</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-41536543-1', 'uci.edu');
+ ga('send', 'pageview');</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <a href=".././" id="bannerLeft">
+ <img src="../images/asterixlogo.png" alt="AsterixDB"/>
+ </a>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2017-09-14</li>
+
+
+
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="../index.html" title="Documentation Home">
+ Documentation Home</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Get Started - Installation</li>
+
+ <li>
+
+ <a href="../ncservice.html" title="Option 1: using NCService">
+ <i class="none"></i>
+ Option 1: using NCService</a>
+ </li>
+
+ <li>
+
+ <a href="../ansible.html" title="Option 2: using Ansible">
+ <i class="none"></i>
+ Option 2: using Ansible</a>
+ </li>
+
+ <li>
+
+ <a href="../aws.html" title="Option 3: using Amazon Web Services">
+ <i class="none"></i>
+ Option 3: using Amazon Web Services</a>
+ </li>
+
+ <li>
+
+ <a href="../yarn.html" title="Option 4: using YARN">
+ <i class="none"></i>
+ Option 4: using YARN</a>
+ </li>
+
+ <li>
+
+ <a href="../install.html" title="Option 5: using Managix (deprecated)">
+ <i class="none"></i>
+ Option 5: using Managix (deprecated)</a>
+ </li>
+ <li class="nav-header">AsterixDB Primer</li>
+
+ <li>
+
+ <a href="../sqlpp/primer-sqlpp.html" title="Option 1: using SQL++">
+ <i class="none"></i>
+ Option 1: using SQL++</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/primer.html" title="Option 2: using AQL">
+ <i class="none"></i>
+ Option 2: using AQL</a>
+ </li>
+ <li class="nav-header">Data Model</li>
+
+ <li>
+
+ <a href="../datamodel.html" title="The Asterix Data Model">
+ <i class="none"></i>
+ The Asterix Data Model</a>
+ </li>
+ <li class="nav-header">Queries - SQL++</li>
+
+ <li>
+
+ <a href="../sqlpp/manual.html" title="The SQL++ Query Language">
+ <i class="none"></i>
+ The SQL++ Query Language</a>
+ </li>
+
+ <li>
+
+ <a href="../sqlpp/builtins.html" title="Builtin Functions">
+ <i class="none"></i>
+ Builtin Functions</a>
+ </li>
+ <li class="nav-header">Queries - AQL</li>
+
+ <li>
+
+ <a href="../aql/manual.html" title="The Asterix Query Language (AQL)">
+ <i class="none"></i>
+ The Asterix Query Language (AQL)</a>
+ </li>
+
+ <li class="active">
+
+ <a href="#"><i class="none"></i>Builtin Functions</a>
+ </li>
+ <li class="nav-header">API/SDK</li>
+
+ <li>
+
+ <a href="../api.html" title="HTTP API">
+ <i class="none"></i>
+ HTTP API</a>
+ </li>
+
+ <li>
+
+ <a href="../csv.html" title="CSV Output">
+ <i class="none"></i>
+ CSV Output</a>
+ </li>
+ <li class="nav-header">Advanced Features</li>
+
+ <li>
+
+ <a href="../aql/fulltext.html" title="Support of Full-text Queries">
+ <i class="none"></i>
+ Support of Full-text Queries</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/externaldata.html" title="Accessing External Data">
+ <i class="none"></i>
+ Accessing External Data</a>
+ </li>
+
+ <li>
+
+ <a href="../feeds/tutorial.html" title="Support for Data Ingestion">
+ <i class="none"></i>
+ Support for Data Ingestion</a>
+ </li>
+
+ <li>
+
+ <a href="../udf.html" title="User Defined Functions">
+ <i class="none"></i>
+ User Defined Functions</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/filters.html" title="Filter-Based LSM Index Acceleration">
+ <i class="none"></i>
+ Filter-Based LSM Index Acceleration</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/similarity.html" title="Support of Similarity Queries">
+ <i class="none"></i>
+ Support of Similarity Queries</a>
+ </li>
+ </ul>
+
+
+
+ <hr class="divider" />
+
+ <div id="poweredBy">
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href=".././" title="AsterixDB" class="builtBy">
+ <img class="builtBy" alt="AsterixDB" src="../images/asterixlogo.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <!-- ! 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.
+ ! --><h1>Builtin Functions</h1>
+<div class="section">
+<h2><a name="Table_of_Contents"></a><a name="toc" id="toc">Table of Contents</a></h2>
+
+<ul>
+
+<li><a href="#NumericFunctions">Numeric Functions</a></li>
+
+<li><a href="#StringFunctions">String Functions</a></li>
+
+<li><a href="#BinaryFunctions">Binary Functions</a></li>
+
+<li><a href="#SpatialFunctions">Spatial Functions</a></li>
+
+<li><a href="#SimilarityFunctions">Similarity Functions</a></li>
+
+<li><a href="#TokenizingFunctions">Tokenizing Functions</a></li>
+
+<li><a href="#TemporalFunctions">Temporal Functions</a></li>
+
+<li><a href="#ObjectFunctions">Object Functions</a></li>
+
+<li><a href="#AggregateFunctions">Aggregate Functions (Array Functions)</a></li>
+
+<li><a href="#ComparisonFunctions">Comparison Functions</a></li>
+
+<li><a href="#TypeFunctions">Type Functions</a></li>
+
+<li><a href="#ConditionalFunctions">Conditional Functions</a></li>
+
+<li><a href="#MiscFunctions">Miscellaneous Functions</a></li>
+</ul>
+<p>The system provides various classes of functions to support operations on numeric, string, spatial, and temporal data. This document explains how to use these functions. <!-- ! 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.
+ ! --></p></div>
+<div class="section">
+<h2><a name="Numeric_Functions"></a><a name="NumericFunctions" id="NumericFunctions">Numeric Functions</a></h2>
+<div class="section">
+<h3><a name="abs"></a>abs</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>abs(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the absolute value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>The absolute value of the argument with the same type as the input argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": abs(2013), "v2": abs(-4036), "v3": abs(0), "v4": abs(float("-2013.5")), "v5": abs(double("-2013.593823748327284")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 2013, "v2": 4036, "v3": 0, "v4": 2013.5, "v5": 2013.5938237483274 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="acos"></a>acos</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>acos(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the arc cosine value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> arc cosine in radians for the argument, if the argument is in the range of -1 (inclusive) to 1 (inclusive),</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error,</li>
+
+<li>“NaN” for other legitimate numeric values.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": acos(1), "v2": acos(2), "v3": acos(0), "v4": acos(float("0.5")), "v5": acos(double("-0.5")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.0, "v2": "NaN", "v3": 1.5707963267948966, "v4": 1.0471975511965979, "v5": 2.0943951023931957 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="asin"></a>asin</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>asin(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the arc sine value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> arc sin in radians for the argument, if the argument is in the range of -1 (inclusive) to 1 (inclusive),</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error,</li>
+
+<li>“NaN” for other legitimate numeric values.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": asin(1), "v2": asin(2), "v3": asin(0), "v4": asin(float("0.5")), "v5": asin(double("-0.5")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1.5707963267948966, "v2": "NaN", "v3": 0.0, "v4": 0.5235987755982989, "v5": -0.5235987755982989 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="atan"></a>atan</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>atan(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the arc tangent value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> arc tangent in radians for the argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": atan(1), "v2": atan(2), "v3": atan(0), "v4": atan(float("0.5")), "v5": atan(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.7853981633974483, "v2": 1.1071487177940904, "v3": 0.0, "v4": 0.4636476090008061, "v5": 1.5697963271282298 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="atan2"></a>atan2</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>atan2(numeric_value1, numeric_value2)
+</pre></div></div></li>
+
+<li>
+<p>Computes the arc tangent value of numeric_value2/numeric_value1.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value1</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li><tt>numeric_value2</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> arc tangent in radians for <tt>numeric_value1</tt> and <tt>numeric_value2</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": atan2(1, 2), "v2": atan2(0, 4), "v3": atan2(float("0.5"), double("-0.5")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.4636476090008061, "v2": 0.0, "v3": 2.356194490192345 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="ceil"></a>ceil</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>ceil(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the smallest (closest to negative infinity) number with no fractional part that is not less than the value of the argument. If the argument is already equal to mathematical integer, then the result is the same as the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>The ceiling value for the given number in the same type as the input argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": ceil(2013),
+ "v2": ceil(-4036),
+ "v3": ceil(0.3),
+ "v4": ceil(float("-2013.2")),
+ "v5": ceil(double("-2013.893823748327284"))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 2013, "v2": -4036, "v3": 1.0, "v4": -2013.0, "v5": -2013.0 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="cos"></a>cos</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>cos(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the cosine value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> cosine value for the argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": cos(1), "v2": cos(2), "v3": cos(0), "v4": cos(float("0.5")), "v5": cos(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.5403023058681398, "v2": -0.4161468365471424, "v3": 1.0, "v4": 0.8775825618903728, "v5": 0.562379076290703 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="exp"></a>exp</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>exp(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes e<sup>numeric_value</sup>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>e<sup>numeric_value</sup>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": exp(1), "v2": exp(2), "v3": exp(0), "v4": exp(float("0.5")), "v5": exp(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 2.718281828459045, "v2": 7.38905609893065, "v3": 1.0, "v4": 1.6487212707001282, "v5": "Infinity" }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="floor"></a>floor</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>floor(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the largest (closest to positive infinity) number with no fractional part that is not greater than the value. If the argument is already equal to mathematical integer, then the result is the same as the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>The floor value for the given number in the same type as the input argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": floor(2013),
+ "v2": floor(-4036),
+ "v3": floor(0.8),
+ "v4": floor(float("-2013.2")),
+ "v5": floor(double("-2013.893823748327284"))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 2013, "v2": -4036, "v3": 0.0, "v4": -2014.0, "v5": -2014.0 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="ln"></a>ln</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>ln(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes log<sub>e</sub>numeric_value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>log<sub>e</sub>numeric_value,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": ln(1), "v2": ln(2), "v3": ln(0), "v4": ln(float("0.5")), "v5": ln(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.0, "v2": 0.6931471805599453, "v3": "-Infinity", "v4": -0.6931471805599453, "v5": 6.907755278982137 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="log"></a>log</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>log(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes log<sub>10</sub>numeric_value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>log<sub>10</sub>numeric_value,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": log(1), "v2": log(2), "v3": log(0), "v4": log(float("0.5")), "v5": log(double("1000")) };
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.0, "v2": 0.3010299956639812, "v3": "-Infinity", "v4": -0.3010299956639812, "v5": 3.0 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="power"></a>power</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>power(numeric_value1, numeric_value2)
+</pre></div></div></li>
+
+<li>
+<p>Computes numeric_value1<sup>numeric_value2</sup>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value1</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li><tt>numeric_value2</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>numeric_value1<sup>numeric_value2</sup>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": power(1, 2), "v3": power(0, 4), "v4": power(float("0.5"), double("-0.5")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1, "v3": 0, "v4": 1.4142135623730951 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="round"></a>round</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>round(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the number with no fractional part that is closest (and also closest to positive infinity) to the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>The rounded value for the given number in the same type as the input argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": round(2013),
+ "v2": round(-4036),
+ "v3": round(0.8),
+ "v4": round(float("-2013.256")),
+ "v5": round(double("-2013.893823748327284"))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 2013, "v2": -4036, "v3": 1.0, "v4": -2013.0, "v5": -2014.0 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="sign"></a>sign</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>sign(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the sign of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the sign (a <tt>tinyint</tt>) of the argument, -1 for negative values, 0 for 0, and 1 for positive values,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": sign(1), "v2": sign(2), "v3": sign(0), "v4": sign(float("0.5")), "v5": sign(double("-1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1, "v2": 1, "v3": 0, "v4": 1, "v5": -1 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="sin"></a>sin</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>sin(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the sine value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> sine value for the argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": sin(1), "v2": sin(2), "v3": sin(0), "v4": sin(float("0.5")), "v5": sin(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.8414709848078965, "v2": 0.9092974268256817, "v3": 0.0, "v4": 0.479425538604203, "v5": 0.8268795405320025 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="sqrt"></a>sqrt</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>sqrt(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the square root of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> square root value for the argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": sqrt(1), "v2": sqrt(2), "v3": sqrt(0), "v4": sqrt(float("0.5")), "v5": sqrt(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1.0, "v2": 1.4142135623730951, "v3": 0.0, "v4": 0.7071067811865476, "v5": 31.622776601683793 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="tan"></a>tan</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>tan(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the tangent value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> tangent value for the argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": tan(1), "v2": tan(2), "v3": tan(0), "v4": tan(float("0.5")), "v5": tan(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1.5574077246549023, "v2": -2.185039863261519, "v3": 0.0, "v4": 0.5463024898437905, "v5": 1.4703241557027185 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="trunc"></a>trunc</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>trunc(numeric_value, number_digits)
+</pre></div></div></li>
+
+<li>
+<p>Truncates the number to the given number of integer digits to the right of the decimal point (left if digits is negative). Digits is 0 if not given.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li><tt>number_digits</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> tangent value for the argument,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is <tt>missing</tt>,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-numeric value,</li>
+
+<li>the second argument is any other non-tinyint, non-smallint, non-integer, and non-bigint value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": trunc(1, 1), "v2": trunc(2, -2), "v3": trunc(0.122, 2), "v4": trunc(float("11.52"), -1), "v5": trunc(double("1000.5252"), 3) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1, "v2": 2, "v3": 0.12, "v4": 10.0, "v5": 1000.525 }
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div>
+<div class="section">
+<h3><a name="round_half_to_even"></a>round_half_to_even</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>round_half_to_even(numeric_value, [precision])
+</pre></div></div></li>
+
+<li>
+<p>Computes the closest numeric value to <tt>numeric_value</tt> that is a multiple of ten to the power of minus <tt>precision</tt>. <tt>precision</tt> is optional and by default value <tt>0</tt> is used.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+
+<li><tt>precision</tt>: an optional <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> field representing the number of digits in the fraction of the the result</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>The rounded value for the given number in the same type as the input argument,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-numeric value,</li>
+
+<li>or, the second argument is any other non-tinyint, non-smallint, non-integer, or non-bigint value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": round_half_to_even(2013),
+ "v2": round_half_to_even(-4036),
+ "v3": round_half_to_even(0.8),
+ "v4": round_half_to_even(float("-2013.256")),
+ "v5": round_half_to_even(double("-2013.893823748327284")),
+ "v6": round_half_to_even(double("-2013.893823748327284"), 2),
+ "v7": round_half_to_even(2013, 4),
+ "v8": round_half_to_even(float("-2013.256"), 5)
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 2013, "v2": -4036, "v3": 1.0, "v4": -2013.0, "v5": -2014.0, "v6": -2013.89, "v7": 2013, "v8": -2013.256 }
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="String_Functions"></a><a name="StringFunctions" id="StringFunctions">String Functions</a></h2>
+<div class="section">
+<h3><a name="concat"></a>concat</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>concat(string1, string2, ...)
+</pre></div></div></li>
+
+<li>
+<p>Returns a concatenated string from arguments.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string1</tt>: a string value,</li>
+
+<li><tt>string2</tt>: a string value,</li>
+
+<li>….</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a concatenated string from arguments,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>concat("test ", "driven ", "development");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"test driven development"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="contains"></a>contains</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>contains(string, substring_to_contain)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the string <tt>string</tt> contains the string <tt>substring_to_contain</tt></p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might contain the given substring,</li>
+
+<li><tt>substring_to_contain</tt> : a target <tt>string</tt> that might be contained.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> value, <tt>true</tt> if <tt>string</tt> contains <tt>substring_to_contain</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error,</li>
+
+<li><tt>false</tt> otherwise.</li>
+ </ul></li>
+
+<li>
+<p>Note: an <a href="similarity.html#UsingIndexesToSupportSimilarityQueries">n_gram index</a> can be utilized for this function.</p></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": contains("I like x-phone", "phone"), "v2": contains("one", "phone") };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="ends_with"></a>ends_with</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>ends_with(string, substring_to_end_with)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the string <tt>string</tt> ends with the string <tt>substring_to_end_with</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might end with the given string,</li>
+
+<li><tt>substring_to_end_with</tt> : a <tt>string</tt> that might be contained as the ending substring.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> value, <tt>true</tt> if <tt>string</tt> contains <tt>substring_to_contain</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error,</li>
+
+<li><tt>false</tt> otherwise.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": ends_with(" love product-b its shortcut_menu is awesome:)", ":)"),
+ "v2": ends_with(" awsome:)", ":-)")
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="initcap_or_title"></a>initcap (or title)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>initcap(string)
+</pre></div></div></li>
+
+<li>
+<p>Converts a given string <tt>string</tt> so that the first letter of each word is uppercase and every other letter is lowercase. The function has an alias called “title”.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be converted.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> as the title form of the given <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": initcap("ASTERIXDB is here!"), "v2": title("ASTERIXDB is here!") };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": "Asterixdb Is Here!", "v2": "Asterixdb Is Here!" }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="length"></a>length</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>length(string)
+</pre></div></div></li>
+
+<li>
+<p>Returns the length of the string <tt>string</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> or <tt>null</tt> that represents the string to be checked.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>bigint</tt> that represents the length of <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>length("test string");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>11
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="lower"></a>lower</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>lower(string)
+</pre></div></div></li>
+
+<li>
+<p>Converts a given string <tt>string</tt> to its lowercase form.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be converted.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> as the lowercase form of the given <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>lower("ASTERIXDB");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"asterixdb"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="ltrim"></a>ltrim</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>ltrim(string[, chars]);
+</pre></div></div></li>
+
+<li>
+<p>Returns a new string with all leading characters that appear in <tt>chars</tt> removed. By default, white space is the character to trim.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be trimmed,</li>
+
+<li><tt>chars</tt> : a <tt>string</tt> that contains characters that are used to trim.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a trimmed, new <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>ltrim("me like x-phone", "eml");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>" like x-phone"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="position"></a>position</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>position(string, string_pattern)
+</pre></div></div></li>
+
+<li>
+<p>Returns the first position of <tt>string_pattern</tt> within <tt>string</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might contain the pattern,</li>
+
+<li><tt>string_pattern</tt> : a pattern <tt>string</tt> to be matched.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the first position that <tt>string_pattern</tt> appears within <tt>string</tt>, or -1 if it does not appear,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": position("ppphonepp", "phone"),
+ "v2": position("hone", "phone")
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 3, "v2": -1 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="regexp_contains"></a>regexp_contains</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>regexp_contains(string, string_pattern[, string_flags])
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the strings <tt>string</tt> contains the regular expression pattern <tt>string_pattern</tt> (a Java regular expression pattern).</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might contain the pattern,</li>
+
+<li><tt>string_pattern</tt> : a pattern <tt>string</tt> to be matched,</li>
+
+<li><tt>string_flag</tt> : (Optional) a <tt>string</tt> with flags to be used during regular expression matching.
+
+<ul>
+
+<li>The following modes are enabled with these flags: dotall (s), multiline (m), case_insensitive (i), and comments and whitespace (x).</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt>, returns <tt>true</tt> if <tt>string</tt> contains the pattern <tt>string_pattern</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error,</li>
+
+<li><tt>false</tt> otherwise.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": regexp_contains("pphonepp", "p*hone"),
+ "v2": regexp_contains("hone", "p+hone")
+}
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="regexp_like"></a>regexp_like</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>regexp_like(string, string_pattern[, string_flags])
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the string <tt>string</tt> exactly matches the regular expression pattern <tt>string_pattern</tt> (a Java regular expression pattern).</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might contain the pattern,</li>
+
+<li><tt>string_pattern</tt> : a pattern <tt>string</tt> that might be contained,</li>
+
+<li><tt>string_flag</tt> : (Optional) a <tt>string</tt> with flags to be used during regular expression matching.
+
+<ul>
+
+<li>The following modes are enabled with these flags: dotall (s), multiline (m), case_insensitive (i), and comments and whitespace (x).</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> value, <tt>true</tt> if <tt>string</tt> contains the pattern <tt>string_pattern</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error,</li>
+
+<li><tt>false</tt> otherwise.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": regexp_like(" can't stand acast the network is horrible:(", ".*acast.*"),
+ "v2": regexp_like("acast", ".*acst.*")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="regexp_position"></a>regexp_position</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>regexp_position(string, string_pattern[, string_flags])
+</pre></div></div></li>
+
+<li>
+<p>Returns first position of the regular expression <tt>string_pattern</tt> (a Java regular expression pattern) within <tt>string</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might contain the pattern,</li>
+
+<li><tt>string_pattern</tt> : a pattern <tt>string</tt> to be matched,</li>
+
+<li><tt>string_flag</tt> : (Optional) a <tt>string</tt> with flags to be used during regular expression matching.
+
+<ul>
+
+<li>The following modes are enabled with these flags: dotall (s), multiline (m), case_insensitive (i), and comments and whitespace (x).</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the first position that the regular expression <tt>string_pattern</tt> appears in <tt>string</tt>, or -1 if it does not appear.</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": regexp_position("pphonepp", "p*hone"),
+ "v2": regexp_position("hone", "p+hone")
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1, "v2": -1 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="regexp_replace"></a>regexp_replace</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>regexp_replace(string, string_pattern, string_replacement[, string_flags])
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the string <tt>string</tt> matches the given regular expression pattern <tt>string_pattern</tt> (a Java regular expression pattern), and replace the matched pattern <tt>string_pattern</tt> with the new pattern <tt>string_replacement</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might contain the pattern,</li>
+
+<li><tt>string_pattern</tt> : a pattern <tt>string</tt> to be matched,</li>
+
+<li><tt>string_replacement</tt> : a pattern <tt>string</tt> to be used as the replacement,</li>
+
+<li><tt>string_flag</tt> : (Optional) a <tt>string</tt> with flags to be used during replace.
+
+<ul>
+
+<li>The following modes are enabled with these flags: dotall (s), multiline (m), case_insensitive (i), and comments and whitespace (x).</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>Returns a <tt>string</tt> that is obtained after the replacements,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>regexp_replace(" like x-phone the voicemail_service is awesome", " like x-phone", "like product-a")
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"like product-a the voicemail_service is awesome"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="repeat"></a>repeat</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>repeat(string, n)
+</pre></div></div></li>
+
+<li>
+<p>Returns a string formed by repeating the input <tt>string</tt> <tt>n</tt> times.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be repeated,</li>
+
+<li><tt>offset</tt> : an <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value as the starting offset of the substring in <tt>string</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a string that repeats the input <tt>string</tt> <tt>n</tt> times,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-string value,</li>
+
+<li>or, the second argument is not a <tt>tinyint</tt>, <tt>smallint</tt>, <tt>integer</tt>, or <tt>bigint</tt>.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>repeat("test", 3);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"testtesttest"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="rtrim"></a>rtrim</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>rtrim(string[, chars]);
+</pre></div></div></li>
+
+<li>
+<p>Returns a new string with all trailing characters that appear in <tt>chars</tt> removed. By default, white space is the character to trim.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be trimmed,</li>
+
+<li><tt>chars</tt> : a <tt>string</tt> that contains characters that are used to trim.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a trimmed, new <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": rtrim("i like x-phone", "x-phone"),
+ "v2": rtrim("i like x-phone", "onexph")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": "i like ", "v2": "i like " }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="split"></a>split</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>split(string, sep)
+</pre></div></div></li>
+
+<li>
+<p>Splits the input <tt>string</tt> into an array of substrings separated by the string <tt>sep</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be split.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an array of substrings by splitting the input <tt>string</tt> by <tt>sep</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>split("test driven development", " ");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ "test", "driven", "development" ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="starts_with"></a>starts_with</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>starts_with(string, substring_to_start_with)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the string <tt>string</tt> starts with the string <tt>substring_to_start_with</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might start with the given string.</li>
+
+<li><tt>substring_to_start_with</tt> : a <tt>string</tt> that might be contained as the starting substring.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt>, returns <tt>true</tt> if <tt>string</tt> starts with the string <tt>substring_to_start_with</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error,</li>
+
+<li><tt>false</tt> otherwise.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1" : starts_with(" like the plan, amazing", " like"),
+ "v2" : starts_with("I like the plan, amazing", " like")
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="substr"></a>substr</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>substr(string, offset[, length])
+</pre></div></div></li>
+
+<li>
+<p>Returns the substring from the given string <tt>string</tt> based on the given start offset <tt>offset</tt> with the optional <tt>length</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be extracted,</li>
+
+<li><tt>offset</tt> : an <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value as the starting offset of the substring in <tt>string</tt>,</li>
+
+<li><tt>length</tt> : (Optional) an an <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value as the length of the substring.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> that represents the substring,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-string value,</li>
+
+<li>or, the second argument is not a <tt>tinyint</tt>, <tt>smallint</tt>, <tt>integer</tt>, or <tt>bigint</tt>,</li>
+
+<li>or, the third argument is not a <tt>tinyint</tt>, <tt>smallint</tt>, <tt>integer</tt>, or <tt>bigint</tt> if the argument is present.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>substr("test string", 6, 3);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"str"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="trim"></a>trim</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>trim(string[, chars]);
+</pre></div></div></li>
+
+<li>
+<p>Returns a new string with all leading characters that appear in <tt>chars</tt> removed. By default, white space is the character to trim.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be trimmed,</li>
+
+<li><tt>chars</tt> : a <tt>string</tt> that contains characters that are used to trim.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a trimmed, new <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>trim("i like x-phone", "xphoen");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>" like "
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="upper"></a>upper</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>upper(string)
+</pre></div></div></li>
+
+<li>
+<p>Converts a given string <tt>string</tt> to its uppercase form.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be converted.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> as the uppercase form of the given <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>upper("hello")
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"HELLO"
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div>
+<div class="section">
+<h3><a name="string_concat"></a>string_concat</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>string_concat(array)
+</pre></div></div></li>
+
+<li>
+<p>Concatenates an array of strings <tt>array</tt> into a single string.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array</tt> : an <tt>array</tt> or <tt>multiset</tt> of <tt>string</tt>s (could be <tt>null</tt> or <tt>missing</tt>) to be concatenated.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the concatenated <tt>string</tt> value,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li><tt>missing</tt> if any element in the input array is <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if any element in the input array is <tt>null</tt> but no element in the input array is <tt>missing</tt>,</li>
+
+<li>any other non-array input value or non-integer element in the input array will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>string_concat(["ASTERIX", " ", "ROCKS!"]);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"ASTERIX ROCKS!"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="string_join"></a>string_join</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>string_join(array, string)
+</pre></div></div></li>
+
+<li>
+<p>Joins an array or multiset of strings <tt>array</tt> with the given separator <tt>string</tt> into a single string.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array</tt> : an <tt>array</tt> or <tt>multiset</tt> of strings (could be <tt>null</tt>) to be joined.</li>
+
+<li><tt>string</tt> : a <tt>string</tt> to serve as the separator.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the joined <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li><tt>missing</tt> if the first argument array contains a <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if the first argument array contains a <tt>null</tt> but does not contain a <tt>missing</tt>,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-array value, or contains any other non-string value,</li>
+
+<li>or, the second argument is any other non-string value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>string_join(["ASTERIX", "ROCKS~"], "!! ");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"ASTERIX!! ROCKS~"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="string_to_codepoint"></a>string_to_codepoint</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>string_to_codepoint(string)
+</pre></div></div></li>
+
+<li>
+<p>Converts the string <tt>string</tt> to its code_based representation.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that will be converted.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>array</tt> of the code points for the string <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>string_to_codepoint("Hello ASTERIX!");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ 72, 101, 108, 108, 111, 32, 65, 83, 84, 69, 82, 73, 88, 33 ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="codepoint_to_string"></a>codepoint_to_string</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>codepoint_to_string(array)
+</pre></div></div></li>
+
+<li>
+<p>Converts the ordered code_based representation <tt>array</tt> to the corresponding string.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array</tt> : an <tt>array</tt> of integer code_points.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> representation of <tt>array</tt>.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li><tt>missing</tt> if any element in the input array is <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if any element in the input array is <tt>null</tt> but no element in the input array is <tt>missing</tt>,</li>
+
+<li>any other non-array input value or non-integer element in the input array will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>codepoint_to_string([72, 101, 108, 108, 111, 32, 65, 83, 84, 69, 82, 73, 88, 33]);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"Hello ASTERIX!"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="substring_before"></a>substring_before</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>substring_before(string, string_pattern)
+</pre></div></div></li>
+
+<li>
+<p>Returns the substring from the given string <tt>string</tt> before the given pattern <tt>string_pattern</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be extracted.</li>
+
+<li><tt>string_pattern</tt> : a <tt>string</tt> pattern to be searched.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> that represents the substring,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>substring_before(" like x-phone", "x-phone");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>" like "
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="substring_after"></a>substring_after</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>substring_after(string, string_pattern);</p></li>
+
+<li>
+<p>Returns the substring from the given string <tt>string</tt> after the given pattern <tt>string_pattern</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be extracted.</li>
+
+<li><tt>string_pattern</tt> : a <tt>string</tt> pattern to be searched.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> that represents the substring,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>substring_after(" like x-phone", "xph");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"one"
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Binary_Functions"></a><a name="BinaryFunctions" id="BinaryFunctions">Binary Functions</a></h2>
+<div class="section">
+<h3><a name="parse_binary"></a>parse_binary</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>parse_binary(string, encoding)</p></li>
+
+<li>
+<p>Creates a <tt>binary</tt> from an string encoded in <tt>encoding</tt> format.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : an encoded <tt>string</tt>,</li>
+
+<li><tt>encoding</tt> : a string notation specifies the encoding type of the given <tt>string</tt>. Currently we support <tt>hex</tt> and <tt>base64</tt> format.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>binary</tt> that is decoded from the given <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+<p>[ parse_binary(“ABCDEF0123456789”,“hex”), parse_binary(“abcdef0123456789”,“HEX”), parse_binary(‘QXN0ZXJpeAE=’,“base64”) ];</p></li>
+
+<li>
+<p>The expected result is:</p>
+<p>[ hex(“ABCDEF0123456789”), hex(“ABCDEF0123456789”), hex(“4173746572697801”) ]</p></li>
+</ul></div>
+<div class="section">
+<h3><a name="print_binary"></a>print_binary</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>print_binary(binary, encoding)</p></li>
+
+<li>
+<p>Prints a <tt>binary</tt> to the required encoding <tt>string</tt> format.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>binary</tt> : a <tt>binary</tt> data need to be printed.</li>
+
+<li><tt>encoding</tt> : a string notation specifies the expected encoding type. Currently we support <tt>hex</tt> and <tt>base64</tt> format.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> that represents the encoded format of a <tt>binary</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ print_binary(hex("ABCDEF0123456789"), "base64"), print_binary(base64("q83vASNFZ4k="), "hex") ]
+</pre></div></div></li>
+
+<li>
+<p>The expected result are:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ "q83vASNFZ4k=", "ABCDEF0123456789" ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="binary_length"></a>binary_length</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>binary_length(binary)</p></li>
+
+<li>
+<p>Returns the number of bytes storing the binary data.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>binary</tt> : a <tt>binary</tt> value to be checked.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>bigint</tt> that represents the number of bytes,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-binary input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>binary_length(hex("00AA"))
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+<p>2</p></li>
+</ul></div>
+<div class="section">
+<h3><a name="sub_binary"></a>sub_binary</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>sub_binary(binary, offset[, length])</p></li>
+
+<li>
+<p>Returns the sub binary from the given <tt>binary</tt> based on the given start offset with the optional <tt>length</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>binary</tt> : a <tt>binary</tt> to be extracted,</li>
+
+<li><tt>offset</tt> : a <tt>tinyint</tt>, <tt>smallint</tt>, <tt>integer</tt>, or <tt>bigint</tt> value as the starting offset of the sub binary in <tt>binary</tt>,</li>
+
+<li><tt>length</tt> : (Optional) a <tt>tinyint</tt>, <tt>smallint</tt>, <tt>integer</tt>, or <tt>bigint</tt> value as the length of the sub binary.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>binary</tt> that represents the sub binary,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-binary value,</li>
+
+<li>or, the second argument is any other non-integer value,</li>
+
+<li>or, the third argument is any other non-integer value, if it is present.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>sub_binary(hex("AABBCCDD"), 4);
+</pre></div></div></li>
+
+<li>
+<p>The expected result is</p>
+
+<div class="source">
+<div class="source">
+<pre>hex("DD")
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="binary_concat"></a>binary_concat</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>binary_concat(array)</p></li>
+
+<li>
+<p>Concatenates a binary <tt>array</tt> or <tt>multiset</tt> into a single binary.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array</tt> : an <tt>array</tt> or <tt>multiset</tt> of binaries (could be <tt>null</tt> or <tt>missing</tt>) to be concatenated.</li>
+ </ul></li>
+
+<li>Return Value :
+
+<ul>
+
+<li>the concatenated <tt>binary</tt> value,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li><tt>missing</tt> if any element in the input array is <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if any element in the input array is <tt>null</tt> but no element in the input array is <tt>missing</tt>,</li>
+
+<li>any other non-array input value or non-binary element in the input array will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+<p>binary_concat([hex(“42”), hex(""), hex(‘42’)]);</p></li>
+
+<li>
+<p>The expected result is</p>
+<p>hex(“4242”)</p></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Spatial_Functions"></a><a name="SpatialFunctions" id="SpatialFunctions">Spatial Functions</a></h2>
+<div class="section">
+<h3><a name="create_point"></a>create_point</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>create_point(x, y)
+</pre></div></div></li>
+
+<li>
+<p>Creates the primitive type <tt>point</tt> using an <tt>x</tt> and <tt>y</tt> value.</p></li>
+
+<li>Arguments:</li>
+
+<li><tt>x</tt> : a <tt>double</tt> that represents the x-coordinate,</li>
+
+<li><tt>y</tt> : a <tt>double</tt> that represents the y-coordinate.</li>
+
+<li>Return Value:</li>
+
+<li>a <tt>point</tt> representing the ordered pair (<tt>x</tt>, <tt>y</tt>),</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-double input value will cause a type error.</li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "point": create_point(30.0,70.0) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "point": point("30.0,70.0") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="create_line"></a>create_line</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>create_line(point1, point2)
+</pre></div></div></li>
+
+<li>
+<p>Creates the primitive type <tt>line</tt> using <tt>point1</tt> and <tt>point2</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>point1</tt> : a <tt>point</tt> that represents the start point of the line.</li>
+
+<li><tt>point2</tt> : a <tt>point</tt> that represents the end point of the line.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a spatial <tt>line</tt> created using the points provided in <tt>point1</tt> and <tt>point2</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-point input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "line": create_line(create_point(30.0,70.0), create_point(50.0,90.0)) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "line": line("30.0,70.0 50.0,90.0") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="create_rectangle"></a>create_rectangle</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>create_rectangle(point1, point2)
+</pre></div></div></li>
+
+<li>
+<p>Creates the primitive type <tt>rectangle</tt> using <tt>point1</tt> and <tt>point2</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>point1</tt> : a <tt>point</tt> that represents the lower_left point of the rectangle.</li>
+
+<li><tt>point2</tt> : a <tt>point</tt> that represents the upper_right point of the rectangle.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a spatial <tt>rectangle</tt> created using the points provided in <tt>point1</tt> and <tt>point2</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-point input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "rectangle": create_rectangle(create_point(30.0,70.0), create_point(50.0,90.0)) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "rectangle": rectangle("30.0,70.0 50.0,90.0") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="create_circle"></a>create_circle</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>create_circle(point, radius)
+</pre></div></div></li>
+
+<li>
+<p>Creates the primitive type <tt>circle</tt> using <tt>point</tt> and <tt>radius</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>point</tt> : a <tt>point</tt> that represents the center of the circle.</li>
+
+<li><tt>radius</tt> : a <tt>double</tt> that represents the radius of the circle.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a spatial <tt>circle</tt> created using the center point and the radius provided in <tt>point</tt> and <tt>radius</tt>.</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-point value,</li>
+
+<li>or, the second argument is any other non-double value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "circle": create_circle(create_point(30.0,70.0), 5.0) }
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "circle": circle("30.0,70.0 5.0") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="create_polygon"></a>create_polygon</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>create_polygon(array)
+</pre></div></div></li>
+
+<li>
+<p>Creates the primitive type <tt>polygon</tt> using the double values provided in the argument <tt>array</tt>. Each two consecutive double values represent a point starting from the first double value in the array. Note that at least six double values should be specified, meaning a total of three points.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array</tt> : an array of doubles representing the points of the polygon.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>polygon</tt>, represents a spatial simple polygon created using the points provided in <tt>array</tt>.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li><tt>missing</tt> if any element in the input array is <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if any element in the input array is <tt>null</tt> but no element in the input array is <tt>missing</tt>,</li>
+
+<li>any other non-array input value or non-double element in the input array will cause a type error.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "polygon": create_polygon([1.0,1.0,2.0,2.0,3.0,3.0,4.0,4.0]) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "polygon": polygon("1.0,1.0 2.0,2.0 3.0,3.0 4.0,4.0") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_xget_y"></a>get_x/get_y</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_x(point) or get_y(point)
+</pre></div></div></li>
+
+<li>
+<p>Returns the x or y coordinates of a point <tt>point</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>point</tt> : a <tt>point</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>double</tt> representing the x or y coordinates of the point <tt>point</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-point input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "x_coordinate": get_x(create_point(2.3,5.0)), "y_coordinate": get_y(create_point(2.3,5.0)) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "x_coordinate": 2.3, "y_coordinate": 5.0 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_points"></a>get_points</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_points(spatial_object)
+</pre></div></div></li>
+
+<li>
+<p>Returns an ordered array of the points forming the spatial object <tt>spatial_object</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>spatial_object</tt> : a <tt>point</tt>, <tt>line</tt>, <tt>rectangle</tt>, <tt>circle</tt>, or <tt>polygon</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>array</tt> of the points forming the spatial object <tt>spatial_object</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-spatial-object input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_points(create_polygon([1.0,1.0,2.0,2.0,3.0,3.0,4.0,4.0]))
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ point("1.0,1.0"), point("2.0,2.0"), point("3.0,3.0"), point("4.0,4.0") ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_centerget_radius"></a>get_center/get_radius</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_center(circle_expression) or get_radius(circle_expression)
+</pre></div></div></li>
+
+<li>
+<p>Returns the center and the radius of a circle <tt>circle_expression</tt>, respectively.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>circle_expression</tt> : a <tt>circle</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>point</tt> or <tt>double</tt>, represent the center or radius of the circle <tt>circle_expression</tt>.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-circle input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "circle_radius": get_radius(create_circle(create_point(6.0,3.0), 1.0)),
+ "circle_center": get_center(create_circle(create_point(6.0,3.0), 1.0))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "circle_radius": 1.0, "circle_center": point("6.0,3.0") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="spatial_distance"></a>spatial_distance</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_distance(point1, point2)
+</pre></div></div></li>
+
+<li>
+<p>Returns the Euclidean distance between <tt>point1</tt> and <tt>point2</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>point1</tt> : a <tt>point</tt>.</li>
+
+<li><tt>point2</tt> : a <tt>point</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>double</tt> as the Euclidean distance between <tt>point1</tt> and <tt>point2</tt>.</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-point input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_distance(point("47.44,80.65"), create_point(30.0,70.0));
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>20.434678857275934
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="spatial_area"></a>spatial_area</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_area(spatial_2d_expression)
+</pre></div></div></li>
+
+<li>
+<p>Returns the spatial area of <tt>spatial_2d_expression</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>spatial_2d_expression</tt> : a <tt>rectangle</tt>, <tt>circle</tt>, or <tt>polygon</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>double</tt> representing the area of <tt>spatial_2d_expression</tt>.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-2d-spatial-object will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_area(create_circle(create_point(0.0,0.0), 5.0));
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>78.53981625
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="spatial_intersect"></a>spatial_intersect</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_intersect(spatial_object1, spatial_object2)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether <tt>@arg1</tt> and <tt>@arg2</tt> spatially intersect each other.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>spatial_object1</tt> : a <tt>point</tt>, <tt>line</tt>, <tt>rectangle</tt>, <tt>circle</tt>, or <tt>polygon</tt>.</li>
+
+<li><tt>spatial_object2</tt> : a <tt>point</tt>, <tt>line</tt>, <tt>rectangle</tt>, <tt>circle</tt>, or <tt>polygon</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> representing whether <tt>spatial_object1</tt> and <tt>spatial_object2</tt> spatially overlap with each other,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-spatial-object input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_intersect(point("39.28,70.48"), create_rectangle(create_point(30.0,70.0), create_point(40.0,80.0)));
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>true
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="spatial_cell"></a>spatial_cell</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_cell(point1, point2, x_increment, y_increment)
+</pre></div></div></li>
+
+<li>
+<p>Returns the grid cell that <tt>point1</tt> belongs to.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>point1</tt> : a <tt>point</tt> representing the point of interest that its grid cell will be returned.</li>
+
+<li><tt>point2</tt> : a <tt>point</tt> representing the origin of the grid.</li>
+
+<li><tt>x_increment</tt> : a <tt>double</tt>, represents X increments.</li>
+
+<li><tt>y_increment</tt> : a <tt>double</tt>, represents Y increments.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>rectangle</tt> representing the grid cell that <tt>point1</tt> belongs to,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first or second argument is any other non-point value,</li>
+
+<li>or, the second or third argument is any other non-double value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_cell(point("39.28,70.48"), create_point(20.0,50.0), 5.5, 6.0);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>rectangle("36.5,68.0 42.0,74.0");
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Similarity_Functions"></a><a name="SimilarityFunctions" id="SimilarityFunctions">Similarity Functions</a></h2>
+<p>AsterixDB supports queries with different similarity functions, including <a class="externalLink" href="http://en.wikipedia.org/wiki/Levenshtein_distance">edit distance</a> and <a class="externalLink" href="https://en.wikipedia.org/wiki/Jaccard_index">Jaccard</a>.</p>
+<div class="section">
+<h3><a name="edit_distance"></a>edit_distance</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>edit_distance(expression1, expression2)
+</pre></div></div></li>
+
+<li>
+<p>Returns the edit distance of <tt>expression1</tt> and <tt>expression2</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expression1</tt> : a <tt>string</tt> or a homogeneous <tt>array</tt> of a comparable item type.</li>
+
+<li><tt>expression2</tt> : The same type as <tt>expression1</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>bigint</tt> that represents the edit distance between <tt>expression1</tt> and <tt>expression2</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>Note: an <a href="similarity.html#UsingIndexesToSupportSimilarityQueries">n_gram index</a> can be utilized for this function.</li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>edit_distance("SuzannaTillson", "Suzanna Tilson");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>2
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="edit_distance_check"></a>edit_distance_check</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>edit_distance_check(expression1, expression2, threshold)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the edit distance of <tt>expression1</tt> and <tt>expression2</tt> is within a given threshold.</p></li>
+
+<li>
+<p>Arguments:</p>
+
+<ul>
+
+<li><tt>expression1</tt> : a <tt>string</tt> or a homogeneous <tt>array</tt> of a comparable item type.</li>
+
+<li><tt>expression2</tt> : The same type as <tt>expression1</tt>.</li>
+
+<li><tt>threshold</tt> : a <tt>bigint</tt> that represents the distance threshold.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>array</tt> with two items:
+
+<ul>
+
+<li>The first item contains a <tt>boolean</tt> value representing whether the edit distance of <tt>expression1</tt> and <tt>expression2</tt> is within the given threshold.</li>
+
+<li>The second item contains an <tt>integer</tt> that represents the edit distance of <tt>expression1</tt> and <tt>expression2</tt> if the first item is true.</li>
+
+<li>If the first item is false, then the second item is set to 2147483647.</li>
+ </ul></li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first or second argument is any other non-string value,</li>
+
+<li>or, the third argument is any other non-bigint value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Note: an <a href="similarity.html#UsingIndexesToSupportSimilarityQueries">n_gram index</a> can be utilized for this function.</li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>edit_distance_check("happy","hapr",2);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ true, 2 ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="edit_distance_contains"></a>edit_distance_contains</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>edit_distance_contains(expression1, expression2, threshold)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether <tt>expression1</tt> contains <tt>expression2</tt> with an <a class="externalLink" href="http://en.wikipedia.org/wiki/Levenshtein_distance">edit distance</a> within a given threshold.</p></li>
+
+<li>
+<p>Arguments:</p>
+
+<ul>
+
+<li><tt>expression1</tt> : a <tt>string</tt> or a homogeneous <tt>array</tt> of a comparable item type.</li>
+
+<li><tt>expression2</tt> : The same type as <tt>expression1</tt>.</li>
+
+<li><tt>threshold</tt> : a <tt>bigint</tt> that represents the distance threshold.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>array</tt> with two items:
+
+<ul>
+
+<li>The first item contains a <tt>boolean</tt> value representing whether <tt>expression1</tt> can contain <tt>expression2</tt>.</li>
+
+<li>The second item contains an <tt>integer</tt> that represents the required edit distance for <tt>expression1</tt> to contain <tt>expression2</tt> if the first item is true.</li>
+ </ul></li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first or second argument is any other non-string value,</li>
+
+<li>or, the third argument is any other non-bigint value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Note: an <a href="similarity.html#UsingIndexesToSupportSimilarityQueries">n_gram index</a> can be utilized for this function.</li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>edit_distance_contains("happy","hapr",2);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ true, 1 ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="similarity_jaccard"></a>similarity_jaccard</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>similarity_jaccard(array1, array2)
+</pre></div></div></li>
+
+<li>
+<p>Returns the <a class="externalLink" href="http://en.wikipedia.org/wiki/Jaccard_index">Jaccard similarity</a> of <tt>array1</tt> and <tt>array2</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array1</tt> : an <tt>array</tt> or <tt>multiset</tt>.</li>
+
+<li><tt>array2</tt> : an <tt>array</tt> or <tt>multiset</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>float</tt> that represents the Jaccard similarity of <tt>array1</tt> and <tt>array2</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li><tt>missing</tt> if any element in any input array is <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if any element in any input array is <tt>null</tt> but no element in the input array is <tt>missing</tt>,</li>
+
+<li>any other non-array input value or non-integer element in any input array will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Note: a <a href="similarity.html#UsingIndexesToSupportSimilarityQueries">keyword index</a> can be utilized for this function.</p></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>similarity_jaccard([1,5,8,9], [1,5,9,10]);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>0.6
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="similarity_jaccard_check"></a>similarity_jaccard_check</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>similarity_jaccard_check(array1, array2, threshold)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether <tt>array1</tt> and <tt>array2</tt> have a <a class="externalLink" href="http://en.wikipedia.org/wiki/Jaccard_index">Jaccard similarity</a> greater than or equal to threshold. Again, the “check” version of Jaccard is faster than the “non_check” version.</p></li>
+
+<li>
+<p>Arguments:</p>
+
+<ul>
+
+<li><tt>array1</tt> : an <tt>array</tt> or <tt>multiset</tt>.</li>
+
+<li><tt>array2</tt> : an <tt>array</tt> or <tt>multiset</tt>.</li>
+
+<li><tt>threshold</tt> : a <tt>double</tt> that represents the similarity threshold.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>array</tt> with two items:
+
+<ul>
+
+<li>The first item contains a <tt>boolean</tt> value representing whether <tt>array1</tt> and <tt>array2</tt> are similar.</li>
+
+<li>The second item contains a <tt>float</tt> that represents the Jaccard similarity of <tt>array1</tt> and <tt>array2</tt> if it is greater than or equal to the threshold, or 0 otherwise.</li>
+ </ul></li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li><tt>missing</tt> if any element in any input array is <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if any element in any input array is <tt>null</tt> but no element in the input array is <tt>missing</tt>,</li>
+
+<li>a type error will be raised if: * the first or second argument is any other non-array value, * or, the third argument is any other non-double value.</li>
+ </ul></li>
+
+<li>
+<p>Note: a <a href="similarity.html#UsingIndexesToSupportSimilarityQueries">keyword index</a> can be utilized for this function.</p></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>similarity_jaccard_check([1,5,8,9], [1,5,9,10], 0.6);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ false, 0.0 ]
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Tokenizing_Functions"></a><a name="TokenizingFunctions" id="TokenizingFunctions">Tokenizing Functions</a></h2>
+<div class="section">
+<h3><a name="word_tokens"></a>word_tokens</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>word_tokens(string)
+</pre></div></div></li>
+
+<li>
+<p>Returns an array of word tokens of <tt>string</tt> using non_alphanumeric characters as delimiters.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that will be tokenized.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>array</tt> of <tt>string</tt> word tokens,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>word_tokens("I like the phone, awesome!");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ "i", "like", "the", "phone", "awesome" ]
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Temporal_Functions"></a><a name="TemporalFunctions" id="TemporalFunctions">Temporal Functions</a></h2>
+<div class="section">
+<h3><a name="get_yearget_monthget_dayget_hourget_minuteget_secondget_millisecond"></a>get_year/get_month/get_day/get_hour/get_minute/get_second/get_millisecond</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_year/get_month/get_day/get_hour/get_minute/get_second/get_millisecond(temporal_value)
+</pre></div></div></li>
+
+<li>
+<p>Accessors for accessing fields in a temporal value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>temporal_value</tt> : a temporal value represented as one of the following types: <tt>date</tt>, <tt>datetime</tt>, <tt>time</tt>, and <tt>duration</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>bigint</tt> value representing the field to be extracted,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "year": get_year(date("2010-10-30")),
+ "month": get_month(datetime("1987-11-19T23:49:23.938")),
+ "day": get_day(date("2010-10-30")),
+ "hour": get_hour(time("12:23:34.930+07:00")),
+ "min": get_minute(duration("P3Y73M632DT49H743M3948.94S")),
+ "second": get_second(datetime("1987-11-19T23:49:23.938")),
+ "ms": get_millisecond(duration("P3Y73M632DT49H743M3948.94S"))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "year": 2010, "month": 11, "day": 30, "hour": 5, "min": 28, "second": 23, "ms": 94 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="adjust_datetime_for_timezone"></a>adjust_datetime_for_timezone</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>adjust_datetime_for_timezone(datetime, string)
+</pre></div></div></li>
+
+<li>
+<p>Adjusts the given datetime <tt>datetime</tt> by applying the timezone information <tt>string</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>datetime</tt> : a <tt>datetime</tt> value to be adjusted.</li>
+
+<li><tt>string</tt> : a <tt>string</tt> representing the timezone information.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> value representing the new datetime after being adjusted by the timezone information,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-datetime value,</li>
+
+<li>or, the second argument is any other non-string value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>adjust_datetime_for_timezone(datetime("2008-04-26T10:10:00"), "+08:00");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"2008-04-26T18:10:00.000+08:00"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="adjust_time_for_timezone"></a>adjust_time_for_timezone</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>adjust_time_for_timezone(time, string)
+</pre></div></div></li>
+
+<li>
+<p>Adjusts the given time <tt>time</tt> by applying the timezone information <tt>string</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>time</tt> : a <tt>time</tt> value to be adjusted.</li>
+
+<li><tt>string</tt> : a <tt>string</tt> representing the timezone information.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> value representing the new time after being adjusted by the timezone information,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-time value,</li>
+
+<li>or, the second argument is any other non-string value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>adjust_time_for_timezone(get_time_from_datetime(datetime("2008-04-26T10:10:00")), "+08:00");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"18:10:00.000+08:00"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="calendar_duration_from_datetime"></a>calendar_duration_from_datetime</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>calendar_duration_from_datetime(datetime, duration_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets a user_friendly representation of the duration <tt>duration_value</tt> based on the given datetime <tt>datetime</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>datetime</tt> : a <tt>datetime</tt> value to be used as the reference time point.</li>
+
+<li><tt>duration_value</tt> : a <tt>duration</tt> value to be converted.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>duration</tt> value with the duration as <tt>duration_value</tt> but with a user_friendly representation,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-datetime value,</li>
+
+<li>or, the second argument is any other non-duration input value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>calendar_duration_from_datetime(
+ datetime("2016-03-26T10:10:00"),
+ datetime("2016-03-26T10:10:00") - datetime("2011-01-01T00:00:00")
+);
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>duration("P5Y2M24DT10H10M")
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_year_month_durationget_day_time_duration"></a>get_year_month_duration/get_day_time_duration</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_year_month_duration/get_day_time_duration(duration_value)
+</pre></div></div></li>
+
+<li>
+<p>Extracts the correct <tt>duration</tt> subtype from <tt>duration_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>duration_value</tt> : a <tt>duration</tt> value to be converted.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>year_month_duration</tt> value or a <tt>day_time_duration</tt> value,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-duration input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_year_month_duration(duration("P12M50DT10H"));
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>year_month_duration("P1Y")
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="months_from_year_month_durationmilliseconds_from_day_time_duration"></a>months_from_year_month_duration/milliseconds_from_day_time_duration</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>months_from_year_month_duration/milliseconds_from_day_time_duration(duration_value)
+</pre></div></div></li>
+
+<li>
+<p>Extracts the number of months or the number of milliseconds from the <tt>duration</tt> subtype.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>duration_value</tt> : a <tt>duration</tt> of the correct subtype.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>bigint</tt> representing the number or months/milliseconds,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-duration input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>months_from_year_month_duration(get_year_month_duration(duration("P5Y7MT50M")));
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>67
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="duration_from_monthsduration_from_ms"></a>duration_from_months/duration_from_ms</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>duration_from_months/duration_from_ms(number_value)
+</pre></div></div></li>
+
+<li>
+<p>Creates a <tt>duration</tt> from <tt>number_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>number_value</tt> : a <tt>bigint</tt> representing the number of months/milliseconds</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>duration</tt> containing <tt>number_value</tt> value for months/milliseconds,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-duration input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>duration_from_months(8);
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>duration("P8M")
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="duration_from_interval"></a>duration_from_interval</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>duration_from_interval(interval_value)
+</pre></div></div></li>
+
+<li>
+<p>Creates a <tt>duration</tt> from <tt>interval_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval_value</tt> : an <tt>interval</tt> value</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>duration</tt> representing the time in the <tt>interval_value</tt></li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-duration input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "dr1" : duration_from_interval(interval(date("2010-10-30"), date("2010-12-21"))),
+ "dr2" : duration_from_interval(interval(datetime("2012-06-26T01:01:01.111"), datetime("2012-07-27T02:02:02.222"))),
+ "dr3" : duration_from_interval(interval(time("12:32:38"), time("20:29:20"))),
+ "dr4" : duration_from_interval(null)
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "dr1": day_time_duration("P52D"),
+ "dr2": day_time_duration("P31DT1H1M1.111S"),
+ "dr3": day_time_duration("PT7H56M42S"),
+ "dr4": null
+}
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="current_date"></a>current_date</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>current_date()
+</pre></div></div></li>
+
+<li>
+<p>Gets the current date.</p></li>
+
+<li>Arguments: None</li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>date</tt> value of the date when the function is called.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="current_time"></a>current_time</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>current_time()
+</pre></div></div></li>
+
+<li>
+<p>Get the current time</p></li>
+
+<li>Arguments: None</li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>time</tt> value of the time when the function is called.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="current_datetime"></a>current_datetime</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>current_datetime()
+</pre></div></div></li>
+
+<li>
+<p>Get the current datetime</p></li>
+
+<li>Arguments: None</li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>datetime</tt> value of the datetime when the function is called.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_date_from_datetime"></a>get_date_from_datetime</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_date_from_datetime(datetime)
+</pre></div></div></li>
+
+<li>
+<p>Gets the date value from the given datetime value <tt>datetime</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>datetime</tt>: a <tt>datetime</tt> value to be extracted from.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>date</tt> value from the datetime,</li>
+
+<li>any other non-datetime input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_time_from_datetime"></a>get_time_from_datetime</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_time_from_datetime(datetime)
+</pre></div></div></li>
+
+<li>
+<p>Get the time value from the given datetime value <tt>datetime</tt></p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>datetime</tt>: a <tt>datetime</tt> value to be extracted from.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>time</tt> value from the datetime.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-datetime input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_time_from_datetime(datetime("2016-03-26T10:10:00"));
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>time("10:10:00.000Z")
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="day_of_week"></a>day_of_week</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>day_of_week(date)
+</pre></div></div></li>
+
+<li>
+<p>Finds the day of the week for a given date (1_7)</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>date</tt>: a <tt>date</tt> value (Can also be a <tt>datetime</tt>)</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>tinyint</tt> representing the day of the week (1_7),</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-date input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>day_of_week(datetime("2012-12-30T12:12:12.039Z"));
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>7
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="date_from_unix_time_in_days"></a>date_from_unix_time_in_days</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>date_from_unix_time_in_days(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets a date representing the time after <tt>numeric_value</tt> days since 1970_01_01.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value representing the number of days.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>date</tt> value as the time after <tt>numeric_value</tt> days since 1970-01-01,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="datetime_from_unix_time_in_ms"></a>datetime_from_unix_time_in_ms</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>datetime_from_unix_time_in_ms(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets a datetime representing the time after <tt>numeric_value</tt> milliseconds since 1970_01_01T00:00:00Z.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value representing the number of milliseconds.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>datetime</tt> value as the time after <tt>numeric_value</tt> milliseconds since 1970-01-01T00:00:00Z,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="datetime_from_unix_time_in_secs"></a>datetime_from_unix_time_in_secs</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>datetime_from_unix_time_in_secs(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets a datetime representing the time after <tt>numeric_value</tt> seconds since 1970_01_01T00:00:00Z.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value representing the number of seconds.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>datetime</tt> value as the time after <tt>numeric_value</tt> seconds since 1970_01_01T00:00:00Z,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="datetime_from_date_time"></a>datetime_from_date_time</h3>
+
+<ul>
+
+<li>Syntax:</li>
+</ul>
+<p>datetime_from_date_time(date,time)</p>
+
+<ul>
+
+<li>Gets a datetime representing the combination of <tt>date</tt> and <tt>time</tt>
+
+<ul>
+
+<li>Arguments:</li>
+
+<li><tt>date</tt>: a <tt>date</tt> value</li>
+
+<li><tt>time</tt> a <tt>time</tt> value</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>datetime</tt> value by combining <tt>date</tt> and <tt>time</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if
+
+<ul>
+
+<li>the first argument is any other non-date value,</li>
+
+<li>or, the second argument is any other non-time value.</li>
+ </ul></li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="time_from_unix_time_in_ms"></a>time_from_unix_time_in_ms</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>time_from_unix_time_in_ms(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets a time representing the time after <tt>numeric_value</tt> milliseconds since 00:00:00.000Z.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value representing the number of milliseconds.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>time</tt> value as the time after <tt>numeric_value</tt> milliseconds since 00:00:00.000Z,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "date": date_from_unix_time_in_days(15800),
+ "datetime": datetime_from_unix_time_in_ms(1365139700000),
+ "time": time_from_unix_time_in_ms(3748)
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "date": date("2013-04-05"), "datetime": datetime("2013-04-05T05:28:20.000Z"), "time": time("00:00:03.748Z") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="unix_time_from_date_in_days"></a>unix_time_from_date_in_days</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>unix_time_from_date_in_days(date_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets an integer value representing the number of days since 1970_01_01 for <tt>date_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>date_value</tt>: a <tt>date</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>bigint</tt> value representing the number of days,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-date input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="unix_time_from_datetime_in_ms"></a>unix_time_from_datetime_in_ms</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>unix_time_from_datetime_in_ms(datetime_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets an integer value representing the time in milliseconds since 1970_01_01T00:00:00Z for <tt>datetime_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>datetime_value</tt> : a <tt>datetime</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>bigint</tt> value representing the number of milliseconds,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-datetime input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="unix_time_from_datetime_in_secs"></a>unix_time_from_datetime_in_secs</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>unix_time_from_datetime_in_secs(datetime_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets an integer value representing the time in seconds since 1970_01_01T00:00:00Z for <tt>datetime_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>datetime_value</tt> : a <tt>datetime</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>bigint</tt> value representing the number of seconds,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-datetime input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="unix_time_from_time_in_ms"></a>unix_time_from_time_in_ms</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>unix_time_from_time_in_ms(time_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets an integer value representing the time the milliseconds since 00:00:00.000Z for <tt>time_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>time_value</tt> : a <tt>time</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>bigint</tt> value representing the number of milliseconds,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-datetime input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "date": date_from_unix_time_in_days(15800),
+ "datetime": datetime_from_unix_time_in_ms(1365139700000),
+ "time": time_from_unix_time_in_ms(3748)
+}
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "date": date("2013-04-05"), "datetime": datetime("2013-04-05T05:28:20.000Z"), "time": time("00:00:03.748Z") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="parse_dateparse_timeparse_datetime"></a>parse_date/parse_time/parse_datetime</h3>
+
+<ul>
+
+<li>Syntax:</li>
+</ul>
+<p>parse_date/parse_time/parse_datetime(date,formatting_expression)</p>
+
+<ul>
+
+<li>Creates a <tt>date/time/date_time</tt> value by treating <tt>date</tt> with formatting <tt>formatting_expression</tt></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>date</tt>: a <tt>string</tt> value representing the <tt>date/time/datetime</tt>.</li>
+
+<li><tt>formatting_expression</tt> a <tt>string</tt> value providing the formatting for <tt>date_expression</tt>.Characters used to create date expression:</li>
+
+<li><tt>h</tt> hours</li>
+
+<li><tt>m</tt> minutes</li>
+
+<li><tt>s</tt> seconds</li>
+
+<li><tt>n</tt> milliseconds</li>
+
+<li><tt>a</tt> am/pm</li>
+
+<li><tt>z</tt> timezone</li>
+
+<li><tt>Y</tt> year</li>
+
+<li><tt>M</tt> month</li>
+
+<li><tt>D</tt> day</li>
+
+<li><tt>W</tt> weekday</li>
+
+<li><tt>_</tt>, <tt>'</tt>, <tt>/</tt>, <tt>.</tt>, <tt>,</tt>, <tt>T</tt> seperators for both time and date</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>date/time/date_time</tt> value corresponding to <tt>date</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:</li>
+
+<li>the first argument is any other non-date value,</li>
+
+<li>the second argument is any other non-string value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>parse_time("30:30","m:s");
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>time("00:30:30.000Z")
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="print_dateprint_timeprint_datetime"></a>print_date/print_time/print_datetime</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>print_date/print_time/print_datetime(date,formatting_expression)
+</pre></div></div></li>
+
+<li>
+<p>Creates a <tt>string</tt> representing a <tt>date/time/date_time</tt> value of the <tt>date</tt> using the formatting <tt>formatting_expression</tt></p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>date</tt>: a <tt>date/time/datetime</tt> value.</li>
+
+<li><tt>formatting_expression</tt> a <tt>string</tt> value providing the formatting for <tt>date_expression</tt>. Characters used to create date expression:</li>
+
+<li><tt>h</tt> hours</li>
+
+<li><tt>m</tt> minutes</li>
+
+<li><tt>s</tt> seconds</li>
+
+<li><tt>n</tt> milliseconds</li>
+
+<li><tt>a</tt> am/pm</li>
+
+<li><tt>z</tt> timezone</li>
+
+<li><tt>Y</tt> year</li>
+
+<li><tt>M</tt> month</li>
+
+<li><tt>D</tt> day</li>
+
+<li><tt>W</tt> weekday</li>
+
+<li><tt>_</tt>, <tt>'</tt>, <tt>/</tt>, <tt>.</tt>, <tt>,</tt>, <tt>T</tt> seperators for both time and date</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> value corresponding to <tt>date</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-date value,</li>
+
+<li>the second argument is any other non-string value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>print_time(time("00:30:30.000Z"),"m:s");
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"30:30"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_interval_start_get_interval_end"></a>get_interval_start, get_interval_end</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_interval_start/get_interval_end(interval)
+</pre></div></div></li>
+
+<li>
+<p>Gets the start/end of the given interval.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval</tt>: the interval to be accessed.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>time</tt>, <tt>date</tt>, or <tt>datetime</tt> (depending on the time instances of the interval) representing the starting or ending time,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-interval value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "start": get_interval_start(interval_start_from_date("1984-01-01", "P1Y")),
+ "end": get_interval_end(interval_start_from_date("1984-01-01", "P1Y"))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "start": date("1984_01_01"), "end": date("1985_01_01") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_interval_start_dateget_interval_start_datetimeget_interval_start_time_get_interval_end_dateget_interval_end_datetimeget_interval_end_time"></a>get_interval_start_date/get_interval_start_datetimeget_interval_start_time, get_interval_end_date/get_interval_end_datetime/get_interval_end_time</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_interval_start_date/get_interval_start_datetime/get_interval_start_time/get_interval_end_date/get_interval_end_datetime/get_interval_end_time(interval)
+</pre></div></div></li>
+
+<li>
+<p>Gets the start/end of the given interval for the specific date/datetime/time type.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval</tt>: the interval to be accessed.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>time</tt>, <tt>date</tt>, or <tt>datetime</tt> (depending on the function) representing the starting or ending time,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-interval value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "start1": get_interval_start_date(interval_start_from_date("1984-01-01", "P1Y")),
+ "end1": get_interval_end_date(interval_start_from_date("1984-01-01", "P1Y")),
+ "start2": get_interval_start_datetime(interval_start_from_datetime("1984-01-01T08:30:00.000", "P1Y1H")),
+ "end2": get_interval_end_datetime(interval_start_from_datetime("1984-01-01T08:30:00.000", "P1Y1H")),
+ "start3": get_interval_start_time(interval_start_from_time("08:30:00.000", "P1H")),
+ "end3": get_interval_end_time(interval_start_from_time("08:30:00.000", "P1H"))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "start1": date("1984-01-01"),
+ "end1": date("1985-01-01"),
+ "start2": datetime("1984-01-01T08:30:00.000Z"),
+ "end2": datetime("1985-01-01T09:30:00.000Z"),
+ "start3": time("08:30:00.000Z"),
+ "end3": time("09:30:00.000Z")
+}
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_overlapping_interval"></a>get_overlapping_interval</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_overlapping_interval(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>Gets the start/end of the given interval for the specific date/datetime/time type.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>: an <tt>interval</tt> value</li>
+
+<li><tt>interval2</tt>: an <tt>interval</tt> value</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>interval</tt> that is overlapping <tt>interval1</tt> and <tt>interval2</tt>. If <tt>interval1</tt> and <tt>interval2</tt> do not overlap <tt>null</tt> is returned. Note each interval must be of the same type.</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "overlap1": get_overlapping_interval(interval(time("11:23:39"), time("18:27:19")), interval(time("12:23:39"), time("23:18:00"))),
+ "overlap2": get_overlapping_interval(interval(time("12:23:39"), time("18:27:19")), interval(time("07:19:39"), time("09:18:00"))),
+ "overlap3": get_overlapping_interval(interval(date("1980-11-30"), date("1999-09-09")), interval(date("2013-01-01"), date("2014-01-01"))),
+ "overlap4": get_overlapping_interval(interval(date("1980-11-30"), date("2099-09-09")), interval(date("2013-01-01"), date("2014-01-01"))),
+ "overlap5": get_overlapping_interval(interval(datetime("1844-03-03T11:19:39"), datetime("2000-10-30T18:27:19")), interval(datetime("1989-03-04T12:23:39"), datetime("2009-10-10T23:18:00"))),
+ "overlap6": get_overlapping_interval(interval(datetime("1989-03-04T12:23:39"), datetime("2000-10-30T18:27:19")), interval(datetime("1844-03-03T11:19:39"), datetime("1888-10-10T23:18:00")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "overlap1": interval(time("12:23:39.000Z"), time("18:27:19.000Z")),
+ "overlap2": null,
+ "overlap3": null,
+ "overlap4": interval(date("2013-01-01"), date("2014_01_01")),
+ "overlap5": interval(datetime("1989-03-04T12:23:39.000Z"), datetime("2000-10-30T18:27:19.000Z")),
+ "overlap6": null
+}
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_bin"></a>interval_bin</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_bin(time_to_bin, time_bin_anchor, duration_bin_size)
+</pre></div></div></li>
+
+<li>
+<p>Returns the <tt>interval</tt> value representing the bin containing the <tt>time_to_bin</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>time_to_bin</tt>: a date/time/datetime value representing the time to be binned.</li>
+
+<li><tt>time_bin_anchor</tt>: a date/time/datetime value representing an anchor of a bin starts. The type of this argument should be the same as the first <tt>time_to_bin</tt> argument.</li>
+
+<li><tt>duration_bin_size</tt>: the duration value representing the size of the bin, in the type of year_month_duration or day_time_duration. The type of this duration should be compatible with the type of <tt>time_to_bin</tt>, so that the arithmetic operation between <tt>time_to_bin</tt> and <tt>duration_bin_size</tt> is well_defined. Currently AsterixDB supports the following arithmetic operations:
+
+<ul>
+
+<li>datetime +|_ year_month_duration</li>
+
+<li>datetime +|_ day_time_duration</li>
+
+<li>date +|_ year_month_duration</li>
+
+<li>date +|_ day_time_duration</li>
+
+<li>time +|_ day_time_duration</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>interval</tt> value representing the bin containing the <tt>time_to_bin</tt> value. Note that the internal type of this interval value should be the same as the <tt>time_to_bin</tt> type,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument or the second argument is any other non-date/non-time/non-datetime value,</li>
+
+<li>or, the second argument is any other non-year_month_duration/non-day_time_duration value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "bin1": interval_bin(date("2010-10-30"), date("1990-01-01"), year_month_duration("P1Y")),
+ "bin2": interval_bin(datetime("1987-11-19T23:49:23.938"), datetime("1990-01-01T00:00:00.000Z"), year_month_duration("P6M")),
+ "bin3": interval_bin(time("12:23:34.930+07:00"), time("00:00:00"), day_time_duration("PT1M")),
+ "bin4": interval_bin(datetime("1987-11-19T23:49:23.938"), datetime("2013-01-01T00:00:00.000"), day_time_duration("PT24H"))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "bin1": interval(date("2010-01-01"),date("2011-01-01")),
+ "bin2": interval(datetime("1987-07-01T00:00:00.000Z"), datetime("1988-01-01T00:00:00.000Z")),
+ "bin3": interval(time("05:23:00.000Z"), time("05:24:00.000Z")),
+ "bin4": interval(datetime("1987-11-19T00:00:00.000Z"), datetime("1987-11-20T00:00:00.000Z"))
+}
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_start_from_datetimedatetime"></a>interval_start_from_date/time/datetime</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_start_from_date/time/datetime(date/time/datetime, duration)
+</pre></div></div></li>
+
+<li>
+<p>Construct an <tt>interval</tt> value by the given starting <tt>date</tt>/<tt>time</tt>/<tt>datetime</tt> and the <tt>duration</tt> that the interval lasts.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>date/time/datetime</tt>: a <tt>string</tt> representing a <tt>date</tt>, <tt>time</tt> or <tt>datetime</tt>, or a <tt>date</tt>/<tt>time</tt>/<tt>datetime</tt> value, representing the starting time point.</li>
+
+<li><tt>duration</tt>: a <tt>string</tt> or <tt>duration</tt> value representing the duration of the interval. Note that duration cannot be negative value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>interval</tt> value representing the interval starting from the given time point with the length of duration,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument or the second argument is any other non-date/non-time/non-datetime value,</li>
+
+<li>or, the second argument is any other non-duration value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "interval1": interval_start_from_date("1984-01-01", "P1Y"),
+ "interval2": interval_start_from_time(time("02:23:28.394"), "PT3H24M"),
+ "interval3": interval_start_from_datetime("1999-09-09T09:09:09.999", duration("P2M30D"))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expectecd result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "interval1": interval(date("1984-01-01"), date("1985-01-01")),
+ "interval2": interval(time("02:23:28.394Z"), time("05:47:28.394Z")),
+ "interval3": interval(datetime("1999-09-09T09:09:09.999Z"), datetime("1999-12-09T09:09:09.999Z"))
+}
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="overlap_bins"></a>overlap_bins</h3>
+
+<ul>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a <tt>interval</tt> value representing the bin containing the <tt>time_to_bin</tt> value. Note that the internal type of this interval value should be the same as the <tt>time_to_bin</tt> type.</li>
+ </ul></li>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>overlap_bins(interval, time_bin_anchor, duration_bin_size)
+</pre></div></div></li>
+
+<li>
+<p>Returns an ordered list of <tt>interval</tt> values representing each bin that is overlapping the <tt>interval</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval</tt>: an <tt>interval</tt> value</li>
+
+<li><tt>time_bin_anchor</tt>: a date/time/datetime value representing an anchor of a bin starts. The type of this argument should be the same as the first <tt>time_to_bin</tt> argument.</li>
+
+<li><tt>duration_bin_size</tt>: the duration value representing the size of the bin, in the type of year_month_duration or day_time_duration. The type of this duration should be compatible with the type of <tt>time_to_bin</tt>, so that the arithmetic operation between <tt>time_to_bin</tt> and <tt>duration_bin_size</tt> is well_defined. Currently AsterixDB supports the following arithmetic operations:
+
+<ul>
+
+<li>datetime +|_ year_month_duration</li>
+
+<li>datetime +|_ day_time_duration</li>
+
+<li>date +|_ year_month_duration</li>
+
+<li>date +|_ day_time_duration</li>
+
+<li>time +|_ day_time_duration</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a ordered list of <tt>interval</tt> values representing each bin that is overlapping the <tt>interval</tt>. Note that the internal type as <tt>time_to_bin</tt> and <tt>duration_bin_size</tt>.</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first arugment is any other non-interval value,</li>
+
+<li>or, the second argument is any other non-date/non-time/non-datetime value,</li>
+
+<li>or, the second argument is any other non-year_month_duration/non-day_time_duration value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "timebins": overlap_bins(interval(time("17:23:37"), time("18:30:21")), time("00:00:00"), day_time_duration("PT30M")),
+ "datebins": overlap_bins(interval(date("1984-03-17"), date("2013-08-22")), date("1990-01-01"), year_month_duration("P10Y")),
+ "datetimebins": overlap_bins(interval(datetime("1800-01-01T23:59:48.938"), datetime("2015-07-26T13:28:30.218")),
+ datetime("1900-01-01T00:00:00.000"), year_month_duration("P100Y"))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "timebins": [
+ interval(time("17:00:00.000Z"), time("17:30:00.000Z")),
+ interval(time("17:30:00.000Z"), time("18:00:00.000Z")),
+ interval(time("18:00:00.000Z"), time("18:30:00.000Z")),
+ interval(time("18:30:00.000Z"), time("19:00:00.000Z"))
+ ],
+ "datebins": [
+ interval(date("1980-01-01"), date("1990-01-01")),
+ interval(date("1990-01-01"), date("2000-01-01")),
+ interval(date("2000-01-01"), date("2010-01-01")),
+ interval(date("2010-01-01"), date("2020-01-01"))
+ ],
+ "datetimebins": [
+ interval(datetime("1800-01-01T00:00:00.000Z"), datetime("1900-01-01T00:00:00.000Z")),
+ interval(datetime("1900-01-01T00:00:00.000Z"), datetime("2000-01-01T00:00:00.000Z")),
+ interval(datetime("2000-01-01T00:00:00.000Z"), datetime("2100-01-01T00:00:00.000Z"))
+ ]
+};
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div>
+<div class="section">
+<h3><a name="interval_before_interval_after"></a>interval_before, interval_after</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_before(interval1, interval2)
+interval_after(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>These two functions check whether an interval happens before/after another interval.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_before(interval1, interval2)</tt> is true if and only if <tt>interval1.end < interval2.start</tt>, and <tt>interval_after(interval1, interval2)</tt> is true if and only if <tt>interval1.start > interval2.end</tt>.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "interval_before": interval_before(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("2005-05-01"), date("2012-09-09"))),
+ "interval_after": interval_after(interval(date("2005-05-01"), date("2012-09-09")),
+ interval(date("2000-01-01"), date("2005-01-01")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "interval_before": true, "interval_after": true }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_covers_interval_covered_by"></a>interval_covers, interval_covered_by</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_covers(interval1, interval2)
+interval_covered_by(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>These two functions check whether one interval covers the other interval.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_covers(interval1, interval2)</tt> is true if and only if</li>
+ </ul>
+
+<div class="source">
+<div class="source">
+<pre>interval1.start <= interval2.start AND interval1.end >= interval2.end
+
+`interval_covered_by(interval1, interval2)` is true if and only if
+
+interval2.start <= interval1.start AND interval2.end >= interval1.end
+</pre></div></div>
+
+<ul>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "interval_covers": interval_covers(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("2000-03-01"), date("2004-09-09"))),
+ "interval_covered_by": interval_covered_by(interval(date("2006-08-01"), date("2007-03-01")),
+ interval(date("2004-09-10"), date("2012-08-01")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "interval_covers": true, "interval_covered_by": true }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_overlaps_interval_overlapped_by"></a>interval_overlaps, interval_overlapped_by</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_overlaps(interval1, interval2)
+interval_overlapped_by(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>These functions check whether two intervals overlap with each other.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_overlaps(interval1, interval2)</tt> is true if and only if</li>
+ </ul>
+
+<div class="source">
+<div class="source">
+<pre>interval1.start < interval2.start
+AND interval2.end > interval1.end
+AND interval1.end > interval2.start
+</pre></div></div>
+<p><tt>interval_overlapped_by(interval1, interval2)</tt> is true if and only if</p>
+
+<div class="source">
+<div class="source">
+<pre>interval2.start < interval1.start
+AND interval1.end > interval2.end
+AND interval2.end > interval1.start
+</pre></div></div>
+
+<ul>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul>
+<p>Note that <tt>interval_overlaps</tt> and <tt>interval_overlapped_by</tt> are following the Allen’s relations on the definition of overlap.</p></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "overlaps": interval_overlaps(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("2004-05-01"), date("2012-09-09"))),
+ "overlapped_by": interval_overlapped_by(interval(date("2006-08-01"), date("2007-03-01")),
+ interval(date("2004-05-01"), date("2012-09-09"))))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "overlaps": true, "overlapped_by": true }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_overlapping"></a>interval_overlapping</h3>
+<p>Note that <tt>interval_overlapping</tt> is not an Allen’s Relation, but syntactic sugar we added for the case that the intersect of two intervals is not empty. Basically this function returns true if any of these functions return true: <tt>interval_overlaps</tt>, <tt>interval_overlapped_by</tt>, <tt>interval_covers</tt>, or <tt>interval_covered_by</tt>.</p>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_overlapping(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>This functions check whether two intervals share any points with each other.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_overlapping(interval1, interval2)</tt> is true if</li>
+ </ul>
+
+<div class="source">
+<div class="source">
+<pre>interval1.start < interval2.end
+AND interval1.end > interval2.start
+</pre></div></div>
+
+<ul>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "overlapping1": interval_overlapping(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("2004-05-01"), date("2012-09-09"))),
+ "overlapping2": interval_overlapping(interval(date("2006-08-01"), date("2007-03-01")),
+ interval(date("2004-09-10"), date("2006-12-31")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "overlapping1": true, "overlapping2": true }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_meets_interval_met_by"></a>interval_meets, interval_met_by</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_meets(interval1, interval2)
+interval_met_by(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>These two functions check whether an interval meets with another interval.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_meets(interval1, interval2)</tt> is true if and only if <tt>interval1.end = interval2.start</tt>, and <tt>interval_met_by(interval1, interval2)</tt> is true if and only if <tt>interval1.start = interval2.end</tt>. If any of the two inputs is <tt>null</tt>, <tt>null</tt> is returned.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "meets": interval_meets(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("2005-01-01"), date("2012-09-09"))),
+ "metby": interval_met_by(interval(date("2006-08-01"), date("2007-03-01")),
+ interval(date("2004-09-10"), date("2006-08-01")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "meets": true, "metby": true }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_starts_interval_started_by"></a>interval_starts, interval_started_by</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_starts(interval1, interval2)
+interval_started_by(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>These two functions check whether one interval starts with the other interval.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_starts(interval1, interval2)</tt> returns true if and only if</li>
+ </ul>
+
+<div class="source">
+<div class="source">
+<pre>interval1.start = interval2.start
+AND interval1.end <= interval2.end
+</pre></div></div>
+<p><tt>interval_started_by(interval1, interval2)</tt> returns true if and only if</p>
+
+<div class="source">
+<div class="source">
+<pre>interval1.start = interval2.start
+AND interval2.end <= interval1.end
+</pre></div></div>
+
+<ul>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "interval_starts": interval_starts(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("2000-01-01"), date("2012-09-09"))),
+ "interval_started_by": interval_started_by(interval(date("2006-08-01"), date("2007-03-01")),
+ interval(date("2006-08-01"), date("2006-08-02")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "interval_starts": true, "interval_started_by": true }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_ends_interval_ended_by"></a>interval_ends, interval_ended_by</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_ends(interval1, interval2)
+interval_ended_by(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>These two functions check whether one interval ends with the other interval.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_ends(interval1, interval2)</tt> returns true if and only if</li>
+ </ul>
+
+<div class="source">
+<div class="source">
+<pre>interval1.end = interval2.end
+AND interval1.start >= interval2.start
+
+`interval_ended_by(interval1, interval2)` returns true if and only if
+
+interval2.end = interval1.end
+AND interval2.start >= interval1.start
+</pre></div></div>
+
+<ul>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "interval_ends": interval_ends(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("1998-01-01"), date("2005-01-01"))),
+ "interval_ended_by": interval_ended_by(interval(date("2006-08-01"), date("2007-03-01")),
+ interval(date("2006-09-10"), date("2007-03-01")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "interval_ends": true, "interval_ended_by": true }
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Object_Functions"></a><a name="ObjectFunctions" id="ObjectFunctions">Object Functions</a></h2>
+<div class="section">
+<h3><a name="get_object_fields"></a>get_object_fields</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_object_fields(input_object)
+</pre></div></div></li>
+
+<li>
+<p>Access the object field names, type and open status for a given object.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>input_object</tt> : a object value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an array of <tt>object</tt> values that include the field_name <tt>string</tt>, field_type <tt>string</tt>, is_open <tt>boolean</tt> (used for debug purposes only: <tt>true</tt> if field is open and <tt>false</tt> otherwise), and optional nested <tt>orderedList</tt> for the values of a nested object,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-object input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_object_fields(
+ {
+ "id": 1,
+ "project": "AsterixDB",
+ "address": {"city": "Irvine", "state": "CA"},
+ "related": ["Hivestrix", "Preglix", "Apache VXQuery"]
+ }
+ );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[
+ { "field-name": "id", "field-type": "INT64", "is-open": false },
+ { "field-name": "project", "field-type": "STRING", "is-open": false },
+ { "field-name": "address", "field-type": "RECORD", "is-open": false,
+ "nested": [
+ { "field-name": "city", "field-type": "STRING", "is-open": false },
+ { "field-name": "state", "field-type": "STRING", "is-open": false }
+ ]
+ },
+ { "field-name":
+ "related",
+ "field-type": "ORDEREDLIST",
+ "is-open": false,
+ "list": [
+ { "field-type": "STRING" },
+ { "field-type": "STRING" },
+ { "field-type": "STRING" }
+ ]
+ }
+]
+</pre></div></div></li>
+</ul>
+<p>]</p></div>
+<div class="section">
+<h3><a name="get_object_field_value"></a>get_object_field_value</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_object_field_value(input_object, string)
+</pre></div></div></li>
+
+<li>
+<p>Access the field name given in the <tt>string_expression</tt> from the <tt>object_expression</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>input_object</tt> : a <tt>object</tt> value.</li>
+
+<li><tt>string</tt> : a <tt>string</tt> representing the top level field name.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>any</tt> value saved in the designated field of the object,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-object value,</li>
+
+<li>or, the second argument is any other non-string value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_object_field_value({
+ "id": 1,
+ "project": "AsterixDB",
+ "address": {"city": "Irvine", "state": "CA"},
+ "related": ["Hivestrix", "Preglix", "Apache VXQuery"]
+ },
+ "project"
+ );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"AsterixDB"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="object_remove_fields"></a>object_remove_fields</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>object_remove_fields(input_object, field_names)
+</pre></div></div></li>
+
+<li>
+<p>Remove indicated fields from a object given a list of field names.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>input_object</tt>: a object value.</li>
+
+<li><tt>field_names</tt>: an array of strings and/or array of array of strings.</li>
+ </ul></li>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a new object value without the fields listed in the second argument,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-object value,</li>
+
+<li>or, the second argument is any other non-array value or recursively contains non-string items.</li>
+ </ul></li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>object_remove_fields(
+ {
+ "id":1,
+ "project":"AsterixDB",
+ "address":{"city":"Irvine", "state":"CA"},
+ "related":["Hivestrix", "Preglix", "Apache VXQuery"]
+ },
+ [["address", "city"], "related"]
+ );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "id":1,
+ "project":"AsterixDB",
+ "address":{ "state": "CA" }
+}
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="object_add_fields"></a>object_add_fields</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>object_add_fields(input_object, fields)
+</pre></div></div></li>
+
+<li>
+<p>Add fields to a object given a list of field names.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>input_object</tt> : a object value.</li>
+
+<li><tt>fields</tt>: an array of field descriptor objects where each object has field_name and field_value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a new object value with the new fields included,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-object value,</li>
+
+<li>the second argument is any other non-array value, or contains non-object items.</li>
+ </ul></li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>object_add_fields(
+ {
+ "id":1,
+ "project":"AsterixDB",
+ "address":{"city":"Irvine", "state":"CA"},
+ "related":["Hivestrix", "Preglix", "Apache VXQuery"]
+ },
+ [{"field-name":"employment_location", "field-value":create_point(30.0,70.0)}]
+ );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "id":1,
+ "project":"AsterixDB",
+ "address":{"city":"Irvine", "state":"CA"},
+ "related":["Hivestrix", "Preglix", "Apache VXQuery"]
+ "employment_location": point("30.0,70.0")
+ }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="object_merge"></a>object_merge</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>object_merge(object1, object2)
+</pre></div></div></li>
+
+<li>
+<p>Merge two different objects into a new object.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>object1</tt> : a object value.</li>
+
+<li><tt>object2</tt> : a object value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a new object value with fields from both input objects. If a field’s names in both objects are the same, an exception is issued,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-object input value will cause a type error.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>object_merge(
+ {
+ "id":1,
+ "project":"AsterixDB",
+ "address":{"city":"Irvine", "state":"CA"},
+ "related":["Hivestrix", "Preglix", "Apache VXQuery"]
+ },
+ {
+ "user_id": 22,
+ "employer": "UC Irvine",
+ "employment_type": "visitor"
+ }
+ );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "employment_type": "visitor",
+ "address": {
+ "city": "Irvine",
+ "state": "CA"
+ },
+ "related": [
+ "Hivestrix",
+ "Preglix",
+ "Apache VXQuery"
+ ],
+ "user_id": 22,
+ "project": "AsterixDB",
+ "employer": "UC Irvine",
+ "id": 1
+}
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Aggregate_Functions_Array_Functions"></a><a name="AggregateFunctions" id="AggregateFunctions">Aggregate Functions (Array Functions) </a></h2>
+<p>This section contains detailed descriptions of each SQL++ aggregate function (i.e., array function). Note that as described in the SQL++ query reference documentation, standard SQL aggregate functions (e.g., <tt>MIN</tt>, <tt>MAX</tt>, <tt>SUM</tt>, <tt>COUNT</tt>, and <tt>AVG</tt>) are not real functions in SQL++ but just syntactic sugars over corresponding SQL++ builtin aggregate functions (e.g., <tt>ARRAY_MIN</tt>, <tt>ARRAY_MAX</tt>, <tt>ARRAY_SUM</tt>, <tt>ARRAY_COUNT</tt>, and <tt>ARRAY_AVG</tt>).</p>
+<div class="section">
+<h3><a name="array_count"></a>array_count</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_count(collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the number of non-null and non-missing items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt> to be counted,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>bigint</tt> value representing the number of non-null and non-missing items in the given collection,</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li>any other non-array and non-multiset input value will cause an error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_count( ['hello', 'world', 1, 2, 3, null, missing] );
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>5
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="array_avg"></a>array_avg</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_avg(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the average value of the non-null and non-missing numeric items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt> containing numeric values, <tt>null</tt>s or <tt>missing</tt>s,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>double</tt> value representing the average of the non-null and non-missing numbers in the given collection,</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if the given collection does not contain any non-null and non-missing items,</li>
+
+<li>any other non-array and non-multiset input value will cause a type error,</li>
+
+<li>any other non-numeric value in the input collection will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_avg( [1.2, 2.3, 3.4, 0, null] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>1.725
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="array_sum"></a>array_sum</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_sum(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the sum of non-null and non-missing items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt> containing numeric values, <tt>null</tt>s or <tt>missing</tt>s,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the sum of the non-null and non-missing numbers in the given collection. The returning type is decided by the item type with the highest order in the numeric type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among items.</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if the given collection does not contain any non-null and non-missing items,</li>
+
+<li>any other non-array and non-multiset input value will cause a type error,</li>
+
+<li>any other non-numeric value in the input collection will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_sum( [1.2, 2.3, 3.4, 0, null, missing] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>6.9
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="array_sql_min"></a>array_sql_min</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_min(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the min value of non-null and non-missing comparable items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt>,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the min value of non-null and non-missing values in the given collection. The returning type is decided by the item type with the highest order in the type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among numeric items.</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if the given collection does not contain any non-null and non-missing items,</li>
+
+<li>multiple incomparable items in the input array or multiset will cause a type error,</li>
+
+<li>any other non-array and non-multiset input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_min( [1.2, 2.3, 3.4, 0, null, missing] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>0.0
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="array_max"></a>array_max</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_max(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the max value of the non-null and non-missing comparable items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt>,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the max value of non-null and non-missing numbers in the given collection. The returning type is decided by the item type with the highest order in the type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among numeric items.</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if the given collection does not contain any non-null and non-missing items,</li>
+
+<li>multiple incomparable items in the input array or multiset will cause a type error,</li>
+
+<li>any other non-array and non-multiset input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_max( [1.2, 2.3, 3.4, 0, null, missing] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>3.4
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="coll_count"></a>coll_count</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_count(collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the number of items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt> containing the items to be counted,</li>
+
+<li>or a <tt>null</tt> value,</li>
+
+<li>or a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>bigint</tt> value representing the number of items in the given collection,</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_count( [1, 2, null, missing] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>4
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="coll_avg"></a>coll_avg</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_avg(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the average value of the numeric items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt> containing numeric values, <tt>null</tt>s or <tt>missing</tt>s,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>double</tt> value representing the average of the numbers in the given collection,</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if there is a <tt>null</tt> or <tt>missing</tt> in the input collection,</li>
+
+<li>any other non-numeric value in the input collection will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_avg( [100, 200, 300] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ 200.0 ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="coll_sum"></a>coll_sum</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_sum(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the sum of the items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt> containing numeric values, <tt>null</tt>s or <tt>missing</tt>s,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the sum of the numbers in the given collection. The returning type is decided by the item type with the highest order in the numeric type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among items.</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if there is a <tt>null</tt> or <tt>missing</tt> in the input collection,</li>
+
+<li>any other non-numeric value in the input collection will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_sum( [100, 200, 300] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>600
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="array_min"></a>array_min</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_min(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the min value of comparable items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt>,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the min value of the given collection. The returning type is decided by the item type with the highest order in the type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among numeric items.</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if there is a <tt>null</tt> or <tt>missing</tt> in the input collection,</li>
+
+<li>multiple incomparable items in the input array or multiset will cause a type error,</li>
+
+<li>any other non-array and non-multiset input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_min( [10.2, 100, 5] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>5.0
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="array_max"></a>array_max</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_max(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the max value of numeric items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt>,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>The max value of the given collection. The returning type is decided by the item type with the highest order in the type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among numeric items.</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if there is a <tt>null</tt> or <tt>missing</tt> in the input collection,</li>
+
+<li>multiple incomparable items in the input array or multiset will cause a type error,</li>
+
+<li>any other non-array and non-multiset input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_max( [10.2, 100, 5] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>100.0
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Comparison_Functions"></a><a name="ComparisonFunctions" id="ComparisonFunctions">Comparison Functions</a></h2>
+<div class="section">
+<h3><a name="greatest"></a>greatest</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>greatest(numeric_value1, numeric_value2, ...)
+</pre></div></div></li>
+
+<li>
+<p>Computes the greatest value among arguments.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value1</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li><tt>numeric_value2</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li>….</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the greatest values among arguments. The returning type is decided by the item type with the highest order in the numeric type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among items.</li>
+
+<li><tt>null</tt> if any argument is a <tt>missing</tt> value or <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": greatest(1, 2, 3), "v2": greatest(float("0.5"), double("-0.5"), 5000) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 3, "v2": 5000.0 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="least"></a>least</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>least(numeric_value1, numeric_value2, ...)
+</pre></div></div></li>
+
+<li>
+<p>Computes the least value among arguments.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value1</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li><tt>numeric_value2</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li>….</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the least values among arguments. The returning type is decided by the item type with the highest order in the numeric type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among items.</li>
+
+<li><tt>null</tt> if any argument is a <tt>missing</tt> value or <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": least(1, 2, 3), "v2": least(float("0.5"), double("-0.5"), 5000) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1, "v2": -0.5 }
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Type_Functions"></a><a name="TypeFunctions" id="TypeFunctions">Type Functions</a></h2>
+<div class="section">
+<h3><a name="is_array_isarray"></a>is_array (isarray)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_array(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be an <tt>array</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the argument is an <tt>array</tt> value or not,</li>
+
+<li>a <tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li>a <tt>null</tt> if the argument is a <tt>null</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": is_array(true),
+ "b": is_array(false),
+ "c": isarray(null),
+ "d": isarray(missing),
+ "e": isarray("d"),
+ "f": isarray(4.0),
+ "g": isarray(5),
+ "h": isarray(["1", 2]),
+ "i": isarray({"a":1})
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": false, "b": false, "c": null, "e": false, "f": false, "g": false, "h": true, "i": false }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>isarray</tt>.</p></div>
+<div class="section">
+<h3><a name="is_boolean_isboolean_isbool"></a>is_boolean (isboolean, isbool)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_boolean(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be a <tt>boolean</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the argument is a <tt>boolean</tt> value or not,</li>
+
+<li>a <tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li>a <tt>null</tt> if the argument is a <tt>null</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": isboolean(true),
+ "b": isboolean(false),
+ "c": is_boolean(null),
+ "d": is_boolean(missing),
+ "e": isbool("d"),
+ "f": isbool(4.0),
+ "g": isbool(5),
+ "h": isbool(["1", 2]),
+ "i": isbool({"a":1})
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": true, "b": true, "c": null, "e": false, "f": false, "g": false, "h": false, "i": false }
+</pre></div></div></li>
+</ul>
+<p>The function has two aliases, <tt>isboolean</tt> or <tt>isbool</tt>.</p></div>
+<div class="section">
+<h3><a name="is_number_isnumber_isnum"></a>is_number (isnumber, isnum)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_number(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be a numeric value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the argument is a <tt>smallint</tt>/<tt>tinyint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value or not,</li>
+
+<li>a <tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li>a <tt>null</tt> if the argument is a <tt>null</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": is_number(true),
+ "b": is_number(false),
+ "c": isnumber(null),
+ "d": isnumber(missing),
+ "e": isnumber("d"),
+ "f": isnum(4.0),
+ "g": isnum(5),
+ "h": isnum(["1", 2]),
+ "i": isnum({"a":1})
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": false, "b": false, "c": null, "e": false, "f": true, "g": true, "h": false, "i": false }
+</pre></div></div></li>
+</ul>
+<p>The function has two aliases, <tt>isnumber</tt> or <tt>isnum</tt>.</p></div>
+<div class="section">
+<h3><a name="is_object_isobject_isobj"></a>is_object (isobject, isobj)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_object(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be a <tt>object</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the argument is a <tt>object</tt> value or not,</li>
+
+<li>a <tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li>a <tt>null</tt> if the argument is a <tt>null</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": is_object(true),
+ "b": is_object(false),
+ "c": isobject(null),
+ "d": isobject(missing),
+ "e": isobj("d"),
+ "f": isobj(4.0),
+ "g": isobj(5),
+ "h": isobj(["1", 2]),
+ "i": isobj({"a":1})
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+<p>{ “a”: false, “b”: false, “c”: null, “e”: false, “f”: false, “g”: false, “h”: false, “i”: true }</p></li>
+</ul>
+<p>The function has two aliases, <tt>isobject</tt> or <tt>isobj</tt>.</p></div>
+<div class="section">
+<h3><a name="is_string_isstring_isstr"></a>is_string (isstring, isstr)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_string(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be a <tt>string</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the argument is a <tt>string</tt> value or not,</li>
+
+<li>a <tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li>a <tt>null</tt> if the argument is a <tt>null</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": is_string(true),
+ "b": isstring(false),
+ "c": isstring(null),
+ "d": isstr(missing),
+ "e": isstr("d"),
+ "f": isstr(4.0),
+ "g": isstr(5),
+ "h": isstr(["1", 2]),
+ "i": isstr({"a":1})
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": false, "b": false, "c": null, "e": true, "f": false, "g": false, "h": false, "i": false }
+</pre></div></div></li>
+</ul>
+<p>The function has two aliases, <tt>isstring</tt> or <tt>isstr</tt>.</p></div>
+<div class="section">
+<h3><a name="is_null"></a>is_null</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_null(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be a <tt>null</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the variable is a <tt>null</tt> or not,</li>
+
+<li>a <tt>missing</tt> if the input is <tt>missing</tt>.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": is_null(null), "v2": is_null(1), "v3": is_null(missing) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>isnull</tt>.</p></div>
+<div class="section">
+<h3><a name="is_missing"></a>is_missing</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_missing(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be a <tt>missing</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the variable is a <tt>missing</tt> or not.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": is_missing(null), "v2": is_missing(1), "v3": is_missing(missing) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": false, "v2": false, "v3": true }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>ismissing</tt>.</p></div>
+<div class="section">
+<h3><a name="is_unknown"></a>is_unknown</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_unknown(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given variable is a <tt>null</tt> value or a <tt>missing</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the variable is a <tt>null</tt>/`<tt>missing</tt> value (<tt>true</tt>) or not (<tt>false</tt>).</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": is_unknown(null), "v2": is_unknown(1), "v3": is_unknown(missing) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false, "v3": true }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>isunknown</tt>.</p></div>
+<div class="section">
+<h3><a name="to_boolean"></a>to_boolean</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>to_boolean(expr)
+</pre></div></div></li>
+
+<li>
+<p>Converts input value to a <tt>boolean</tt> value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>if the argument is <tt>missing</tt> then <tt>missing</tt> is returned</li>
+
+<li>if the argument is <tt>null</tt> then <tt>null</tt> is returned</li>
+
+<li>if the argument is of <tt>boolean</tt> type then it is returned as is</li>
+
+<li>if the argument is of numeric type then <tt>false</tt> is returned if it is <tt>0</tt> or <tt>NaN</tt>, otherwise <tt>true</tt></li>
+
+<li>if the argument is of <tt>string</tt> type then <tt>false</tt> is returned if it’s empty, otherwise <tt>true</tt></li>
+
+<li>if the argument is of <tt>array</tt> or <tt>multiset</tt> type then <tt>false</tt> is returned if it’s size is <tt>0</tt>, otherwise <tt>true</tt></li>
+
+<li>if the argument is of <tt>object</tt> type then <tt>false</tt> is returned if it has no fields, otherwise <tt>true</tt></li>
+
+<li>type error is raised for all other input types</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": to_boolean(0),
+ "v2": to_boolean(1),
+ "v3": to_boolean(""),
+ "v4": to_boolean("asterix")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": false, "v2": true, "v3": false, "v4": true }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>toboolean</tt>.</p></div>
+<div class="section">
+<h3><a name="to_bigint"></a>to_bigint</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>to_bigint(expr)
+</pre></div></div></li>
+
+<li>
+<p>Converts input value to an integer value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>if the argument is <tt>missing</tt> then <tt>missing</tt> is returned</li>
+
+<li>if the argument is <tt>null</tt> then <tt>null</tt> is returned</li>
+
+<li>if the argument is of <tt>boolean</tt> type then <tt>1</tt> is returned if it is <tt>true</tt>, <tt>0</tt> if it is <tt>false</tt></li>
+
+<li>if the argument is of numeric integer type then it is returned as the same value of <tt>bigint</tt> type</li>
+
+<li>if the argument is of numeric <tt>float</tt>/<tt>double</tt> type then it is converted to <tt>bigint</tt> type</li>
+
+<li>if the argument is of <tt>string</tt> type and can be parsed as integer then that integer value is returned, otherwise <tt>null</tt> is returned</li>
+
+<li>if the argument is of <tt>array</tt>/<tt>multiset</tt>/<tt>object</tt> type then <tt>null</tt> is returned</li>
+
+<li>type error is raised for all other input types</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": to_bigint(false),
+ "v2": to_bigint(true),
+ "v3": to_bigint(10),
+ "v4": to_bigint(float("1e100")),
+ "v5": to_bigint(double("1e1000")),
+ "v6": to_bigint("20")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0, "v2": 1, "v3": 10, "v4": 9223372036854775807, "v5": 9223372036854775807, "v6": 20 }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>tobigint</tt>.</p></div>
+<div class="section">
+<h3><a name="to_double"></a>to_double</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>to_double(expr)
+</pre></div></div></li>
+
+<li>
+<p>Converts input value to a <tt>double</tt> value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>if the argument is <tt>missing</tt> then <tt>missing</tt> is returned</li>
+
+<li>if the argument is <tt>null</tt> then <tt>null</tt> is returned</li>
+
+<li>if the argument is of <tt>boolean</tt> type then <tt>1.0</tt> is returned if it is <tt>true</tt>, <tt>0.0</tt> if it is <tt>false</tt></li>
+
+<li>if the argument is of numeric type then it is returned as the value of <tt>double</tt> type</li>
+
+<li>if the argument is of <tt>string</tt> type and can be parsed as <tt>double</tt> then that <tt>double</tt> value is returned, otherwise <tt>null</tt> is returned</li>
+
+<li>if the argument is of <tt>array</tt>/<tt>multiset</tt>/<tt>object</tt> type then <tt>null</tt> is returned</li>
+
+<li>type error is raised for all other input types</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": to_double(false),
+ "v2": to_double(true),
+ "v3": to_double(10),
+ "v4": to_double(11.5),
+ "v5": to_double("12.5")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.0, "v2": 1.0, "v3": 10.0, "v4": 11.5, "v5": 12.5 }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>todouble</tt>.</p></div>
+<div class="section">
+<h3><a name="to_string"></a>to_string</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>to_string(expr)
+</pre></div></div></li>
+
+<li>
+<p>Converts input value to a string value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>if the argument is <tt>missing</tt> then <tt>missing</tt> is returned</li>
+
+<li>if the argument is <tt>null</tt> then <tt>null</tt> is returned</li>
+
+<li>if the argument is of <tt>boolean</tt> type then <tt>"true"</tt> is returned if it is <tt>true</tt>, <tt>"false"</tt> if it is <tt>false</tt></li>
+
+<li>if the argument is of numeric type then its string representation is returned</li>
+
+<li>if the argument is of <tt>string</tt> type then it is returned as is</li>
+
+<li>if the argument is of <tt>array</tt>/<tt>multiset</tt>/<tt>object</tt> type then <tt>null</tt> is returned</li>
+
+<li>type error is raised for all other input types</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": to_string(false),
+ "v2": to_string(true),
+ "v3": to_string(10),
+ "v4": to_string(11.5),
+ "v5": to_string("asterix")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": "false", "v2": "true", "v3": "10", "v4": "11.5", "v5": "asterix" }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>tostring</tt>. <!-- ! 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.
+ ! --></p></div></div>
+<div class="section">
+<h2><a name="Conditional_Functions"></a><a name="ConditionalFunctions" id="ConditionalFunctions">Conditional Functions</a></h2>
+<div class="section">
+<h3><a name="if_null_ifnull"></a>if_null (ifnull)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>if_null(expression1, expression2, ... expressionN)
+</pre></div></div></li>
+
+<li>
+<p>Finds first argument which value is not <tt>null</tt> and returns that value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expressionI</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>null</tt> if all arguments evaluate to <tt>null</tt> or no arguments specified</li>
+
+<li>a value of the first non-<tt>null</tt> argument otherwise</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": if_null(),
+ "b": if_null(null),
+ "c": if_null(null, "asterixdb"),
+ "d": is_missing(if_null(missing))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": null, "b": null, "c": "asterixdb", "d": true }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>ifnull</tt>.</p></div>
+<div class="section">
+<h3><a name="if_missing_ifmissing"></a>if_missing (ifmissing)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>if_missing(expression1, expression2, ... expressionN)
+</pre></div></div></li>
+
+<li>
+<p>Finds first argument which value is not <tt>missing</tt> and returns that value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expressionI</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>null</tt> if all arguments evaluate to <tt>missing</tt> or no arguments specified</li>
+
+<li>a value of the first non-<tt>missing</tt> argument otherwise</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": if_missing(),
+ "b": if_missing(missing),
+ "c": if_missing(missing, "asterixdb"),
+ "d": if_missing(null, "asterixdb")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": null, "b": null, "c": "asterixdb", "d": null }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>ifmissing</tt>.</p></div>
+<div class="section">
+<h3><a name="if_missing_or_null_ifmissingornull"></a>if_missing_or_null (ifmissingornull)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>if_missing_or_null(expression1, expression2, ... expressionN)
+</pre></div></div></li>
+
+<li>
+<p>Finds first argument which value is not <tt>null</tt> or <tt>missing</tt> and returns that value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expressionI</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>null</tt> if all arguments evaluate to either <tt>null</tt> or <tt>missing</tt>, or no arguments specified</li>
+
+<li>a value of the first non-<tt>null</tt>, non-<tt>missing</tt> argument otherwise</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": if_missing_or_null(),
+ "b": if_missing_or_null(null, missing),
+ "c": if_missing_or_null(null, missing, "asterixdb")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": null, "b": null, "c": "asterixdb" }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>ifmissingornull</tt>. <!-- ! 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.
+ ! --></p></div></div>
+<div class="section">
+<h2><a name="Miscellaneous_Functions"></a><a name="MiscFunctions" id="MiscFunctions">Miscellaneous Functions</a></h2>
+<div class="section">
+<h3><a name="uuid"></a>uuid</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>uuid()
+</pre></div></div></li>
+
+<li>
+<p>Generates a <tt>uuid</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li>none</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a generated, random <tt>uuid</tt>.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="len"></a>len</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>len(array)</p></li>
+
+<li>
+<p>Returns the length of the array array.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array</tt> : an <tt>array</tt>, <tt>multiset</tt>, <tt>null</tt>, or <tt>missing</tt>, represents the collection that needs to be checked.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>integer</tt> that represents the length of input array or the size of the input multiset,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>len(["Hello", "World"])
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>2
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="not"></a>not</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>not(expr)
+</pre></div></div></li>
+
+<li>
+<p>Inverts a <tt>boolean</tt> value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt>, the inverse of <tt>expr</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>other non-boolean argument value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": `not`(true), "v2": `not`(false), "v3": `not`(null), "v4": `not`(missing) };
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": false, "v2": true, "v3": null }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="range"></a>range</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>range(start_numeric_value, end_numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Generates a series of <tt>bigint</tt> values based start the <tt>start_numeric_value</tt> until the <tt>end_numeric_value</tt>.</p></li>
+
+<li>Arguments:</li>
+
+<li><tt>start_numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value representing the start value.</li>
+
+<li><tt>end_numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value representing the max final value.</li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an array that starts with the integer value of <tt>start_numeric_value</tt> and ends with the integer value of <tt>end_numeric_value</tt>, where the value of each entry in the array is the integer successor of the value in the preceding entry.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>range(0, 3);
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ 0, 1, 2, 3 ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="switch_case"></a>switch_case</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>switch_case(
+ condition,
+ case1, case1_result,
+ case2, case2_result,
+ ...,
+ default, default_result
+)
+</pre></div></div></li>
+
+<li>
+<p>Switches amongst a sequence of cases and returns the result of the first matching case. If no match is found, the result of the default case is returned.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>condition</tt>: a variable (any type is allowed).</li>
+
+<li><tt>caseI/default</tt>: a variable (any type is allowed).</li>
+
+<li><tt>caseI/default_result</tt>: a variable (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li><tt>caseI_result</tt> if <tt>condition</tt> matches <tt>caseI</tt>, otherwise <tt>default_result</tt>.</li>
+ </ul></li>
+
+<li>
+<p>Example 1:</p>
+
+<div class="source">
+<div class="source">
+<pre>switch_case(
+ "a",
+ "a", 0,
+ "x", 1,
+ "y", 2,
+ "z", 3
+);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>0
+</pre></div></div></li>
+
+<li>
+<p>Example 2:</p>
+
+<div class="source">
+<div class="source">
+<pre>switch_case(
+ "a",
+ "x", 1,
+ "y", 2,
+ "z", 3
+);
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>3
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="deep_equal"></a>deep_equal</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>deep_equal(expr1, expr2)
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>Assess the equality between two expressions of any type (e.g., object, arrays, or multiset). Two objects are deeply equal iff both their types and values are equal.</li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr1</tt> : an expression,</li>
+
+<li><tt>expr2</tt> : an expression.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li><tt>true</tt> or <tt>false</tt> depending on the data equality,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>deep_equal(
+ {
+ "id":1,
+ "project":"AsterixDB",
+ "address":{"city":"Irvine", "state":"CA"},
+ "related":["Hivestrix", "Preglix", "Apache VXQuery"]
+ },
+ {
+ "id":1,
+ "project":"AsterixDB",
+ "address":{"city":"San Diego", "state":"CA"},
+ "related":["Hivestrix", "Preglix", "Apache VXQuery"]
+ }
+);
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>false
+</pre></div></div></li>
+</ul></div></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row span12">Copyright © 2017
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<div class="row-fluid">Apache AsterixDB, AsterixDB, Apache, the Apache
+ feather logo, and the Apache AsterixDB project logo are either
+ registered trademarks or trademarks of The Apache Software
+ Foundation in the United States and other countries.
+ All other marks mentioned may be trademarks or registered
+ trademarks of their respective owners.</div>
+
+
+ </div>
+ </footer>
+ </body>
+</html>
diff --git a/docs/0.9.2/aql/externaldata.html b/docs/0.9.2/aql/externaldata.html
index 46d48f3..fec80ae 100644
--- a/docs/0.9.2/aql/externaldata.html
+++ b/docs/0.9.2/aql/externaldata.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – Accessing External Data in AsterixDB</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/aql/filters.html b/docs/0.9.2/aql/filters.html
index 8433765..560d786 100644
--- a/docs/0.9.2/aql/filters.html
+++ b/docs/0.9.2/aql/filters.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – Filter-Based LSM Index Acceleration</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/aql/fulltext.html b/docs/0.9.2/aql/fulltext.html
index b34c661..5be0cfe 100644
--- a/docs/0.9.2/aql/fulltext.html
+++ b/docs/0.9.2/aql/fulltext.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – AsterixDB Support of Full-text search queries</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/aql/js-sdk.html b/docs/0.9.2/aql/js-sdk.html
index aa6d633..93d1269 100644
--- a/docs/0.9.2/aql/js-sdk.html
+++ b/docs/0.9.2/aql/js-sdk.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – AsterixDB Javascript SDK</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/aql/manual.html b/docs/0.9.2/aql/manual.html
index 7bebcfa..11f23bf 100644
--- a/docs/0.9.2/aql/manual.html
+++ b/docs/0.9.2/aql/manual.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – The Asterix Query Language, Version 1.0</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/aql/primer.html b/docs/0.9.2/aql/primer.html
index 1ff056c..894b68b 100644
--- a/docs/0.9.2/aql/primer.html
+++ b/docs/0.9.2/aql/primer.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-08-25
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170825" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – AsterixDB 101: An ADM and AQL Primer</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-08-25</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.3-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
@@ -885,34 +885,6 @@
{ "chirp": { "chirpId": "8", "user": { "screenName": "NathanGiesen@211", "lang": "en", "friendsCount": 39339, "statusesCount": 473, "name": "Nathan Giesen", "followersCount": 49416 }, "senderLocation": point("46.05,93.34"), "sendTime": datetime("2005-10-14T10:10:00.000Z"), "referredTopics": {{ "product-z", "shortcut-menu" }}, "messageText": " like product-z the shortcut-menu is awesome:)" }, "similarChirps": [ {{ "ccast", "shortcut-menu" }}, {{ "product-z", "customization" }} ] }
</pre></div></div></div>
<div class="section">
-<h3><a name="Inserting_New_Data"></a>Inserting New Data</h3>
-<p>In addition to loading and querying data, AsterixDB supports incremental additions to datasets via the AQL <i>insert</i> statement.</p>
-<p>The following example adds a new chirp by user “<a class="externalLink" href="mailto:NathanGiesen@211">NathanGiesen@211</a>” to the ChirpMessages dataset. (An astute reader may notice that this chirp was issued a half an hour after his last chirp, so his counts have all gone up in the interim, although he appears not to have moved in the last half hour.)</p>
-
-<div class="source">
-<div class="source">
-<pre> use dataverse TinySocial;
-
- insert into dataset ChirpMessages
- (
- {"chirpId": "13",
- "user":
- {"screenName": "NathanGiesen@211",
- "lang": "en",
- "friendsCount": 39345,
- "statusesCount": 479,
- "name": "Nathan Giesen",
- "followersCount": 49420
- },
- "senderLocation": point("47.44,80.65"),
- "sendTime": datetime("2008-04-26T10:10:35"),
- "referredTopics": {{"chirping"}},
- "messageText": "chirpy chirp, my fellow chirpers!"
- }
- );
-</pre></div></div>
-<p>In general, the data to be inserted may be specified using any valid AQL query expression. The insertion of a single object instance, as in this example, is just a special case where the query expression happens to be a object constructor involving only constants.</p></div>
-<div class="section">
<h3><a name="Deleting_Existing_Data"></a>Deleting Existing Data</h3>
<p>In addition to inserting new data, AsterixDB supports deletion from datasets via the AQL <i>delete</i> statement. The statement supports “searched delete” semantics, and its <i>where</i> clause can involve any valid XQuery expression.</p>
<p>The following example deletes the chirp that we just added from user "<a class="externalLink" href="mailto:NathanGiesen@211"">NathanGiesen@211"</a>. (Easy come, easy go. :-))</p>
diff --git a/docs/0.9.2/aql/similarity.html b/docs/0.9.2/aql/similarity.html
index b151ff7..3f45116 100644
--- a/docs/0.9.2/aql/similarity.html
+++ b/docs/0.9.2/aql/similarity.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – AsterixDB Support of Similarity Queries</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/aws.html b/docs/0.9.2/aws.html
new file mode 100644
index 0000000..7f31136
--- /dev/null
+++ b/docs/0.9.2/aws.html
@@ -0,0 +1,525 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2017-09-14
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>AsterixDB – </title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-41536543-1', 'uci.edu');
+ ga('send', 'pageview');</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="./" id="bannerLeft">
+ <img src="images/asterixlogo.png" alt="AsterixDB"/>
+ </a>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2017-09-14</li>
+
+
+
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="index.html" title="Documentation Home">
+ Documentation Home</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Get Started - Installation</li>
+
+ <li>
+
+ <a href="ncservice.html" title="Option 1: using NCService">
+ <i class="none"></i>
+ Option 1: using NCService</a>
+ </li>
+
+ <li>
+
+ <a href="ansible.html" title="Option 2: using Ansible">
+ <i class="none"></i>
+ Option 2: using Ansible</a>
+ </li>
+
+ <li class="active">
+
+ <a href="#"><i class="none"></i>Option 3: using Amazon Web Services</a>
+ </li>
+
+ <li>
+
+ <a href="yarn.html" title="Option 4: using YARN">
+ <i class="none"></i>
+ Option 4: using YARN</a>
+ </li>
+
+ <li>
+
+ <a href="install.html" title="Option 5: using Managix (deprecated)">
+ <i class="none"></i>
+ Option 5: using Managix (deprecated)</a>
+ </li>
+ <li class="nav-header">AsterixDB Primer</li>
+
+ <li>
+
+ <a href="sqlpp/primer-sqlpp.html" title="Option 1: using SQL++">
+ <i class="none"></i>
+ Option 1: using SQL++</a>
+ </li>
+
+ <li>
+
+ <a href="aql/primer.html" title="Option 2: using AQL">
+ <i class="none"></i>
+ Option 2: using AQL</a>
+ </li>
+ <li class="nav-header">Data Model</li>
+
+ <li>
+
+ <a href="datamodel.html" title="The Asterix Data Model">
+ <i class="none"></i>
+ The Asterix Data Model</a>
+ </li>
+ <li class="nav-header">Queries - SQL++</li>
+
+ <li>
+
+ <a href="sqlpp/manual.html" title="The SQL++ Query Language">
+ <i class="none"></i>
+ The SQL++ Query Language</a>
+ </li>
+
+ <li>
+
+ <a href="sqlpp/builtins.html" title="Builtin Functions">
+ <i class="none"></i>
+ Builtin Functions</a>
+ </li>
+ <li class="nav-header">Queries - AQL</li>
+
+ <li>
+
+ <a href="aql/manual.html" title="The Asterix Query Language (AQL)">
+ <i class="none"></i>
+ The Asterix Query Language (AQL)</a>
+ </li>
+
+ <li>
+
+ <a href="aql/builtins.html" title="Builtin Functions">
+ <i class="none"></i>
+ Builtin Functions</a>
+ </li>
+ <li class="nav-header">API/SDK</li>
+
+ <li>
+
+ <a href="api.html" title="HTTP API">
+ <i class="none"></i>
+ HTTP API</a>
+ </li>
+
+ <li>
+
+ <a href="csv.html" title="CSV Output">
+ <i class="none"></i>
+ CSV Output</a>
+ </li>
+ <li class="nav-header">Advanced Features</li>
+
+ <li>
+
+ <a href="aql/fulltext.html" title="Support of Full-text Queries">
+ <i class="none"></i>
+ Support of Full-text Queries</a>
+ </li>
+
+ <li>
+
+ <a href="aql/externaldata.html" title="Accessing External Data">
+ <i class="none"></i>
+ Accessing External Data</a>
+ </li>
+
+ <li>
+
+ <a href="feeds/tutorial.html" title="Support for Data Ingestion">
+ <i class="none"></i>
+ Support for Data Ingestion</a>
+ </li>
+
+ <li>
+
+ <a href="udf.html" title="User Defined Functions">
+ <i class="none"></i>
+ User Defined Functions</a>
+ </li>
+
+ <li>
+
+ <a href="aql/filters.html" title="Filter-Based LSM Index Acceleration">
+ <i class="none"></i>
+ Filter-Based LSM Index Acceleration</a>
+ </li>
+
+ <li>
+
+ <a href="aql/similarity.html" title="Support of Similarity Queries">
+ <i class="none"></i>
+ Support of Similarity Queries</a>
+ </li>
+ </ul>
+
+
+
+ <hr class="divider" />
+
+ <div id="poweredBy">
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="./" title="AsterixDB" class="builtBy">
+ <img class="builtBy" alt="AsterixDB" src="images/asterixlogo.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <!-- ! 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.
+ ! -->
+<ul>
+
+<li><a href="#Introduction">Introduction</a></li>
+
+<li><a href="#Prerequisites">Prerequisites</a></li>
+
+<li><a href="#config">Cluster Configuration</a></li>
+
+<li><a href="#lifecycle">Cluster Lifecycle Management</a> <!-- ! 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.
+ ! --></li>
+</ul>
+<div class="section">
+<h2><a name="Introduction" id="Introduction">Introduction</a></h2>
+<p>Note that you can always manually launch a number of Amazon Web Services EC2 instances and then run the Ansible cluster installation scripts as described <a href="ansible.html">here</a> separately to manage the lifecycle of an AsterixDB cluster on those EC2 instances.</p>
+<p>However, via this installation option, we provide a combo solution for automating both AWS EC2 and AsterixDB, where you can run only one script to deploy, start, stop, and terminate an AsterixDB cluster on AWS.</p></div>
+<div class="section">
+<h2><a name="Prerequisites" id="Prerequisites">Prerequisites</a></h2>
+
+<ul>
+
+<li>
+<p>Supported operating systems for the client: <b>Linux</b> and <b>MacOS</b></p></li>
+
+<li>
+<p>Supported operating systems for Amazon Web Services instances: <b>Linux</b></p></li>
+
+<li>
+<p>Install pip on your client machine:</p>
+<p>CentOS</p>
+
+<div class="source">
+<div class="source">
+<pre> $ sudo yum install python-pip
+</pre></div></div>
+<p>Ubuntu</p>
+
+<div class="source">
+<div class="source">
+<pre> $ sudo apt-get install python-pip
+</pre></div></div>
+<p>macOS</p>
+
+<div class="source">
+<div class="source">
+<pre> $ brew install pip
+</pre></div></div></li>
+
+<li>
+<p>Install Ansible, boto, and boto3 on your client machine:</p>
+
+<div class="source">
+<div class="source">
+<pre> $ pip install ansible
+ $ pip install boto
+ $ pip install boto3
+</pre></div></div>
+<p>Note that you might need <tt>sudo</tt> depending on your system configuration.</p>
+<p><b>Make sure that the version of Ansible is no less than 2.2.1.0</b>:</p>
+
+<div class="source">
+<div class="source">
+<pre> $ ansible --version
+ ansible 2.2.1.0
+</pre></div></div>
+<p><b>For users with macOS 10.11+</b>, please create a user-level Ansible configuration file at:</p>
+
+<div class="source">
+<div class="source">
+<pre> ~/.ansible.cfg
+</pre></div></div>
+<p>and add the following configuration:</p>
+
+<div class="source">
+<div class="source">
+<pre> [ssh_connection]
+ control_path = %(directory)s/%%C
+</pre></div></div></li>
+
+<li>
+<p>Download the AsterixDB distribution package, unzip it, navigate to <tt>opt/aws/</tt></p>
+
+<div class="source">
+<div class="source">
+<pre> $ cd opt/aws
+</pre></div></div>
+<p>The following files and directories are in the directory <tt>opt/aws</tt>:</p>
+
+<div class="source">
+<div class="source">
+<pre> README bin conf yaml
+</pre></div></div>
+<p><tt>bin</tt> contains scripts that start and terminate an AWS-based cluster instance, according to the configuration specified in files under <tt>conf</tt>, and <tt>yaml</tt> contains internal Ansible scripts that the shell scripts in <tt>bin</tt> use.</p></li>
+
+<li>
+<p>Create an AWS account and an IAM user.</p>
+<p>Set up a security group that you’d like to use for your AWS cluster. <b>The security group should at least allow all TCP connections from anywhere.</b> Provide the name of the security group as the value for the <tt>group</tt> field in <tt>conf/aws_settings.yml</tt>.</p></li>
+
+<li>
+<p>Retrieve your AWS EC2 key pair name and use that as the <tt>keypair</tt> in <tt>conf/aws_settings.yml</tt>;</p>
+<p>retrieve your AWS IAM <tt>access key ID</tt> and use that as the <tt>access_key_id</tt> in <tt>conf/aws_settings.yml</tt>;</p>
+<p>retrieve your AWS IAM <tt>secret access key</tt> and use that as the <tt>secret_access_key</tt> in <tt>conf/aws_settings.yml</tt>.</p>
+<p>Note that you can only read or download <tt>access key ID</tt> and <tt>secret access key</tt> once from your AWS console. If you forget them, you have to create new keys and delete the old ones.</p></li>
+
+<li>
+<p>Configure your ssh setting by editing <tt>~/.ssh/config</tt> and adding the following entry:</p>
+
+<div class="source">
+<div class="source">
+<pre> Host *.amazonaws.com
+ IdentityFile <path_of_private_key>
+</pre></div></div>
+<p>Note that <path_of_private_key> should be replaced by the path to the file that stores the private key for the key pair that you uploaded to AWS and used in <tt>conf/aws_settings</tt>. For example:</p>
+
+<div class="source">
+<div class="source">
+<pre> Host *.amazonaws.com
+ IdentityFile ~/.ssh/id_rsa
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h2><a name="Cluster_Configuration"></a><a name="config" id="config">Cluster Configuration</a></h2>
+
+<ul>
+
+<li>
+<p><b>AWS settings</b>. Edit <tt>conf/instance_settings.yml</tt>. The meaning of each parameter is listed as follows:</p>
+
+<div class="source">
+<div class="source">
+<pre> # The OS image id for ec2 instances.
+ image: ami-76fa4116
+
+ # The data center region for ec2 instances.
+ region: us-west-2
+
+ # The tag for each ec2 machine. Use different tags for isolation.
+ tag: scale_test
+
+ # The name of a security group that appears in your AWS console.
+ group: default
+
+ # The name of a key pair that appears in your AWS console.
+ keypair: <to be filled>
+
+ # The AWS access key id for your IAM user.
+ access_key_id: <to be filled>
+
+ # The AWS secret key for your IAM user.
+ secret_access_key: <to be filled>
+
+ # The AWS instance type. A full list of available types are listed at:
+ # https://aws.amazon.com/ec2/instance-types/
+ instance_type: t2.micro
+
+ # The number of ec2 instances that construct a cluster.
+ count: 3
+
+ # The user name.
+ user: ec2-user
+
+ # Whether to reuse one slave machine to host the master process.
+ cc_on_nc: false
+</pre></div></div>
+<p><b>As described in <a href="#Prerequisites">prerequisites</a>, the following parameters must be customized:</b></p>
+
+<div class="source">
+<div class="source">
+<pre> # The tag for each ec2 machine. Use different tags for isolation.
+ tag: scale_test
+
+ # The name of a security group that appears in your AWS console.
+ group: default
+
+ # The name of a key pair that appears in your AWS console.
+ keypair: <to be filled>
+
+ # The AWS access key id for your IAM user.
+ access_key_id: <to be filled>
+
+ # The AWS secrety key for your IAM user.
+ secret_access_key: <to be filled>
+</pre></div></div></li>
+
+<li>
+<p><b>Remote working directories</b>. Edit <tt>conf/instance_settings.yml</tt> to change the remote binary directory (the variable “binarydir”) when necessary. By default, the binary directory will be under the home directory (as the value of Ansible builtin variable ansible_env.HOME) of the ssh user account on each node.</p></li>
+</ul></div>
+<div class="section">
+<h2><a name="Cluster_Lifecycle_Management"></a><a name="lifecycle" id="lifecycle">Cluster Lifecycle Management</a></h2>
+
+<ul>
+
+<li>
+<p>Allocate AWS EC2 nodes (the number of nodes is specified in <tt>conf/instance_settings.yml</tt>) and deploy the binary to all allocated EC2 nodes:</p>
+
+<div class="source">
+<div class="source">
+<pre> bin/deploy.sh
+</pre></div></div></li>
+
+<li>
+<p>Before starting the AsterixDB cluster, you the instance configuration file <tt>conf/instance/cc.conf</tt> can be modified with the exception of the IP addresses/DNS names which are are generated and cannot be changed. All available parameters and their usage can be found <a href="ncservice.html#Parameters">here</a>.</p></li>
+
+<li>
+<p>Launch your AsterixDB cluster on EC2:</p>
+
+<div class="source">
+<div class="source">
+<pre> bin/start.sh
+</pre></div></div>
+<p>Now you can use the multi-node AsterixDB cluster on EC2 by by opening the master node listed in <tt>conf/instance/inventory</tt> at port <tt>19001</tt> (which can be customized in <tt>conf/instance/cc.conf</tt>) in your browser.</p></li>
+
+<li>
+<p>If you want to stop the AWS-based AsterixDB cluster, run the following script:</p>
+
+<div class="source">
+<div class="source">
+<pre> bin/stop.sh
+</pre></div></div>
+<p>Note that this only stops AsterixDB but does not stop the EC2 nodes.</p></li>
+
+<li>
+<p>If you want to terminate the EC2 nodes that run the AsterixDB cluster, run the following script:</p>
+
+<div class="source">
+<div class="source">
+<pre> bin/terminate.sh
+</pre></div></div>
+<p><b>Note that it will destroy everything in the AsterixDB cluster you installed and terminate all EC2 nodes for the cluster.</b></p></li>
+</ul></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row span12">Copyright © 2017
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<div class="row-fluid">Apache AsterixDB, AsterixDB, Apache, the Apache
+ feather logo, and the Apache AsterixDB project logo are either
+ registered trademarks or trademarks of The Apache Software
+ Foundation in the United States and other countries.
+ All other marks mentioned may be trademarks or registered
+ trademarks of their respective owners.</div>
+
+
+ </div>
+ </footer>
+ </body>
+</html>
diff --git a/docs/0.9.2/csv.html b/docs/0.9.2/csv.html
index 0971608..534bfd1 100644
--- a/docs/0.9.2/csv.html
+++ b/docs/0.9.2/csv.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – CSV Support in AsterixDB</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/datamodel.html b/docs/0.9.2/datamodel.html
index f9144f0..d064195 100644
--- a/docs/0.9.2/datamodel.html
+++ b/docs/0.9.2/datamodel.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – The Asterix Data Model (ADM)</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
@@ -263,14 +263,14 @@
<li><a href="#PrimitiveTypesBoolean">Boolean</a></li>
+<li><a href="#PrimitiveTypesString">String</a></li>
+
<li><a href="#PrimitiveTypesInt">Tinyint / Smallint / Integer (Int) / Bigint</a></li>
<li><a href="#PrimitiveTypesFloat">Float</a></li>
<li><a href="#PrimitiveTypesDouble">Double (Double Precision)</a></li>
-<li><a href="#PrimitiveTypesString">String</a></li>
-
<li><a href="#PrimitiveTypesBinary">Binary</a></li>
<li><a href="#PrimitiveTypesPoint">Point</a></li>
@@ -296,7 +296,7 @@
<li><a href="#PrimitiveTypesUUID">UUID</a></li>
</ul></li>
-<li><a href="#IncompleteInformationTypesTypes">Incomplete Information Types</a>
+<li><a href="#IncompleteInformationTypes">Incomplete Information Types</a>
<ul>
@@ -317,7 +317,24 @@
</ul></li>
</ul>
<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>
-<p>The type names are case-insensitive, e.g., both <tt>BIGINT</tt> and <tt>bigint</tt> are acceptable.</p></div>
+<p>The type names are case-insensitive, e.g., both <tt>BIGINT</tt> and <tt>bigint</tt> are acceptable.</p>
+<!-- ! 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.
+ ! --></div>
<div class="section">
<h2><a name="Primitive_Types"></a><a name="PrimitiveTypes" id="PrimitiveTypes">Primitive Types</a></h2>
<div class="section">
@@ -346,16 +363,41 @@
</pre></div></div></li>
</ul></div>
<div class="section">
+<h3><a name="String"></a><a name="PrimitiveTypesString" id="PrimitiveTypesString">String</a></h3>
+<p><tt>string</tt> represents a sequence of characters. The total length of the sequence can be up to 2,147,483,648.</p>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": string("This is a string."), "v2": string("\"This is a quoted string\"") };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": "This is a string.", "v2": "\"This is a quoted string\"" }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
<h3><a name="Tinyint__Smallint__Integer_Int__Bigint"></a><a name="PrimitiveTypesInt" id="PrimitiveTypesInt">Tinyint / Smallint / Integer (Int) / Bigint</a></h3>
<p>Integer types using 8, 16, 32, or 64 bits. The ranges of these types are:</p>
<ul>
-<li><tt>tinyint</tt>: -127 to 127</li>
+<li><tt>tinyint</tt>: -128 to 127</li>
-<li><tt>smallint</tt>: -32767 to 32767</li>
+<li><tt>smallint</tt>: -32768 to 32767</li>
-<li><tt>integer</tt>: -2147483647 to 2147483647</li>
+<li><tt>integer</tt>: -2147483648 to 2147483647</li>
<li><tt>bigint</tt>: -9223372036854775808 to 9223372036854775807</li>
</ul>
@@ -404,7 +446,7 @@
<div class="source">
<div class="source">
-<pre>{ "v1": NaN, "v2": Infinity, "v3": -Infinity, "v4": -2013.5 }
+<pre>{ "v1": "NaN", "v2": "Infinity", "v3": "-Infinity", "v4": -2013.5 }
</pre></div></div></li>
</ul></div>
<div class="section">
@@ -429,35 +471,27 @@
<div class="source">
<div class="source">
-<pre>{ "v1": NaN, "v2": Infinity, "v3": -Infinity, "v4": -2013.5938237483274 }
+<pre>{ "v1": "NaN", "v2": "Infinity", "v3": "-Infinity", "v4": -2013.5938237483274 }
</pre></div></div></li>
</ul>
-<p><tt>Double precision</tt> is an alias of <tt>double</tt>.</p></div>
-<div class="section">
-<h3><a name="String"></a><a name="PrimitiveTypesString" id="PrimitiveTypesString">String</a></h3>
-<p><tt>string</tt> represents a sequence of characters. The total length of the sequence can be up to 2,147,483,648.</p>
-
-<ul>
-
-<li>
-<p>Example:</p>
-
-<div class="source">
-<div class="source">
-<pre>{ "v1": string("This is a string."), "v2": string("\"This is a quoted string\"") };
-</pre></div></div></li>
-</ul>
-
-<ul>
-
-<li>
-<p>The expected result is:</p>
-
-<div class="source">
-<div class="source">
-<pre>{ "v1": "This is a string.", "v2": "\"This is a quoted string\"" }
-</pre></div></div></li>
-</ul></div>
+<p><tt>Double precision</tt> is an alias of <tt>double</tt>.</p>
+<!-- ! 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.
+ ! --></div>
<div class="section">
<h3><a name="Binary"></a><a name="PrimitiveTypesBinary" id="PrimitiveTypesBinary">Binary</a></h3>
<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>
@@ -791,7 +825,24 @@
<div class="source">
<pre>{ "v1": uuid("5c848e5c-6b6a-498f-8452-8847a2957421") }
</pre></div></div></li>
-</ul></div></div>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
<div class="section">
<h2><a name="Incomplete_Information_Types"></a><a name="IncompleteInformationTypes" id="IncompleteInformationTypes">Incomplete Information Types</a></h2>
<div class="section">
@@ -821,7 +872,7 @@
</ul></div>
<div class="section">
<h3><a name="Missing"></a><a name="IncompleteInformationTypesMissing" id="IncompleteInformationTypesMissing">Missing</a></h3>
-<p><tt>missing</tt> represents a missing name-value pair in an object. If the referenced field does not exist, an empty result value is returned by the query.</p>
+<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>
<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>
<ul>
@@ -845,7 +896,24 @@
<pre>{ }
</pre></div></div></li>
</ul>
-<p>Since a field with value <tt>missing</tt> means the field is absent, we get an empty object.</p></div></div>
+<p>Since a field with value <tt>missing</tt> means the field is absent, we get an empty object.</p>
+<!-- ! 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.
+ ! --></div></div>
<div class="section">
<h2><a name="Derived_Types"></a><a name="DerivedTypes" id="DerivedTypes">Derived Types</a></h2>
<div class="section">
diff --git a/docs/0.9.2/feeds/tutorial.html b/docs/0.9.2/feeds/tutorial.html
index c6000c1..b39917d 100644
--- a/docs/0.9.2/feeds/tutorial.html
+++ b/docs/0.9.2/feeds/tutorial.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – Support for Data Ingestion in AsterixDB</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/index.html b/docs/0.9.2/index.html
index 7fee0dc..96f7523 100644
--- a/docs/0.9.2/index.html
+++ b/docs/0.9.2/index.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – AsterixDB</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/install.html b/docs/0.9.2/install.html
index eda0747..dc750ad 100644
--- a/docs/0.9.2/install.html
+++ b/docs/0.9.2/install.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – Introduction</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/ncservice.html b/docs/0.9.2/ncservice.html
index 3db6c21..1c16a18 100644
--- a/docs/0.9.2/ncservice.html
+++ b/docs/0.9.2/ncservice.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – <a id="toc">Table of Contents</a></title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/overview.html b/docs/0.9.2/overview.html
index 13e7d4f..ccf58dd 100644
--- a/docs/0.9.2/overview.html
+++ b/docs/0.9.2/overview.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – AsterixDB: A Big Data Management System</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/sqlpp/builtins.html b/docs/0.9.2/sqlpp/builtins.html
new file mode 100644
index 0000000..243f489
--- /dev/null
+++ b/docs/0.9.2/sqlpp/builtins.html
@@ -0,0 +1,9070 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2017-09-14
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>AsterixDB – Builtin Functions</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-41536543-1', 'uci.edu');
+ ga('send', 'pageview');</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <a href=".././" id="bannerLeft">
+ <img src="../images/asterixlogo.png" alt="AsterixDB"/>
+ </a>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2017-09-14</li>
+
+
+
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="../index.html" title="Documentation Home">
+ Documentation Home</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Get Started - Installation</li>
+
+ <li>
+
+ <a href="../ncservice.html" title="Option 1: using NCService">
+ <i class="none"></i>
+ Option 1: using NCService</a>
+ </li>
+
+ <li>
+
+ <a href="../ansible.html" title="Option 2: using Ansible">
+ <i class="none"></i>
+ Option 2: using Ansible</a>
+ </li>
+
+ <li>
+
+ <a href="../aws.html" title="Option 3: using Amazon Web Services">
+ <i class="none"></i>
+ Option 3: using Amazon Web Services</a>
+ </li>
+
+ <li>
+
+ <a href="../yarn.html" title="Option 4: using YARN">
+ <i class="none"></i>
+ Option 4: using YARN</a>
+ </li>
+
+ <li>
+
+ <a href="../install.html" title="Option 5: using Managix (deprecated)">
+ <i class="none"></i>
+ Option 5: using Managix (deprecated)</a>
+ </li>
+ <li class="nav-header">AsterixDB Primer</li>
+
+ <li>
+
+ <a href="../sqlpp/primer-sqlpp.html" title="Option 1: using SQL++">
+ <i class="none"></i>
+ Option 1: using SQL++</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/primer.html" title="Option 2: using AQL">
+ <i class="none"></i>
+ Option 2: using AQL</a>
+ </li>
+ <li class="nav-header">Data Model</li>
+
+ <li>
+
+ <a href="../datamodel.html" title="The Asterix Data Model">
+ <i class="none"></i>
+ The Asterix Data Model</a>
+ </li>
+ <li class="nav-header">Queries - SQL++</li>
+
+ <li>
+
+ <a href="../sqlpp/manual.html" title="The SQL++ Query Language">
+ <i class="none"></i>
+ The SQL++ Query Language</a>
+ </li>
+
+ <li class="active">
+
+ <a href="#"><i class="none"></i>Builtin Functions</a>
+ </li>
+ <li class="nav-header">Queries - AQL</li>
+
+ <li>
+
+ <a href="../aql/manual.html" title="The Asterix Query Language (AQL)">
+ <i class="none"></i>
+ The Asterix Query Language (AQL)</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/builtins.html" title="Builtin Functions">
+ <i class="none"></i>
+ Builtin Functions</a>
+ </li>
+ <li class="nav-header">API/SDK</li>
+
+ <li>
+
+ <a href="../api.html" title="HTTP API">
+ <i class="none"></i>
+ HTTP API</a>
+ </li>
+
+ <li>
+
+ <a href="../csv.html" title="CSV Output">
+ <i class="none"></i>
+ CSV Output</a>
+ </li>
+ <li class="nav-header">Advanced Features</li>
+
+ <li>
+
+ <a href="../aql/fulltext.html" title="Support of Full-text Queries">
+ <i class="none"></i>
+ Support of Full-text Queries</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/externaldata.html" title="Accessing External Data">
+ <i class="none"></i>
+ Accessing External Data</a>
+ </li>
+
+ <li>
+
+ <a href="../feeds/tutorial.html" title="Support for Data Ingestion">
+ <i class="none"></i>
+ Support for Data Ingestion</a>
+ </li>
+
+ <li>
+
+ <a href="../udf.html" title="User Defined Functions">
+ <i class="none"></i>
+ User Defined Functions</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/filters.html" title="Filter-Based LSM Index Acceleration">
+ <i class="none"></i>
+ Filter-Based LSM Index Acceleration</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/similarity.html" title="Support of Similarity Queries">
+ <i class="none"></i>
+ Support of Similarity Queries</a>
+ </li>
+ </ul>
+
+
+
+ <hr class="divider" />
+
+ <div id="poweredBy">
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href=".././" title="AsterixDB" class="builtBy">
+ <img class="builtBy" alt="AsterixDB" src="../images/asterixlogo.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <!-- ! 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.
+ ! --><h1>Builtin Functions</h1>
+<div class="section">
+<h2><a name="Table_of_Contents"></a><a name="toc" id="toc">Table of Contents</a></h2>
+
+<ul>
+
+<li><a href="#NumericFunctions">Numeric Functions</a></li>
+
+<li><a href="#StringFunctions">String Functions</a></li>
+
+<li><a href="#BinaryFunctions">Binary Functions</a></li>
+
+<li><a href="#SpatialFunctions">Spatial Functions</a></li>
+
+<li><a href="#SimilarityFunctions">Similarity Functions</a></li>
+
+<li><a href="#TokenizingFunctions">Tokenizing Functions</a></li>
+
+<li><a href="#TemporalFunctions">Temporal Functions</a></li>
+
+<li><a href="#ObjectFunctions">Object Functions</a></li>
+
+<li><a href="#AggregateFunctions">Aggregate Functions (Array Functions)</a></li>
+
+<li><a href="#ComparisonFunctions">Comparison Functions</a></li>
+
+<li><a href="#TypeFunctions">Type Functions</a></li>
+
+<li><a href="#ConditionalFunctions">Conditional Functions</a></li>
+
+<li><a href="#MiscFunctions">Miscellaneous Functions</a></li>
+</ul>
+<p>The system provides various classes of functions to support operations on numeric, string, spatial, and temporal data. This document explains how to use these functions. <!-- ! 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.
+ ! --></p></div>
+<div class="section">
+<h2><a name="Numeric_Functions"></a><a name="NumericFunctions" id="NumericFunctions">Numeric Functions</a></h2>
+<div class="section">
+<h3><a name="abs"></a>abs</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>abs(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the absolute value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>The absolute value of the argument with the same type as the input argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": abs(2013), "v2": abs(-4036), "v3": abs(0), "v4": abs(float("-2013.5")), "v5": abs(double("-2013.593823748327284")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 2013, "v2": 4036, "v3": 0, "v4": 2013.5, "v5": 2013.5938237483274 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="acos"></a>acos</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>acos(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the arc cosine value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> arc cosine in radians for the argument, if the argument is in the range of -1 (inclusive) to 1 (inclusive),</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error,</li>
+
+<li>“NaN” for other legitimate numeric values.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": acos(1), "v2": acos(2), "v3": acos(0), "v4": acos(float("0.5")), "v5": acos(double("-0.5")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.0, "v2": "NaN", "v3": 1.5707963267948966, "v4": 1.0471975511965979, "v5": 2.0943951023931957 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="asin"></a>asin</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>asin(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the arc sine value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> arc sin in radians for the argument, if the argument is in the range of -1 (inclusive) to 1 (inclusive),</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error,</li>
+
+<li>“NaN” for other legitimate numeric values.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": asin(1), "v2": asin(2), "v3": asin(0), "v4": asin(float("0.5")), "v5": asin(double("-0.5")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1.5707963267948966, "v2": "NaN", "v3": 0.0, "v4": 0.5235987755982989, "v5": -0.5235987755982989 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="atan"></a>atan</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>atan(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the arc tangent value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> arc tangent in radians for the argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": atan(1), "v2": atan(2), "v3": atan(0), "v4": atan(float("0.5")), "v5": atan(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.7853981633974483, "v2": 1.1071487177940904, "v3": 0.0, "v4": 0.4636476090008061, "v5": 1.5697963271282298 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="atan2"></a>atan2</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>atan2(numeric_value1, numeric_value2)
+</pre></div></div></li>
+
+<li>
+<p>Computes the arc tangent value of numeric_value2/numeric_value1.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value1</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li><tt>numeric_value2</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> arc tangent in radians for <tt>numeric_value1</tt> and <tt>numeric_value2</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": atan2(1, 2), "v2": atan2(0, 4), "v3": atan2(float("0.5"), double("-0.5")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.4636476090008061, "v2": 0.0, "v3": 2.356194490192345 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="ceil"></a>ceil</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>ceil(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the smallest (closest to negative infinity) number with no fractional part that is not less than the value of the argument. If the argument is already equal to mathematical integer, then the result is the same as the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>The ceiling value for the given number in the same type as the input argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": ceil(2013),
+ "v2": ceil(-4036),
+ "v3": ceil(0.3),
+ "v4": ceil(float("-2013.2")),
+ "v5": ceil(double("-2013.893823748327284"))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 2013, "v2": -4036, "v3": 1.0, "v4": -2013.0, "v5": -2013.0 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="cos"></a>cos</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>cos(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the cosine value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> cosine value for the argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": cos(1), "v2": cos(2), "v3": cos(0), "v4": cos(float("0.5")), "v5": cos(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.5403023058681398, "v2": -0.4161468365471424, "v3": 1.0, "v4": 0.8775825618903728, "v5": 0.562379076290703 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="exp"></a>exp</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>exp(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes e<sup>numeric_value</sup>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>e<sup>numeric_value</sup>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": exp(1), "v2": exp(2), "v3": exp(0), "v4": exp(float("0.5")), "v5": exp(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 2.718281828459045, "v2": 7.38905609893065, "v3": 1.0, "v4": 1.6487212707001282, "v5": "Infinity" }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="floor"></a>floor</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>floor(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the largest (closest to positive infinity) number with no fractional part that is not greater than the value. If the argument is already equal to mathematical integer, then the result is the same as the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>The floor value for the given number in the same type as the input argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": floor(2013),
+ "v2": floor(-4036),
+ "v3": floor(0.8),
+ "v4": floor(float("-2013.2")),
+ "v5": floor(double("-2013.893823748327284"))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 2013, "v2": -4036, "v3": 0.0, "v4": -2014.0, "v5": -2014.0 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="ln"></a>ln</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>ln(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes log<sub>e</sub>numeric_value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>log<sub>e</sub>numeric_value,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": ln(1), "v2": ln(2), "v3": ln(0), "v4": ln(float("0.5")), "v5": ln(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.0, "v2": 0.6931471805599453, "v3": "-Infinity", "v4": -0.6931471805599453, "v5": 6.907755278982137 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="log"></a>log</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>log(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes log<sub>10</sub>numeric_value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>log<sub>10</sub>numeric_value,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": log(1), "v2": log(2), "v3": log(0), "v4": log(float("0.5")), "v5": log(double("1000")) };
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.0, "v2": 0.3010299956639812, "v3": "-Infinity", "v4": -0.3010299956639812, "v5": 3.0 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="power"></a>power</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>power(numeric_value1, numeric_value2)
+</pre></div></div></li>
+
+<li>
+<p>Computes numeric_value1<sup>numeric_value2</sup>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value1</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li><tt>numeric_value2</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>numeric_value1<sup>numeric_value2</sup>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": power(1, 2), "v3": power(0, 4), "v4": power(float("0.5"), double("-0.5")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1, "v3": 0, "v4": 1.4142135623730951 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="round"></a>round</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>round(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the number with no fractional part that is closest (and also closest to positive infinity) to the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>The rounded value for the given number in the same type as the input argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": round(2013),
+ "v2": round(-4036),
+ "v3": round(0.8),
+ "v4": round(float("-2013.256")),
+ "v5": round(double("-2013.893823748327284"))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 2013, "v2": -4036, "v3": 1.0, "v4": -2013.0, "v5": -2014.0 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="sign"></a>sign</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>sign(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the sign of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the sign (a <tt>tinyint</tt>) of the argument, -1 for negative values, 0 for 0, and 1 for positive values,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": sign(1), "v2": sign(2), "v3": sign(0), "v4": sign(float("0.5")), "v5": sign(double("-1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1, "v2": 1, "v3": 0, "v4": 1, "v5": -1 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="sin"></a>sin</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>sin(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the sine value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> sine value for the argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": sin(1), "v2": sin(2), "v3": sin(0), "v4": sin(float("0.5")), "v5": sin(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.8414709848078965, "v2": 0.9092974268256817, "v3": 0.0, "v4": 0.479425538604203, "v5": 0.8268795405320025 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="sqrt"></a>sqrt</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>sqrt(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the square root of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> square root value for the argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": sqrt(1), "v2": sqrt(2), "v3": sqrt(0), "v4": sqrt(float("0.5")), "v5": sqrt(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1.0, "v2": 1.4142135623730951, "v3": 0.0, "v4": 0.7071067811865476, "v5": 31.622776601683793 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="tan"></a>tan</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>tan(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Computes the tangent value of the argument.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> tangent value for the argument,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": tan(1), "v2": tan(2), "v3": tan(0), "v4": tan(float("0.5")), "v5": tan(double("1000")) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1.5574077246549023, "v2": -2.185039863261519, "v3": 0.0, "v4": 0.5463024898437905, "v5": 1.4703241557027185 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="trunc"></a>trunc</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>trunc(numeric_value, number_digits)
+</pre></div></div></li>
+
+<li>
+<p>Truncates the number to the given number of integer digits to the right of the decimal point (left if digits is negative). Digits is 0 if not given.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li><tt>number_digits</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the <tt>double</tt> tangent value for the argument,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is <tt>missing</tt>,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-numeric value,</li>
+
+<li>the second argument is any other non-tinyint, non-smallint, non-integer, and non-bigint value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": trunc(1, 1), "v2": trunc(2, -2), "v3": trunc(0.122, 2), "v4": trunc(float("11.52"), -1), "v5": trunc(double("1000.5252"), 3) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1, "v2": 2, "v3": 0.12, "v4": 10.0, "v5": 1000.525 }
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div>
+<div class="section">
+<h3><a name="round_half_to_even"></a>round_half_to_even</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>round_half_to_even(numeric_value, [precision])
+</pre></div></div></li>
+
+<li>
+<p>Computes the closest numeric value to <tt>numeric_value</tt> that is a multiple of ten to the power of minus <tt>precision</tt>. <tt>precision</tt> is optional and by default value <tt>0</tt> is used.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value.</li>
+
+<li><tt>precision</tt>: an optional <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> field representing the number of digits in the fraction of the the result</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>The rounded value for the given number in the same type as the input argument,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-numeric value,</li>
+
+<li>or, the second argument is any other non-tinyint, non-smallint, non-integer, or non-bigint value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": round_half_to_even(2013),
+ "v2": round_half_to_even(-4036),
+ "v3": round_half_to_even(0.8),
+ "v4": round_half_to_even(float("-2013.256")),
+ "v5": round_half_to_even(double("-2013.893823748327284")),
+ "v6": round_half_to_even(double("-2013.893823748327284"), 2),
+ "v7": round_half_to_even(2013, 4),
+ "v8": round_half_to_even(float("-2013.256"), 5)
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 2013, "v2": -4036, "v3": 1.0, "v4": -2013.0, "v5": -2014.0, "v6": -2013.89, "v7": 2013, "v8": -2013.256 }
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="String_Functions"></a><a name="StringFunctions" id="StringFunctions">String Functions</a></h2>
+<div class="section">
+<h3><a name="concat"></a>concat</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>concat(string1, string2, ...)
+</pre></div></div></li>
+
+<li>
+<p>Returns a concatenated string from arguments.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string1</tt>: a string value,</li>
+
+<li><tt>string2</tt>: a string value,</li>
+
+<li>….</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a concatenated string from arguments,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>concat("test ", "driven ", "development");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"test driven development"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="contains"></a>contains</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>contains(string, substring_to_contain)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the string <tt>string</tt> contains the string <tt>substring_to_contain</tt></p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might contain the given substring,</li>
+
+<li><tt>substring_to_contain</tt> : a target <tt>string</tt> that might be contained.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> value, <tt>true</tt> if <tt>string</tt> contains <tt>substring_to_contain</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error,</li>
+
+<li><tt>false</tt> otherwise.</li>
+ </ul></li>
+
+<li>
+<p>Note: an <a href="similarity.html#UsingIndexesToSupportSimilarityQueries">n_gram index</a> can be utilized for this function.</p></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": contains("I like x-phone", "phone"), "v2": contains("one", "phone") };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="ends_with"></a>ends_with</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>ends_with(string, substring_to_end_with)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the string <tt>string</tt> ends with the string <tt>substring_to_end_with</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might end with the given string,</li>
+
+<li><tt>substring_to_end_with</tt> : a <tt>string</tt> that might be contained as the ending substring.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> value, <tt>true</tt> if <tt>string</tt> contains <tt>substring_to_contain</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error,</li>
+
+<li><tt>false</tt> otherwise.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": ends_with(" love product-b its shortcut_menu is awesome:)", ":)"),
+ "v2": ends_with(" awsome:)", ":-)")
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="initcap_or_title"></a>initcap (or title)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>initcap(string)
+</pre></div></div></li>
+
+<li>
+<p>Converts a given string <tt>string</tt> so that the first letter of each word is uppercase and every other letter is lowercase. The function has an alias called “title”.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be converted.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> as the title form of the given <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": initcap("ASTERIXDB is here!"), "v2": title("ASTERIXDB is here!") };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": "Asterixdb Is Here!", "v2": "Asterixdb Is Here!" }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="length"></a>length</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>length(string)
+</pre></div></div></li>
+
+<li>
+<p>Returns the length of the string <tt>string</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> or <tt>null</tt> that represents the string to be checked.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>bigint</tt> that represents the length of <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>length("test string");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>11
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="lower"></a>lower</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>lower(string)
+</pre></div></div></li>
+
+<li>
+<p>Converts a given string <tt>string</tt> to its lowercase form.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be converted.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> as the lowercase form of the given <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>lower("ASTERIXDB");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"asterixdb"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="ltrim"></a>ltrim</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>ltrim(string[, chars]);
+</pre></div></div></li>
+
+<li>
+<p>Returns a new string with all leading characters that appear in <tt>chars</tt> removed. By default, white space is the character to trim.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be trimmed,</li>
+
+<li><tt>chars</tt> : a <tt>string</tt> that contains characters that are used to trim.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a trimmed, new <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>ltrim("me like x-phone", "eml");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>" like x-phone"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="position"></a>position</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>position(string, string_pattern)
+</pre></div></div></li>
+
+<li>
+<p>Returns the first position of <tt>string_pattern</tt> within <tt>string</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might contain the pattern,</li>
+
+<li><tt>string_pattern</tt> : a pattern <tt>string</tt> to be matched.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the first position that <tt>string_pattern</tt> appears within <tt>string</tt>, or -1 if it does not appear,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": position("ppphonepp", "phone"),
+ "v2": position("hone", "phone")
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 3, "v2": -1 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="regexp_contains"></a>regexp_contains</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>regexp_contains(string, string_pattern[, string_flags])
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the strings <tt>string</tt> contains the regular expression pattern <tt>string_pattern</tt> (a Java regular expression pattern).</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might contain the pattern,</li>
+
+<li><tt>string_pattern</tt> : a pattern <tt>string</tt> to be matched,</li>
+
+<li><tt>string_flag</tt> : (Optional) a <tt>string</tt> with flags to be used during regular expression matching.
+
+<ul>
+
+<li>The following modes are enabled with these flags: dotall (s), multiline (m), case_insensitive (i), and comments and whitespace (x).</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt>, returns <tt>true</tt> if <tt>string</tt> contains the pattern <tt>string_pattern</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error,</li>
+
+<li><tt>false</tt> otherwise.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": regexp_contains("pphonepp", "p*hone"),
+ "v2": regexp_contains("hone", "p+hone")
+}
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="regexp_like"></a>regexp_like</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>regexp_like(string, string_pattern[, string_flags])
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the string <tt>string</tt> exactly matches the regular expression pattern <tt>string_pattern</tt> (a Java regular expression pattern).</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might contain the pattern,</li>
+
+<li><tt>string_pattern</tt> : a pattern <tt>string</tt> that might be contained,</li>
+
+<li><tt>string_flag</tt> : (Optional) a <tt>string</tt> with flags to be used during regular expression matching.
+
+<ul>
+
+<li>The following modes are enabled with these flags: dotall (s), multiline (m), case_insensitive (i), and comments and whitespace (x).</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> value, <tt>true</tt> if <tt>string</tt> contains the pattern <tt>string_pattern</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error,</li>
+
+<li><tt>false</tt> otherwise.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": regexp_like(" can't stand acast the network is horrible:(", ".*acast.*"),
+ "v2": regexp_like("acast", ".*acst.*")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="regexp_position"></a>regexp_position</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>regexp_position(string, string_pattern[, string_flags])
+</pre></div></div></li>
+
+<li>
+<p>Returns first position of the regular expression <tt>string_pattern</tt> (a Java regular expression pattern) within <tt>string</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might contain the pattern,</li>
+
+<li><tt>string_pattern</tt> : a pattern <tt>string</tt> to be matched,</li>
+
+<li><tt>string_flag</tt> : (Optional) a <tt>string</tt> with flags to be used during regular expression matching.
+
+<ul>
+
+<li>The following modes are enabled with these flags: dotall (s), multiline (m), case_insensitive (i), and comments and whitespace (x).</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the first position that the regular expression <tt>string_pattern</tt> appears in <tt>string</tt>, or -1 if it does not appear.</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": regexp_position("pphonepp", "p*hone"),
+ "v2": regexp_position("hone", "p+hone")
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1, "v2": -1 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="regexp_replace"></a>regexp_replace</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>regexp_replace(string, string_pattern, string_replacement[, string_flags])
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the string <tt>string</tt> matches the given regular expression pattern <tt>string_pattern</tt> (a Java regular expression pattern), and replace the matched pattern <tt>string_pattern</tt> with the new pattern <tt>string_replacement</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might contain the pattern,</li>
+
+<li><tt>string_pattern</tt> : a pattern <tt>string</tt> to be matched,</li>
+
+<li><tt>string_replacement</tt> : a pattern <tt>string</tt> to be used as the replacement,</li>
+
+<li><tt>string_flag</tt> : (Optional) a <tt>string</tt> with flags to be used during replace.
+
+<ul>
+
+<li>The following modes are enabled with these flags: dotall (s), multiline (m), case_insensitive (i), and comments and whitespace (x).</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>Returns a <tt>string</tt> that is obtained after the replacements,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>regexp_replace(" like x-phone the voicemail_service is awesome", " like x-phone", "like product-a")
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"like product-a the voicemail_service is awesome"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="repeat"></a>repeat</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>repeat(string, n)
+</pre></div></div></li>
+
+<li>
+<p>Returns a string formed by repeating the input <tt>string</tt> <tt>n</tt> times.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be repeated,</li>
+
+<li><tt>offset</tt> : an <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value as the starting offset of the substring in <tt>string</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a string that repeats the input <tt>string</tt> <tt>n</tt> times,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-string value,</li>
+
+<li>or, the second argument is not a <tt>tinyint</tt>, <tt>smallint</tt>, <tt>integer</tt>, or <tt>bigint</tt>.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>repeat("test", 3);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"testtesttest"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="rtrim"></a>rtrim</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>rtrim(string[, chars]);
+</pre></div></div></li>
+
+<li>
+<p>Returns a new string with all trailing characters that appear in <tt>chars</tt> removed. By default, white space is the character to trim.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be trimmed,</li>
+
+<li><tt>chars</tt> : a <tt>string</tt> that contains characters that are used to trim.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a trimmed, new <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": rtrim("i like x-phone", "x-phone"),
+ "v2": rtrim("i like x-phone", "onexph")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": "i like ", "v2": "i like " }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="split"></a>split</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>split(string, sep)
+</pre></div></div></li>
+
+<li>
+<p>Splits the input <tt>string</tt> into an array of substrings separated by the string <tt>sep</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be split.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an array of substrings by splitting the input <tt>string</tt> by <tt>sep</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>split("test driven development", " ");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ "test", "driven", "development" ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="starts_with"></a>starts_with</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>starts_with(string, substring_to_start_with)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the string <tt>string</tt> starts with the string <tt>substring_to_start_with</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that might start with the given string.</li>
+
+<li><tt>substring_to_start_with</tt> : a <tt>string</tt> that might be contained as the starting substring.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt>, returns <tt>true</tt> if <tt>string</tt> starts with the string <tt>substring_to_start_with</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error,</li>
+
+<li><tt>false</tt> otherwise.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1" : starts_with(" like the plan, amazing", " like"),
+ "v2" : starts_with("I like the plan, amazing", " like")
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="substr"></a>substr</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>substr(string, offset[, length])
+</pre></div></div></li>
+
+<li>
+<p>Returns the substring from the given string <tt>string</tt> based on the given start offset <tt>offset</tt> with the optional <tt>length</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be extracted,</li>
+
+<li><tt>offset</tt> : an <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value as the starting offset of the substring in <tt>string</tt>,</li>
+
+<li><tt>length</tt> : (Optional) an an <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value as the length of the substring.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> that represents the substring,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-string value,</li>
+
+<li>or, the second argument is not a <tt>tinyint</tt>, <tt>smallint</tt>, <tt>integer</tt>, or <tt>bigint</tt>,</li>
+
+<li>or, the third argument is not a <tt>tinyint</tt>, <tt>smallint</tt>, <tt>integer</tt>, or <tt>bigint</tt> if the argument is present.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>substr("test string", 6, 3);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"str"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="trim"></a>trim</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>trim(string[, chars]);
+</pre></div></div></li>
+
+<li>
+<p>Returns a new string with all leading characters that appear in <tt>chars</tt> removed. By default, white space is the character to trim.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be trimmed,</li>
+
+<li><tt>chars</tt> : a <tt>string</tt> that contains characters that are used to trim.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a trimmed, new <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>trim("i like x-phone", "xphoen");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>" like "
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="upper"></a>upper</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>upper(string)
+</pre></div></div></li>
+
+<li>
+<p>Converts a given string <tt>string</tt> to its uppercase form.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be converted.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> as the uppercase form of the given <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>upper("hello")
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"HELLO"
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div>
+<div class="section">
+<h3><a name="string_concat"></a>string_concat</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>string_concat(array)
+</pre></div></div></li>
+
+<li>
+<p>Concatenates an array of strings <tt>array</tt> into a single string.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array</tt> : an <tt>array</tt> or <tt>multiset</tt> of <tt>string</tt>s (could be <tt>null</tt> or <tt>missing</tt>) to be concatenated.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the concatenated <tt>string</tt> value,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li><tt>missing</tt> if any element in the input array is <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if any element in the input array is <tt>null</tt> but no element in the input array is <tt>missing</tt>,</li>
+
+<li>any other non-array input value or non-integer element in the input array will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>string_concat(["ASTERIX", " ", "ROCKS!"]);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"ASTERIX ROCKS!"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="string_join"></a>string_join</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>string_join(array, string)
+</pre></div></div></li>
+
+<li>
+<p>Joins an array or multiset of strings <tt>array</tt> with the given separator <tt>string</tt> into a single string.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array</tt> : an <tt>array</tt> or <tt>multiset</tt> of strings (could be <tt>null</tt>) to be joined.</li>
+
+<li><tt>string</tt> : a <tt>string</tt> to serve as the separator.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the joined <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li><tt>missing</tt> if the first argument array contains a <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if the first argument array contains a <tt>null</tt> but does not contain a <tt>missing</tt>,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-array value, or contains any other non-string value,</li>
+
+<li>or, the second argument is any other non-string value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>string_join(["ASTERIX", "ROCKS~"], "!! ");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"ASTERIX!! ROCKS~"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="string_to_codepoint"></a>string_to_codepoint</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>string_to_codepoint(string)
+</pre></div></div></li>
+
+<li>
+<p>Converts the string <tt>string</tt> to its code_based representation.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that will be converted.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>array</tt> of the code points for the string <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>string_to_codepoint("Hello ASTERIX!");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ 72, 101, 108, 108, 111, 32, 65, 83, 84, 69, 82, 73, 88, 33 ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="codepoint_to_string"></a>codepoint_to_string</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>codepoint_to_string(array)
+</pre></div></div></li>
+
+<li>
+<p>Converts the ordered code_based representation <tt>array</tt> to the corresponding string.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array</tt> : an <tt>array</tt> of integer code_points.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> representation of <tt>array</tt>.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li><tt>missing</tt> if any element in the input array is <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if any element in the input array is <tt>null</tt> but no element in the input array is <tt>missing</tt>,</li>
+
+<li>any other non-array input value or non-integer element in the input array will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>codepoint_to_string([72, 101, 108, 108, 111, 32, 65, 83, 84, 69, 82, 73, 88, 33]);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"Hello ASTERIX!"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="substring_before"></a>substring_before</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>substring_before(string, string_pattern)
+</pre></div></div></li>
+
+<li>
+<p>Returns the substring from the given string <tt>string</tt> before the given pattern <tt>string_pattern</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be extracted.</li>
+
+<li><tt>string_pattern</tt> : a <tt>string</tt> pattern to be searched.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> that represents the substring,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>substring_before(" like x-phone", "x-phone");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>" like "
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="substring_after"></a>substring_after</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>substring_after(string, string_pattern);</p></li>
+
+<li>
+<p>Returns the substring from the given string <tt>string</tt> after the given pattern <tt>string_pattern</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> to be extracted.</li>
+
+<li><tt>string_pattern</tt> : a <tt>string</tt> pattern to be searched.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> that represents the substring,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>substring_after(" like x-phone", "xph");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"one"
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Binary_Functions"></a><a name="BinaryFunctions" id="BinaryFunctions">Binary Functions</a></h2>
+<div class="section">
+<h3><a name="parse_binary"></a>parse_binary</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>parse_binary(string, encoding)</p></li>
+
+<li>
+<p>Creates a <tt>binary</tt> from an string encoded in <tt>encoding</tt> format.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : an encoded <tt>string</tt>,</li>
+
+<li><tt>encoding</tt> : a string notation specifies the encoding type of the given <tt>string</tt>. Currently we support <tt>hex</tt> and <tt>base64</tt> format.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>binary</tt> that is decoded from the given <tt>string</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+<p>[ parse_binary(“ABCDEF0123456789”,“hex”), parse_binary(“abcdef0123456789”,“HEX”), parse_binary(‘QXN0ZXJpeAE=’,“base64”) ];</p></li>
+
+<li>
+<p>The expected result is:</p>
+<p>[ hex(“ABCDEF0123456789”), hex(“ABCDEF0123456789”), hex(“4173746572697801”) ]</p></li>
+</ul></div>
+<div class="section">
+<h3><a name="print_binary"></a>print_binary</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>print_binary(binary, encoding)</p></li>
+
+<li>
+<p>Prints a <tt>binary</tt> to the required encoding <tt>string</tt> format.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>binary</tt> : a <tt>binary</tt> data need to be printed.</li>
+
+<li><tt>encoding</tt> : a string notation specifies the expected encoding type. Currently we support <tt>hex</tt> and <tt>base64</tt> format.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> that represents the encoded format of a <tt>binary</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ print_binary(hex("ABCDEF0123456789"), "base64"), print_binary(base64("q83vASNFZ4k="), "hex") ]
+</pre></div></div></li>
+
+<li>
+<p>The expected result are:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ "q83vASNFZ4k=", "ABCDEF0123456789" ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="binary_length"></a>binary_length</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>binary_length(binary)</p></li>
+
+<li>
+<p>Returns the number of bytes storing the binary data.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>binary</tt> : a <tt>binary</tt> value to be checked.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>bigint</tt> that represents the number of bytes,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-binary input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>binary_length(hex("00AA"))
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+<p>2</p></li>
+</ul></div>
+<div class="section">
+<h3><a name="sub_binary"></a>sub_binary</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>sub_binary(binary, offset[, length])</p></li>
+
+<li>
+<p>Returns the sub binary from the given <tt>binary</tt> based on the given start offset with the optional <tt>length</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>binary</tt> : a <tt>binary</tt> to be extracted,</li>
+
+<li><tt>offset</tt> : a <tt>tinyint</tt>, <tt>smallint</tt>, <tt>integer</tt>, or <tt>bigint</tt> value as the starting offset of the sub binary in <tt>binary</tt>,</li>
+
+<li><tt>length</tt> : (Optional) a <tt>tinyint</tt>, <tt>smallint</tt>, <tt>integer</tt>, or <tt>bigint</tt> value as the length of the sub binary.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>binary</tt> that represents the sub binary,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-binary value,</li>
+
+<li>or, the second argument is any other non-integer value,</li>
+
+<li>or, the third argument is any other non-integer value, if it is present.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>sub_binary(hex("AABBCCDD"), 4);
+</pre></div></div></li>
+
+<li>
+<p>The expected result is</p>
+
+<div class="source">
+<div class="source">
+<pre>hex("DD")
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="binary_concat"></a>binary_concat</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>binary_concat(array)</p></li>
+
+<li>
+<p>Concatenates a binary <tt>array</tt> or <tt>multiset</tt> into a single binary.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array</tt> : an <tt>array</tt> or <tt>multiset</tt> of binaries (could be <tt>null</tt> or <tt>missing</tt>) to be concatenated.</li>
+ </ul></li>
+
+<li>Return Value :
+
+<ul>
+
+<li>the concatenated <tt>binary</tt> value,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li><tt>missing</tt> if any element in the input array is <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if any element in the input array is <tt>null</tt> but no element in the input array is <tt>missing</tt>,</li>
+
+<li>any other non-array input value or non-binary element in the input array will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+<p>binary_concat([hex(“42”), hex(""), hex(‘42’)]);</p></li>
+
+<li>
+<p>The expected result is</p>
+<p>hex(“4242”)</p></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Spatial_Functions"></a><a name="SpatialFunctions" id="SpatialFunctions">Spatial Functions</a></h2>
+<div class="section">
+<h3><a name="create_point"></a>create_point</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>create_point(x, y)
+</pre></div></div></li>
+
+<li>
+<p>Creates the primitive type <tt>point</tt> using an <tt>x</tt> and <tt>y</tt> value.</p></li>
+
+<li>Arguments:</li>
+
+<li><tt>x</tt> : a <tt>double</tt> that represents the x-coordinate,</li>
+
+<li><tt>y</tt> : a <tt>double</tt> that represents the y-coordinate.</li>
+
+<li>Return Value:</li>
+
+<li>a <tt>point</tt> representing the ordered pair (<tt>x</tt>, <tt>y</tt>),</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-double input value will cause a type error.</li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "point": create_point(30.0,70.0) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "point": point("30.0,70.0") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="create_line"></a>create_line</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>create_line(point1, point2)
+</pre></div></div></li>
+
+<li>
+<p>Creates the primitive type <tt>line</tt> using <tt>point1</tt> and <tt>point2</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>point1</tt> : a <tt>point</tt> that represents the start point of the line.</li>
+
+<li><tt>point2</tt> : a <tt>point</tt> that represents the end point of the line.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a spatial <tt>line</tt> created using the points provided in <tt>point1</tt> and <tt>point2</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-point input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "line": create_line(create_point(30.0,70.0), create_point(50.0,90.0)) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "line": line("30.0,70.0 50.0,90.0") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="create_rectangle"></a>create_rectangle</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>create_rectangle(point1, point2)
+</pre></div></div></li>
+
+<li>
+<p>Creates the primitive type <tt>rectangle</tt> using <tt>point1</tt> and <tt>point2</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>point1</tt> : a <tt>point</tt> that represents the lower_left point of the rectangle.</li>
+
+<li><tt>point2</tt> : a <tt>point</tt> that represents the upper_right point of the rectangle.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a spatial <tt>rectangle</tt> created using the points provided in <tt>point1</tt> and <tt>point2</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-point input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "rectangle": create_rectangle(create_point(30.0,70.0), create_point(50.0,90.0)) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "rectangle": rectangle("30.0,70.0 50.0,90.0") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="create_circle"></a>create_circle</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>create_circle(point, radius)
+</pre></div></div></li>
+
+<li>
+<p>Creates the primitive type <tt>circle</tt> using <tt>point</tt> and <tt>radius</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>point</tt> : a <tt>point</tt> that represents the center of the circle.</li>
+
+<li><tt>radius</tt> : a <tt>double</tt> that represents the radius of the circle.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a spatial <tt>circle</tt> created using the center point and the radius provided in <tt>point</tt> and <tt>radius</tt>.</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-point value,</li>
+
+<li>or, the second argument is any other non-double value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "circle": create_circle(create_point(30.0,70.0), 5.0) }
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "circle": circle("30.0,70.0 5.0") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="create_polygon"></a>create_polygon</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>create_polygon(array)
+</pre></div></div></li>
+
+<li>
+<p>Creates the primitive type <tt>polygon</tt> using the double values provided in the argument <tt>array</tt>. Each two consecutive double values represent a point starting from the first double value in the array. Note that at least six double values should be specified, meaning a total of three points.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array</tt> : an array of doubles representing the points of the polygon.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>polygon</tt>, represents a spatial simple polygon created using the points provided in <tt>array</tt>.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li><tt>missing</tt> if any element in the input array is <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if any element in the input array is <tt>null</tt> but no element in the input array is <tt>missing</tt>,</li>
+
+<li>any other non-array input value or non-double element in the input array will cause a type error.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "polygon": create_polygon([1.0,1.0,2.0,2.0,3.0,3.0,4.0,4.0]) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "polygon": polygon("1.0,1.0 2.0,2.0 3.0,3.0 4.0,4.0") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_xget_y"></a>get_x/get_y</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_x(point) or get_y(point)
+</pre></div></div></li>
+
+<li>
+<p>Returns the x or y coordinates of a point <tt>point</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>point</tt> : a <tt>point</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>double</tt> representing the x or y coordinates of the point <tt>point</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-point input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "x_coordinate": get_x(create_point(2.3,5.0)), "y_coordinate": get_y(create_point(2.3,5.0)) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "x_coordinate": 2.3, "y_coordinate": 5.0 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_points"></a>get_points</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_points(spatial_object)
+</pre></div></div></li>
+
+<li>
+<p>Returns an ordered array of the points forming the spatial object <tt>spatial_object</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>spatial_object</tt> : a <tt>point</tt>, <tt>line</tt>, <tt>rectangle</tt>, <tt>circle</tt>, or <tt>polygon</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>array</tt> of the points forming the spatial object <tt>spatial_object</tt>,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-spatial-object input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_points(create_polygon([1.0,1.0,2.0,2.0,3.0,3.0,4.0,4.0]))
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ point("1.0,1.0"), point("2.0,2.0"), point("3.0,3.0"), point("4.0,4.0") ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_centerget_radius"></a>get_center/get_radius</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_center(circle_expression) or get_radius(circle_expression)
+</pre></div></div></li>
+
+<li>
+<p>Returns the center and the radius of a circle <tt>circle_expression</tt>, respectively.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>circle_expression</tt> : a <tt>circle</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>point</tt> or <tt>double</tt>, represent the center or radius of the circle <tt>circle_expression</tt>.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-circle input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "circle_radius": get_radius(create_circle(create_point(6.0,3.0), 1.0)),
+ "circle_center": get_center(create_circle(create_point(6.0,3.0), 1.0))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "circle_radius": 1.0, "circle_center": point("6.0,3.0") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="spatial_distance"></a>spatial_distance</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_distance(point1, point2)
+</pre></div></div></li>
+
+<li>
+<p>Returns the Euclidean distance between <tt>point1</tt> and <tt>point2</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>point1</tt> : a <tt>point</tt>.</li>
+
+<li><tt>point2</tt> : a <tt>point</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>double</tt> as the Euclidean distance between <tt>point1</tt> and <tt>point2</tt>.</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-point input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_distance(point("47.44,80.65"), create_point(30.0,70.0));
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>20.434678857275934
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="spatial_area"></a>spatial_area</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_area(spatial_2d_expression)
+</pre></div></div></li>
+
+<li>
+<p>Returns the spatial area of <tt>spatial_2d_expression</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>spatial_2d_expression</tt> : a <tt>rectangle</tt>, <tt>circle</tt>, or <tt>polygon</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>double</tt> representing the area of <tt>spatial_2d_expression</tt>.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-2d-spatial-object will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_area(create_circle(create_point(0.0,0.0), 5.0));
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>78.53981625
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="spatial_intersect"></a>spatial_intersect</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_intersect(spatial_object1, spatial_object2)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether <tt>@arg1</tt> and <tt>@arg2</tt> spatially intersect each other.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>spatial_object1</tt> : a <tt>point</tt>, <tt>line</tt>, <tt>rectangle</tt>, <tt>circle</tt>, or <tt>polygon</tt>.</li>
+
+<li><tt>spatial_object2</tt> : a <tt>point</tt>, <tt>line</tt>, <tt>rectangle</tt>, <tt>circle</tt>, or <tt>polygon</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> representing whether <tt>spatial_object1</tt> and <tt>spatial_object2</tt> spatially overlap with each other,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-spatial-object input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_intersect(point("39.28,70.48"), create_rectangle(create_point(30.0,70.0), create_point(40.0,80.0)));
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>true
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="spatial_cell"></a>spatial_cell</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_cell(point1, point2, x_increment, y_increment)
+</pre></div></div></li>
+
+<li>
+<p>Returns the grid cell that <tt>point1</tt> belongs to.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>point1</tt> : a <tt>point</tt> representing the point of interest that its grid cell will be returned.</li>
+
+<li><tt>point2</tt> : a <tt>point</tt> representing the origin of the grid.</li>
+
+<li><tt>x_increment</tt> : a <tt>double</tt>, represents X increments.</li>
+
+<li><tt>y_increment</tt> : a <tt>double</tt>, represents Y increments.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>rectangle</tt> representing the grid cell that <tt>point1</tt> belongs to,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first or second argument is any other non-point value,</li>
+
+<li>or, the second or third argument is any other non-double value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>spatial_cell(point("39.28,70.48"), create_point(20.0,50.0), 5.5, 6.0);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>rectangle("36.5,68.0 42.0,74.0");
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Similarity_Functions"></a><a name="SimilarityFunctions" id="SimilarityFunctions">Similarity Functions</a></h2>
+<p>AsterixDB supports queries with different similarity functions, including <a class="externalLink" href="http://en.wikipedia.org/wiki/Levenshtein_distance">edit distance</a> and <a class="externalLink" href="https://en.wikipedia.org/wiki/Jaccard_index">Jaccard</a>.</p>
+<div class="section">
+<h3><a name="edit_distance"></a>edit_distance</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>edit_distance(expression1, expression2)
+</pre></div></div></li>
+
+<li>
+<p>Returns the edit distance of <tt>expression1</tt> and <tt>expression2</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expression1</tt> : a <tt>string</tt> or a homogeneous <tt>array</tt> of a comparable item type.</li>
+
+<li><tt>expression2</tt> : The same type as <tt>expression1</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>bigint</tt> that represents the edit distance between <tt>expression1</tt> and <tt>expression2</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>Note: an <a href="similarity.html#UsingIndexesToSupportSimilarityQueries">n_gram index</a> can be utilized for this function.</li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>edit_distance("SuzannaTillson", "Suzanna Tilson");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>2
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="edit_distance_check"></a>edit_distance_check</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>edit_distance_check(expression1, expression2, threshold)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the edit distance of <tt>expression1</tt> and <tt>expression2</tt> is within a given threshold.</p></li>
+
+<li>
+<p>Arguments:</p>
+
+<ul>
+
+<li><tt>expression1</tt> : a <tt>string</tt> or a homogeneous <tt>array</tt> of a comparable item type.</li>
+
+<li><tt>expression2</tt> : The same type as <tt>expression1</tt>.</li>
+
+<li><tt>threshold</tt> : a <tt>bigint</tt> that represents the distance threshold.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>array</tt> with two items:
+
+<ul>
+
+<li>The first item contains a <tt>boolean</tt> value representing whether the edit distance of <tt>expression1</tt> and <tt>expression2</tt> is within the given threshold.</li>
+
+<li>The second item contains an <tt>integer</tt> that represents the edit distance of <tt>expression1</tt> and <tt>expression2</tt> if the first item is true.</li>
+
+<li>If the first item is false, then the second item is set to 2147483647.</li>
+ </ul></li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first or second argument is any other non-string value,</li>
+
+<li>or, the third argument is any other non-bigint value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Note: an <a href="similarity.html#UsingIndexesToSupportSimilarityQueries">n_gram index</a> can be utilized for this function.</li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>edit_distance_check("happy","hapr",2);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ true, 2 ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="edit_distance_contains"></a>edit_distance_contains</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>edit_distance_contains(expression1, expression2, threshold)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether <tt>expression1</tt> contains <tt>expression2</tt> with an <a class="externalLink" href="http://en.wikipedia.org/wiki/Levenshtein_distance">edit distance</a> within a given threshold.</p></li>
+
+<li>
+<p>Arguments:</p>
+
+<ul>
+
+<li><tt>expression1</tt> : a <tt>string</tt> or a homogeneous <tt>array</tt> of a comparable item type.</li>
+
+<li><tt>expression2</tt> : The same type as <tt>expression1</tt>.</li>
+
+<li><tt>threshold</tt> : a <tt>bigint</tt> that represents the distance threshold.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>array</tt> with two items:
+
+<ul>
+
+<li>The first item contains a <tt>boolean</tt> value representing whether <tt>expression1</tt> can contain <tt>expression2</tt>.</li>
+
+<li>The second item contains an <tt>integer</tt> that represents the required edit distance for <tt>expression1</tt> to contain <tt>expression2</tt> if the first item is true.</li>
+ </ul></li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first or second argument is any other non-string value,</li>
+
+<li>or, the third argument is any other non-bigint value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Note: an <a href="similarity.html#UsingIndexesToSupportSimilarityQueries">n_gram index</a> can be utilized for this function.</li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>edit_distance_contains("happy","hapr",2);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ true, 1 ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="similarity_jaccard"></a>similarity_jaccard</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>similarity_jaccard(array1, array2)
+</pre></div></div></li>
+
+<li>
+<p>Returns the <a class="externalLink" href="http://en.wikipedia.org/wiki/Jaccard_index">Jaccard similarity</a> of <tt>array1</tt> and <tt>array2</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array1</tt> : an <tt>array</tt> or <tt>multiset</tt>.</li>
+
+<li><tt>array2</tt> : an <tt>array</tt> or <tt>multiset</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>float</tt> that represents the Jaccard similarity of <tt>array1</tt> and <tt>array2</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li><tt>missing</tt> if any element in any input array is <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if any element in any input array is <tt>null</tt> but no element in the input array is <tt>missing</tt>,</li>
+
+<li>any other non-array input value or non-integer element in any input array will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Note: a <a href="similarity.html#UsingIndexesToSupportSimilarityQueries">keyword index</a> can be utilized for this function.</p></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>similarity_jaccard([1,5,8,9], [1,5,9,10]);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>0.6
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="similarity_jaccard_check"></a>similarity_jaccard_check</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>similarity_jaccard_check(array1, array2, threshold)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether <tt>array1</tt> and <tt>array2</tt> have a <a class="externalLink" href="http://en.wikipedia.org/wiki/Jaccard_index">Jaccard similarity</a> greater than or equal to threshold. Again, the “check” version of Jaccard is faster than the “non_check” version.</p></li>
+
+<li>
+<p>Arguments:</p>
+
+<ul>
+
+<li><tt>array1</tt> : an <tt>array</tt> or <tt>multiset</tt>.</li>
+
+<li><tt>array2</tt> : an <tt>array</tt> or <tt>multiset</tt>.</li>
+
+<li><tt>threshold</tt> : a <tt>double</tt> that represents the similarity threshold.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>array</tt> with two items:
+
+<ul>
+
+<li>The first item contains a <tt>boolean</tt> value representing whether <tt>array1</tt> and <tt>array2</tt> are similar.</li>
+
+<li>The second item contains a <tt>float</tt> that represents the Jaccard similarity of <tt>array1</tt> and <tt>array2</tt> if it is greater than or equal to the threshold, or 0 otherwise.</li>
+ </ul></li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li><tt>missing</tt> if any element in any input array is <tt>missing</tt>,</li>
+
+<li><tt>null</tt> if any element in any input array is <tt>null</tt> but no element in the input array is <tt>missing</tt>,</li>
+
+<li>a type error will be raised if: * the first or second argument is any other non-array value, * or, the third argument is any other non-double value.</li>
+ </ul></li>
+
+<li>
+<p>Note: a <a href="similarity.html#UsingIndexesToSupportSimilarityQueries">keyword index</a> can be utilized for this function.</p></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>similarity_jaccard_check([1,5,8,9], [1,5,9,10], 0.6);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ false, 0.0 ]
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Tokenizing_Functions"></a><a name="TokenizingFunctions" id="TokenizingFunctions">Tokenizing Functions</a></h2>
+<div class="section">
+<h3><a name="word_tokens"></a>word_tokens</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>word_tokens(string)
+</pre></div></div></li>
+
+<li>
+<p>Returns an array of word tokens of <tt>string</tt> using non_alphanumeric characters as delimiters.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>string</tt> : a <tt>string</tt> that will be tokenized.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>array</tt> of <tt>string</tt> word tokens,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-string input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>word_tokens("I like the phone, awesome!");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ "i", "like", "the", "phone", "awesome" ]
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Temporal_Functions"></a><a name="TemporalFunctions" id="TemporalFunctions">Temporal Functions</a></h2>
+<div class="section">
+<h3><a name="get_yearget_monthget_dayget_hourget_minuteget_secondget_millisecond"></a>get_year/get_month/get_day/get_hour/get_minute/get_second/get_millisecond</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_year/get_month/get_day/get_hour/get_minute/get_second/get_millisecond(temporal_value)
+</pre></div></div></li>
+
+<li>
+<p>Accessors for accessing fields in a temporal value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>temporal_value</tt> : a temporal value represented as one of the following types: <tt>date</tt>, <tt>datetime</tt>, <tt>time</tt>, and <tt>duration</tt>.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>bigint</tt> value representing the field to be extracted,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "year": get_year(date("2010-10-30")),
+ "month": get_month(datetime("1987-11-19T23:49:23.938")),
+ "day": get_day(date("2010-10-30")),
+ "hour": get_hour(time("12:23:34.930+07:00")),
+ "min": get_minute(duration("P3Y73M632DT49H743M3948.94S")),
+ "second": get_second(datetime("1987-11-19T23:49:23.938")),
+ "ms": get_millisecond(duration("P3Y73M632DT49H743M3948.94S"))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "year": 2010, "month": 11, "day": 30, "hour": 5, "min": 28, "second": 23, "ms": 94 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="adjust_datetime_for_timezone"></a>adjust_datetime_for_timezone</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>adjust_datetime_for_timezone(datetime, string)
+</pre></div></div></li>
+
+<li>
+<p>Adjusts the given datetime <tt>datetime</tt> by applying the timezone information <tt>string</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>datetime</tt> : a <tt>datetime</tt> value to be adjusted.</li>
+
+<li><tt>string</tt> : a <tt>string</tt> representing the timezone information.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> value representing the new datetime after being adjusted by the timezone information,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-datetime value,</li>
+
+<li>or, the second argument is any other non-string value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>adjust_datetime_for_timezone(datetime("2008-04-26T10:10:00"), "+08:00");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"2008-04-26T18:10:00.000+08:00"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="adjust_time_for_timezone"></a>adjust_time_for_timezone</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>adjust_time_for_timezone(time, string)
+</pre></div></div></li>
+
+<li>
+<p>Adjusts the given time <tt>time</tt> by applying the timezone information <tt>string</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>time</tt> : a <tt>time</tt> value to be adjusted.</li>
+
+<li><tt>string</tt> : a <tt>string</tt> representing the timezone information.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> value representing the new time after being adjusted by the timezone information,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-time value,</li>
+
+<li>or, the second argument is any other non-string value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>adjust_time_for_timezone(get_time_from_datetime(datetime("2008-04-26T10:10:00")), "+08:00");
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"18:10:00.000+08:00"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="calendar_duration_from_datetime"></a>calendar_duration_from_datetime</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>calendar_duration_from_datetime(datetime, duration_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets a user_friendly representation of the duration <tt>duration_value</tt> based on the given datetime <tt>datetime</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>datetime</tt> : a <tt>datetime</tt> value to be used as the reference time point.</li>
+
+<li><tt>duration_value</tt> : a <tt>duration</tt> value to be converted.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>duration</tt> value with the duration as <tt>duration_value</tt> but with a user_friendly representation,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-datetime value,</li>
+
+<li>or, the second argument is any other non-duration input value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>calendar_duration_from_datetime(
+ datetime("2016-03-26T10:10:00"),
+ datetime("2016-03-26T10:10:00") - datetime("2011-01-01T00:00:00")
+);
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>duration("P5Y2M24DT10H10M")
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_year_month_durationget_day_time_duration"></a>get_year_month_duration/get_day_time_duration</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_year_month_duration/get_day_time_duration(duration_value)
+</pre></div></div></li>
+
+<li>
+<p>Extracts the correct <tt>duration</tt> subtype from <tt>duration_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>duration_value</tt> : a <tt>duration</tt> value to be converted.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>year_month_duration</tt> value or a <tt>day_time_duration</tt> value,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-duration input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_year_month_duration(duration("P12M50DT10H"));
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>year_month_duration("P1Y")
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="months_from_year_month_durationmilliseconds_from_day_time_duration"></a>months_from_year_month_duration/milliseconds_from_day_time_duration</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>months_from_year_month_duration/milliseconds_from_day_time_duration(duration_value)
+</pre></div></div></li>
+
+<li>
+<p>Extracts the number of months or the number of milliseconds from the <tt>duration</tt> subtype.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>duration_value</tt> : a <tt>duration</tt> of the correct subtype.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>bigint</tt> representing the number or months/milliseconds,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-duration input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>months_from_year_month_duration(get_year_month_duration(duration("P5Y7MT50M")));
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>67
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="duration_from_monthsduration_from_ms"></a>duration_from_months/duration_from_ms</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>duration_from_months/duration_from_ms(number_value)
+</pre></div></div></li>
+
+<li>
+<p>Creates a <tt>duration</tt> from <tt>number_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>number_value</tt> : a <tt>bigint</tt> representing the number of months/milliseconds</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>duration</tt> containing <tt>number_value</tt> value for months/milliseconds,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-duration input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>duration_from_months(8);
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>duration("P8M")
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="duration_from_interval"></a>duration_from_interval</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>duration_from_interval(interval_value)
+</pre></div></div></li>
+
+<li>
+<p>Creates a <tt>duration</tt> from <tt>interval_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval_value</tt> : an <tt>interval</tt> value</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>duration</tt> representing the time in the <tt>interval_value</tt></li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-duration input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "dr1" : duration_from_interval(interval(date("2010-10-30"), date("2010-12-21"))),
+ "dr2" : duration_from_interval(interval(datetime("2012-06-26T01:01:01.111"), datetime("2012-07-27T02:02:02.222"))),
+ "dr3" : duration_from_interval(interval(time("12:32:38"), time("20:29:20"))),
+ "dr4" : duration_from_interval(null)
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "dr1": day_time_duration("P52D"),
+ "dr2": day_time_duration("P31DT1H1M1.111S"),
+ "dr3": day_time_duration("PT7H56M42S"),
+ "dr4": null
+}
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="current_date"></a>current_date</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>current_date()
+</pre></div></div></li>
+
+<li>
+<p>Gets the current date.</p></li>
+
+<li>Arguments: None</li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>date</tt> value of the date when the function is called.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="current_time"></a>current_time</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>current_time()
+</pre></div></div></li>
+
+<li>
+<p>Get the current time</p></li>
+
+<li>Arguments: None</li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>time</tt> value of the time when the function is called.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="current_datetime"></a>current_datetime</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>current_datetime()
+</pre></div></div></li>
+
+<li>
+<p>Get the current datetime</p></li>
+
+<li>Arguments: None</li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>datetime</tt> value of the datetime when the function is called.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_date_from_datetime"></a>get_date_from_datetime</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_date_from_datetime(datetime)
+</pre></div></div></li>
+
+<li>
+<p>Gets the date value from the given datetime value <tt>datetime</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>datetime</tt>: a <tt>datetime</tt> value to be extracted from.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>date</tt> value from the datetime,</li>
+
+<li>any other non-datetime input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_time_from_datetime"></a>get_time_from_datetime</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_time_from_datetime(datetime)
+</pre></div></div></li>
+
+<li>
+<p>Get the time value from the given datetime value <tt>datetime</tt></p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>datetime</tt>: a <tt>datetime</tt> value to be extracted from.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>time</tt> value from the datetime.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-datetime input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_time_from_datetime(datetime("2016-03-26T10:10:00"));
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>time("10:10:00.000Z")
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="day_of_week"></a>day_of_week</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>day_of_week(date)
+</pre></div></div></li>
+
+<li>
+<p>Finds the day of the week for a given date (1_7)</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>date</tt>: a <tt>date</tt> value (Can also be a <tt>datetime</tt>)</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>tinyint</tt> representing the day of the week (1_7),</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-date input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>day_of_week(datetime("2012-12-30T12:12:12.039Z"));
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>7
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="date_from_unix_time_in_days"></a>date_from_unix_time_in_days</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>date_from_unix_time_in_days(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets a date representing the time after <tt>numeric_value</tt> days since 1970_01_01.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value representing the number of days.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>date</tt> value as the time after <tt>numeric_value</tt> days since 1970-01-01,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="datetime_from_unix_time_in_ms"></a>datetime_from_unix_time_in_ms</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>datetime_from_unix_time_in_ms(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets a datetime representing the time after <tt>numeric_value</tt> milliseconds since 1970_01_01T00:00:00Z.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value representing the number of milliseconds.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>datetime</tt> value as the time after <tt>numeric_value</tt> milliseconds since 1970-01-01T00:00:00Z,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="datetime_from_unix_time_in_secs"></a>datetime_from_unix_time_in_secs</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>datetime_from_unix_time_in_secs(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets a datetime representing the time after <tt>numeric_value</tt> seconds since 1970_01_01T00:00:00Z.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value representing the number of seconds.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>datetime</tt> value as the time after <tt>numeric_value</tt> seconds since 1970_01_01T00:00:00Z,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="datetime_from_date_time"></a>datetime_from_date_time</h3>
+
+<ul>
+
+<li>Syntax:</li>
+</ul>
+<p>datetime_from_date_time(date,time)</p>
+
+<ul>
+
+<li>Gets a datetime representing the combination of <tt>date</tt> and <tt>time</tt>
+
+<ul>
+
+<li>Arguments:</li>
+
+<li><tt>date</tt>: a <tt>date</tt> value</li>
+
+<li><tt>time</tt> a <tt>time</tt> value</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>datetime</tt> value by combining <tt>date</tt> and <tt>time</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if
+
+<ul>
+
+<li>the first argument is any other non-date value,</li>
+
+<li>or, the second argument is any other non-time value.</li>
+ </ul></li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="time_from_unix_time_in_ms"></a>time_from_unix_time_in_ms</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>time_from_unix_time_in_ms(numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets a time representing the time after <tt>numeric_value</tt> milliseconds since 00:00:00.000Z.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value representing the number of milliseconds.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>time</tt> value as the time after <tt>numeric_value</tt> milliseconds since 00:00:00.000Z,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "date": date_from_unix_time_in_days(15800),
+ "datetime": datetime_from_unix_time_in_ms(1365139700000),
+ "time": time_from_unix_time_in_ms(3748)
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "date": date("2013-04-05"), "datetime": datetime("2013-04-05T05:28:20.000Z"), "time": time("00:00:03.748Z") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="unix_time_from_date_in_days"></a>unix_time_from_date_in_days</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>unix_time_from_date_in_days(date_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets an integer value representing the number of days since 1970_01_01 for <tt>date_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>date_value</tt>: a <tt>date</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>bigint</tt> value representing the number of days,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-date input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="unix_time_from_datetime_in_ms"></a>unix_time_from_datetime_in_ms</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>unix_time_from_datetime_in_ms(datetime_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets an integer value representing the time in milliseconds since 1970_01_01T00:00:00Z for <tt>datetime_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>datetime_value</tt> : a <tt>datetime</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>bigint</tt> value representing the number of milliseconds,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-datetime input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="unix_time_from_datetime_in_secs"></a>unix_time_from_datetime_in_secs</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>unix_time_from_datetime_in_secs(datetime_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets an integer value representing the time in seconds since 1970_01_01T00:00:00Z for <tt>datetime_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>datetime_value</tt> : a <tt>datetime</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>bigint</tt> value representing the number of seconds,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-datetime input value will cause a type error.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="unix_time_from_time_in_ms"></a>unix_time_from_time_in_ms</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>unix_time_from_time_in_ms(time_value)
+</pre></div></div></li>
+
+<li>
+<p>Gets an integer value representing the time the milliseconds since 00:00:00.000Z for <tt>time_value</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>time_value</tt> : a <tt>time</tt> value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>bigint</tt> value representing the number of milliseconds,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-datetime input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "date": date_from_unix_time_in_days(15800),
+ "datetime": datetime_from_unix_time_in_ms(1365139700000),
+ "time": time_from_unix_time_in_ms(3748)
+}
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "date": date("2013-04-05"), "datetime": datetime("2013-04-05T05:28:20.000Z"), "time": time("00:00:03.748Z") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="parse_dateparse_timeparse_datetime"></a>parse_date/parse_time/parse_datetime</h3>
+
+<ul>
+
+<li>Syntax:</li>
+</ul>
+<p>parse_date/parse_time/parse_datetime(date,formatting_expression)</p>
+
+<ul>
+
+<li>Creates a <tt>date/time/date_time</tt> value by treating <tt>date</tt> with formatting <tt>formatting_expression</tt></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>date</tt>: a <tt>string</tt> value representing the <tt>date/time/datetime</tt>.</li>
+
+<li><tt>formatting_expression</tt> a <tt>string</tt> value providing the formatting for <tt>date_expression</tt>.Characters used to create date expression:</li>
+
+<li><tt>h</tt> hours</li>
+
+<li><tt>m</tt> minutes</li>
+
+<li><tt>s</tt> seconds</li>
+
+<li><tt>n</tt> milliseconds</li>
+
+<li><tt>a</tt> am/pm</li>
+
+<li><tt>z</tt> timezone</li>
+
+<li><tt>Y</tt> year</li>
+
+<li><tt>M</tt> month</li>
+
+<li><tt>D</tt> day</li>
+
+<li><tt>W</tt> weekday</li>
+
+<li><tt>_</tt>, <tt>'</tt>, <tt>/</tt>, <tt>.</tt>, <tt>,</tt>, <tt>T</tt> seperators for both time and date</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>date/time/date_time</tt> value corresponding to <tt>date</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:</li>
+
+<li>the first argument is any other non-date value,</li>
+
+<li>the second argument is any other non-string value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>parse_time("30:30","m:s");
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>time("00:30:30.000Z")
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="print_dateprint_timeprint_datetime"></a>print_date/print_time/print_datetime</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>print_date/print_time/print_datetime(date,formatting_expression)
+</pre></div></div></li>
+
+<li>
+<p>Creates a <tt>string</tt> representing a <tt>date/time/date_time</tt> value of the <tt>date</tt> using the formatting <tt>formatting_expression</tt></p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>date</tt>: a <tt>date/time/datetime</tt> value.</li>
+
+<li><tt>formatting_expression</tt> a <tt>string</tt> value providing the formatting for <tt>date_expression</tt>. Characters used to create date expression:</li>
+
+<li><tt>h</tt> hours</li>
+
+<li><tt>m</tt> minutes</li>
+
+<li><tt>s</tt> seconds</li>
+
+<li><tt>n</tt> milliseconds</li>
+
+<li><tt>a</tt> am/pm</li>
+
+<li><tt>z</tt> timezone</li>
+
+<li><tt>Y</tt> year</li>
+
+<li><tt>M</tt> month</li>
+
+<li><tt>D</tt> day</li>
+
+<li><tt>W</tt> weekday</li>
+
+<li><tt>_</tt>, <tt>'</tt>, <tt>/</tt>, <tt>.</tt>, <tt>,</tt>, <tt>T</tt> seperators for both time and date</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>string</tt> value corresponding to <tt>date</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-date value,</li>
+
+<li>the second argument is any other non-string value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>print_time(time("00:30:30.000Z"),"m:s");
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"30:30"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_interval_start_get_interval_end"></a>get_interval_start, get_interval_end</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_interval_start/get_interval_end(interval)
+</pre></div></div></li>
+
+<li>
+<p>Gets the start/end of the given interval.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval</tt>: the interval to be accessed.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>time</tt>, <tt>date</tt>, or <tt>datetime</tt> (depending on the time instances of the interval) representing the starting or ending time,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-interval value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "start": get_interval_start(interval_start_from_date("1984-01-01", "P1Y")),
+ "end": get_interval_end(interval_start_from_date("1984-01-01", "P1Y"))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "start": date("1984_01_01"), "end": date("1985_01_01") }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_interval_start_dateget_interval_start_datetimeget_interval_start_time_get_interval_end_dateget_interval_end_datetimeget_interval_end_time"></a>get_interval_start_date/get_interval_start_datetimeget_interval_start_time, get_interval_end_date/get_interval_end_datetime/get_interval_end_time</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_interval_start_date/get_interval_start_datetime/get_interval_start_time/get_interval_end_date/get_interval_end_datetime/get_interval_end_time(interval)
+</pre></div></div></li>
+
+<li>
+<p>Gets the start/end of the given interval for the specific date/datetime/time type.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval</tt>: the interval to be accessed.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>time</tt>, <tt>date</tt>, or <tt>datetime</tt> (depending on the function) representing the starting or ending time,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-interval value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "start1": get_interval_start_date(interval_start_from_date("1984-01-01", "P1Y")),
+ "end1": get_interval_end_date(interval_start_from_date("1984-01-01", "P1Y")),
+ "start2": get_interval_start_datetime(interval_start_from_datetime("1984-01-01T08:30:00.000", "P1Y1H")),
+ "end2": get_interval_end_datetime(interval_start_from_datetime("1984-01-01T08:30:00.000", "P1Y1H")),
+ "start3": get_interval_start_time(interval_start_from_time("08:30:00.000", "P1H")),
+ "end3": get_interval_end_time(interval_start_from_time("08:30:00.000", "P1H"))
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "start1": date("1984-01-01"),
+ "end1": date("1985-01-01"),
+ "start2": datetime("1984-01-01T08:30:00.000Z"),
+ "end2": datetime("1985-01-01T09:30:00.000Z"),
+ "start3": time("08:30:00.000Z"),
+ "end3": time("09:30:00.000Z")
+}
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="get_overlapping_interval"></a>get_overlapping_interval</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_overlapping_interval(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>Gets the start/end of the given interval for the specific date/datetime/time type.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>: an <tt>interval</tt> value</li>
+
+<li><tt>interval2</tt>: an <tt>interval</tt> value</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>interval</tt> that is overlapping <tt>interval1</tt> and <tt>interval2</tt>. If <tt>interval1</tt> and <tt>interval2</tt> do not overlap <tt>null</tt> is returned. Note each interval must be of the same type.</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "overlap1": get_overlapping_interval(interval(time("11:23:39"), time("18:27:19")), interval(time("12:23:39"), time("23:18:00"))),
+ "overlap2": get_overlapping_interval(interval(time("12:23:39"), time("18:27:19")), interval(time("07:19:39"), time("09:18:00"))),
+ "overlap3": get_overlapping_interval(interval(date("1980-11-30"), date("1999-09-09")), interval(date("2013-01-01"), date("2014-01-01"))),
+ "overlap4": get_overlapping_interval(interval(date("1980-11-30"), date("2099-09-09")), interval(date("2013-01-01"), date("2014-01-01"))),
+ "overlap5": get_overlapping_interval(interval(datetime("1844-03-03T11:19:39"), datetime("2000-10-30T18:27:19")), interval(datetime("1989-03-04T12:23:39"), datetime("2009-10-10T23:18:00"))),
+ "overlap6": get_overlapping_interval(interval(datetime("1989-03-04T12:23:39"), datetime("2000-10-30T18:27:19")), interval(datetime("1844-03-03T11:19:39"), datetime("1888-10-10T23:18:00")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "overlap1": interval(time("12:23:39.000Z"), time("18:27:19.000Z")),
+ "overlap2": null,
+ "overlap3": null,
+ "overlap4": interval(date("2013-01-01"), date("2014_01_01")),
+ "overlap5": interval(datetime("1989-03-04T12:23:39.000Z"), datetime("2000-10-30T18:27:19.000Z")),
+ "overlap6": null
+}
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_bin"></a>interval_bin</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_bin(time_to_bin, time_bin_anchor, duration_bin_size)
+</pre></div></div></li>
+
+<li>
+<p>Returns the <tt>interval</tt> value representing the bin containing the <tt>time_to_bin</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>time_to_bin</tt>: a date/time/datetime value representing the time to be binned.</li>
+
+<li><tt>time_bin_anchor</tt>: a date/time/datetime value representing an anchor of a bin starts. The type of this argument should be the same as the first <tt>time_to_bin</tt> argument.</li>
+
+<li><tt>duration_bin_size</tt>: the duration value representing the size of the bin, in the type of year_month_duration or day_time_duration. The type of this duration should be compatible with the type of <tt>time_to_bin</tt>, so that the arithmetic operation between <tt>time_to_bin</tt> and <tt>duration_bin_size</tt> is well_defined. Currently AsterixDB supports the following arithmetic operations:
+
+<ul>
+
+<li>datetime +|_ year_month_duration</li>
+
+<li>datetime +|_ day_time_duration</li>
+
+<li>date +|_ year_month_duration</li>
+
+<li>date +|_ day_time_duration</li>
+
+<li>time +|_ day_time_duration</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>interval</tt> value representing the bin containing the <tt>time_to_bin</tt> value. Note that the internal type of this interval value should be the same as the <tt>time_to_bin</tt> type,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument or the second argument is any other non-date/non-time/non-datetime value,</li>
+
+<li>or, the second argument is any other non-year_month_duration/non-day_time_duration value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "bin1": interval_bin(date("2010-10-30"), date("1990-01-01"), year_month_duration("P1Y")),
+ "bin2": interval_bin(datetime("1987-11-19T23:49:23.938"), datetime("1990-01-01T00:00:00.000Z"), year_month_duration("P6M")),
+ "bin3": interval_bin(time("12:23:34.930+07:00"), time("00:00:00"), day_time_duration("PT1M")),
+ "bin4": interval_bin(datetime("1987-11-19T23:49:23.938"), datetime("2013-01-01T00:00:00.000"), day_time_duration("PT24H"))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "bin1": interval(date("2010-01-01"),date("2011-01-01")),
+ "bin2": interval(datetime("1987-07-01T00:00:00.000Z"), datetime("1988-01-01T00:00:00.000Z")),
+ "bin3": interval(time("05:23:00.000Z"), time("05:24:00.000Z")),
+ "bin4": interval(datetime("1987-11-19T00:00:00.000Z"), datetime("1987-11-20T00:00:00.000Z"))
+}
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_start_from_datetimedatetime"></a>interval_start_from_date/time/datetime</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_start_from_date/time/datetime(date/time/datetime, duration)
+</pre></div></div></li>
+
+<li>
+<p>Construct an <tt>interval</tt> value by the given starting <tt>date</tt>/<tt>time</tt>/<tt>datetime</tt> and the <tt>duration</tt> that the interval lasts.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>date/time/datetime</tt>: a <tt>string</tt> representing a <tt>date</tt>, <tt>time</tt> or <tt>datetime</tt>, or a <tt>date</tt>/<tt>time</tt>/<tt>datetime</tt> value, representing the starting time point.</li>
+
+<li><tt>duration</tt>: a <tt>string</tt> or <tt>duration</tt> value representing the duration of the interval. Note that duration cannot be negative value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>interval</tt> value representing the interval starting from the given time point with the length of duration,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument or the second argument is any other non-date/non-time/non-datetime value,</li>
+
+<li>or, the second argument is any other non-duration value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "interval1": interval_start_from_date("1984-01-01", "P1Y"),
+ "interval2": interval_start_from_time(time("02:23:28.394"), "PT3H24M"),
+ "interval3": interval_start_from_datetime("1999-09-09T09:09:09.999", duration("P2M30D"))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expectecd result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "interval1": interval(date("1984-01-01"), date("1985-01-01")),
+ "interval2": interval(time("02:23:28.394Z"), time("05:47:28.394Z")),
+ "interval3": interval(datetime("1999-09-09T09:09:09.999Z"), datetime("1999-12-09T09:09:09.999Z"))
+}
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="overlap_bins"></a>overlap_bins</h3>
+
+<ul>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a <tt>interval</tt> value representing the bin containing the <tt>time_to_bin</tt> value. Note that the internal type of this interval value should be the same as the <tt>time_to_bin</tt> type.</li>
+ </ul></li>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>overlap_bins(interval, time_bin_anchor, duration_bin_size)
+</pre></div></div></li>
+
+<li>
+<p>Returns an ordered list of <tt>interval</tt> values representing each bin that is overlapping the <tt>interval</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval</tt>: an <tt>interval</tt> value</li>
+
+<li><tt>time_bin_anchor</tt>: a date/time/datetime value representing an anchor of a bin starts. The type of this argument should be the same as the first <tt>time_to_bin</tt> argument.</li>
+
+<li><tt>duration_bin_size</tt>: the duration value representing the size of the bin, in the type of year_month_duration or day_time_duration. The type of this duration should be compatible with the type of <tt>time_to_bin</tt>, so that the arithmetic operation between <tt>time_to_bin</tt> and <tt>duration_bin_size</tt> is well_defined. Currently AsterixDB supports the following arithmetic operations:
+
+<ul>
+
+<li>datetime +|_ year_month_duration</li>
+
+<li>datetime +|_ day_time_duration</li>
+
+<li>date +|_ year_month_duration</li>
+
+<li>date +|_ day_time_duration</li>
+
+<li>time +|_ day_time_duration</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a ordered list of <tt>interval</tt> values representing each bin that is overlapping the <tt>interval</tt>. Note that the internal type as <tt>time_to_bin</tt> and <tt>duration_bin_size</tt>.</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first arugment is any other non-interval value,</li>
+
+<li>or, the second argument is any other non-date/non-time/non-datetime value,</li>
+
+<li>or, the second argument is any other non-year_month_duration/non-day_time_duration value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "timebins": overlap_bins(interval(time("17:23:37"), time("18:30:21")), time("00:00:00"), day_time_duration("PT30M")),
+ "datebins": overlap_bins(interval(date("1984-03-17"), date("2013-08-22")), date("1990-01-01"), year_month_duration("P10Y")),
+ "datetimebins": overlap_bins(interval(datetime("1800-01-01T23:59:48.938"), datetime("2015-07-26T13:28:30.218")),
+ datetime("1900-01-01T00:00:00.000"), year_month_duration("P100Y"))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "timebins": [
+ interval(time("17:00:00.000Z"), time("17:30:00.000Z")),
+ interval(time("17:30:00.000Z"), time("18:00:00.000Z")),
+ interval(time("18:00:00.000Z"), time("18:30:00.000Z")),
+ interval(time("18:30:00.000Z"), time("19:00:00.000Z"))
+ ],
+ "datebins": [
+ interval(date("1980-01-01"), date("1990-01-01")),
+ interval(date("1990-01-01"), date("2000-01-01")),
+ interval(date("2000-01-01"), date("2010-01-01")),
+ interval(date("2010-01-01"), date("2020-01-01"))
+ ],
+ "datetimebins": [
+ interval(datetime("1800-01-01T00:00:00.000Z"), datetime("1900-01-01T00:00:00.000Z")),
+ interval(datetime("1900-01-01T00:00:00.000Z"), datetime("2000-01-01T00:00:00.000Z")),
+ interval(datetime("2000-01-01T00:00:00.000Z"), datetime("2100-01-01T00:00:00.000Z"))
+ ]
+};
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div>
+<div class="section">
+<h3><a name="interval_before_interval_after"></a>interval_before, interval_after</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_before(interval1, interval2)
+interval_after(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>These two functions check whether an interval happens before/after another interval.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_before(interval1, interval2)</tt> is true if and only if <tt>interval1.end < interval2.start</tt>, and <tt>interval_after(interval1, interval2)</tt> is true if and only if <tt>interval1.start > interval2.end</tt>.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "interval_before": interval_before(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("2005-05-01"), date("2012-09-09"))),
+ "interval_after": interval_after(interval(date("2005-05-01"), date("2012-09-09")),
+ interval(date("2000-01-01"), date("2005-01-01")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "interval_before": true, "interval_after": true }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_covers_interval_covered_by"></a>interval_covers, interval_covered_by</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_covers(interval1, interval2)
+interval_covered_by(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>These two functions check whether one interval covers the other interval.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_covers(interval1, interval2)</tt> is true if and only if</li>
+ </ul>
+
+<div class="source">
+<div class="source">
+<pre>interval1.start <= interval2.start AND interval1.end >= interval2.end
+
+`interval_covered_by(interval1, interval2)` is true if and only if
+
+interval2.start <= interval1.start AND interval2.end >= interval1.end
+</pre></div></div>
+
+<ul>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "interval_covers": interval_covers(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("2000-03-01"), date("2004-09-09"))),
+ "interval_covered_by": interval_covered_by(interval(date("2006-08-01"), date("2007-03-01")),
+ interval(date("2004-09-10"), date("2012-08-01")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "interval_covers": true, "interval_covered_by": true }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_overlaps_interval_overlapped_by"></a>interval_overlaps, interval_overlapped_by</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_overlaps(interval1, interval2)
+interval_overlapped_by(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>These functions check whether two intervals overlap with each other.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_overlaps(interval1, interval2)</tt> is true if and only if</li>
+ </ul>
+
+<div class="source">
+<div class="source">
+<pre>interval1.start < interval2.start
+AND interval2.end > interval1.end
+AND interval1.end > interval2.start
+</pre></div></div>
+<p><tt>interval_overlapped_by(interval1, interval2)</tt> is true if and only if</p>
+
+<div class="source">
+<div class="source">
+<pre>interval2.start < interval1.start
+AND interval1.end > interval2.end
+AND interval2.end > interval1.start
+</pre></div></div>
+
+<ul>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul>
+<p>Note that <tt>interval_overlaps</tt> and <tt>interval_overlapped_by</tt> are following the Allen’s relations on the definition of overlap.</p></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "overlaps": interval_overlaps(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("2004-05-01"), date("2012-09-09"))),
+ "overlapped_by": interval_overlapped_by(interval(date("2006-08-01"), date("2007-03-01")),
+ interval(date("2004-05-01"), date("2012-09-09"))))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "overlaps": true, "overlapped_by": true }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_overlapping"></a>interval_overlapping</h3>
+<p>Note that <tt>interval_overlapping</tt> is not an Allen’s Relation, but syntactic sugar we added for the case that the intersect of two intervals is not empty. Basically this function returns true if any of these functions return true: <tt>interval_overlaps</tt>, <tt>interval_overlapped_by</tt>, <tt>interval_covers</tt>, or <tt>interval_covered_by</tt>.</p>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_overlapping(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>This functions check whether two intervals share any points with each other.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_overlapping(interval1, interval2)</tt> is true if</li>
+ </ul>
+
+<div class="source">
+<div class="source">
+<pre>interval1.start < interval2.end
+AND interval1.end > interval2.start
+</pre></div></div>
+
+<ul>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "overlapping1": interval_overlapping(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("2004-05-01"), date("2012-09-09"))),
+ "overlapping2": interval_overlapping(interval(date("2006-08-01"), date("2007-03-01")),
+ interval(date("2004-09-10"), date("2006-12-31")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "overlapping1": true, "overlapping2": true }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_meets_interval_met_by"></a>interval_meets, interval_met_by</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_meets(interval1, interval2)
+interval_met_by(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>These two functions check whether an interval meets with another interval.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_meets(interval1, interval2)</tt> is true if and only if <tt>interval1.end = interval2.start</tt>, and <tt>interval_met_by(interval1, interval2)</tt> is true if and only if <tt>interval1.start = interval2.end</tt>. If any of the two inputs is <tt>null</tt>, <tt>null</tt> is returned.</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "meets": interval_meets(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("2005-01-01"), date("2012-09-09"))),
+ "metby": interval_met_by(interval(date("2006-08-01"), date("2007-03-01")),
+ interval(date("2004-09-10"), date("2006-08-01")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "meets": true, "metby": true }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_starts_interval_started_by"></a>interval_starts, interval_started_by</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_starts(interval1, interval2)
+interval_started_by(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>These two functions check whether one interval starts with the other interval.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_starts(interval1, interval2)</tt> returns true if and only if</li>
+ </ul>
+
+<div class="source">
+<div class="source">
+<pre>interval1.start = interval2.start
+AND interval1.end <= interval2.end
+</pre></div></div>
+<p><tt>interval_started_by(interval1, interval2)</tt> returns true if and only if</p>
+
+<div class="source">
+<div class="source">
+<pre>interval1.start = interval2.start
+AND interval2.end <= interval1.end
+</pre></div></div>
+
+<ul>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "interval_starts": interval_starts(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("2000-01-01"), date("2012-09-09"))),
+ "interval_started_by": interval_started_by(interval(date("2006-08-01"), date("2007-03-01")),
+ interval(date("2006-08-01"), date("2006-08-02")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "interval_starts": true, "interval_started_by": true }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="interval_ends_interval_ended_by"></a>interval_ends, interval_ended_by</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>interval_ends(interval1, interval2)
+interval_ended_by(interval1, interval2)
+</pre></div></div></li>
+
+<li>
+<p>These two functions check whether one interval ends with the other interval.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>interval1</tt>, <tt>interval2</tt>: two intervals to be compared</li>
+ </ul></li>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a <tt>boolean</tt> value. Specifically, <tt>interval_ends(interval1, interval2)</tt> returns true if and only if</li>
+ </ul>
+
+<div class="source">
+<div class="source">
+<pre>interval1.end = interval2.end
+AND interval1.start >= interval2.start
+
+`interval_ended_by(interval1, interval2)` returns true if and only if
+
+interval2.end = interval1.end
+AND interval2.start >= interval1.start
+</pre></div></div>
+
+<ul>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-interval input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Examples:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "interval_ends": interval_ends(interval(date("2000-01-01"), date("2005-01-01")),
+ interval(date("1998-01-01"), date("2005-01-01"))),
+ "interval_ended_by": interval_ended_by(interval(date("2006-08-01"), date("2007-03-01")),
+ interval(date("2006-09-10"), date("2007-03-01")))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "interval_ends": true, "interval_ended_by": true }
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Object_Functions"></a><a name="ObjectFunctions" id="ObjectFunctions">Object Functions</a></h2>
+<div class="section">
+<h3><a name="get_object_fields"></a>get_object_fields</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_object_fields(input_object)
+</pre></div></div></li>
+
+<li>
+<p>Access the object field names, type and open status for a given object.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>input_object</tt> : a object value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an array of <tt>object</tt> values that include the field_name <tt>string</tt>, field_type <tt>string</tt>, is_open <tt>boolean</tt> (used for debug purposes only: <tt>true</tt> if field is open and <tt>false</tt> otherwise), and optional nested <tt>orderedList</tt> for the values of a nested object,</li>
+
+<li><tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if the argument is a <tt>null</tt> value,</li>
+
+<li>any other non-object input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_object_fields(
+ {
+ "id": 1,
+ "project": "AsterixDB",
+ "address": {"city": "Irvine", "state": "CA"},
+ "related": ["Hivestrix", "Preglix", "Apache VXQuery"]
+ }
+ );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[
+ { "field-name": "id", "field-type": "INT64", "is-open": false },
+ { "field-name": "project", "field-type": "STRING", "is-open": false },
+ { "field-name": "address", "field-type": "RECORD", "is-open": false,
+ "nested": [
+ { "field-name": "city", "field-type": "STRING", "is-open": false },
+ { "field-name": "state", "field-type": "STRING", "is-open": false }
+ ]
+ },
+ { "field-name":
+ "related",
+ "field-type": "ORDEREDLIST",
+ "is-open": false,
+ "list": [
+ { "field-type": "STRING" },
+ { "field-type": "STRING" },
+ { "field-type": "STRING" }
+ ]
+ }
+]
+</pre></div></div></li>
+</ul>
+<p>]</p></div>
+<div class="section">
+<h3><a name="get_object_field_value"></a>get_object_field_value</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_object_field_value(input_object, string)
+</pre></div></div></li>
+
+<li>
+<p>Access the field name given in the <tt>string_expression</tt> from the <tt>object_expression</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>input_object</tt> : a <tt>object</tt> value.</li>
+
+<li><tt>string</tt> : a <tt>string</tt> representing the top level field name.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>any</tt> value saved in the designated field of the object,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-object value,</li>
+
+<li>or, the second argument is any other non-string value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>get_object_field_value({
+ "id": 1,
+ "project": "AsterixDB",
+ "address": {"city": "Irvine", "state": "CA"},
+ "related": ["Hivestrix", "Preglix", "Apache VXQuery"]
+ },
+ "project"
+ );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>"AsterixDB"
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="object_remove_fields"></a>object_remove_fields</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>object_remove_fields(input_object, field_names)
+</pre></div></div></li>
+
+<li>
+<p>Remove indicated fields from a object given a list of field names.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>input_object</tt>: a object value.</li>
+
+<li><tt>field_names</tt>: an array of strings and/or array of array of strings.</li>
+ </ul></li>
+
+<li>
+<p>Return Value:</p>
+
+<ul>
+
+<li>a new object value without the fields listed in the second argument,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-object value,</li>
+
+<li>or, the second argument is any other non-array value or recursively contains non-string items.</li>
+ </ul></li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>object_remove_fields(
+ {
+ "id":1,
+ "project":"AsterixDB",
+ "address":{"city":"Irvine", "state":"CA"},
+ "related":["Hivestrix", "Preglix", "Apache VXQuery"]
+ },
+ [["address", "city"], "related"]
+ );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "id":1,
+ "project":"AsterixDB",
+ "address":{ "state": "CA" }
+}
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="object_add_fields"></a>object_add_fields</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>object_add_fields(input_object, fields)
+</pre></div></div></li>
+
+<li>
+<p>Add fields to a object given a list of field names.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>input_object</tt> : a object value.</li>
+
+<li><tt>fields</tt>: an array of field descriptor objects where each object has field_name and field_value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a new object value with the new fields included,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>a type error will be raised if:
+
+<ul>
+
+<li>the first argument is any other non-object value,</li>
+
+<li>the second argument is any other non-array value, or contains non-object items.</li>
+ </ul></li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>object_add_fields(
+ {
+ "id":1,
+ "project":"AsterixDB",
+ "address":{"city":"Irvine", "state":"CA"},
+ "related":["Hivestrix", "Preglix", "Apache VXQuery"]
+ },
+ [{"field-name":"employment_location", "field-value":create_point(30.0,70.0)}]
+ );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "id":1,
+ "project":"AsterixDB",
+ "address":{"city":"Irvine", "state":"CA"},
+ "related":["Hivestrix", "Preglix", "Apache VXQuery"]
+ "employment_location": point("30.0,70.0")
+ }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="object_merge"></a>object_merge</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>object_merge(object1, object2)
+</pre></div></div></li>
+
+<li>
+<p>Merge two different objects into a new object.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>object1</tt> : a object value.</li>
+
+<li><tt>object2</tt> : a object value.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a new object value with fields from both input objects. If a field’s names in both objects are the same, an exception is issued,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>any other non-object input value will cause a type error.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>object_merge(
+ {
+ "id":1,
+ "project":"AsterixDB",
+ "address":{"city":"Irvine", "state":"CA"},
+ "related":["Hivestrix", "Preglix", "Apache VXQuery"]
+ },
+ {
+ "user_id": 22,
+ "employer": "UC Irvine",
+ "employment_type": "visitor"
+ }
+ );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "employment_type": "visitor",
+ "address": {
+ "city": "Irvine",
+ "state": "CA"
+ },
+ "related": [
+ "Hivestrix",
+ "Preglix",
+ "Apache VXQuery"
+ ],
+ "user_id": 22,
+ "project": "AsterixDB",
+ "employer": "UC Irvine",
+ "id": 1
+}
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Aggregate_Functions_Array_Functions"></a><a name="AggregateFunctions" id="AggregateFunctions">Aggregate Functions (Array Functions) </a></h2>
+<p>This section contains detailed descriptions of each SQL++ aggregate function (i.e., array function). Note that as described in the SQL++ query reference documentation, standard SQL aggregate functions (e.g., <tt>MIN</tt>, <tt>MAX</tt>, <tt>SUM</tt>, <tt>COUNT</tt>, and <tt>AVG</tt>) are not real functions in SQL++ but just syntactic sugars over corresponding SQL++ builtin aggregate functions (e.g., <tt>ARRAY_MIN</tt>, <tt>ARRAY_MAX</tt>, <tt>ARRAY_SUM</tt>, <tt>ARRAY_COUNT</tt>, and <tt>ARRAY_AVG</tt>).</p>
+<div class="section">
+<h3><a name="array_count"></a>array_count</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_count(collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the number of non-null and non-missing items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt> to be counted,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>bigint</tt> value representing the number of non-null and non-missing items in the given collection,</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li>any other non-array and non-multiset input value will cause an error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_count( ['hello', 'world', 1, 2, 3, null, missing] );
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>5
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="array_avg"></a>array_avg</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_avg(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the average value of the non-null and non-missing numeric items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt> containing numeric values, <tt>null</tt>s or <tt>missing</tt>s,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>double</tt> value representing the average of the non-null and non-missing numbers in the given collection,</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if the given collection does not contain any non-null and non-missing items,</li>
+
+<li>any other non-array and non-multiset input value will cause a type error,</li>
+
+<li>any other non-numeric value in the input collection will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_avg( [1.2, 2.3, 3.4, 0, null] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>1.725
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="array_sum"></a>array_sum</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_sum(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the sum of non-null and non-missing items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt> containing numeric values, <tt>null</tt>s or <tt>missing</tt>s,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the sum of the non-null and non-missing numbers in the given collection. The returning type is decided by the item type with the highest order in the numeric type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among items.</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if the given collection does not contain any non-null and non-missing items,</li>
+
+<li>any other non-array and non-multiset input value will cause a type error,</li>
+
+<li>any other non-numeric value in the input collection will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_sum( [1.2, 2.3, 3.4, 0, null, missing] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>6.9
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="array_sql_min"></a>array_sql_min</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_min(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the min value of non-null and non-missing comparable items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt>,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the min value of non-null and non-missing values in the given collection. The returning type is decided by the item type with the highest order in the type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among numeric items.</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if the given collection does not contain any non-null and non-missing items,</li>
+
+<li>multiple incomparable items in the input array or multiset will cause a type error,</li>
+
+<li>any other non-array and non-multiset input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_min( [1.2, 2.3, 3.4, 0, null, missing] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>0.0
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="array_max"></a>array_max</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_max(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the max value of the non-null and non-missing comparable items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt>,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the max value of non-null and non-missing numbers in the given collection. The returning type is decided by the item type with the highest order in the type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among numeric items.</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if the given collection does not contain any non-null and non-missing items,</li>
+
+<li>multiple incomparable items in the input array or multiset will cause a type error,</li>
+
+<li>any other non-array and non-multiset input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>array_max( [1.2, 2.3, 3.4, 0, null, missing] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>3.4
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="coll_count"></a>coll_count</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_count(collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the number of items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt> containing the items to be counted,</li>
+
+<li>or a <tt>null</tt> value,</li>
+
+<li>or a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>bigint</tt> value representing the number of items in the given collection,</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_count( [1, 2, null, missing] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>4
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="coll_avg"></a>coll_avg</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_avg(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the average value of the numeric items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt> containing numeric values, <tt>null</tt>s or <tt>missing</tt>s,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>double</tt> value representing the average of the numbers in the given collection,</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if there is a <tt>null</tt> or <tt>missing</tt> in the input collection,</li>
+
+<li>any other non-numeric value in the input collection will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_avg( [100, 200, 300] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ 200.0 ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="coll_sum"></a>coll_sum</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_sum(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the sum of the items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt> containing numeric values, <tt>null</tt>s or <tt>missing</tt>s,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the sum of the numbers in the given collection. The returning type is decided by the item type with the highest order in the numeric type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among items.</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if there is a <tt>null</tt> or <tt>missing</tt> in the input collection,</li>
+
+<li>any other non-numeric value in the input collection will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_sum( [100, 200, 300] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>600
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="array_min"></a>array_min</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_min(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the min value of comparable items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt>,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the min value of the given collection. The returning type is decided by the item type with the highest order in the type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among numeric items.</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if there is a <tt>null</tt> or <tt>missing</tt> in the input collection,</li>
+
+<li>multiple incomparable items in the input array or multiset will cause a type error,</li>
+
+<li>any other non-array and non-multiset input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_min( [10.2, 100, 5] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>5.0
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="array_max"></a>array_max</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_max(num_collection)
+</pre></div></div></li>
+
+<li>
+<p>Gets the max value of numeric items in the given collection.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>num_collection</tt> could be:
+
+<ul>
+
+<li>an <tt>array</tt> or <tt>multiset</tt>,</li>
+
+<li>or, a <tt>null</tt> value,</li>
+
+<li>or, a <tt>missing</tt> value.</li>
+ </ul></li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>The max value of the given collection. The returning type is decided by the item type with the highest order in the type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among numeric items.</li>
+
+<li><tt>null</tt> is returned if the input is <tt>null</tt> or <tt>missing</tt>,</li>
+
+<li><tt>null</tt> is returned if there is a <tt>null</tt> or <tt>missing</tt> in the input collection,</li>
+
+<li>multiple incomparable items in the input array or multiset will cause a type error,</li>
+
+<li>any other non-array and non-multiset input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>coll_max( [10.2, 100, 5] );
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>100.0
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Comparison_Functions"></a><a name="ComparisonFunctions" id="ComparisonFunctions">Comparison Functions</a></h2>
+<div class="section">
+<h3><a name="greatest"></a>greatest</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>greatest(numeric_value1, numeric_value2, ...)
+</pre></div></div></li>
+
+<li>
+<p>Computes the greatest value among arguments.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value1</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li><tt>numeric_value2</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li>….</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the greatest values among arguments. The returning type is decided by the item type with the highest order in the numeric type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among items.</li>
+
+<li><tt>null</tt> if any argument is a <tt>missing</tt> value or <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": greatest(1, 2, 3), "v2": greatest(float("0.5"), double("-0.5"), 5000) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 3, "v2": 5000.0 }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="least"></a>least</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>least(numeric_value1, numeric_value2, ...)
+</pre></div></div></li>
+
+<li>
+<p>Computes the least value among arguments.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>numeric_value1</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li><tt>numeric_value2</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value,</li>
+
+<li>….</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>the least values among arguments. The returning type is decided by the item type with the highest order in the numeric type promotion order (<tt>tinyint</tt>-> <tt>smallint</tt>-><tt>integer</tt>-><tt>bigint</tt>-><tt>float</tt>-><tt>double</tt>) among items.</li>
+
+<li><tt>null</tt> if any argument is a <tt>missing</tt> value or <tt>null</tt> value,</li>
+
+<li>any other non-numeric input value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": least(1, 2, 3), "v2": least(float("0.5"), double("-0.5"), 5000) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 1, "v2": -0.5 }
+</pre></div></div></li>
+</ul>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h2><a name="Type_Functions"></a><a name="TypeFunctions" id="TypeFunctions">Type Functions</a></h2>
+<div class="section">
+<h3><a name="is_array_isarray"></a>is_array (isarray)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_array(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be an <tt>array</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the argument is an <tt>array</tt> value or not,</li>
+
+<li>a <tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li>a <tt>null</tt> if the argument is a <tt>null</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": is_array(true),
+ "b": is_array(false),
+ "c": isarray(null),
+ "d": isarray(missing),
+ "e": isarray("d"),
+ "f": isarray(4.0),
+ "g": isarray(5),
+ "h": isarray(["1", 2]),
+ "i": isarray({"a":1})
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": false, "b": false, "c": null, "e": false, "f": false, "g": false, "h": true, "i": false }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>isarray</tt>.</p></div>
+<div class="section">
+<h3><a name="is_boolean_isboolean_isbool"></a>is_boolean (isboolean, isbool)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_boolean(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be a <tt>boolean</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the argument is a <tt>boolean</tt> value or not,</li>
+
+<li>a <tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li>a <tt>null</tt> if the argument is a <tt>null</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": isboolean(true),
+ "b": isboolean(false),
+ "c": is_boolean(null),
+ "d": is_boolean(missing),
+ "e": isbool("d"),
+ "f": isbool(4.0),
+ "g": isbool(5),
+ "h": isbool(["1", 2]),
+ "i": isbool({"a":1})
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": true, "b": true, "c": null, "e": false, "f": false, "g": false, "h": false, "i": false }
+</pre></div></div></li>
+</ul>
+<p>The function has two aliases, <tt>isboolean</tt> or <tt>isbool</tt>.</p></div>
+<div class="section">
+<h3><a name="is_number_isnumber_isnum"></a>is_number (isnumber, isnum)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_number(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be a numeric value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the argument is a <tt>smallint</tt>/<tt>tinyint</tt>/<tt>integer</tt>/<tt>bigint</tt>/<tt>float</tt>/<tt>double</tt> value or not,</li>
+
+<li>a <tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li>a <tt>null</tt> if the argument is a <tt>null</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": is_number(true),
+ "b": is_number(false),
+ "c": isnumber(null),
+ "d": isnumber(missing),
+ "e": isnumber("d"),
+ "f": isnum(4.0),
+ "g": isnum(5),
+ "h": isnum(["1", 2]),
+ "i": isnum({"a":1})
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": false, "b": false, "c": null, "e": false, "f": true, "g": true, "h": false, "i": false }
+</pre></div></div></li>
+</ul>
+<p>The function has two aliases, <tt>isnumber</tt> or <tt>isnum</tt>.</p></div>
+<div class="section">
+<h3><a name="is_object_isobject_isobj"></a>is_object (isobject, isobj)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_object(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be a <tt>object</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the argument is a <tt>object</tt> value or not,</li>
+
+<li>a <tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li>a <tt>null</tt> if the argument is a <tt>null</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": is_object(true),
+ "b": is_object(false),
+ "c": isobject(null),
+ "d": isobject(missing),
+ "e": isobj("d"),
+ "f": isobj(4.0),
+ "g": isobj(5),
+ "h": isobj(["1", 2]),
+ "i": isobj({"a":1})
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+<p>{ “a”: false, “b”: false, “c”: null, “e”: false, “f”: false, “g”: false, “h”: false, “i”: true }</p></li>
+</ul>
+<p>The function has two aliases, <tt>isobject</tt> or <tt>isobj</tt>.</p></div>
+<div class="section">
+<h3><a name="is_string_isstring_isstr"></a>is_string (isstring, isstr)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_string(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be a <tt>string</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the argument is a <tt>string</tt> value or not,</li>
+
+<li>a <tt>missing</tt> if the argument is a <tt>missing</tt> value,</li>
+
+<li>a <tt>null</tt> if the argument is a <tt>null</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": is_string(true),
+ "b": isstring(false),
+ "c": isstring(null),
+ "d": isstr(missing),
+ "e": isstr("d"),
+ "f": isstr(4.0),
+ "g": isstr(5),
+ "h": isstr(["1", 2]),
+ "i": isstr({"a":1})
+};
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": false, "b": false, "c": null, "e": true, "f": false, "g": false, "h": false, "i": false }
+</pre></div></div></li>
+</ul>
+<p>The function has two aliases, <tt>isstring</tt> or <tt>isstr</tt>.</p></div>
+<div class="section">
+<h3><a name="is_null"></a>is_null</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_null(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be a <tt>null</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the variable is a <tt>null</tt> or not,</li>
+
+<li>a <tt>missing</tt> if the input is <tt>missing</tt>.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": is_null(null), "v2": is_null(1), "v3": is_null(missing) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>isnull</tt>.</p></div>
+<div class="section">
+<h3><a name="is_missing"></a>is_missing</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_missing(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given expression is evaluated to be a <tt>missing</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the variable is a <tt>missing</tt> or not.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": is_missing(null), "v2": is_missing(1), "v3": is_missing(missing) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": false, "v2": false, "v3": true }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>ismissing</tt>.</p></div>
+<div class="section">
+<h3><a name="is_unknown"></a>is_unknown</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>is_unknown(expr)
+</pre></div></div></li>
+
+<li>
+<p>Checks whether the given variable is a <tt>null</tt> value or a <tt>missing</tt> value.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt> on whether the variable is a <tt>null</tt>/`<tt>missing</tt> value (<tt>true</tt>) or not (<tt>false</tt>).</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": is_unknown(null), "v2": is_unknown(1), "v3": is_unknown(missing) };
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": true, "v2": false, "v3": true }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>isunknown</tt>.</p></div>
+<div class="section">
+<h3><a name="to_boolean"></a>to_boolean</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>to_boolean(expr)
+</pre></div></div></li>
+
+<li>
+<p>Converts input value to a <tt>boolean</tt> value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>if the argument is <tt>missing</tt> then <tt>missing</tt> is returned</li>
+
+<li>if the argument is <tt>null</tt> then <tt>null</tt> is returned</li>
+
+<li>if the argument is of <tt>boolean</tt> type then it is returned as is</li>
+
+<li>if the argument is of numeric type then <tt>false</tt> is returned if it is <tt>0</tt> or <tt>NaN</tt>, otherwise <tt>true</tt></li>
+
+<li>if the argument is of <tt>string</tt> type then <tt>false</tt> is returned if it’s empty, otherwise <tt>true</tt></li>
+
+<li>if the argument is of <tt>array</tt> or <tt>multiset</tt> type then <tt>false</tt> is returned if it’s size is <tt>0</tt>, otherwise <tt>true</tt></li>
+
+<li>if the argument is of <tt>object</tt> type then <tt>false</tt> is returned if it has no fields, otherwise <tt>true</tt></li>
+
+<li>type error is raised for all other input types</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": to_boolean(0),
+ "v2": to_boolean(1),
+ "v3": to_boolean(""),
+ "v4": to_boolean("asterix")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": false, "v2": true, "v3": false, "v4": true }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>toboolean</tt>.</p></div>
+<div class="section">
+<h3><a name="to_bigint"></a>to_bigint</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>to_bigint(expr)
+</pre></div></div></li>
+
+<li>
+<p>Converts input value to an integer value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>if the argument is <tt>missing</tt> then <tt>missing</tt> is returned</li>
+
+<li>if the argument is <tt>null</tt> then <tt>null</tt> is returned</li>
+
+<li>if the argument is of <tt>boolean</tt> type then <tt>1</tt> is returned if it is <tt>true</tt>, <tt>0</tt> if it is <tt>false</tt></li>
+
+<li>if the argument is of numeric integer type then it is returned as the same value of <tt>bigint</tt> type</li>
+
+<li>if the argument is of numeric <tt>float</tt>/<tt>double</tt> type then it is converted to <tt>bigint</tt> type</li>
+
+<li>if the argument is of <tt>string</tt> type and can be parsed as integer then that integer value is returned, otherwise <tt>null</tt> is returned</li>
+
+<li>if the argument is of <tt>array</tt>/<tt>multiset</tt>/<tt>object</tt> type then <tt>null</tt> is returned</li>
+
+<li>type error is raised for all other input types</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": to_bigint(false),
+ "v2": to_bigint(true),
+ "v3": to_bigint(10),
+ "v4": to_bigint(float("1e100")),
+ "v5": to_bigint(double("1e1000")),
+ "v6": to_bigint("20")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0, "v2": 1, "v3": 10, "v4": 9223372036854775807, "v5": 9223372036854775807, "v6": 20 }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>tobigint</tt>.</p></div>
+<div class="section">
+<h3><a name="to_double"></a>to_double</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>to_double(expr)
+</pre></div></div></li>
+
+<li>
+<p>Converts input value to a <tt>double</tt> value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>if the argument is <tt>missing</tt> then <tt>missing</tt> is returned</li>
+
+<li>if the argument is <tt>null</tt> then <tt>null</tt> is returned</li>
+
+<li>if the argument is of <tt>boolean</tt> type then <tt>1.0</tt> is returned if it is <tt>true</tt>, <tt>0.0</tt> if it is <tt>false</tt></li>
+
+<li>if the argument is of numeric type then it is returned as the value of <tt>double</tt> type</li>
+
+<li>if the argument is of <tt>string</tt> type and can be parsed as <tt>double</tt> then that <tt>double</tt> value is returned, otherwise <tt>null</tt> is returned</li>
+
+<li>if the argument is of <tt>array</tt>/<tt>multiset</tt>/<tt>object</tt> type then <tt>null</tt> is returned</li>
+
+<li>type error is raised for all other input types</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": to_double(false),
+ "v2": to_double(true),
+ "v3": to_double(10),
+ "v4": to_double(11.5),
+ "v5": to_double("12.5")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": 0.0, "v2": 1.0, "v3": 10.0, "v4": 11.5, "v5": 12.5 }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>todouble</tt>.</p></div>
+<div class="section">
+<h3><a name="to_string"></a>to_string</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>to_string(expr)
+</pre></div></div></li>
+
+<li>
+<p>Converts input value to a string value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>if the argument is <tt>missing</tt> then <tt>missing</tt> is returned</li>
+
+<li>if the argument is <tt>null</tt> then <tt>null</tt> is returned</li>
+
+<li>if the argument is of <tt>boolean</tt> type then <tt>"true"</tt> is returned if it is <tt>true</tt>, <tt>"false"</tt> if it is <tt>false</tt></li>
+
+<li>if the argument is of numeric type then its string representation is returned</li>
+
+<li>if the argument is of <tt>string</tt> type then it is returned as is</li>
+
+<li>if the argument is of <tt>array</tt>/<tt>multiset</tt>/<tt>object</tt> type then <tt>null</tt> is returned</li>
+
+<li>type error is raised for all other input types</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "v1": to_string(false),
+ "v2": to_string(true),
+ "v3": to_string(10),
+ "v4": to_string(11.5),
+ "v5": to_string("asterix")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": "false", "v2": "true", "v3": "10", "v4": "11.5", "v5": "asterix" }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>tostring</tt>. <!-- ! 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.
+ ! --></p></div></div>
+<div class="section">
+<h2><a name="Conditional_Functions"></a><a name="ConditionalFunctions" id="ConditionalFunctions">Conditional Functions</a></h2>
+<div class="section">
+<h3><a name="if_null_ifnull"></a>if_null (ifnull)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>if_null(expression1, expression2, ... expressionN)
+</pre></div></div></li>
+
+<li>
+<p>Finds first argument which value is not <tt>null</tt> and returns that value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expressionI</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>null</tt> if all arguments evaluate to <tt>null</tt> or no arguments specified</li>
+
+<li>a value of the first non-<tt>null</tt> argument otherwise</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": if_null(),
+ "b": if_null(null),
+ "c": if_null(null, "asterixdb"),
+ "d": is_missing(if_null(missing))
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": null, "b": null, "c": "asterixdb", "d": true }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>ifnull</tt>.</p></div>
+<div class="section">
+<h3><a name="if_missing_ifmissing"></a>if_missing (ifmissing)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>if_missing(expression1, expression2, ... expressionN)
+</pre></div></div></li>
+
+<li>
+<p>Finds first argument which value is not <tt>missing</tt> and returns that value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expressionI</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>null</tt> if all arguments evaluate to <tt>missing</tt> or no arguments specified</li>
+
+<li>a value of the first non-<tt>missing</tt> argument otherwise</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": if_missing(),
+ "b": if_missing(missing),
+ "c": if_missing(missing, "asterixdb"),
+ "d": if_missing(null, "asterixdb")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": null, "b": null, "c": "asterixdb", "d": null }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>ifmissing</tt>.</p></div>
+<div class="section">
+<h3><a name="if_missing_or_null_ifmissingornull"></a>if_missing_or_null (ifmissingornull)</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>if_missing_or_null(expression1, expression2, ... expressionN)
+</pre></div></div></li>
+
+<li>
+<p>Finds first argument which value is not <tt>null</tt> or <tt>missing</tt> and returns that value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expressionI</tt> : an expression (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>null</tt> if all arguments evaluate to either <tt>null</tt> or <tt>missing</tt>, or no arguments specified</li>
+
+<li>a value of the first non-<tt>null</tt>, non-<tt>missing</tt> argument otherwise</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{
+ "a": if_missing_or_null(),
+ "b": if_missing_or_null(null, missing),
+ "c": if_missing_or_null(null, missing, "asterixdb")
+};
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "a": null, "b": null, "c": "asterixdb" }
+</pre></div></div></li>
+</ul>
+<p>The function has an alias <tt>ifmissingornull</tt>. <!-- ! 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.
+ ! --></p></div></div>
+<div class="section">
+<h2><a name="Miscellaneous_Functions"></a><a name="MiscFunctions" id="MiscFunctions">Miscellaneous Functions</a></h2>
+<div class="section">
+<h3><a name="uuid"></a>uuid</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>uuid()
+</pre></div></div></li>
+
+<li>
+<p>Generates a <tt>uuid</tt>.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li>none</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a generated, random <tt>uuid</tt>.</li>
+ </ul></li>
+</ul></div>
+<div class="section">
+<h3><a name="len"></a>len</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+<p>len(array)</p></li>
+
+<li>
+<p>Returns the length of the array array.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>array</tt> : an <tt>array</tt>, <tt>multiset</tt>, <tt>null</tt>, or <tt>missing</tt>, represents the collection that needs to be checked.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an <tt>integer</tt> that represents the length of input array or the size of the input multiset,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>len(["Hello", "World"])
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>2
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="not"></a>not</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>not(expr)
+</pre></div></div></li>
+
+<li>
+<p>Inverts a <tt>boolean</tt> value</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr</tt> : an expression</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li>a <tt>boolean</tt>, the inverse of <tt>expr</tt>,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value,</li>
+
+<li>other non-boolean argument value will cause a type error.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": `not`(true), "v2": `not`(false), "v3": `not`(null), "v4": `not`(missing) };
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>{ "v1": false, "v2": true, "v3": null }
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="range"></a>range</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>range(start_numeric_value, end_numeric_value)
+</pre></div></div></li>
+
+<li>
+<p>Generates a series of <tt>bigint</tt> values based start the <tt>start_numeric_value</tt> until the <tt>end_numeric_value</tt>.</p></li>
+
+<li>Arguments:</li>
+
+<li><tt>start_numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value representing the start value.</li>
+
+<li><tt>end_numeric_value</tt>: a <tt>tinyint</tt>/<tt>smallint</tt>/<tt>integer</tt>/<tt>bigint</tt> value representing the max final value.</li>
+
+<li>Return Value:
+
+<ul>
+
+<li>an array that starts with the integer value of <tt>start_numeric_value</tt> and ends with the integer value of <tt>end_numeric_value</tt>, where the value of each entry in the array is the integer successor of the value in the preceding entry.</li>
+ </ul></li>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>range(0, 3);
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ 0, 1, 2, 3 ]
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="switch_case"></a>switch_case</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>switch_case(
+ condition,
+ case1, case1_result,
+ case2, case2_result,
+ ...,
+ default, default_result
+)
+</pre></div></div></li>
+
+<li>
+<p>Switches amongst a sequence of cases and returns the result of the first matching case. If no match is found, the result of the default case is returned.</p></li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>condition</tt>: a variable (any type is allowed).</li>
+
+<li><tt>caseI/default</tt>: a variable (any type is allowed).</li>
+
+<li><tt>caseI/default_result</tt>: a variable (any type is allowed).</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li><tt>caseI_result</tt> if <tt>condition</tt> matches <tt>caseI</tt>, otherwise <tt>default_result</tt>.</li>
+ </ul></li>
+
+<li>
+<p>Example 1:</p>
+
+<div class="source">
+<div class="source">
+<pre>switch_case(
+ "a",
+ "a", 0,
+ "x", 1,
+ "y", 2,
+ "z", 3
+);
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>0
+</pre></div></div></li>
+
+<li>
+<p>Example 2:</p>
+
+<div class="source">
+<div class="source">
+<pre>switch_case(
+ "a",
+ "x", 1,
+ "y", 2,
+ "z", 3
+);
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>3
+</pre></div></div></li>
+</ul></div>
+<div class="section">
+<h3><a name="deep_equal"></a>deep_equal</h3>
+
+<ul>
+
+<li>
+<p>Syntax:</p>
+
+<div class="source">
+<div class="source">
+<pre>deep_equal(expr1, expr2)
+</pre></div></div></li>
+</ul>
+
+<ul>
+
+<li>Assess the equality between two expressions of any type (e.g., object, arrays, or multiset). Two objects are deeply equal iff both their types and values are equal.</li>
+
+<li>Arguments:
+
+<ul>
+
+<li><tt>expr1</tt> : an expression,</li>
+
+<li><tt>expr2</tt> : an expression.</li>
+ </ul></li>
+
+<li>Return Value:
+
+<ul>
+
+<li><tt>true</tt> or <tt>false</tt> depending on the data equality,</li>
+
+<li><tt>missing</tt> if any argument is a <tt>missing</tt> value,</li>
+
+<li><tt>null</tt> if any argument is a <tt>null</tt> value but no argument is a <tt>missing</tt> value.</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>
+<p>Example:</p>
+
+<div class="source">
+<div class="source">
+<pre>deep_equal(
+ {
+ "id":1,
+ "project":"AsterixDB",
+ "address":{"city":"Irvine", "state":"CA"},
+ "related":["Hivestrix", "Preglix", "Apache VXQuery"]
+ },
+ {
+ "id":1,
+ "project":"AsterixDB",
+ "address":{"city":"San Diego", "state":"CA"},
+ "related":["Hivestrix", "Preglix", "Apache VXQuery"]
+ }
+);
+</pre></div></div></li>
+
+<li>
+<p>The expected result is:</p>
+
+<div class="source">
+<div class="source">
+<pre>false
+</pre></div></div></li>
+</ul></div></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row span12">Copyright © 2017
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<div class="row-fluid">Apache AsterixDB, AsterixDB, Apache, the Apache
+ feather logo, and the Apache AsterixDB project logo are either
+ registered trademarks or trademarks of The Apache Software
+ Foundation in the United States and other countries.
+ All other marks mentioned may be trademarks or registered
+ trademarks of their respective owners.</div>
+
+
+ </div>
+ </footer>
+ </body>
+</html>
diff --git a/docs/0.9.2/sqlpp/manual.html b/docs/0.9.2/sqlpp/manual.html
new file mode 100644
index 0000000..a2499d9
--- /dev/null
+++ b/docs/0.9.2/sqlpp/manual.html
@@ -0,0 +1,4590 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2017-09-14
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>AsterixDB – The SQL++ Query Language</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="../css/site.css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+
+<script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-41536543-1', 'uci.edu');
+ ga('send', 'pageview');</script>
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <a href=".././" id="bannerLeft">
+ <img src="../images/asterixlogo.png" alt="AsterixDB"/>
+ </a>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2017-09-14</li>
+
+
+
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="../index.html" title="Documentation Home">
+ Documentation Home</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Get Started - Installation</li>
+
+ <li>
+
+ <a href="../ncservice.html" title="Option 1: using NCService">
+ <i class="none"></i>
+ Option 1: using NCService</a>
+ </li>
+
+ <li>
+
+ <a href="../ansible.html" title="Option 2: using Ansible">
+ <i class="none"></i>
+ Option 2: using Ansible</a>
+ </li>
+
+ <li>
+
+ <a href="../aws.html" title="Option 3: using Amazon Web Services">
+ <i class="none"></i>
+ Option 3: using Amazon Web Services</a>
+ </li>
+
+ <li>
+
+ <a href="../yarn.html" title="Option 4: using YARN">
+ <i class="none"></i>
+ Option 4: using YARN</a>
+ </li>
+
+ <li>
+
+ <a href="../install.html" title="Option 5: using Managix (deprecated)">
+ <i class="none"></i>
+ Option 5: using Managix (deprecated)</a>
+ </li>
+ <li class="nav-header">AsterixDB Primer</li>
+
+ <li>
+
+ <a href="../sqlpp/primer-sqlpp.html" title="Option 1: using SQL++">
+ <i class="none"></i>
+ Option 1: using SQL++</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/primer.html" title="Option 2: using AQL">
+ <i class="none"></i>
+ Option 2: using AQL</a>
+ </li>
+ <li class="nav-header">Data Model</li>
+
+ <li>
+
+ <a href="../datamodel.html" title="The Asterix Data Model">
+ <i class="none"></i>
+ The Asterix Data Model</a>
+ </li>
+ <li class="nav-header">Queries - SQL++</li>
+
+ <li class="active">
+
+ <a href="#"><i class="none"></i>The SQL++ Query Language</a>
+ </li>
+
+ <li>
+
+ <a href="../sqlpp/builtins.html" title="Builtin Functions">
+ <i class="none"></i>
+ Builtin Functions</a>
+ </li>
+ <li class="nav-header">Queries - AQL</li>
+
+ <li>
+
+ <a href="../aql/manual.html" title="The Asterix Query Language (AQL)">
+ <i class="none"></i>
+ The Asterix Query Language (AQL)</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/builtins.html" title="Builtin Functions">
+ <i class="none"></i>
+ Builtin Functions</a>
+ </li>
+ <li class="nav-header">API/SDK</li>
+
+ <li>
+
+ <a href="../api.html" title="HTTP API">
+ <i class="none"></i>
+ HTTP API</a>
+ </li>
+
+ <li>
+
+ <a href="../csv.html" title="CSV Output">
+ <i class="none"></i>
+ CSV Output</a>
+ </li>
+ <li class="nav-header">Advanced Features</li>
+
+ <li>
+
+ <a href="../aql/fulltext.html" title="Support of Full-text Queries">
+ <i class="none"></i>
+ Support of Full-text Queries</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/externaldata.html" title="Accessing External Data">
+ <i class="none"></i>
+ Accessing External Data</a>
+ </li>
+
+ <li>
+
+ <a href="../feeds/tutorial.html" title="Support for Data Ingestion">
+ <i class="none"></i>
+ Support for Data Ingestion</a>
+ </li>
+
+ <li>
+
+ <a href="../udf.html" title="User Defined Functions">
+ <i class="none"></i>
+ User Defined Functions</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/filters.html" title="Filter-Based LSM Index Acceleration">
+ <i class="none"></i>
+ Filter-Based LSM Index Acceleration</a>
+ </li>
+
+ <li>
+
+ <a href="../aql/similarity.html" title="Support of Similarity Queries">
+ <i class="none"></i>
+ Support of Similarity Queries</a>
+ </li>
+ </ul>
+
+
+
+ <hr class="divider" />
+
+ <div id="poweredBy">
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href=".././" title="AsterixDB" class="builtBy">
+ <img class="builtBy" alt="AsterixDB" src="../images/asterixlogo.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <!-- ! 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.
+ ! --><h1>The SQL++ Query Language</h1>
+
+<ul>
+
+<li><a href="#Introduction">1. Introduction</a></li>
+
+<li><a href="#Expressions">2. Expressions</a>
+
+<ul>
+
+<li><a href="#Operator_expressions">Operator Expressions</a>
+
+<ul>
+
+<li><a href="#Arithmetic_operators">Arithmetic Operators</a></li>
+
+<li><a href="#Collection_operators">Collection Operators</a></li>
+
+<li><a href="#Comparison_operators">Comparison Operators</a></li>
+
+<li><a href="#Logical_operators">Logical Operators</a></li>
+ </ul></li>
+
+<li><a href="#Case_expressions">Case Expressions</a></li>
+
+<li><a href="#Quantified_expressions">Quantified Expressions</a></li>
+
+<li><a href="#Path_expressions">Path Expressions</a></li>
+
+<li><a href="#Primary_expressions">Primary Expressions</a>
+
+<ul>
+
+<li><a href="#Literals">Literals</a></li>
+
+<li><a href="#Variable_references">Variable References</a></li>
+
+<li><a href="#Parenthesized_expressions">Parenthesized Expressions</a></li>
+
+<li><a href="#Function_call_expressions">Function call Expressions</a></li>
+
+<li><a href="#Constructors">Constructors</a></li>
+ </ul></li>
+ </ul></li>
+
+<li><a href="#Queries">3. Queries</a>
+
+<ul>
+
+<li><a href="#Declarations">Declarations</a></li>
+
+<li><a href="#SELECT_statements">SELECT Statements</a></li>
+
+<li><a href="#Select_clauses">SELECT Clauses</a>
+
+<ul>
+
+<li><a href="#Select_element">Select Element/Value/Raw</a></li>
+
+<li><a href="#SQL_select">SQL-style Select</a></li>
+
+<li><a href="#Select_star">Select *</a></li>
+
+<li><a href="#Select_distinct">Select Distinct</a></li>
+
+<li><a href="#Unnamed_projections">Unnamed Projections</a></li>
+
+<li><a href="#Abbreviated_field_access_expressions">Abbreviated Field Access Expressions</a></li>
+ </ul></li>
+
+<li><a href="#Unnest_clauses">UNNEST Clauses</a>
+
+<ul>
+
+<li><a href="#Inner_unnests">Inner Unnests</a></li>
+
+<li><a href="#Left_outer_unnests">Left Outer Unnests</a></li>
+
+<li><a href="#Expressing_joins_using_unnests">Expressing Joins Using Unnests</a></li>
+ </ul></li>
+
+<li><a href="#From_clauses">FROM clauses</a>
+
+<ul>
+
+<li><a href="#Binding_expressions">Binding Expressions</a></li>
+
+<li><a href="#Multiple_from_terms">Multiple From Terms</a></li>
+
+<li><a href="#Expressing_joins_using_from_terms">Expressing Joins Using From Terms</a></li>
+
+<li><a href="#Implicit_binding_variables">Implicit Binding Variables</a></li>
+ </ul></li>
+
+<li><a href="#Join_clauses">JOIN Clauses</a>
+
+<ul>
+
+<li><a href="#Inner_joins">Inner Joins</a></li>
+
+<li><a href="#Left_outer_joins">Left Outer Joins</a></li>
+ </ul></li>
+
+<li><a href="#Group_By_clauses">GROUP BY Clauses</a>
+
+<ul>
+
+<li><a href="#Group_variables">Group Variables</a></li>
+
+<li><a href="#Implicit_group_key_variables">Implicit Group Key Variables</a></li>
+
+<li><a href="#Implicit_group_variables">Implicit Group Variables</a></li>
+
+<li><a href="#Aggregation_functions">Aggregation Functions</a></li>
+
+<li><a href="#SQL-92_aggregation_functions">SQL-92 Aggregation Functions</a></li>
+
+<li><a href="#SQL-92_compliant_gby">SQL-92 Compliant GROUP BY Aggregations</a></li>
+
+<li><a href="#Column_aliases">Column Aliases</a></li>
+ </ul></li>
+
+<li><a href="#Where_having_clauses">WHERE Clauses and HAVING Clauses</a></li>
+
+<li><a href="#Order_By_clauses">ORDER BY Clauses</a></li>
+
+<li><a href="#Limit_clauses">LIMIT Clauses</a></li>
+
+<li><a href="#With_clauses">WITH Clauses</a></li>
+
+<li><a href="#Let_clauses">LET Clauses</a></li>
+
+<li><a href="#Union_all">UNION ALL</a></li>
+
+<li><a href="#Vs_SQL-92">SQL++ Vs. SQL-92</a></li>
+ </ul></li>
+
+<li><a href="#Errors">4. Errors</a>
+
+<ul>
+
+<li><a href="#Syntax_errors">Syntax Errors</a></li>
+
+<li><a href="#Identifier_resolution_errors">Identifier Resolution Errors</a></li>
+
+<li><a href="#Type_errors">Type Errors</a></li>
+
+<li><a href="#Resource_errors">Resource Errors</a></li>
+ </ul></li>
+
+<li><a href="#DDL_and_DML_statements">5. DDL and DML Statements</a>
+
+<ul>
+
+<li><a href="#Lifecycle_management_statements">Lifecycle Management Statements</a>
+
+<ul>
+
+<li><a href="#Dataverses">Dataverses</a></li>
+
+<li><a href="#Types">Types</a></li>
+
+<li><a href="#Datasets">Datasets</a></li>
+
+<li><a href="#Indices">Indices</a></li>
+
+<li><a href="#Functions">Functions</a></li>
+
+<li><a href="#Removal">Removal</a></li>
+
+<li><a href="#Load_statement">Load Statement</a></li>
+ </ul></li>
+
+<li><a href="#Modification_statements">Modification Statements</a>
+
+<ul>
+
+<li><a href="#Inserts">Inserts</a></li>
+
+<li><a href="#Upserts">Upserts</a></li>
+
+<li><a href="#Deletes">Deletes</a></li>
+ </ul></li>
+ </ul></li>
+
+<li><a href="#Reserved_keywords">Appendix 1. Reserved Keywords</a></li>
+
+<li><a href="#Performance_tuning">Appendix 2. Performance Tuning</a>
+
+<ul>
+
+<li><a href="#Parallelism_parameter">Parallelism Parameter</a></li>
+
+<li><a href="#Memory_parameters">Memory Parameters</a></li>
+ </ul></li>
+</ul>
+<!-- ! 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.
+ ! -->
+<h1><a name="Introduction" id="Introduction">1. Introduction</a><font size="3" /></h1>
+<p>This document is intended as a reference guide to the full syntax and semantics of the SQL++ Query Language, a SQL-inspired language for working with semistructured data. SQL++ has much in common with SQL, but some differences do exist due to the different data models that the two languages were designed to serve. SQL was designed in the 1970’s for interacting with the flat, schema-ified world of relational databases, while SQL++ is much newer and targets the nested, schema-optional (or even schema-less) world of modern NoSQL systems.</p>
+<p>In the context of Apache AsterixDB, SQL++ is intended for working with the Asterix Data Model (<a href="../datamodel.html">ADM</a>),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 “<a href="primer-sqlpp.html">AsterixDB 101: An ADM and SQL++ Primer</a>” before attempting to make use of this document. In addition, readers are advised to read through the <a href="../datamodel.html">Asterix Data Model (ADM) reference guide</a> first as well, as an understanding of the data model is a prerequisite to understanding SQL++.</p>
+<p>In what follows, we detail the features of the SQL++ language in a grammar-guided manner. We list and briefly explain each of the productions in the SQL++ grammar, offering examples (and results) for clarity.</p>
+<!-- ! 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.
+ ! -->
+<h1><a name="Expressions" id="Expressions">2. Expressions</a></h1>
+<!-- ! 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.
+ ! -->
+<p>SQL++ is a highly composable expression language. Each SQL++ expression returns zero or more data model instances. There are three major kinds of expressions in SQL++. At the topmost level, a SQL++ expression can be an OperatorExpression (similar to a mathematical expression), an ConditionalExpression (to choose between alternative values), or a QuantifiedExpression (which yields a boolean value). Each will be detailed as we explore the full SQL++ grammar.</p>
+
+<div class="source">
+<div class="source">
+<pre>Expression ::= OperatorExpression | CaseExpression | QuantifiedExpression
+</pre></div></div>
+<p>Note that in the following text, words enclosed in angle brackets denote keywords that are not case-sensitive.</p>
+<div class="section">
+<h2><a name="Operator_Expressions"></a><a name="Operator_expressions" id="Operator_expressions">Operator Expressions</a></h2>
+<p>Operators perform a specific operation on the input values or expressions. The syntax of an operator expression is as follows:</p>
+
+<div class="source">
+<div class="source">
+<pre>OperatorExpression ::= PathExpression
+ | Operator OperatorExpression
+ | OperatorExpression Operator (OperatorExpression)?
+ | OperatorExpression <BETWEEN> OperatorExpression <AND> OperatorExpression
+</pre></div></div>
+<p>SQL++ provides a full set of operators that you can use within its statements. Here are the categories of operators:</p>
+
+<ul>
+
+<li><a href="#Arithmetic_operators">Arithmetic Operators</a>, to perform basic mathematical operations;</li>
+
+<li><a href="#Collection_operators">Collection Operators</a>, to evaluate expressions on collections or objects;</li>
+
+<li><a href="#Comparison_operators">Comparison Operators</a>, to compare two expressions;</li>
+
+<li><a href="#Logical_operators">Logical Operators</a>, to combine operators using Boolean logic.</li>
+</ul>
+<p>The following table summarizes the precedence order (from higher to lower) of the major unary and binary operators:</p>
+
+<table border="0" class="table table-striped">
+ <thead>
+
+<tr class="a">
+
+<th>Operator </th>
+
+<th>Operation </th>
+ </tr>
+ </thead>
+ <tbody>
+
+<tr class="b">
+
+<td>EXISTS, NOT EXISTS </td>
+
+<td>Collection emptiness testing </td>
+ </tr>
+
+<tr class="a">
+
+<td>^ </td>
+
+<td>Exponentiation </td>
+ </tr>
+
+<tr class="b">
+
+<td>*, /, % </td>
+
+<td>Multiplication, division, modulo </td>
+ </tr>
+
+<tr class="a">
+
+<td>+, - </td>
+
+<td>Addition, subtraction </td>
+ </tr>
+
+<tr class="b">
+
+<td>|| </td>
+
+<td>String concatenation </td>
+ </tr>
+
+<tr class="a">
+
+<td>IS NULL, IS NOT NULL, IS MISSING, IS NOT MISSING, <br />IS UNKNOWN, IS NOT UNKNOWN</td>
+
+<td>Unknown value comparison </td>
+ </tr>
+
+<tr class="b">
+
+<td>BETWEEN, NOT BETWEEN </td>
+
+<td>Range comparison (inclusive on both sides) </td>
+ </tr>
+
+<tr class="a">
+
+<td>=, !=, <>, <, >, <=, >=, LIKE, NOT LIKE, IN, NOT IN </td>
+
+<td>Comparison </td>
+ </tr>
+
+<tr class="b">
+
+<td>NOT </td>
+
+<td>Logical negation </td>
+ </tr>
+
+<tr class="a">
+
+<td>AND </td>
+
+<td>Conjunction </td>
+ </tr>
+
+<tr class="b">
+
+<td>OR </td>
+
+<td>Disjunction </td>
+ </tr>
+ </tbody>
+</table>
+<p>In general, if any operand evaluates to a <tt>MISSING</tt> value, the enclosing operator will return <tt>MISSING</tt>; if none of operands evaluates to a <tt>MISSING</tt> value but there is an operand evaluates to a <tt>NULL</tt> value, the enclosing operator will return <tt>NULL</tt>. However, there are a few exceptions listed in <a href="#Comparison_operators">comparison operators</a> and <a href="#Logical_operators">logical operators</a>.</p>
+<div class="section">
+<h3><a name="Arithmetic_Operators"></a><a name="Arithmetic_operators" id="Arithmetic_operators">Arithmetic Operators</a></h3>
+<p>Arithmetic operators are used to exponentiate, add, subtract, multiply, and divide numeric values, or concatenate string values.</p>
+
+<table border="0" class="table table-striped">
+ <thead>
+
+<tr class="a">
+
+<th>Operator </th>
+
+<th>Purpose </th>
+
+<th>Example </th>
+ </tr>
+ </thead>
+ <tbody>
+
+<tr class="b">
+
+<td>+, - </td>
+
+<td>As unary operators, they denote a <br />positive or negative expression </td>
+
+<td>SELECT VALUE -1; </td>
+ </tr>
+
+<tr class="a">
+
+<td>+, - </td>
+
+<td>As binary operators, they add or subtract </td>
+
+<td>SELECT VALUE 1 + 2; </td>
+ </tr>
+
+<tr class="b">
+
+<td>*, /, % </td>
+
+<td>Multiply, divide, modulo </td>
+
+<td>SELECT VALUE 4 / 2.0; </td>
+ </tr>
+
+<tr class="a">
+
+<td>^ </td>
+
+<td>Exponentiation </td>
+
+<td>SELECT VALUE 2^3; </td>
+ </tr>
+
+<tr class="b">
+
+<td>|| </td>
+
+<td>String concatenation </td>
+
+<td>SELECT VALUE “ab”||“c”||“d”; </td>
+ </tr>
+ </tbody>
+</table></div>
+<div class="section">
+<h3><a name="Collection_Operators"></a><a name="Collection_operators" id="Collection_operators">Collection Operators</a></h3>
+<p>Collection operators are used for membership tests (IN, NOT IN) or empty collection tests (EXISTS, NOT EXISTS).</p>
+
+<table border="0" class="table table-striped">
+ <thead>
+
+<tr class="a">
+
+<th>Operator </th>
+
+<th>Purpose </th>
+
+<th>Example </th>
+ </tr>
+ </thead>
+ <tbody>
+
+<tr class="b">
+
+<td>IN </td>
+
+<td>Membership test </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.user.lang IN [“en”, “de”]; </td>
+ </tr>
+
+<tr class="a">
+
+<td>NOT IN </td>
+
+<td>Non-membership test </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.user.lang NOT IN [“en”]; </td>
+ </tr>
+
+<tr class="b">
+
+<td>EXISTS </td>
+
+<td>Check whether a collection is not empty </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE EXISTS cm.referredTopics; </td>
+ </tr>
+
+<tr class="a">
+
+<td>NOT EXISTS </td>
+
+<td>Check whether a collection is empty </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE NOT EXISTS cm.referredTopics; </td>
+ </tr>
+ </tbody>
+</table></div>
+<div class="section">
+<h3><a name="Comparison_Operators"></a><a name="Comparison_operators" id="Comparison_operators">Comparison Operators</a></h3>
+<p>Comparison operators are used to compare values. The comparison operators fall into one of two sub-categories: missing value comparisons and regular value comparisons. SQL++ (and JSON) has two ways of representing missing information in a object - the presence of the field with a NULL for its value (as in SQL), and the absence of the field (which JSON permits). For example, the first of the following objects represents Jack, whose friend is Jill. In the other examples, Jake is friendless a la SQL, with a friend field that is NULL, while Joe is friendless in a more natural (for JSON) way, i.e., by not having a friend field.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Examples"></a>Examples</h5>
+<p>{“name”: “Jack”, “friend”: “Jill”}</p>
+<p>{“name”: “Jake”, “friend”: NULL}</p>
+<p>{“name”: “Joe”}</p>
+<p>The following table enumerates all of SQL++’s comparison operators.</p>
+
+<table border="0" class="table table-striped">
+ <thead>
+
+<tr class="a">
+
+<th>Operator </th>
+
+<th>Purpose </th>
+
+<th>Example </th>
+ </tr>
+ </thead>
+ <tbody>
+
+<tr class="b">
+
+<td>IS NULL </td>
+
+<td>Test if a value is NULL </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.user.name IS NULL; </td>
+ </tr>
+
+<tr class="a">
+
+<td>IS NOT NULL </td>
+
+<td>Test if a value is not NULL </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.user.name IS NOT NULL; </td>
+ </tr>
+
+<tr class="b">
+
+<td>IS MISSING </td>
+
+<td>Test if a value is MISSING </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.user.name IS MISSING; </td>
+ </tr>
+
+<tr class="a">
+
+<td>IS NOT MISSING </td>
+
+<td>Test if a value is not MISSING </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.user.name IS NOT MISSING;</td>
+ </tr>
+
+<tr class="b">
+
+<td>IS UNKNOWN </td>
+
+<td>Test if a value is NULL or MISSING </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.user.name IS UNKNOWN; </td>
+ </tr>
+
+<tr class="a">
+
+<td>IS NOT UNKNOWN </td>
+
+<td>Test if a value is neither NULL nor MISSING </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.user.name IS NOT UNKNOWN;</td>
+ </tr>
+
+<tr class="b">
+
+<td>BETWEEN </td>
+
+<td>Test if a value is between a start value and <br />a end value. The comparison is inclusive <br />to both start and end values. </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.chirpId BETWEEN 10 AND 20;</td>
+ </tr>
+
+<tr class="a">
+
+<td>= </td>
+
+<td>Equality test </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.chirpId=10; </td>
+ </tr>
+
+<tr class="b">
+
+<td>!= </td>
+
+<td>Inequality test </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.chirpId!=10;</td>
+ </tr>
+
+<tr class="a">
+
+<td><> </td>
+
+<td>Inequality test </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.chirpId<>10;</td>
+ </tr>
+
+<tr class="b">
+
+<td>< </td>
+
+<td>Less than </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.chirpId<10; </td>
+ </tr>
+
+<tr class="a">
+
+<td>> </td>
+
+<td>Greater than </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.chirpId>10; </td>
+ </tr>
+
+<tr class="b">
+
+<td><= </td>
+
+<td>Less than or equal to </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.chirpId<=10; </td>
+ </tr>
+
+<tr class="a">
+
+<td>>= </td>
+
+<td>Greater than or equal to </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.chirpId>=10; </td>
+ </tr>
+
+<tr class="b">
+
+<td>LIKE </td>
+
+<td>Test if the left side matches a<br /> pattern defined on the right<br /> side; in the pattern, “%” matches <br />any string while “_” matches <br /> any character. </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.user.name LIKE “%Giesen%”;</td>
+ </tr>
+
+<tr class="a">
+
+<td>NOT LIKE </td>
+
+<td>Test if the left side does not <br />match a pattern defined on the right<br /> side; in the pattern, “%” matches <br />any string while “_” matches <br /> any character. </td>
+
+<td>SELECT * FROM ChirpMessages cm <br />WHERE cm.user.name NOT LIKE “%Giesen%”;</td>
+ </tr>
+ </tbody>
+</table>
+<p>The following table summarizes how the missing value comparison operators work.</p>
+
+<table border="0" class="table table-striped">
+ <thead>
+
+<tr class="a">
+
+<th>Operator </th>
+
+<th>Non-NULL/Non-MISSING value </th>
+
+<th>NULL </th>
+
+<th>MISSING </th>
+ </tr>
+ </thead>
+ <tbody>
+
+<tr class="b">
+
+<td>IS NULL </td>
+
+<td>FALSE </td>
+
+<td>TRUE </td>
+
+<td>MISSING </td>
+ </tr>
+
+<tr class="a">
+
+<td>IS NOT NULL </td>
+
+<td>TRUE </td>
+
+<td>FALSE </td>
+
+<td>MISSING </td>
+ </tr>
+
+<tr class="b">
+
+<td>IS MISSING </td>
+
+<td>FALSE </td>
+
+<td>FALSE </td>
+
+<td>TRUE </td>
+ </tr>
+
+<tr class="a">
+
+<td>IS NOT MISSING </td>
+
+<td>TRUE </td>
+
+<td>TRUE </td>
+
+<td>FALSE </td>
+ </tr>
+
+<tr class="b">
+
+<td>IS UNKNOWN </td>
+
+<td>FALSE </td>
+
+<td>TRUE </td>
+
+<td>TRUE </td>
+ </tr>
+
+<tr class="a">
+
+<td>IS NOT UNKNOWN </td>
+
+<td>TRUE </td>
+
+<td>FALSE </td>
+
+<td>FALSE</td>
+ </tr>
+ </tbody>
+</table></div></div></div>
+<div class="section">
+<h3><a name="Logical_Operators"></a><a name="Logical_operators" id="Logical_operators">Logical Operators</a></h3>
+<p>Logical operators perform logical <tt>NOT</tt>, <tt>AND</tt>, and <tt>OR</tt> operations over Boolean values (<tt>TRUE</tt> and <tt>FALSE</tt>) plus <tt>NULL</tt> and <tt>MISSING</tt>.</p>
+
+<table border="0" class="table table-striped">
+ <thead>
+
+<tr class="a">
+
+<th>Operator </th>
+
+<th>Purpose </th>
+
+<th>Example </th>
+ </tr>
+ </thead>
+ <tbody>
+
+<tr class="b">
+
+<td>NOT </td>
+
+<td>Returns true if the following condition is false, otherwise returns false </td>
+
+<td>SELECT VALUE NOT TRUE; </td>
+ </tr>
+
+<tr class="a">
+
+<td>AND </td>
+
+<td>Returns true if both branches are true, otherwise returns false </td>
+
+<td>SELECT VALUE TRUE AND FALSE; </td>
+ </tr>
+
+<tr class="b">
+
+<td>OR </td>
+
+<td>Returns true if one branch is true, otherwise returns false </td>
+
+<td>SELECT VALUE FALSE OR FALSE; </td>
+ </tr>
+ </tbody>
+</table>
+<p>The following table is the truth table for <tt>AND</tt> and <tt>OR</tt>.</p>
+
+<table border="0" class="table table-striped">
+ <thead>
+
+<tr class="a">
+
+<th>A </th>
+
+<th>B </th>
+
+<th>A AND B </th>
+
+<th>A OR B </th>
+ </tr>
+ </thead>
+ <tbody>
+
+<tr class="b">
+
+<td>TRUE </td>
+
+<td>TRUE </td>
+
+<td>TRUE </td>
+
+<td>TRUE </td>
+ </tr>
+
+<tr class="a">
+
+<td>TRUE </td>
+
+<td>FALSE </td>
+
+<td>FALSE </td>
+
+<td>TRUE </td>
+ </tr>
+
+<tr class="b">
+
+<td>TRUE </td>
+
+<td>NULL </td>
+
+<td>NULL </td>
+
+<td>TRUE </td>
+ </tr>
+
+<tr class="a">
+
+<td>TRUE </td>
+
+<td>MISSING </td>
+
+<td>MISSING </td>
+
+<td>TRUE </td>
+ </tr>
+
+<tr class="b">
+
+<td>FALSE </td>
+
+<td>FALSE </td>
+
+<td>FALSE </td>
+
+<td>FALSE </td>
+ </tr>
+
+<tr class="a">
+
+<td>FALSE </td>
+
+<td>NULL </td>
+
+<td>FALSE </td>
+
+<td>NULL </td>
+ </tr>
+
+<tr class="b">
+
+<td>FALSE </td>
+
+<td>MISSING </td>
+
+<td>FALSE </td>
+
+<td>MISSING </td>
+ </tr>
+
+<tr class="a">
+
+<td>NULL </td>
+
+<td>NULL </td>
+
+<td>NULL </td>
+
+<td>NULL </td>
+ </tr>
+
+<tr class="b">
+
+<td>NULL </td>
+
+<td>MISSING </td>
+
+<td>MISSING </td>
+
+<td>NULL </td>
+ </tr>
+
+<tr class="a">
+
+<td>MISSING </td>
+
+<td>MISSING </td>
+
+<td>MISSING </td>
+
+<td>MISSING </td>
+ </tr>
+ </tbody>
+</table>
+<p>The following table demonstrates the results of <tt>NOT</tt> on all possible inputs.</p>
+
+<table border="0" class="table table-striped">
+ <thead>
+
+<tr class="a">
+
+<th>A </th>
+
+<th>NOT A </th>
+ </tr>
+ </thead>
+ <tbody>
+
+<tr class="b">
+
+<td>TRUE </td>
+
+<td>FALSE </td>
+ </tr>
+
+<tr class="a">
+
+<td>FALSE </td>
+
+<td>TRUE </td>
+ </tr>
+
+<tr class="b">
+
+<td>NULL </td>
+
+<td>NULL </td>
+ </tr>
+
+<tr class="a">
+
+<td>MISSING </td>
+
+<td>MISSING </td>
+ </tr>
+ </tbody>
+</table></div></div>
+<div class="section">
+<h2><a name="Case_Expressions"></a><a name="Case_expressions" id="Case_expressions">Case Expressions</a></h2>
+
+<div class="source">
+<div class="source">
+<pre>CaseExpression ::= SimpleCaseExpression | SearchedCaseExpression
+SimpleCaseExpression ::= <CASE> Expression ( <WHEN> Expression <THEN> Expression )+ ( <ELSE> Expression )? <END>
+SearchedCaseExpression ::= <CASE> ( <WHEN> Expression <THEN> Expression )+ ( <ELSE> Expression )? <END>
+</pre></div></div>
+<p>In a simple <tt>CASE</tt> expression, the query evaluator searches for the first <tt>WHEN</tt> … <tt>THEN</tt> pair in which the <tt>WHEN</tt> expression is equal to the expression following <tt>CASE</tt> and returns the expression following <tt>THEN</tt>. If none of the <tt>WHEN</tt> … <tt>THEN</tt> pairs meet this condition, and an <tt>ELSE</tt> branch exists, it returns the <tt>ELSE</tt> expression. Otherwise, <tt>NULL</tt> is returned.</p>
+<p>In a searched CASE expression, the query evaluator searches from left to right until it finds a <tt>WHEN</tt> expression that is evaluated to <tt>TRUE</tt>, and then returns its corresponding <tt>THEN</tt> expression. If no condition is found to be <tt>TRUE</tt>, and an <tt>ELSE</tt> branch exists, it returns the <tt>ELSE</tt> expression. Otherwise, it returns <tt>NULL</tt>.</p>
+<p>The following example illustrates the form of a case expression.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>CASE (2 < 3) WHEN true THEN "yes" ELSE "no" END
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="Quantified_Expressions"></a><a name="Quantified_expressions" id="Quantified_expressions">Quantified Expressions</a></h2>
+
+<div class="source">
+<div class="source">
+<pre>QuantifiedExpression ::= ( (<ANY>|<SOME>) | <EVERY> ) Variable <IN> Expression ( "," Variable "in" Expression )*
+ <SATISFIES> Expression (<END>)?
+</pre></div></div>
+<p>Quantified expressions are used for expressing existential or universal predicates involving the elements of a collection.</p>
+<p>The following pair of examples illustrate the use of a quantified expression to test that every (or some) element in the set [1, 2, 3] of integers is less than three. The first example yields <tt>FALSE</tt> and second example yields <tt>TRUE</tt>.</p>
+<p>It is useful to note that if the set were instead the empty set, the first expression would yield <tt>TRUE</tt> (“every” value in an empty set satisfies the condition) while the second expression would yield <tt>FALSE</tt> (since there isn’t “some” value, as there are no values in the set, that satisfies the condition).</p>
+<p>A quantified expression will return a <tt>NULL</tt> (or <tt>MISSING</tt>) if the first expression in it evaluates to <tt>NULL</tt> (or <tt>MISSING</tt>). A type error will be raised if the first expression in a quantified expression does not return a collection.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Examples"></a>Examples</h5>
+
+<div class="source">
+<div class="source">
+<pre>EVERY x IN [ 1, 2, 3 ] SATISFIES x < 3
+SOME x IN [ 1, 2, 3 ] SATISFIES x < 3
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="Path_Expressions"></a><a name="Path_expressions" id="Path_expressions">Path Expressions</a></h2>
+
+<div class="source">
+<div class="source">
+<pre>PathExpression ::= PrimaryExpression ( Field | Index )*
+Field ::= "." Identifier
+Index ::= "[" ( Expression | "?" ) "]"
+</pre></div></div>
+<p>Components of complex types in the data model are accessed via path expressions. Path access can be applied to the result of a SQL++ expression that yields an instance of a complex type, for example, a object or array instance. For objects, path access is based on field names. For arrays, path access is based on (zero-based) array-style indexing. SQL++ also supports an “I’m feeling lucky” style index accessor, [?], for selecting an arbitrary element from an array. Attempts to access non-existent fields or out-of-bound array elements produce the special value <tt>MISSING</tt>. Type errors will be raised for inappropriate use of a path expression, such as applying a field accessor to a numeric value.</p>
+<p>The following examples illustrate field access for a object, index-based element access for an array, and also a composition thereof.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Examples"></a>Examples</h5>
+
+<div class="source">
+<div class="source">
+<pre>({"name": "MyABCs", "array": [ "a", "b", "c"]}).array
+
+(["a", "b", "c"])[2]
+
+({"name": "MyABCs", "array": [ "a", "b", "c"]}).array[2]
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="Primary_Expressions"></a><a name="Primary_expressions" id="Primary_expressions">Primary Expressions</a></h2>
+
+<div class="source">
+<div class="source">
+<pre>PrimaryExpr ::= Literal
+ | VariableReference
+ | ParenthesizedExpression
+ | FunctionCallExpression
+ | Constructor
+</pre></div></div>
+<p>The most basic building block for any SQL++ expression is PrimaryExpression. This can be a simple literal (constant) value, a reference to a query variable that is in scope, a parenthesized expression, a function call, or a newly constructed instance of the data model (such as a newly constructed object, array, or multiset of data model instances).</p></div>
+<div class="section">
+<h2><a name="Literals" id="Literals">Literals</a></h2>
+
+<div class="source">
+<div class="source">
+<pre>Literal ::= StringLiteral
+ | IntegerLiteral
+ | FloatLiteral
+ | DoubleLiteral
+ | <NULL>
+ | <MISSING>
+ | <TRUE>
+ | <FALSE>
+StringLiteral ::= "\"" (
+ <EscapeQuot>
+ | <EscapeBslash>
+ | <EscapeSlash>
+ | <EscapeBspace>
+ | <EscapeFormf>
+ | <EscapeNl>
+ | <EscapeCr>
+ | <EscapeTab>
+ | ~["\"","\\"])*
+ "\""
+ | "\'"(
+ <EscapeApos>
+ | <EscapeBslash>
+ | <EscapeSlash>
+ | <EscapeBspace>
+ | <EscapeFormf>
+ | <EscapeNl>
+ | <EscapeCr>
+ | <EscapeTab>
+ | ~["\'","\\"])*
+ "\'"
+<ESCAPE_Apos> ::= "\\\'"
+<ESCAPE_Quot> ::= "\\\""
+<EscapeBslash> ::= "\\\\"
+<EscapeSlash> ::= "\\/"
+<EscapeBspace> ::= "\\b"
+<EscapeFormf> ::= "\\f"
+<EscapeNl> ::= "\\n"
+<EscapeCr> ::= "\\r"
+<EscapeTab> ::= "\\t"
+
+IntegerLiteral ::= <DIGITS>
+<DIGITS> ::= ["0" - "9"]+
+FloatLiteral ::= <DIGITS> ( "f" | "F" )
+ | <DIGITS> ( "." <DIGITS> ( "f" | "F" ) )?
+ | "." <DIGITS> ( "f" | "F" )
+DoubleLiteral ::= <DIGITS> "." <DIGITS>
+ | "." <DIGITS>
+</pre></div></div>
+<p>Literals (constants) in SQL++ can be strings, integers, floating point values, double values, boolean constants, or special constant values like <tt>NULL</tt> and <tt>MISSING</tt>. The <tt>NULL</tt> value is like a <tt>NULL</tt> in SQL; it is used to represent an unknown field value. The specialy value <tt>MISSING</tt> is only meaningful in the context of SQL++ field accesses; it occurs when the accessed field simply does not exist at all in a object being accessed.</p>
+<p>The following are some simple examples of SQL++ literals.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Examples"></a>Examples</h5>
+
+<div class="source">
+<div class="source">
+<pre>'a string'
+"test string"
+42
+</pre></div></div>
+<p>Different from standard SQL, double quotes play the same role as single quotes and may be used for string literals in SQL++.</p></div></div></div>
+<div class="section">
+<h3><a name="Variable_References"></a><a name="Variable_references" id="Variable_references">Variable References</a></h3>
+
+<div class="source">
+<div class="source">
+<pre>VariableReference ::= <IDENTIFIER>|<DelimitedIdentifier>
+<IDENTIFIER> ::= <LETTER> (<LETTER> | <DIGIT> | "_" | "$")*
+<LETTER> ::= ["A" - "Z", "a" - "z"]
+DelimitedIdentifier ::= "`" (<EscapeQuot>
+ | <EscapeBslash>
+ | <EscapeSlash>
+ | <EscapeBspace>
+ | <EscapeFormf>
+ | <EscapeNl>
+ | <EscapeCr>
+ | <EscapeTab>
+ | ~["`","\\"])*
+ "`"
+</pre></div></div>
+<p>A variable in SQL++ can be bound to any legal data model value. A variable reference refers to the value to which an in-scope variable is bound. (E.g., a variable binding may originate from one of the <tt>FROM</tt>, <tt>WITH</tt> or <tt>LET</tt> clauses of a <tt>SELECT</tt> statement or from an input parameter in the context of a function body.) Backticks, for example, `id`, are used for delimited identifiers. Delimiting is needed when a variable’s desired name clashes with a SQL++ keyword or includes characters not allowed in regular identifiers.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Examples"></a>Examples</h5>
+
+<div class="source">
+<div class="source">
+<pre>tweet
+id
+`SELECT`
+`my-function`
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="Parenthesized_Expressions"></a><a name="Parenthesized_expressions" id="Parenthesized_expressions">Parenthesized Expressions</a></h3>
+
+<div class="source">
+<div class="source">
+<pre>ParenthesizedExpression ::= "(" Expression ")" | Subquery
+</pre></div></div>
+<p>An expression can be parenthesized to control the precedence order or otherwise clarify a query. In SQL++, for composability, a subquery is also an parenthesized expression.</p>
+<p>The following expression evaluates to the value 2.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>( 1 + 1 )
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="Function_Call_Expressions"></a><a name="Function_call_expressions" id="Function_call_expressions">Function Call Expressions</a></h3>
+
+<div class="source">
+<div class="source">
+<pre>FunctionCallExpression ::= FunctionName "(" ( Expression ( "," Expression )* )? ")"
+</pre></div></div>
+<p>Functions are included in SQL++, like most languages, as a way to package useful functionality or to componentize complicated or reusable SQL++ computations. A function call is a legal SQL++ query expression that represents the value resulting from the evaluation of its body expression with the given parameter bindings; the parameter value bindings can themselves be any SQL++ expressions.</p>
+<p>The following example is a (built-in) function call expression whose value is 8.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>length('a string')
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="Constructors" id="Constructors">Constructors</a></h3>
+
+<div class="source">
+<div class="source">
+<pre>Constructor ::= ArrayConstructor | MultisetConstructor | ObjectConstructor
+ArrayConstructor ::= "[" ( Expression ( "," Expression )* )? "]"
+MultisetConstructor ::= "{{" ( Expression ( "," Expression )* )? "}}"
+ObjectConstructor ::= "{" ( FieldBinding ( "," FieldBinding )* )? "}"
+FieldBinding ::= Expression ":" Expression
+</pre></div></div>
+<p>A major feature of SQL++ is its ability to construct new data model instances. This is accomplished using its constructors for each of the model’s complex object structures, namely arrays, multisets, and objects. Arrays are like JSON arrays, while multisets have bag semantics. Objects are built from fields that are field-name/field-value pairs, again like JSON.</p>
+<p>The following examples illustrate how to construct a new array with 4 items and a new object with 2 fields respectively. Array elements can be homogeneous (as in the first example), which is the common case, or they may be heterogeneous (as in the second example). The data values and field name values used to construct arrays, multisets, and objects in constructors are all simply SQL++ expressions. Thus, the collection elements, field names, and field values used in constructors can be simple literals or they can come from query variable references or even arbitrarily complex SQL++ expressions (subqueries). Type errors will be raised if the field names in an object are not strings, and duplicate field errors will be raised if they are not distinct.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Examples"></a>Examples</h5>
+
+<div class="source">
+<div class="source">
+<pre>[ 'a', 'b', 'c', 'c' ]
+
+[ 42, "forty-two!", { "rank" : "Captain", "name": "America" }, 3.14159 ]
+
+{
+ 'project name': 'Hyracks',
+ 'project members': [ 'vinayakb', 'dtabass', 'chenli', 'tsotras', 'tillw' ]
+}
+</pre></div></div>
+<!-- ! 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.
+ ! -->
+<h1><a name="Queries" id="Queries">3. Queries</a></h1>
+<p>A SQL++ query can be any legal SQL++ expression or <tt>SELECT</tt> statement. A SQL++ query always ends with a semicolon.</p>
+
+<div class="source">
+<div class="source">
+<pre>Query ::= (Expression | SelectStatement) ";"
+</pre></div></div>
+<!-- ! 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.
+ ! --></div></div></div></div>
+<div class="section">
+<h2><a name="Declarations" id="Declarations">Declarations</a></h2>
+
+<div class="source">
+<div class="source">
+<pre>DatabaseDeclaration ::= "USE" Identifier
+</pre></div></div>
+<p>At the uppermost level, the world of data is organized into data namespaces called <b>dataverses</b>. To set the default dataverse for a series of statements, the USE statement is provided in SQL++.</p>
+<p>As an example, the following statement sets the default dataverse to be “TinySocial”.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>USE TinySocial;
+</pre></div></div>
+<!-- ! 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.
+ ! -->
+<p>When writing a complex SQL++ query, it can sometimes be helpful to define one or more auxilliary functions that each address a sub-piece of the overall query. The declare function statement supports the creation of such helper functions. In general, the function body (expression) can be any legal SQL++ query expression.</p>
+
+<div class="source">
+<div class="source">
+<pre>FunctionDeclaration ::= "DECLARE" "FUNCTION" Identifier ParameterList "{" Expression "}"
+ParameterList ::= "(" ( <VARIABLE> ( "," <VARIABLE> )* )? ")"
+</pre></div></div>
+<p>The following is a simple example of a temporary SQL++ function definition and its use.</p></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>DECLARE FUNCTION friendInfo(userId) {
+ (SELECT u.id, u.name, len(u.friendIds) AS friendCount
+ FROM GleambookUsers u
+ WHERE u.id = userId)[0]
+ };
+
+SELECT VALUE friendInfo(2);
+</pre></div></div>
+<p>For our sample data set, this returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[
+ { "id": 2, "name": "IsbelDull", "friendCount": 2 }
+]
+</pre></div></div>
+<!-- ! 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.
+ ! --></div></div></div></div>
+<div class="section">
+<h2><a name="SELECT_Statements"></a><a name="SELECT_statements" id="SELECT_statements">SELECT Statements</a></h2>
+<p>The following shows the (rich) grammar for the <tt>SELECT</tt> statement in SQL++.</p>
+
+<div class="source">
+<div class="source">
+<pre>SelectStatement ::= ( WithClause )?
+ SelectSetOperation (OrderbyClause )? ( LimitClause )?
+SelectSetOperation ::= SelectBlock (<UNION> <ALL> ( SelectBlock | Subquery ) )*
+Subquery ::= "(" SelectStatement ")"
+
+SelectBlock ::= SelectClause
+ ( FromClause ( LetClause )?)?
+ ( WhereClause )?
+ ( GroupbyClause ( LetClause )? ( HavingClause )? )?
+ |
+ FromClause ( LetClause )?
+ ( WhereClause )?
+ ( GroupbyClause ( LetClause )? ( HavingClause )? )?
+ SelectClause
+
+SelectClause ::= <SELECT> ( <ALL> | <DISTINCT> )? ( SelectRegular | SelectValue )
+SelectRegular ::= Projection ( "," Projection )*
+SelectValue ::= ( <VALUE> | <ELEMENT> | <RAW> ) Expression
+Projection ::= ( Expression ( <AS> )? Identifier | "*" )
+
+FromClause ::= <FROM> FromTerm ( "," FromTerm )*
+FromTerm ::= Expression (( <AS> )? Variable)?
+ ( ( JoinType )? ( JoinClause | UnnestClause ) )*
+
+JoinClause ::= <JOIN> Expression (( <AS> )? Variable)? <ON> Expression
+UnnestClause ::= ( <UNNEST> | <CORRELATE> | <FLATTEN> ) Expression
+ ( <AS> )? Variable ( <AT> Variable )?
+JoinType ::= ( <INNER> | <LEFT> ( <OUTER> )? )
+
+WithClause ::= <WITH> WithElement ( "," WithElement )*
+LetClause ::= (<LET> | <LETTING>) LetElement ( "," LetElement )*
+LetElement ::= Variable "=" Expression
+WithElement ::= Variable <AS> Expression
+
+WhereClause ::= <WHERE> Expression
+
+GroupbyClause ::= <GROUP> <BY> ( Expression ( (<AS>)? Variable )? ( "," Expression ( (<AS>)? Variable )? )*
+ ( <GROUP> <AS> Variable
+ ("(" Variable <AS> VariableReference ("," Variable <AS> VariableReference )* ")")?
+ )?
+HavingClause ::= <HAVING> Expression
+
+OrderbyClause ::= <ORDER> <BY> Expression ( <ASC> | <DESC> )? ( "," Expression ( <ASC> | <DESC> )? )*
+LimitClause ::= <LIMIT> Expression ( <OFFSET> Expression )?
+</pre></div></div>
+<p>In this section, we will make use of two stored collections of objects (datasets), <tt>GleambookUsers</tt> and <tt>GleambookMessages</tt>, in a series of running examples to explain <tt>SELECT</tt> queries. The contents of the example collections are as follows:</p>
+<p><tt>GleambookUsers</tt> collection (or, dataset):</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "id":1,
+ "alias":"Margarita",
+ "name":"MargaritaStoddard",
+ "nickname":"Mags",
+ "userSince":"2012-08-20T10:10:00",
+ "friendIds":[2,3,6,10],
+ "employment":[{
+ "organizationName":"Codetechno",
+ "start-date":"2006-08-06"
+ },
+ {
+ "organizationName":"geomedia",
+ "start-date":"2010-06-17",
+ "end-date":"2010-01-26"
+ }],
+ "gender":"F"
+},
+{
+ "id":2,
+ "alias":"Isbel",
+ "name":"IsbelDull",
+ "nickname":"Izzy",
+ "userSince":"2011-01-22T10:10:00",
+ "friendIds":[1,4],
+ "employment":[{
+ "organizationName":"Hexviafind",
+ "startDate":"2010-04-27"
+ }]
+},
+{
+ "id":3,
+ "alias":"Emory",
+ "name":"EmoryUnk",
+ "userSince":"2012-07-10T10:10:00",
+ "friendIds":[1,5,8,9],
+ "employment":[{
+ "organizationName":"geomedia",
+ "startDate":"2010-06-17",
+ "endDate":"2010-01-26"
+ }]
+} ]
+</pre></div></div>
+<p><tt>GleambookMessages</tt> collection (or, dataset):</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "messageId":2,
+ "authorId":1,
+ "inResponseTo":4,
+ "senderLocation":[41.66,80.87],
+ "message":" dislike x-phone its touch-screen is horrible"
+},
+{
+ "messageId":3,
+ "authorId":2,
+ "inResponseTo":4,
+ "senderLocation":[48.09,81.01],
+ "message":" like product-y the plan is amazing"
+},
+{
+ "messageId":4,
+ "authorId":1,
+ "inResponseTo":2,
+ "senderLocation":[37.73,97.04],
+ "message":" can't stand acast the network is horrible:("
+},
+{
+ "messageId":6,
+ "authorId":2,
+ "inResponseTo":1,
+ "senderLocation":[31.5,75.56],
+ "message":" like product-z its platform is mind-blowing"
+}
+{
+ "messageId":8,
+ "authorId":1,
+ "inResponseTo":11,
+ "senderLocation":[40.33,80.87],
+ "message":" like ccast the 3G is awesome:)"
+},
+{
+ "messageId":10,
+ "authorId":1,
+ "inResponseTo":12,
+ "senderLocation":[42.5,70.01],
+ "message":" can't stand product-w the touch-screen is terrible"
+},
+{
+ "messageId":11,
+ "authorId":1,
+ "inResponseTo":1,
+ "senderLocation":[38.97,77.49],
+ "message":" can't stand acast its plan is terrible"
+} ]
+</pre></div></div></div>
+<div class="section">
+<h2><a name="SELECT_Clause"></a><a name="Select_clauses" id="Select_clauses">SELECT Clause</a></h2>
+<p>The SQL++ <tt>SELECT</tt> clause always returns a collection value as its result (even if the result is empty or a singleton).</p>
+<div class="section">
+<h3><a name="Select_ElementValueRaw"></a><a name="Select_element" id="Select_element">Select Element/Value/Raw</a></h3>
+<p>The <tt>SELECT VALUE</tt> clause in SQL++ returns an array or multiset that contains the results of evaluating the <tt>VALUE</tt> expression, with one evaluation being performed per “binding tuple” (i.e., per <tt>FROM</tt> clause item) satisfying the statement’s selection criteria. For historical reasons SQL++ also allows the keywords <tt>ELEMENT</tt> or <tt>RAW</tt> to be used in place of <tt>VALUE</tt> (not recommended).</p>
+<p>If there is no FROM clause, the expression after <tt>VALUE</tt> is evaluated once with no binding tuples (except those inherited from an outer environment).</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT VALUE 1;
+</pre></div></div>
+<p>This query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[
+ 1
+]
+</pre></div></div>
+<p>The following example shows a query that selects one user from the GleambookUsers collection.</p></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT VALUE user
+FROM GleambookUsers user
+WHERE user.id = 1;
+</pre></div></div>
+<p>This query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[{
+ "userSince": "2012-08-20T10:10:00.000Z",
+ "friendIds": [
+ 2,
+ 3,
+ 6,
+ 10
+ ],
+ "gender": "F",
+ "name": "MargaritaStoddard",
+ "nickname": "Mags",
+ "alias": "Margarita",
+ "id": 1,
+ "employment": [
+ {
+ "organizationName": "Codetechno",
+ "start-date": "2006-08-06"
+ },
+ {
+ "end-date": "2010-01-26",
+ "organizationName": "geomedia",
+ "start-date": "2010-06-17"
+ }
+ ]
+} ]
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="SQL-style_SELECT"></a><a name="SQL_select" id="SQL_select">SQL-style SELECT</a></h3>
+<p>In SQL++, the traditional SQL-style <tt>SELECT</tt> syntax is also supported. This syntax can also be reformulated in a <tt>SELECT VALUE</tt> based manner in SQL++. (E.g., <tt>SELECT expA AS fldA, expB AS fldB</tt> is syntactic sugar for <tt>SELECT VALUE { 'fldA': expA, 'fldB': expB }</tt>.) Unlike in SQL, the result of an SQL++ query does not preserve the order of expressions in the <tt>SELECT</tt> clause.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT user.alias user_alias, user.name user_name
+FROM GleambookUsers user
+WHERE user.id = 1;
+</pre></div></div>
+<p>Returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "user_name": "MargaritaStoddard",
+ "user_alias": "Margarita"
+} ]
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="SELECT_"></a><a name="Select_star" id="Select_star">SELECT *</a></h3>
+<p>In SQL++, <tt>SELECT *</tt> returns a object with a nested field for each input tuple. Each field has as its field name the name of a binding variable generated by either the <tt>FROM</tt> clause or <tt>GROUP BY</tt> clause in the current enclosing <tt>SELECT</tt> statement, and its field value is the value of that binding variable.</p>
+<p>Note that the result of <tt>SELECT *</tt> is different from the result of query that selects all the fields of an object.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT *
+FROM GleambookUsers user;
+</pre></div></div>
+<p>Since <tt>user</tt> is the only binding variable generated in the <tt>FROM</tt> clause, this query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "user": {
+ "userSince": "2012-08-20T10:10:00.000Z",
+ "friendIds": [
+ 2,
+ 3,
+ 6,
+ 10
+ ],
+ "gender": "F",
+ "name": "MargaritaStoddard",
+ "nickname": "Mags",
+ "alias": "Margarita",
+ "id": 1,
+ "employment": [
+ {
+ "organizationName": "Codetechno",
+ "start-date": "2006-08-06"
+ },
+ {
+ "end-date": "2010-01-26",
+ "organizationName": "geomedia",
+ "start-date": "2010-06-17"
+ }
+ ]
+ }
+}, {
+ "user": {
+ "userSince": "2011-01-22T10:10:00.000Z",
+ "friendIds": [
+ 1,
+ 4
+ ],
+ "name": "IsbelDull",
+ "nickname": "Izzy",
+ "alias": "Isbel",
+ "id": 2,
+ "employment": [
+ {
+ "organizationName": "Hexviafind",
+ "startDate": "2010-04-27"
+ }
+ ]
+ }
+}, {
+ "user": {
+ "userSince": "2012-07-10T10:10:00.000Z",
+ "friendIds": [
+ 1,
+ 5,
+ 8,
+ 9
+ ],
+ "name": "EmoryUnk",
+ "alias": "Emory",
+ "id": 3,
+ "employment": [
+ {
+ "organizationName": "geomedia",
+ "endDate": "2010-01-26",
+ "startDate": "2010-06-17"
+ }
+ ]
+ }
+} ]
+</pre></div></div></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT *
+FROM GleambookUsers u, GleambookMessages m
+WHERE m.authorId = u.id and u.id = 2;
+</pre></div></div>
+<p>This query does an inner join that we will discuss in <a href="#Multiple_from_terms">multiple from terms</a>. Since both <tt>u</tt> and <tt>m</tt> are binding variables generated in the <tt>FROM</tt> clause, this query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "u": {
+ "userSince": "2011-01-22T10:10:00",
+ "friendIds": [
+ 1,
+ 4
+ ],
+ "name": "IsbelDull",
+ "nickname": "Izzy",
+ "alias": "Isbel",
+ "id": 2,
+ "employment": [
+ {
+ "organizationName": "Hexviafind",
+ "startDate": "2010-04-27"
+ }
+ ]
+ },
+ "m": {
+ "senderLocation": [
+ 31.5,
+ 75.56
+ ],
+ "inResponseTo": 1,
+ "messageId": 6,
+ "authorId": 2,
+ "message": " like product-z its platform is mind-blowing"
+ }
+}, {
+ "u": {
+ "userSince": "2011-01-22T10:10:00",
+ "friendIds": [
+ 1,
+ 4
+ ],
+ "name": "IsbelDull",
+ "nickname": "Izzy",
+ "alias": "Isbel",
+ "id": 2,
+ "employment": [
+ {
+ "organizationName": "Hexviafind",
+ "startDate": "2010-04-27"
+ }
+ ]
+ },
+ "m": {
+ "senderLocation": [
+ 48.09,
+ 81.01
+ ],
+ "inResponseTo": 4,
+ "messageId": 3,
+ "authorId": 2,
+ "message": " like product-y the plan is amazing"
+ }
+} ]
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="SELECT_DISTINCT"></a><a name="Select_distinct" id="Select_distinct">SELECT DISTINCT</a></h3>
+<p>SQL++’s <tt>DISTINCT</tt> keyword is used to eliminate duplicate items in results. The following example shows how it works.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT DISTINCT * FROM [1, 2, 2, 3] AS foo;
+</pre></div></div>
+<p>This query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "foo": 1
+}, {
+ "foo": 2
+}, {
+ "foo": 3
+} ]
+</pre></div></div></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT DISTINCT VALUE foo FROM [1, 2, 2, 3] AS foo;
+</pre></div></div>
+<p>This version of the query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ 1
+, 2
+, 3
+ ]
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="Unnamed_Projections"></a><a name="Unnamed_projections" id="Unnamed_projections">Unnamed Projections</a></h3>
+<p>Similar to standard SQL, SQL++ supports unnamed projections (a.k.a, unnamed <tt>SELECT</tt> clause items), for which names are generated. Name generation has three cases:</p>
+
+<ul>
+
+<li>If a projection expression is a variable reference expression, its generated name is the name of the variable.</li>
+
+<li>If a projection expression is a field access expression, its generated name is the last identifier in the expression.</li>
+
+<li>For all other cases, the query processor will generate a unique name.</li>
+</ul>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT substr(user.name, 10), user.alias
+FROM GleambookUsers user
+WHERE user.id = 1;
+</pre></div></div>
+<p>This query outputs:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "alias": "Margarita",
+ "$1": "Stoddard"
+} ]
+</pre></div></div>
+<p>In the result, <tt>$1</tt> is the generated name for <tt>substr(user.name, 1)</tt>, while <tt>alias</tt> is the generated name for <tt>user.alias</tt>.</p></div></div></div>
+<div class="section">
+<h3><a name="Abbreviated_Field_Access_Expressions"></a><a name="Abbreviated_field_access_expressions" id="Abbreviated_field_access_expressions">Abbreviated Field Access Expressions</a></h3>
+<p>As in standard SQL, SQL++ field access expressions can be abbreviated (not recommended) when there is no ambiguity. In the next example, the variable <tt>user</tt> is the only possible variable reference for fields <tt>id</tt>, <tt>name</tt> and <tt>alias</tt> and thus could be omitted in the query.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT substr(name, 10) AS lname, alias
+FROM GleambookUsers user
+WHERE id = 1;
+</pre></div></div>
+<p>Outputs:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "lname": "Stoddard",
+ "alias": "Margarita"
+} ]
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="UNNEST_Clause"></a><a name="Unnest_clauses" id="Unnest_clauses">UNNEST Clause</a></h2>
+<p>For each of its input tuples, the <tt>UNNEST</tt> clause flattens a collection-valued expression into individual items, producing multiple tuples, each of which is one of the expression’s original input tuples augmented with a flattened item from its collection.</p>
+<div class="section">
+<h3><a name="Inner_UNNEST"></a><a name="Inner_unnests" id="Inner_unnests">Inner UNNEST</a></h3>
+<p>The following example is a query that retrieves the names of the organizations that a selected user has worked for. It uses the <tt>UNNEST</tt> clause to unnest the nested collection <tt>employment</tt> in the user’s object.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT u.id AS userId, e.organizationName AS orgName
+FROM GleambookUsers u
+UNNEST u.employment e
+WHERE u.id = 1;
+</pre></div></div>
+<p>This query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "orgName": "Codetechno",
+ "userId": 1
+}, {
+ "orgName": "geomedia",
+ "userId": 1
+} ]
+</pre></div></div>
+<p>Note that <tt>UNNEST</tt> has SQL’s inner join semantics — that is, if a user has no employment history, no tuple corresponding to that user will be emitted in the result.</p></div></div></div>
+<div class="section">
+<h3><a name="Left_Outer_UNNEST"></a><a name="Left_outer_unnests" id="Left_outer_unnests">Left Outer UNNEST</a></h3>
+<p>As an alternative, the <tt>LEFT OUTER UNNEST</tt> clause offers SQL’s left outer join semantics. For example, no collection-valued field named <tt>hobbies</tt> exists in the object for the user whose id is 1, but the following query’s result still includes user 1.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT u.id AS userId, h.hobbyName AS hobby
+FROM GleambookUsers u
+LEFT OUTER UNNEST u.hobbies h
+WHERE u.id = 1;
+</pre></div></div>
+<p>Returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "userId": 1
+} ]
+</pre></div></div>
+<p>Note that if <tt>u.hobbies</tt> is an empty collection or leads to a <tt>MISSING</tt> (as above) or <tt>NULL</tt> value for a given input tuple, there is no corresponding binding value for variable <tt>h</tt> for an input tuple. A <tt>MISSING</tt> value will be generated for <tt>h</tt> so that the input tuple can still be propagated.</p></div></div></div>
+<div class="section">
+<h3><a name="Expressing_Joins_Using_UNNEST"></a><a name="Expressing_joins_using_unnests" id="Expressing_joins_using_unnests">Expressing Joins Using UNNEST</a></h3>
+<p>The SQL++ <tt>UNNEST</tt> clause is similar to SQL’s <tt>JOIN</tt> clause except that it allows its right argument to be correlated to its left argument, as in the examples above — i.e., think “correlated cross-product”. The next example shows this via a query that joins two data sets, GleambookUsers and GleambookMessages, returning user/message pairs. The results contain one object per pair, with result objects containing the user’s name and an entire message. The query can be thought of as saying “for each Gleambook user, unnest the <tt>GleambookMessages</tt> collection and filter the output with the condition <tt>message.authorId = user.id</tt>”.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT u.name AS uname, m.message AS message
+FROM GleambookUsers u
+UNNEST GleambookMessages m
+WHERE m.authorId = u.id;
+</pre></div></div>
+<p>This returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "uname": "MargaritaStoddard",
+ "message": " can't stand acast its plan is terrible"
+}, {
+ "uname": "MargaritaStoddard",
+ "message": " dislike x-phone its touch-screen is horrible"
+}, {
+ "uname": "MargaritaStoddard",
+ "message": " can't stand acast the network is horrible:("
+}, {
+ "uname": "MargaritaStoddard",
+ "message": " like ccast the 3G is awesome:)"
+}, {
+ "uname": "MargaritaStoddard",
+ "message": " can't stand product-w the touch-screen is terrible"
+}, {
+ "uname": "IsbelDull",
+ "message": " like product-z its platform is mind-blowing"
+}, {
+ "uname": "IsbelDull",
+ "message": " like product-y the plan is amazing"
+} ]
+</pre></div></div>
+<p>Similarly, the above query can also be expressed as the <tt>UNNEST</tt>ing of a correlated SQL++ subquery:</p></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT u.name AS uname, m.message AS message
+FROM GleambookUsers u
+UNNEST (
+ SELECT VALUE msg
+ FROM GleambookMessages msg
+ WHERE msg.authorId = u.id
+) AS m;
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="FROM_clauses"></a><a name="From_clauses" id="From_clauses">FROM clauses</a></h2>
+<p>A <tt>FROM</tt> clause is used for enumerating (i.e., conceptually iterating over) the contents of collections, as in SQL.</p>
+<div class="section">
+<h3><a name="Binding_expressions" id="Binding_expressions">Binding expressions</a></h3>
+<p>In SQL++, in addition to stored collections, a <tt>FROM</tt> clause can iterate over any intermediate collection returned by a valid SQL++ expression. In the tuple stream generated by a <tt>FROM</tt> clause, the ordering of the input tuples are not guaranteed to be preserved.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT VALUE foo
+FROM [1, 2, 2, 3] AS foo
+WHERE foo > 2;
+</pre></div></div>
+<p>Returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[
+ 3
+]
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="Multiple_FROM_Terms"></a><a name="Multiple_from_terms" id="Multiple_from_terms">Multiple FROM Terms</a></h3>
+<p>SQL++ permits correlations among <tt>FROM</tt> terms. Specifically, a <tt>FROM</tt> binding expression can refer to variables defined to its left in the given <tt>FROM</tt> clause. Thus, the first unnesting example above could also be expressed as follows:</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT u.id AS userId, e.organizationName AS orgName
+FROM GleambookUsers u, u.employment e
+WHERE u.id = 1;
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="Expressing_Joins_Using_FROM_Terms"></a><a name="Expressing_joins_using_from_terms" id="Expressing_joins_using_from_terms">Expressing Joins Using FROM Terms</a></h3>
+<p>Similarly, the join intentions of the other <tt>UNNEST</tt>-based join examples above could be expressed as:</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT u.name AS uname, m.message AS message
+FROM GleambookUsers u, GleambookMessages m
+WHERE m.authorId = u.id;
+</pre></div></div></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT u.name AS uname, m.message AS message
+FROM GleambookUsers u,
+ (
+ SELECT VALUE msg
+ FROM GleambookMessages msg
+ WHERE msg.authorId = u.id
+ ) AS m;
+</pre></div></div>
+<p>Note that the first alternative is one of the SQL-92 approaches to expressing a join.</p></div></div></div>
+<div class="section">
+<h3><a name="Implicit_Binding_Variables"></a><a name="Implicit_binding_variables" id="Implicit_binding_variables">Implicit Binding Variables</a></h3>
+<p>Similar to standard SQL, SQL++ supports implicit <tt>FROM</tt> binding variables (i.e., aliases), for which a binding variable is generated. SQL++ variable generation falls into three cases:</p>
+
+<ul>
+
+<li>If the binding expression is a variable reference expression, the generated variable’s name will be the name of the referenced variable itself.</li>
+
+<li>If the binding expression is a field access expression (or a fully qualified name for a dataset), the generated variable’s name will be the last identifier (or the dataset name) in the expression.</li>
+
+<li>For all other cases, a compilation error will be raised.</li>
+</ul>
+<p>The next two examples show queries that do not provide binding variables in their <tt>FROM</tt> clauses.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT GleambookUsers.name, GleambookMessages.message
+FROM GleambookUsers, GleambookMessages
+WHERE GleambookMessages.authorId = GleambookUsers.id;
+</pre></div></div>
+<p>Returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "name": "MargaritaStoddard",
+ "message": " like ccast the 3G is awesome:)"
+}, {
+ "name": "MargaritaStoddard",
+ "message": " can't stand product-w the touch-screen is terrible"
+}, {
+ "name": "MargaritaStoddard",
+ "message": " can't stand acast its plan is terrible"
+}, {
+ "name": "MargaritaStoddard",
+ "message": " dislike x-phone its touch-screen is horrible"
+}, {
+ "name": "MargaritaStoddard",
+ "message": " can't stand acast the network is horrible:("
+}, {
+ "name": "IsbelDull",
+ "message": " like product-y the plan is amazing"
+}, {
+ "name": "IsbelDull",
+ "message": " like product-z its platform is mind-blowing"
+} ]
+</pre></div></div></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT GleambookUsers.name, GleambookMessages.message
+FROM GleambookUsers,
+ (
+ SELECT VALUE GleambookMessages
+ FROM GleambookMessages
+ WHERE GleambookMessages.authorId = GleambookUsers.id
+ );
+</pre></div></div>
+<p>Returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>Error: "Syntax error: Need an alias for the enclosed expression:\n(select element GleambookMessages\n from GleambookMessages as GleambookMessages\n where (GleambookMessages.authorId = GleambookUsers.id)\n )",
+ "query_from_user": "use TinySocial;\n\nSELECT GleambookUsers.name, GleambookMessages.message\n FROM GleambookUsers,\n (\n SELECT VALUE GleambookMessages\n FROM GleambookMessages\n WHERE GleambookMessages.authorId = GleambookUsers.id\n );"
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="JOIN_Clauses"></a><a name="Join_clauses" id="Join_clauses">JOIN Clauses</a></h2>
+<p>The join clause in SQL++ supports both inner joins and left outer joins from standard SQL.</p>
+<div class="section">
+<h3><a name="Inner_joins" id="Inner_joins">Inner joins</a></h3>
+<p>Using a <tt>JOIN</tt> clause, the inner join intent from the preceeding examples can also be expressed as follows:</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT u.name AS uname, m.message AS message
+FROM GleambookUsers u JOIN GleambookMessages m ON m.authorId = u.id;
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="Left_Outer_Joins"></a><a name="Left_outer_joins" id="Left_outer_joins">Left Outer Joins</a></h3>
+<p>SQL++ supports SQL’s notion of left outer join. The following query is an example:</p>
+
+<div class="source">
+<div class="source">
+<pre>SELECT u.name AS uname, m.message AS message
+FROM GleambookUsers u LEFT OUTER JOIN GleambookMessages m ON m.authorId = u.id;
+</pre></div></div>
+<p>Returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "uname": "MargaritaStoddard",
+ "message": " like ccast the 3G is awesome:)"
+}, {
+ "uname": "MargaritaStoddard",
+ "message": " can't stand product-w the touch-screen is terrible"
+}, {
+ "uname": "MargaritaStoddard",
+ "message": " can't stand acast its plan is terrible"
+}, {
+ "uname": "MargaritaStoddard",
+ "message": " dislike x-phone its touch-screen is horrible"
+}, {
+ "uname": "MargaritaStoddard",
+ "message": " can't stand acast the network is horrible:("
+}, {
+ "uname": "IsbelDull",
+ "message": " like product-y the plan is amazing"
+}, {
+ "uname": "IsbelDull",
+ "message": " like product-z its platform is mind-blowing"
+}, {
+ "uname": "EmoryUnk"
+} ]
+</pre></div></div>
+<p>For non-matching left-side tuples, SQL++ produces <tt>MISSING</tt> values for the right-side binding variables; that is why the last object in the above result doesn’t have a <tt>message</tt> field. Note that this is slightly different from standard SQL, which instead would fill in <tt>NULL</tt> values for the right-side fields. The reason for this difference is that, for non-matches in its join results, SQL++ views fields from the right-side as being “not there” (a.k.a. <tt>MISSING</tt>) instead of as being “there but unknown” (i.e., <tt>NULL</tt>).</p>
+<p>The left-outer join query can also be expressed using <tt>LEFT OUTER UNNEST</tt>:</p>
+
+<div class="source">
+<div class="source">
+<pre>SELECT u.name AS uname, m.message AS message
+FROM GleambookUsers u
+LEFT OUTER UNNEST (
+ SELECT VALUE message
+ FROM GleambookMessages message
+ WHERE message.authorId = u.id
+ ) m;
+</pre></div></div>
+<p>In general, in SQL++, SQL-style join queries can also be expressed by <tt>UNNEST</tt> clauses and left outer join queries can be expressed by <tt>LEFT OUTER UNNESTs</tt>.</p></div></div>
+<div class="section">
+<h2><a name="GROUP_BY_Clauses"></a><a name="Group_By_clauses" id="Group_By_clauses">GROUP BY Clauses</a></h2>
+<p>The SQL++ <tt>GROUP BY</tt> clause generalizes standard SQL’s grouping and aggregation semantics, but it also retains backward compatibility with the standard (relational) SQL <tt>GROUP BY</tt> and aggregation features.</p>
+<div class="section">
+<h3><a name="Group_variables" id="Group_variables">Group variables</a></h3>
+<p>In a <tt>GROUP BY</tt> clause, in addition to the binding variable(s) defined for the grouping key(s), SQL++ allows a user to define a <i>group variable</i> by using the clause’s <tt>GROUP AS</tt> extension to denote the resulting group. After grouping, then, the query’s in-scope variables include the grouping key’s binding variables as well as this group variable which will be bound to one collection value for each group. This per-group collection (i.e., multiset) value will be a set of nested objects in which each field of the object is the result of a renamed variable defined in parentheses following the group variable’s name. The <tt>GROUP AS</tt> syntax is as follows:</p>
+
+<div class="source">
+<div class="source">
+<pre><GROUP> <AS> Variable ("(" Variable <AS> VariableReference ("," Variable <AS> VariableReference )* ")")?
+</pre></div></div>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT *
+FROM GleambookMessages message
+GROUP BY message.authorId AS uid GROUP AS msgs(message AS msg);
+</pre></div></div>
+<p>This first example query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "msgs": [
+ {
+ "msg": {
+ "senderLocation": [
+ 38.97,
+ 77.49
+ ],
+ "inResponseTo": 1,
+ "messageId": 11,
+ "authorId": 1,
+ "message": " can't stand acast its plan is terrible"
+ }
+ },
+ {
+ "msg": {
+ "senderLocation": [
+ 41.66,
+ 80.87
+ ],
+ "inResponseTo": 4,
+ "messageId": 2,
+ "authorId": 1,
+ "message": " dislike x-phone its touch-screen is horrible"
+ }
+ },
+ {
+ "msg": {
+ "senderLocation": [
+ 37.73,
+ 97.04
+ ],
+ "inResponseTo": 2,
+ "messageId": 4,
+ "authorId": 1,
+ "message": " can't stand acast the network is horrible:("
+ }
+ },
+ {
+ "msg": {
+ "senderLocation": [
+ 40.33,
+ 80.87
+ ],
+ "inResponseTo": 11,
+ "messageId": 8,
+ "authorId": 1,
+ "message": " like ccast the 3G is awesome:)"
+ }
+ },
+ {
+ "msg": {
+ "senderLocation": [
+ 42.5,
+ 70.01
+ ],
+ "inResponseTo": 12,
+ "messageId": 10,
+ "authorId": 1,
+ "message": " can't stand product-w the touch-screen is terrible"
+ }
+ }
+ ],
+ "uid": 1
+}, {
+ "msgs": [
+ {
+ "msg": {
+ "senderLocation": [
+ 31.5,
+ 75.56
+ ],
+ "inResponseTo": 1,
+ "messageId": 6,
+ "authorId": 2,
+ "message": " like product-z its platform is mind-blowing"
+ }
+ },
+ {
+ "msg": {
+ "senderLocation": [
+ 48.09,
+ 81.01
+ ],
+ "inResponseTo": 4,
+ "messageId": 3,
+ "authorId": 2,
+ "message": " like product-y the plan is amazing"
+ }
+ }
+ ],
+ "uid": 2
+} ]
+</pre></div></div>
+<p>As we can see from the above query result, each group in the example query’s output has an associated group variable value called <tt>msgs</tt> that appears in the <tt>SELECT *</tt>’s result. This variable contains a collection of objects associated with the group; each of the group’s <tt>message</tt> values appears in the <tt>msg</tt> field of the objects in the <tt>msgs</tt> collection.</p>
+<p>The group variable in SQL++ makes more complex, composable, nested subqueries over a group possible, which is important given the more complex data model of SQL++ (relative to SQL). As a simple example of this, as we really just want the messages associated with each user, we might wish to avoid the “extra wrapping” of each message as the <tt>msg</tt> field of a object. (That wrapping is useful in more complex cases, but is essentially just in the way here.) We can use a subquery in the <tt>SELECT</tt> clase to tunnel through the extra nesting and produce the desired result.</p></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT uid, (SELECT VALUE g.msg FROM g) AS msgs
+FROM GleambookMessages gbm
+GROUP BY gbm.authorId AS uid
+GROUP AS g(gbm as msg);
+</pre></div></div>
+<p>This variant of the example query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre> [ {
+ "msgs": [
+ {
+ "senderLocation": [
+ 38.97,
+ 77.49
+ ],
+ "inResponseTo": 1,
+ "messageId": 11,
+ "authorId": 1,
+ "message": " can't stand acast its plan is terrible"
+ },
+ {
+ "senderLocation": [
+ 41.66,
+ 80.87
+ ],
+ "inResponseTo": 4,
+ "messageId": 2,
+ "authorId": 1,
+ "message": " dislike x-phone its touch-screen is horrible"
+ },
+ {
+ "senderLocation": [
+ 37.73,
+ 97.04
+ ],
+ "inResponseTo": 2,
+ "messageId": 4,
+ "authorId": 1,
+ "message": " can't stand acast the network is horrible:("
+ },
+ {
+ "senderLocation": [
+ 40.33,
+ 80.87
+ ],
+ "inResponseTo": 11,
+ "messageId": 8,
+ "authorId": 1,
+ "message": " like ccast the 3G is awesome:)"
+ },
+ {
+ "senderLocation": [
+ 42.5,
+ 70.01
+ ],
+ "inResponseTo": 12,
+ "messageId": 10,
+ "authorId": 1,
+ "message": " can't stand product-w the touch-screen is terrible"
+ }
+ ],
+ "uid": 1
+ }, {
+ "msgs": [
+ {
+ "senderLocation": [
+ 31.5,
+ 75.56
+ ],
+ "inResponseTo": 1,
+ "messageId": 6,
+ "authorId": 2,
+ "message": " like product-z its platform is mind-blowing"
+ },
+ {
+ "senderLocation": [
+ 48.09,
+ 81.01
+ ],
+ "inResponseTo": 4,
+ "messageId": 3,
+ "authorId": 2,
+ "message": " like product-y the plan is amazing"
+ }
+ ],
+ "uid": 2
+ } ]
+</pre></div></div>
+<p>The next example shows a more interesting case involving the use of a subquery in the <tt>SELECT</tt> list. Here the subquery further processes the groups. There is no renaming in the declaration of the group variable <tt>g</tt> such that <tt>g</tt> only has one field <tt>gbm</tt> which comes from the <tt>FROM</tt> clause.</p></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT uid,
+ (SELECT VALUE g.gbm
+ FROM g
+ WHERE g.gbm.message LIKE '% like%'
+ ORDER BY g.gbm.messageId
+ LIMIT 2) AS msgs
+FROM GleambookMessages gbm
+GROUP BY gbm.authorId AS uid
+GROUP AS g;
+</pre></div></div>
+<p>This example query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "msgs": [
+ {
+ "senderLocation": [
+ 40.33,
+ 80.87
+ ],
+ "inResponseTo": 11,
+ "messageId": 8,
+ "authorId": 1,
+ "message": " like ccast the 3G is awesome:)"
+ }
+ ],
+ "uid": 1
+}, {
+ "msgs": [
+ {
+ "senderLocation": [
+ 48.09,
+ 81.01
+ ],
+ "inResponseTo": 4,
+ "messageId": 3,
+ "authorId": 2,
+ "message": " like product-y the plan is amazing"
+ },
+ {
+ "senderLocation": [
+ 31.5,
+ 75.56
+ ],
+ "inResponseTo": 1,
+ "messageId": 6,
+ "authorId": 2,
+ "message": " like product-z its platform is mind-blowing"
+ }
+ ],
+ "uid": 2
+} ]
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="Implicit_Grouping_Key_Variables"></a><a name="Implicit_group_key_variables" id="Implicit_group_key_variables">Implicit Grouping Key Variables</a></h3>
+<p>In the SQL++ syntax, providing named binding variables for <tt>GROUP BY</tt> key expressions is optional. If a grouping key is missing a user-provided binding variable, the underlying compiler will generate one. Automatic grouping key variable naming falls into three cases in SQL++, much like the treatment of unnamed projections:</p>
+
+<ul>
+
+<li>If the grouping key expression is a variable reference expression, the generated variable gets the same name as the referred variable;</li>
+
+<li>If the grouping key expression is a field access expression, the generated variable gets the same name as the last identifier in the expression;</li>
+
+<li>For all other cases, the compiler generates a unique variable (but the user query is unable to refer to this generated variable).</li>
+</ul>
+<p>The next example illustrates a query that doesn’t provide binding variables for its grouping key expressions.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT authorId,
+ (SELECT VALUE g.gbm
+ FROM g
+ WHERE g.gbm.message LIKE '% like%'
+ ORDER BY g.gbm.messageId
+ LIMIT 2) AS msgs
+FROM GleambookMessages gbm
+GROUP BY gbm.authorId
+GROUP AS g;
+</pre></div></div>
+<p>This query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre> [ {
+ "msgs": [
+ {
+ "senderLocation": [
+ 40.33,
+ 80.87
+ ],
+ "inResponseTo": 11,
+ "messageId": 8,
+ "authorId": 1,
+ "message": " like ccast the 3G is awesome:)"
+ }
+ ],
+ "authorId": 1
+}, {
+ "msgs": [
+ {
+ "senderLocation": [
+ 48.09,
+ 81.01
+ ],
+ "inResponseTo": 4,
+ "messageId": 3,
+ "authorId": 2,
+ "message": " like product-y the plan is amazing"
+ },
+ {
+ "senderLocation": [
+ 31.5,
+ 75.56
+ ],
+ "inResponseTo": 1,
+ "messageId": 6,
+ "authorId": 2,
+ "message": " like product-z its platform is mind-blowing"
+ }
+ ],
+ "authorId": 2
+} ]
+</pre></div></div>
+<p>Based on the three variable generation rules, the generated variable for the grouping key expression <tt>message.authorId</tt> is <tt>authorId</tt> (which is how it is referred to in the example’s <tt>SELECT</tt> clause).</p></div></div></div>
+<div class="section">
+<h3><a name="Implicit_Group_Variables"></a><a name="Implicit_group_variables" id="Implicit_group_variables">Implicit Group Variables</a></h3>
+<p>The group variable itself is also optional in SQL++’s <tt>GROUP BY</tt> syntax. If a user’s query does not declare the name and structure of the group variable using <tt>GROUP AS</tt>, the query compiler will generate a unique group variable whose fields include all of the binding variables defined in the <tt>FROM</tt> clause of the current enclosing <tt>SELECT</tt> statement. In this case the user’s query will not be able to refer to the generated group variable, but is able to call SQL-92 aggregation functions as in SQL-92.</p></div>
+<div class="section">
+<h3><a name="Aggregation_Functions"></a><a name="Aggregation_functions" id="Aggregation_functions">Aggregation Functions</a></h3>
+<p>In the traditional SQL, which doesn’t support nested data, grouping always also involves the use of aggregation to compute properties of the groups (for example, the average number of messages per user rather than the actual set of messages per user). Each aggregation function in SQL++ takes a collection (for example, the group of messages) as its input and produces a scalar value as its output. These aggregation functions, being truly functional in nature (unlike in SQL), can be used anywhere in a query where an expression is allowed. The following table catalogs the SQL++ built-in aggregation functions and also indicates how each one handles <tt>NULL</tt>/<tt>MISSING</tt> values in the input collection or a completely empty input collection:</p>
+
+<table border="0" class="table table-striped">
+ <thead>
+
+<tr class="a">
+
+<th>Function </th>
+
+<th>NULL </th>
+
+<th>MISSING </th>
+
+<th>Empty Collection </th>
+ </tr>
+ </thead>
+ <tbody>
+
+<tr class="b">
+
+<td>COLL_COUNT </td>
+
+<td>counted </td>
+
+<td>counted </td>
+
+<td>0 </td>
+ </tr>
+
+<tr class="a">
+
+<td>COLL_SUM </td>
+
+<td>returns NULL </td>
+
+<td>returns NULL </td>
+
+<td>returns NULL </td>
+ </tr>
+
+<tr class="b">
+
+<td>COLL_MAX </td>
+
+<td>returns NULL </td>
+
+<td>returns NULL </td>
+
+<td>returns NULL </td>
+ </tr>
+
+<tr class="a">
+
+<td>COLL_MIN </td>
+
+<td>returns NULL </td>
+
+<td>returns NULL </td>
+
+<td>returns NULL </td>
+ </tr>
+
+<tr class="b">
+
+<td>COLL_AVG </td>
+
+<td>returns NULL </td>
+
+<td>returns NULL </td>
+
+<td>returns NULL </td>
+ </tr>
+
+<tr class="a">
+
+<td>ARRAY_COUNT </td>
+
+<td>not counted </td>
+
+<td>not counted </td>
+
+<td>0 </td>
+ </tr>
+
+<tr class="b">
+
+<td>ARRAY_SUM </td>
+
+<td>ignores NULL </td>
+
+<td>ignores NULL </td>
+
+<td>returns NULL </td>
+ </tr>
+
+<tr class="a">
+
+<td>ARRAY_MAX </td>
+
+<td>ignores NULL </td>
+
+<td>ignores NULL </td>
+
+<td>returns NULL </td>
+ </tr>
+
+<tr class="b">
+
+<td>ARRAY_MIN </td>
+
+<td>ignores NULL </td>
+
+<td>ignores NULL </td>
+
+<td>returns NULL </td>
+ </tr>
+
+<tr class="a">
+
+<td>ARRAY_AVG </td>
+
+<td>ignores NULL </td>
+
+<td>ignores NULL </td>
+
+<td>returns NULL </td>
+ </tr>
+ </tbody>
+</table>
+<p>Notice that SQL++ has twice as many functions listed above as there are aggregate functions in SQL-92. This is because SQL++ offers two versions of each – one that handles <tt>UNKNOWN</tt> values in a semantically strict fashion, where unknown values in the input result in unknown values in the output – and one that handles them in the ad hoc “just ignore the unknown values” fashion that the SQL standard chose to adopt.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>ARRAY_AVG(
+ (
+ SELECT VALUE ARRAY_COUNT(friendIds) FROM GleambookUsers
+ )
+);
+</pre></div></div>
+<p>This example returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>3.3333333333333335
+</pre></div></div></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT uid AS uid, ARRAY_COUNT(grp) AS msgCnt
+FROM GleambookMessages message
+GROUP BY message.authorId AS uid
+GROUP AS grp(message AS msg);
+</pre></div></div>
+<p>This query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "uid": 1,
+ "msgCnt": 5
+}, {
+ "uid": 2,
+ "msgCnt": 2
+} ]
+</pre></div></div>
+<p>Notice how the query forms groups where each group involves a message author and their messages. (SQL cannot do this because the grouped intermediate result is non-1NF in nature.) The query then uses the collection aggregate function ARRAY_COUNT to get the cardinality of each group of messages.</p></div></div></div>
+<div class="section">
+<h3><a name="SQL-92_Aggregation_Functions"></a><a name="SQL-92_aggregation_functions" id="SQL-92_aggregation_functions">SQL-92 Aggregation Functions</a></h3>
+<p>For compatibility with the traditional SQL aggregation functions, SQL++ also offers SQL-92’s aggregation function symbols (<tt>COUNT</tt>, <tt>SUM</tt>, <tt>MAX</tt>, <tt>MIN</tt>, and <tt>AVG</tt>) as supported syntactic sugar. The SQL++ compiler rewrites queries that utilize these function symbols into SQL++ queries that only use the SQL++ collection aggregate functions. The following example uses the SQL-92 syntax approach to compute a result that is identical to that of the more explicit SQL++ example above:</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT uid, COUNT(*) AS msgCnt
+FROM GleambookMessages msg
+GROUP BY msg.authorId AS uid;
+</pre></div></div>
+<p>It is important to realize that <tt>COUNT</tt> is actually <b>not</b> a SQL++ built-in aggregation function. Rather, the <tt>COUNT</tt> query above is using a special “sugared” function symbol that the SQL++ compiler will rewrite as follows:</p>
+
+<div class="source">
+<div class="source">
+<pre>SELECT uid AS uid, ARRAY_COUNT( (SELECT VALUE 1 FROM `$1` as g) ) AS msgCnt
+FROM GleambookMessages msg
+GROUP BY msg.authorId AS uid
+GROUP AS `$1`(msg AS msg);
+</pre></div></div>
+<p>The same sort of rewritings apply to the function symbols <tt>SUM</tt>, <tt>MAX</tt>, <tt>MIN</tt>, and <tt>AVG</tt>. In contrast to the SQL++ collection aggregate functions, these special SQL-92 function symbols can only be used in the same way they are in standard SQL (i.e., with the same restrictions).</p></div></div></div>
+<div class="section">
+<h3><a name="SQL-92_Compliant_GROUP_BY_Aggregations"></a><a name="SQL-92_compliant_gby" id="SQL-92_compliant_gby">SQL-92 Compliant GROUP BY Aggregations</a></h3>
+<p>SQL++ provides full support for SQL-92 <tt>GROUP BY</tt> aggregation queries. The following query is such an example:</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT msg.authorId, COUNT(*)
+FROM GleambookMessages msg
+GROUP BY msg.authorId;
+</pre></div></div>
+<p>This query outputs:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "authorId": 1,
+ "$1": 5
+}, {
+ "authorId": 2,
+ "$1": 2
+} ]
+</pre></div></div>
+<p>In principle, a <tt>msg</tt> reference in the query’s <tt>SELECT</tt> clause would be “sugarized” as a collection (as described in <a href="#Implicit_group_variables">Implicit Group Variables</a>). However, since the SELECT expression <tt>msg.authorId</tt> is syntactically identical to a GROUP BY key expression, it will be internally replaced by the generated group key variable. The following is the equivalent rewritten query that will be generated by the compiler for the query above:</p>
+
+<div class="source">
+<div class="source">
+<pre>SELECT authorId AS authorId, ARRAY_COUNT( (SELECT g.msg FROM `$1` AS g) )
+FROM GleambookMessages msg
+GROUP BY msg.authorId AS authorId
+GROUP AS `$1`(msg AS msg);
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="Column_Aliases"></a><a name="Column_aliases" id="Column_aliases">Column Aliases</a></h3>
+<p>SQL++ also allows column aliases to be used as <tt>GROUP BY</tt> keys or <tt>ORDER BY</tt> keys.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT msg.authorId AS aid, COUNT(*)
+FROM GleambookMessages msg
+GROUP BY aid;
+</pre></div></div>
+<p>This query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "$1": 5,
+ "aid": 1
+}, {
+ "$1": 2,
+ "aid": 2
+} ]
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="WHERE_Clauses_and_HAVING_Clauses"></a><a name="Where_having_clauses" id="Where_having_clauses">WHERE Clauses and HAVING Clauses</a></h2>
+<p>Both <tt>WHERE</tt> clauses and <tt>HAVING</tt> clauses are used to filter input data based on a condition expression. Only tuples for which the condition expression evaluates to <tt>TRUE</tt> are propagated. Note that if the condition expression evaluates to <tt>NULL</tt> or <tt>MISSING</tt> the input tuple will be disgarded.</p></div>
+<div class="section">
+<h2><a name="ORDER_BY_Clauses"></a><a name="Order_By_clauses" id="Order_By_clauses">ORDER BY Clauses</a></h2>
+<p>The <tt>ORDER BY</tt> clause is used to globally sort data in either ascending order (i.e., <tt>ASC</tt>) or descending order (i.e., <tt>DESC</tt>). During ordering, <tt>MISSING</tt> and <tt>NULL</tt> are treated as being smaller than any other value if they are encountered in the ordering key(s). <tt>MISSING</tt> is treated as smaller than <tt>NULL</tt> if both occur in the data being sorted. The following example returns all <tt>GleambookUsers</tt> in descending order by their number of friends.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre> SELECT VALUE user
+ FROM GleambookUsers AS user
+ ORDER BY ARRAY_COUNT(user.friendIds) DESC;
+</pre></div></div>
+<p>This query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre> [ {
+ "userSince": "2012-08-20T10:10:00.000Z",
+ "friendIds": [
+ 2,
+ 3,
+ 6,
+ 10
+ ],
+ "gender": "F",
+ "name": "MargaritaStoddard",
+ "nickname": "Mags",
+ "alias": "Margarita",
+ "id": 1,
+ "employment": [
+ {
+ "organizationName": "Codetechno",
+ "start-date": "2006-08-06"
+ },
+ {
+ "end-date": "2010-01-26",
+ "organizationName": "geomedia",
+ "start-date": "2010-06-17"
+ }
+ ]
+ }, {
+ "userSince": "2012-07-10T10:10:00.000Z",
+ "friendIds": [
+ 1,
+ 5,
+ 8,
+ 9
+ ],
+ "name": "EmoryUnk",
+ "alias": "Emory",
+ "id": 3,
+ "employment": [
+ {
+ "organizationName": "geomedia",
+ "endDate": "2010-01-26",
+ "startDate": "2010-06-17"
+ }
+ ]
+ }, {
+ "userSince": "2011-01-22T10:10:00.000Z",
+ "friendIds": [
+ 1,
+ 4
+ ],
+ "name": "IsbelDull",
+ "nickname": "Izzy",
+ "alias": "Isbel",
+ "id": 2,
+ "employment": [
+ {
+ "organizationName": "Hexviafind",
+ "startDate": "2010-04-27"
+ }
+ ]
+ } ]
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="LIMIT_Clauses"></a><a name="Limit_clauses" id="Limit_clauses">LIMIT Clauses</a></h2>
+<p>The <tt>LIMIT</tt> clause is used to limit the result set to a specified constant size. The use of the <tt>LIMIT</tt> clause is illustrated in the next example.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre> SELECT VALUE user
+ FROM GleambookUsers AS user
+ ORDER BY len(user.friendIds) DESC
+ LIMIT 1;
+</pre></div></div>
+<p>This query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre> [ {
+ "userSince": "2012-08-20T10:10:00.000Z",
+ "friendIds": [
+ 2,
+ 3,
+ 6,
+ 10
+ ],
+ "gender": "F",
+ "name": "MargaritaStoddard",
+ "nickname": "Mags",
+ "alias": "Margarita",
+ "id": 1,
+ "employment": [
+ {
+ "organizationName": "Codetechno",
+ "start-date": "2006-08-06"
+ },
+ {
+ "end-date": "2010-01-26",
+ "organizationName": "geomedia",
+ "start-date": "2010-06-17"
+ }
+ ]
+ } ]
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="WITH_Clauses"></a><a name="With_clauses" id="With_clauses">WITH Clauses</a></h2>
+<p>As in standard SQL, <tt>WITH</tt> clauses are available to improve the modularity of a query. The next query shows an example.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>WITH avgFriendCount AS (
+ SELECT VALUE AVG(ARRAY_COUNT(user.friendIds))
+ FROM GleambookUsers AS user
+)[0]
+SELECT VALUE user
+FROM GleambookUsers user
+WHERE ARRAY_COUNT(user.friendIds) > avgFriendCount;
+</pre></div></div>
+<p>This query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "userSince": "2012-08-20T10:10:00.000Z",
+ "friendIds": [
+ 2,
+ 3,
+ 6,
+ 10
+ ],
+ "gender": "F",
+ "name": "MargaritaStoddard",
+ "nickname": "Mags",
+ "alias": "Margarita",
+ "id": 1,
+ "employment": [
+ {
+ "organizationName": "Codetechno",
+ "start-date": "2006-08-06"
+ },
+ {
+ "end-date": "2010-01-26",
+ "organizationName": "geomedia",
+ "start-date": "2010-06-17"
+ }
+ ]
+}, {
+ "userSince": "2012-07-10T10:10:00.000Z",
+ "friendIds": [
+ 1,
+ 5,
+ 8,
+ 9
+ ],
+ "name": "EmoryUnk",
+ "alias": "Emory",
+ "id": 3,
+ "employment": [
+ {
+ "organizationName": "geomedia",
+ "endDate": "2010-01-26",
+ "startDate": "2010-06-17"
+ }
+ ]
+} ]
+</pre></div></div>
+<p>The query is equivalent to the following, more complex, inlined form of the query:</p>
+
+<div class="source">
+<div class="source">
+<pre>SELECT *
+FROM GleambookUsers user
+WHERE ARRAY_COUNT(user.friendIds) >
+ ( SELECT VALUE AVG(ARRAY_COUNT(user.friendIds))
+ FROM GleambookUsers AS user
+ ) [0];
+</pre></div></div>
+<p>WITH can be particularly useful when a value needs to be used several times in a query.</p>
+<p>Before proceeding further, notice that both the WITH query and its equivalent inlined variant include the syntax “[0]” – this is due to a noteworthy difference between SQL++ and SQL-92. In SQL-92, whenever a scalar value is expected and it is being produced by a query expression, the SQL-92 query processor will evaluate the expression, check that there is only one row and column in the result at runtime, and then coerce the one-row/one-column tabular result into a scalar value. SQL++, being designed to deal with nested data and schema-less data, does not (and should not) do this. Collection-valued data is perfectly legal in most SQL++ contexts, and its data is schema-less, so a query processor rarely knows exactly what to expect where and such automatic conversion is often not desirable. Thus, in the queries above, the use of “[0]” extracts the first (i.e., 0th) element of an array-valued query expression’s result; this is needed above, even though the result is an array of one element, to extract the only element in the singleton array and obtain the desired scalar for the comparison.</p></div></div></div></div>
+<div class="section">
+<h2><a name="LET_Clauses"></a><a name="Let_clauses" id="Let_clauses">LET Clauses</a></h2>
+<p>Similar to <tt>WITH</tt> clauses, <tt>LET</tt> clauses can be useful when a (complex) expression is used several times within a query, allowing it to be written once to make the query more concise. The next query shows an example.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT u.name AS uname, messages AS messages
+FROM GleambookUsers u
+LET messages = (SELECT VALUE m
+ FROM GleambookMessages m
+ WHERE m.authorId = u.id)
+WHERE EXISTS messages;
+</pre></div></div>
+<p>This query lists <tt>GleambookUsers</tt> that have posted <tt>GleambookMessages</tt> and shows all authored messages for each listed user. It returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "uname": "MargaritaStoddard",
+ "messages": [
+ {
+ "senderLocation": [
+ 38.97,
+ 77.49
+ ],
+ "inResponseTo": 1,
+ "messageId": 11,
+ "authorId": 1,
+ "message": " can't stand acast its plan is terrible"
+ },
+ {
+ "senderLocation": [
+ 41.66,
+ 80.87
+ ],
+ "inResponseTo": 4,
+ "messageId": 2,
+ "authorId": 1,
+ "message": " dislike x-phone its touch-screen is horrible"
+ },
+ {
+ "senderLocation": [
+ 37.73,
+ 97.04
+ ],
+ "inResponseTo": 2,
+ "messageId": 4,
+ "authorId": 1,
+ "message": " can't stand acast the network is horrible:("
+ },
+ {
+ "senderLocation": [
+ 40.33,
+ 80.87
+ ],
+ "inResponseTo": 11,
+ "messageId": 8,
+ "authorId": 1,
+ "message": " like ccast the 3G is awesome:)"
+ },
+ {
+ "senderLocation": [
+ 42.5,
+ 70.01
+ ],
+ "inResponseTo": 12,
+ "messageId": 10,
+ "authorId": 1,
+ "message": " can't stand product-w the touch-screen is terrible"
+ }
+ ]
+}, {
+ "uname": "IsbelDull",
+ "messages": [
+ {
+ "senderLocation": [
+ 31.5,
+ 75.56
+ ],
+ "inResponseTo": 1,
+ "messageId": 6,
+ "authorId": 2,
+ "message": " like product-z its platform is mind-blowing"
+ },
+ {
+ "senderLocation": [
+ 48.09,
+ 81.01
+ ],
+ "inResponseTo": 4,
+ "messageId": 3,
+ "authorId": 2,
+ "message": " like product-y the plan is amazing"
+ }
+ ]
+} ]
+</pre></div></div>
+<p>This query is equivalent to the following query that does not use the <tt>LET</tt> clause:</p>
+
+<div class="source">
+<div class="source">
+<pre>SELECT u.name AS uname, ( SELECT VALUE m
+ FROM GleambookMessages m
+ WHERE m.authorId = u.id
+ ) AS messages
+FROM GleambookUsers u
+WHERE EXISTS ( SELECT VALUE m
+ FROM GleambookMessages m
+ WHERE m.authorId = u.id
+ );
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="UNION_ALL"></a><a name="Union_all" id="Union_all">UNION ALL</a></h2>
+<p>UNION ALL can be used to combine two input arrays or multisets into one. As in SQL, there is no ordering guarantee on the contents of the output stream. However, unlike SQL, SQL++ does not constrain what the data looks like on the input streams; in particular, it allows heterogenity on the input and output streams. A type error will be raised if one of the inputs is not a collection. The following odd but legal query is an example:</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT u.name AS uname
+FROM GleambookUsers u
+WHERE u.id = 2
+ UNION ALL
+SELECT VALUE m.message
+FROM GleambookMessages m
+WHERE authorId=2;
+</pre></div></div>
+<p>This query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[
+ " like product-z its platform is mind-blowing"
+ , {
+ "uname": "IsbelDull"
+}, " like product-y the plan is amazing"
+ ]
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="Subqueries" id="Subqueries">Subqueries</a></h2>
+<p>In SQL++, an arbitrary subquery can appear anywhere that an expression can appear. Unlike SQL-92, as was just alluded to, the subqueries in a SELECT list or a boolean predicate need not return singleton, single-column relations. Instead, they may return arbitrary collections. For example, the following query is a variant of the prior group-by query examples; it retrieves an array of up to two “dislike” messages per user.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT uid,
+ (SELECT VALUE m.msg
+ FROM msgs m
+ WHERE m.msg.message LIKE '%dislike%'
+ ORDER BY m.msg.messageId
+ LIMIT 2) AS msgs
+FROM GleambookMessages message
+GROUP BY message.authorId AS uid GROUP AS msgs(message AS msg);
+</pre></div></div>
+<p>For our sample data set, this query returns:</p>
+
+<div class="source">
+<div class="source">
+<pre>[ {
+ "msgs": [
+ {
+ "senderLocation": [
+ 41.66,
+ 80.87
+ ],
+ "inResponseTo": 4,
+ "messageId": 2,
+ "authorId": 1,
+ "message": " dislike x-phone its touch-screen is horrible"
+ }
+ ],
+ "uid": 1
+}, {
+ "msgs": [
+
+ ],
+ "uid": 2
+} ]
+</pre></div></div>
+<p>Note that a subquery, like a top-level <tt>SELECT</tt> statment, always returns a collection – regardless of where within a query the subquery occurs – and again, its result is never automatically cast into a scalar.</p></div></div></div></div>
+<div class="section">
+<h2><a name="SQL_vs._SQL-92"></a><a name="Vs_SQL-92" id="Vs_SQL-92">SQL++ vs. SQL-92</a></h2>
+<p>SQL++ offers the following additional features beyond SQL-92 (hence the “++” in its name):</p>
+
+<ul>
+
+<li>Fully composable and functional: A subquery can iterate over any intermediate collection and can appear anywhere in a query.</li>
+
+<li>Schema-free: The query language does not assume the existence of a static schema for any data that it processes.</li>
+
+<li>Correlated FROM terms: A right-side FROM term expression can refer to variables defined by FROM terms on its left.</li>
+
+<li>Powerful GROUP BY: In addition to a set of aggregate functions as in standard SQL, the groups created by the <tt>GROUP BY</tt> clause are directly usable in nested queries and/or to obtain nested results.</li>
+
+<li>Generalized SELECT clause: A SELECT clause can return any type of collection, while in SQL-92, a <tt>SELECT</tt> clause has to return a (homogeneous) collection of objects.</li>
+</ul>
+<p>The following matrix is a quick “SQL-92 compatibility cheat sheet” for SQL++.</p>
+
+<table border="0" class="table table-striped">
+ <thead>
+
+<tr class="a">
+
+<th>Feature </th>
+
+<th>SQL++ </th>
+
+<th>SQL-92 </th>
+
+<th>Why different? </th>
+ </tr>
+ </thead>
+ <tbody>
+
+<tr class="b">
+
+<td>SELECT * </td>
+
+<td>Returns nested objects </td>
+
+<td>Returns flattened concatenated objects </td>
+
+<td>Nested collections are 1st class citizens </td>
+ </tr>
+
+<tr class="a">
+
+<td>SELECT list </td>
+
+<td>order not preserved </td>
+
+<td>order preserved </td>
+
+<td>Fields in a JSON object is not ordered </td>
+ </tr>
+
+<tr class="b">
+
+<td>Subquery </td>
+
+<td>Returns a collection </td>
+
+<td>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 </td>
+
+<td>Nested collections are 1st class citizens </td>
+ </tr>
+
+<tr class="a">
+
+<td>LEFT OUTER JOIN </td>
+
+<td>Fills in <tt>MISSING</tt>(s) for non-matches </td>
+
+<td>Fills in <tt>NULL</tt>(s) for non-matches </td>
+
+<td>“Absence” is more appropriate than “unknown” here. </td>
+ </tr>
+
+<tr class="b">
+
+<td>UNION ALL </td>
+
+<td>Allows heterogeneous inputs and output </td>
+
+<td>Input streams must be UNION-compatible and output field names are drawn from the first input stream </td>
+
+<td>Heterogenity and nested collections are common </td>
+ </tr>
+
+<tr class="a">
+
+<td>IN constant_expr </td>
+
+<td>The constant expression has to be an array or multiset, i.e., [..,..,…] </td>
+
+<td>The constant collection can be represented as comma-separated items in a paren pair </td>
+
+<td>Nested collections are 1st class citizens </td>
+ </tr>
+
+<tr class="b">
+
+<td>String literal </td>
+
+<td>Double quotes or single quotes </td>
+
+<td>Single quotes only </td>
+
+<td>Double quoted strings are pervasive </td>
+ </tr>
+
+<tr class="a">
+
+<td>Delimited identifiers </td>
+
+<td>Backticks </td>
+
+<td>Double quotes </td>
+
+<td>Double quoted strings are pervasive </td>
+ </tr>
+ </tbody>
+</table>
+<p>The following SQL-92 features are not implemented yet. However, SQL++ does not conflict those features:</p>
+
+<ul>
+
+<li>CROSS JOIN, NATURAL JOIN, UNION JOIN</li>
+
+<li>RIGHT and FULL OUTER JOIN</li>
+
+<li>INTERSECT, EXCEPT, UNION with set semantics</li>
+
+<li>CAST expression</li>
+
+<li>NULLIF expression</li>
+
+<li>COALESCE expression</li>
+
+<li>ALL and SOME predicates for linking to subqueries</li>
+
+<li>UNIQUE predicate (tests a collection for duplicates)</li>
+
+<li>MATCH predicate (tests for referential integrity)</li>
+
+<li>Row and Table constructors</li>
+
+<li>DISTINCT aggregates</li>
+
+<li>Preserved order for expressions in a SELECT list</li>
+</ul>
+<!-- ! 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.
+ ! -->
+<h1><a name="Errors" id="Errors">4. Errors</a></h1>
+<!-- ! 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.
+ ! -->
+<p>A SQL++ query can potentially result in one of the following errors:</p>
+
+<ul>
+
+<li>syntax error,</li>
+
+<li>identifier resolution error,</li>
+
+<li>type error,</li>
+
+<li>resource error.</li>
+</ul>
+<p>If the query processor runs into any error, it will terminate the ongoing processing of the query and immediately return an error message to the client.</p></div>
+<div class="section">
+<h2><a name="Syntax_Errors"></a><a name="Syntax_errors" id="Syntax_errors">Syntax Errors</a></h2>
+<p>An valid SQL++ query must satisfy the SQL++ grammar rules. Otherwise, a syntax error will be raised.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT *
+GleambookUsers user
+</pre></div></div>
+<p>Since the query misses a <tt>FROM</tt> keyword before the dataset <tt>GleambookUsers</tt>, we will get a syntax error as follows:</p>
+
+<div class="source">
+<div class="source">
+<pre>Syntax error: In line 2 >>GleambookUsers user;<< Encountered <IDENTIFIER> \"GleambookUsers\" at column 1.
+</pre></div></div></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT *
+FROM GleambookUsers user
+WHERE type="advertiser";
+</pre></div></div>
+<p>Since “type” is a reserved keyword in the SQL++ parser, we will get a syntax error as follows:</p>
+
+<div class="source">
+<div class="source">
+<pre>Error: Syntax error: In line 3 >>WHERE type="advertiser";<< Encountered 'type' "type" at column 7.
+==> WHERE type="advertiser";
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="Identifier_Resolution_Errors"></a><a name="Identifier_resolution_errors" id="Identifier_resolution_errors">Identifier Resolution Errors</a></h2>
+<p>Referring an undefined identifier can cause an error if the identifier cannot be successfully resolved as a valid field access.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT *
+FROM GleambookUser user;
+</pre></div></div>
+<p>Assume we have a typo in “GleambookUser” which misses the ending “s”, we will get an identifier resolution error as follows:</p>
+
+<div class="source">
+<div class="source">
+<pre>Error: Cannot find dataset GleambookUser in dataverse Default nor an alias with name GleambookUser!
+</pre></div></div></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SELECT name, message
+FROM GleambookUsers u JOIN GleambookMessages m ON m.authorId = u.id;
+</pre></div></div>
+<p>If the compiler cannot figure out all possible fields in <tt>GleambookUsers</tt> and <tt>GleambookMessages</tt>, we will get an identifier resolution error as follows:</p>
+
+<div class="source">
+<div class="source">
+<pre>Error: Cannot resolve ambiguous alias reference for undefined identifier name
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="Type_Errors"></a><a name="Type_errors" id="Type_errors">Type Errors</a></h2>
+<p>The SQL++ compiler does type checks based on its available type information. In addition, the SQL++ runtime also reports type errors if a data model instance it processes does not satisfy the type requirement.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>abs("123");
+</pre></div></div>
+<p>Since function <tt>abs</tt> can only process numeric input values, we will get a type error as follows:</p>
+
+<div class="source">
+<div class="source">
+<pre>Error: Arithmetic operations are not implemented for string
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="Resource_Errors"></a><a name="Resource_errors" id="Resource_errors">Resource Errors</a></h2>
+<p>A query can potentially exhaust system resources, such as the number of open files and disk spaces. For instance, the following two resource errors could be potentially be seen when running the system:</p>
+
+<div class="source">
+<div class="source">
+<pre>Error: no space left on device
+Error: too many open files
+</pre></div></div>
+<p>The “no space left on device” issue usually can be fixed by cleaning up disk spaces and reserving more disk spaces for the system. The “too many open files” issue usually can be fixed by a system administrator, following the instructions <a class="externalLink" href="https://easyengine.io/tutorials/linux/increase-open-files-limit/">here</a>.</p>
+<!-- ! 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.
+ ! -->
+<h1><a name="DDL_and_DML_statements" id="DDL_and_DML_statements">5. DDL and DML statements</a></h1>
+
+<div class="source">
+<div class="source">
+<pre>Statement ::= ( SingleStatement ( ";" )? )* <EOF>
+SingleStatement ::= DatabaseDeclaration
+ | FunctionDeclaration
+ | CreateStatement
+ | DropStatement
+ | LoadStatement
+ | SetStatement
+ | InsertStatement
+ | DeleteStatement
+ | Query ";"
+</pre></div></div>
+<p>In addition to queries, an implementation of SQL++ needs to support statements for data definition and manipulation purposes as well as controlling the context to be used in evaluating SQL++ expressions. This section details the DDL and DML statements supported in the SQL++ language as realized today in Apache AsterixDB.</p>
+<!-- ! 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.
+ ! --></div>
+<div class="section">
+<h2><a name="Lifecycle_Management_Statements"></a><a name="Lifecycle_management_statements" id="Lifecycle_management_statements">Lifecycle Management Statements</a></h2>
+
+<div class="source">
+<div class="source">
+<pre>CreateStatement ::= "CREATE" ( DatabaseSpecification
+ | TypeSpecification
+ | DatasetSpecification
+ | IndexSpecification
+ | FunctionSpecification )
+
+QualifiedName ::= Identifier ( "." Identifier )?
+DoubleQualifiedName ::= Identifier "." Identifier ( "." Identifier )?
+</pre></div></div>
+<p>The CREATE statement in SQL++ is used for creating dataverses as well as other persistent artifacts in a dataverse. It can be used to create new dataverses, datatypes, datasets, indexes, and user-defined SQL++ functions.</p>
+<div class="section">
+<h3><a name="Dataverses" id="Dataverses"> Dataverses</a></h3>
+
+<div class="source">
+<div class="source">
+<pre>DatabaseSpecification ::= "DATAVERSE" Identifier IfNotExists
+</pre></div></div>
+<p>The CREATE DATAVERSE statement is used to create new dataverses. To ease the authoring of reusable SQL++ scripts, an optional IF NOT EXISTS clause is included to allow creation to be requested either unconditionally or only if the dataverse does not already exist. If this clause is absent, an error is returned if a dataverse with the indicated name already exists.</p>
+<p>The following example creates a new dataverse named TinySocial if one does not already exist.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>CREATE DATAVERSE TinySocial IF NOT EXISTS;
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="Types" id="Types"> Types</a></h3>
+
+<div class="source">
+<div class="source">
+<pre>TypeSpecification ::= "TYPE" FunctionOrTypeName IfNotExists "AS" ObjectTypeDef
+FunctionOrTypeName ::= QualifiedName
+IfNotExists ::= ( <IF> <NOT> <EXISTS> )?
+TypeExpr ::= ObjectTypeDef | TypeReference | ArrayTypeDef | MultisetTypeDef
+ObjectTypeDef ::= ( <CLOSED> | <OPEN> )? "{" ( ObjectField ( "," ObjectField )* )? "}"
+ObjectField ::= Identifier ":" ( TypeExpr ) ( "?" )?
+NestedField ::= Identifier ( "." Identifier )*
+IndexField ::= NestedField ( ":" TypeReference )?
+TypeReference ::= Identifier
+ArrayTypeDef ::= "[" ( TypeExpr ) "]"
+MultisetTypeDef ::= "{{" ( TypeExpr ) "}}"
+</pre></div></div>
+<p>The CREATE TYPE statement is used to create a new named datatype. This type can then be used to create stored collections or utilized when defining one or more other datatypes. Much more information about the data model is available in the <a href="../datamodel.html">data model reference guide</a>. A new type can be a object type, a renaming of another type, an array type, or a multiset type. A object type can be defined as being either open or closed. Instances of a closed object type are not permitted to contain fields other than those specified in the create type statement. Instances of an open object type may carry additional fields, and open is the default for new types if neither option is specified.</p>
+<p>The following example creates a new object type called GleambookUser type. Since it is defined as (defaulting to) being an open type, instances will be permitted to contain more than what is specified in the type definition. The first four fields are essentially traditional typed name/value pairs (much like SQL fields). The friendIds field is a multiset of integers. The employment field is an array of instances of another named object type, EmploymentType.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>CREATE TYPE GleambookUserType AS {
+ id: int,
+ alias: string,
+ name: string,
+ userSince: datetime,
+ friendIds: {{ int }},
+ employment: [ EmploymentType ]
+};
+</pre></div></div>
+<p>The next example creates a new object type, closed this time, called MyUserTupleType. Instances of this closed type will not be permitted to have extra fields, although the alias field is marked as optional and may thus be NULL or MISSING in legal instances of the type. Note that the type of the id field in the example is UUID. This field type can be used if you want to have this field be an autogenerated-PK field. (Refer to the Datasets section later for more details on such fields.)</p></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>CREATE TYPE MyUserTupleType AS CLOSED {
+ id: uuid,
+ alias: string?,
+ name: string
+};
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="Datasets" id="Datasets"> Datasets</a></h3>
+
+<div class="source">
+<div class="source">
+<pre>DatasetSpecification ::= ( <INTERNAL> )? <DATASET> QualifiedName "(" QualifiedName ")" IfNotExists
+ PrimaryKey ( <ON> Identifier )? ( <HINTS> Properties )?
+ ( "USING" "COMPACTION" "POLICY" CompactionPolicy ( Configuration )? )?
+ ( <WITH> <FILTER> <ON> Identifier )?
+ |
+ <EXTERNAL> <DATASET> QualifiedName "(" QualifiedName ")" IfNotExists <USING> AdapterName
+ Configuration ( <HINTS> Properties )?
+ ( <USING> <COMPACTION> <POLICY> CompactionPolicy ( Configuration )? )?
+AdapterName ::= Identifier
+Configuration ::= "(" ( KeyValuePair ( "," KeyValuePair )* )? ")"
+KeyValuePair ::= "(" StringLiteral "=" StringLiteral ")"
+Properties ::= ( "(" Property ( "," Property )* ")" )?
+Property ::= Identifier "=" ( StringLiteral | IntegerLiteral )
+FunctionSignature ::= FunctionOrTypeName "@" IntegerLiteral
+PrimaryKey ::= <PRIMARY> <KEY> NestedField ( "," NestedField )* ( <AUTOGENERATED> )?
+CompactionPolicy ::= Identifier
+</pre></div></div>
+<p>The CREATE DATASET statement is used to create a new dataset. Datasets are named, multisets of object type instances; they are where data lives persistently and are the usual targets for SQL++ queries. Datasets are typed, and the system ensures that their contents conform to their type definitions. An Internal dataset (the default kind) is a dataset whose content lives within and is managed by the system. It is required to have a specified unique primary key field which uniquely identifies the contained objects. (The primary key is also used in secondary indexes to identify the indexed primary data objects.)</p>
+<p>Internal datasets contain several advanced options that can be specified when appropriate. One such option is that random primary key (UUID) values can be auto-generated by declaring the field to be UUID and putting “AUTOGENERATED” after the “PRIMARY KEY” identifier. In this case, unlike other non-optional fields, a value for the auto-generated PK field should not be provided at insertion time by the user since each object’s primary key field value will be auto-generated by the system.</p>
+<p>Another advanced option, when creating an Internal dataset, is to specify the merge policy to control which of the underlying LSM storage components to be merged. (The system supports Log-Structured Merge tree based physical storage for Internal datasets.) Currently the system supports four different component merging policies that can be chosen per dataset: no-merge, constant, prefix, and correlated-prefix. The no-merge policy simply never merges disk components. The constant policy merges disk components when the number of components reaches a constant number k that can be configured by the user. The prefix policy relies on both component sizes and the number of components to decide which components to merge. It works by first trying to identify the smallest ordered (oldest to newest) sequence of components such that the sequence does not contain a single component that exceeds some threshold size M and that either the sum of the component’s sizes exceeds M or the number of components in the sequence exceeds another threshold C. If such a sequence exists, the components in the sequence are merged together to form a single component. Finally, the correlated-prefix policy is similar to the prefix policy, but it delegates the decision of merging the disk components of all the indexes in a dataset to the primary index. When the correlated-prefix policy decides that the primary index needs to be merged (using the same decision criteria as for the prefix policy), then it will issue successive merge requests on behalf of all other indexes associated with the same dataset. The system’s default policy is the prefix policy except when there is a filter on a dataset, where the preferred policy for filters is the correlated-prefix.</p>
+<p>Another advanced option shown in the syntax above, related to performance and mentioned above, is that a <b>filter</b> can optionally be created on a field to further optimize range queries with predicates on the filter’s field. Filters allow some range queries to avoid searching all LSM components when the query conditions match the filter. (Refer to <a href="../filters.html">Filter-Based LSM Index Acceleration</a> for more information about filters.)</p>
+<p>An External dataset, in contrast to an Internal dataset, has data stored outside of the system’s control. Files living in HDFS or in the local filesystem(s) of a cluster’s nodes are currently supported. External dataset support allows SQL++ queries to treat foreign data as though it were stored in the system, making it possible to query “legacy” file data (for example, Hive data) without having to physically import it. When defining an External dataset, an appropriate adapter type must be selected for the desired external data. (See the <a href="../externaldata.html">Guide to External Data</a> for more information on the available adapters.)</p>
+<p>The following example creates an Internal dataset for storing FacefookUserType objects. It specifies that their id field is their primary key.</p>
+<div class="section">
+<h4><a name="Example"></a>Example</h4>
+
+<div class="source">
+<div class="source">
+<pre>CREATE INTERNAL DATASET GleambookUsers(GleambookUserType) PRIMARY KEY id;
+</pre></div></div>
+<p>The next example creates another Internal dataset (the default kind when no dataset kind is specified) for storing MyUserTupleType objects. It specifies that the id field should be used as the primary key for the dataset. It also specifies that the id field is an auto-generated field, meaning that a randomly generated UUID value should be assigned to each incoming object by the system. (A user should therefore not attempt to provide a value for this field.) Note that the id field’s declared type must be UUID in this case.</p></div>
+<div class="section">
+<h4><a name="Example"></a>Example</h4>
+
+<div class="source">
+<div class="source">
+<pre>CREATE DATASET MyUsers(MyUserTupleType) PRIMARY KEY id AUTOGENERATED;
+</pre></div></div>
+<p>The next example creates an External dataset for querying LineItemType objects. The choice of the <tt>hdfs</tt> adapter means that this dataset’s data actually resides in HDFS. The example CREATE statement also provides parameters used by the hdfs adapter: the URL and path needed to locate the data in HDFS and a description of the data format.</p></div>
+<div class="section">
+<h4><a name="Example"></a>Example</h4>
+
+<div class="source">
+<div class="source">
+<pre>CREATE EXTERNAL DATASET LineItem(LineItemType) USING hdfs (
+ ("hdfs"="hdfs://HOST:PORT"),
+ ("path"="HDFS_PATH"),
+ ("input-format"="text-input-format"),
+ ("format"="delimited-text"),
+ ("delimiter"="|"));
+</pre></div></div></div></div>
+<div class="section">
+<h3><a name="Indices" id="Indices">Indices</a></h3>
+
+<div class="source">
+<div class="source">
+<pre>IndexSpecification ::= <INDEX> Identifier IfNotExists <ON> QualifiedName
+ "(" ( IndexField ) ( "," IndexField )* ")" ( "type" IndexType "?")?
+ ( (<NOT>)? <ENFORCED> )?
+IndexType ::= <BTREE> | <RTREE> | <KEYWORD> | <NGRAM> "(" IntegerLiteral ")"
+</pre></div></div>
+<p>The CREATE INDEX statement creates a secondary index on one or more fields of a specified dataset. Supported index types include <tt>BTREE</tt> for totally ordered datatypes, <tt>RTREE</tt> for spatial data, and <tt>KEYWORD</tt> and <tt>NGRAM</tt> for textual (string) data. An index can be created on a nested field (or fields) by providing a valid path expression as an index field identifier.</p>
+<p>An indexed field is not required to be part of the datatype associated with a dataset if the dataset’s datatype is declared as open <b>and</b> if the field’s type is provided along with its name and if the <tt>ENFORCED</tt> keyword is specified at the end of the index definition. <tt>ENFORCING</tt> an open field introduces a check that makes sure that the actual type of the indexed field (if the optional field exists in the object) always matches this specified (open) field type.</p>
+<p>The following example creates a btree index called gbAuthorIdx on the authorId field of the GleambookMessages dataset. This index can be useful for accelerating exact-match queries, range search queries, and joins involving the author-id field.</p>
+<div class="section">
+<h4><a name="Example"></a>Example</h4>
+
+<div class="source">
+<div class="source">
+<pre>CREATE INDEX gbAuthorIdx ON GleambookMessages(authorId) TYPE BTREE;
+</pre></div></div>
+<p>The following example creates an open btree index called gbSendTimeIdx on the (non-predeclared) sendTime field of the GleambookMessages dataset having datetime type. This index can be useful for accelerating exact-match queries, range search queries, and joins involving the sendTime field. The index is enforced so that records that do not have the “sendTime” field or have a mismatched type on the field cannot be inserted into the dataset.</p></div>
+<div class="section">
+<h4><a name="Example"></a>Example</h4>
+
+<div class="source">
+<div class="source">
+<pre>CREATE INDEX gbSendTimeIdx ON GleambookMessages(sendTime: datetime?) TYPE BTREE ENFORCED;
+</pre></div></div>
+<p>The following example creates a btree index called crpUserScrNameIdx on screenName, a nested field residing within a object-valued user field in the ChirpMessages dataset. This index can be useful for accelerating exact-match queries, range search queries, and joins involving the nested screenName field. Such nested fields must be singular, i.e., one cannot index through (or on) an array-valued field.</p></div>
+<div class="section">
+<h4><a name="Example"></a>Example</h4>
+
+<div class="source">
+<div class="source">
+<pre>CREATE INDEX crpUserScrNameIdx ON ChirpMessages(user.screenName) TYPE BTREE;
+</pre></div></div>
+<p>The following example creates an rtree index called gbSenderLocIdx on the sender-location field of the GleambookMessages dataset. This index can be useful for accelerating queries that use the <a href="functions.html#spatial-intersect"><tt>spatial-intersect</tt> function</a> in a predicate involving the sender-location field.</p></div>
+<div class="section">
+<h4><a name="Example"></a>Example</h4>
+
+<div class="source">
+<div class="source">
+<pre>CREATE INDEX gbSenderLocIndex ON GleambookMessages("sender-location") TYPE RTREE;
+</pre></div></div>
+<p>The following example creates a 3-gram index called fbUserIdx on the name field of the GleambookUsers dataset. This index can be used to accelerate some similarity or substring maching queries on the name field. For details refer to the document on <a href="similarity.html#NGram_Index">similarity queries</a>.</p></div>
+<div class="section">
+<h4><a name="Example"></a>Example</h4>
+
+<div class="source">
+<div class="source">
+<pre>CREATE INDEX fbUserIdx ON GleambookUsers(name) TYPE NGRAM(3);
+</pre></div></div>
+<p>The following example creates a keyword index called fbMessageIdx on the message field of the GleambookMessages dataset. This keyword index can be used to optimize queries with token-based similarity predicates on the message field. For details refer to the document on <a href="similarity.html#Keyword_Index">similarity queries</a>.</p></div>
+<div class="section">
+<h4><a name="Example"></a>Example</h4>
+
+<div class="source">
+<div class="source">
+<pre>CREATE INDEX fbMessageIdx ON GleambookMessages(message) TYPE KEYWORD;
+</pre></div></div>
+<!-- ! 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.
+ ! -->
+<p>The following example creates an open btree index called gbReadTimeIdx on the (non-predeclared) readTime field of the GleambookMessages dataset having datetime type. This index can be useful for accelerating exact-match queries, range search queries, and joins involving the <tt>readTime</tt> field. The index is not enforced so that records that do not have the <tt>readTime</tt> field or have a mismatched type on the field can still be inserted into the dataset.</p></div>
+<div class="section">
+<h4><a name="Example"></a>Example</h4>
+
+<div class="source">
+<div class="source">
+<pre>CREATE INDEX gbReadTimeIdx ON GleambookMessages(readTime: datetime?);
+</pre></div></div>
+<!-- ! 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.
+ ! --></div></div>
+<div class="section">
+<h3><a name="Functions" id="Functions"> Functions</a></h3>
+<p>The create function statement creates a <b>named</b> function that can then be used and reused in SQL++ queries. The body of a function can be any SQL++ expression involving the function’s parameters.</p>
+
+<div class="source">
+<div class="source">
+<pre>FunctionSpecification ::= "FUNCTION" FunctionOrTypeName IfNotExists ParameterList "{" Expression "}"
+</pre></div></div>
+<p>The following is an example of a CREATE FUNCTION statement which is similar to our earlier DECLARE FUNCTION example. It differs from that example in that it results in a function that is persistently registered by name in the specified dataverse (the current dataverse being used, if not otherwise specified).</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>CREATE FUNCTION friendInfo(userId) {
+ (SELECT u.id, u.name, len(u.friendIds) AS friendCount
+ FROM GleambookUsers u
+ WHERE u.id = userId)[0]
+ };
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="Removal" id="Removal"> Removal</a></h3>
+
+<div class="source">
+<div class="source">
+<pre>DropStatement ::= "DROP" ( "DATAVERSE" Identifier IfExists
+ | "TYPE" FunctionOrTypeName IfExists
+ | "DATASET" QualifiedName IfExists
+ | "INDEX" DoubleQualifiedName IfExists
+ | "FUNCTION" FunctionSignature IfExists )
+IfExists ::= ( "IF" "EXISTS" )?
+</pre></div></div>
+<p>The DROP statement in SQL++ is the inverse of the CREATE statement. It can be used to drop dataverses, datatypes, datasets, indexes, and functions.</p>
+<p>The following examples illustrate some uses of the DROP statement.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>DROP DATASET GleambookUsers IF EXISTS;
+
+DROP INDEX GleambookMessages.gbSenderLocIndex;
+
+DROP TYPE TinySocial2.GleambookUserType;
+
+DROP FUNCTION friendInfo@1;
+
+DROP DATAVERSE TinySocial;
+</pre></div></div>
+<p>When an artifact is dropped, it will be droppped from the current dataverse if none is specified (see the DROP DATASET example above) or from the specified dataverse (see the DROP TYPE example above) if one is specified by fully qualifying the artifact name in the DROP statement. When specifying an index to drop, the index name must be qualified by the dataset that it indexes. When specifying a function to drop, since SQL++ allows functions to be overloaded by their number of arguments, the identifying name of the function to be dropped must explicitly include that information. (<tt>friendInfo@1</tt> above denotes the 1-argument function named friendInfo in the current dataverse.)</p></div></div></div>
+<div class="section">
+<h3><a name="Load_Statement"></a><a name="Load_statement" id="Load_statement">Load Statement</a></h3>
+
+<div class="source">
+<div class="source">
+<pre>LoadStatement ::= <LOAD> <DATASET> QualifiedName <USING> AdapterName Configuration ( <PRE-SORTED> )?
+</pre></div></div>
+<p>The LOAD statement is used to initially populate a dataset via bulk loading of data from an external file. An appropriate adapter must be selected to handle the nature of the desired external data. The LOAD statement accepts the same adapters and the same parameters as discussed earlier for External datasets. (See the <a href="externaldata.html">guide to external data</a> for more information on the available adapters.) If a dataset has an auto-generated primary key field, the file to be imported should not include that field in it.</p>
+<p>The following example shows how to bulk load the GleambookUsers dataset from an external file containing data that has been prepared in ADM (Asterix Data Model) format.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre> LOAD DATASET GleambookUsers USING localfs
+ (("path"="127.0.0.1:///Users/bignosqlfan/tinysocialnew/gbu.adm"),("format"="adm"));
+</pre></div></div>
+<!-- ! 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.
+ ! --></div></div></div></div>
+<div class="section">
+<h2><a name="Modification_statements" id="Modification_statements">Modification statements</a></h2>
+<div class="section">
+<h3><a name="INSERTs"></a><a name="Inserts" id="Inserts">INSERTs</a></h3>
+
+<div class="source">
+<div class="source">
+<pre>InsertStatement ::= <INSERT> <INTO> QualifiedName Query
+</pre></div></div>
+<p>The SQL++ INSERT statement is used to insert new data into a dataset. The data to be inserted comes from a SQL++ query expression. This expression can be as simple as a constant expression, or in general it can be any legal SQL++ query. If the target dataset has an auto-generated primary key field, the insert statement should not include a value for that field in it. (The system will automatically extend the provided object with this additional field and a corresponding value.) Insertion will fail if the dataset already has data with the primary key value(s) being inserted.</p>
+<p>Inserts are processed transactionally by the system. The transactional scope of each insert transaction is the insertion of a single object plus its affiliated secondary index entries (if any). If the query part of an insert returns a single object, then the INSERT statement will be a single, atomic transaction. If the query part returns multiple objects, each object being inserted will be treated as a separate tranaction. The following example illustrates a query-based insertion.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>INSERT INTO UsersCopy (SELECT VALUE user FROM GleambookUsers user)
+</pre></div></div></div></div></div>
+<div class="section">
+<h3><a name="UPSERTs"></a><a name="Upserts" id="Upserts">UPSERTs</a></h3>
+
+<div class="source">
+<div class="source">
+<pre>UpsertStatement ::= <UPSERT> <INTO> QualifiedName Query
+</pre></div></div>
+<p>The SQL++ UPSERT statement syntactically mirrors the INSERT statement discussed above. The difference lies in its semantics, which for UPSERT are “add or replace” instead of the INSERT “add if not present, else error” semantics. Whereas an INSERT can fail if another object already exists with the specified key, the analogous UPSERT will replace the previous object’s value with that of the new object in such cases.</p>
+<p>The following example illustrates a query-based upsert operation.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>UPSERT INTO UsersCopy (SELECT VALUE user FROM GleambookUsers user)
+</pre></div></div>
+<p>*Editor’s note: Upserts currently work in AQL but are not yet enabled (at the moment) in SQL++.</p></div></div></div>
+<div class="section">
+<h3><a name="DELETEs"></a><a name="Deletes" id="Deletes">DELETEs</a></h3>
+
+<div class="source">
+<div class="source">
+<pre>DeleteStatement ::= <DELETE> <FROM> QualifiedName ( ( <AS> )? Variable )? ( <WHERE> Expression )?
+</pre></div></div>
+<p>The SQL++ DELETE statement is used to delete data from a target dataset. The data to be deleted is identified by a boolean expression involving the variable bound to the target dataset in the DELETE statement.</p>
+<p>Deletes are processed transactionally by the system. The transactional scope of each delete transaction is the deletion of a single object plus its affiliated secondary index entries (if any). If the boolean expression for a delete identifies a single object, then the DELETE statement itself will be a single, atomic transaction. If the expression identifies multiple objects, then each object deleted will be handled as a separate transaction.</p>
+<p>The following examples illustrate single-object deletions.</p>
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>DELETE FROM GleambookUsers user WHERE user.id = 8;
+</pre></div></div></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>DELETE FROM GleambookUsers WHERE id = 5;
+</pre></div></div>
+<!-- ! 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.
+ ! -->
+<h1><a name="Reserved_keywords" id="Reserved_keywords">Appendix 1. Reserved keywords</a></h1>
+<!-- ! 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.
+ ! -->
+<p>All reserved keywords are listed in the following table:</p>
+
+<table border="0" class="table table-striped">
+ <thead>
+
+<tr class="a">
+
+<th> </th>
+
+<th> </th>
+
+<th> </th>
+
+<th> </th>
+
+<th> </th>
+
+<th> </th>
+ </tr>
+ </thead>
+ <tbody>
+
+<tr class="b">
+
+<td>AND </td>
+
+<td>ANY </td>
+
+<td>APPLY </td>
+
+<td>AS </td>
+
+<td>ASC </td>
+
+<td>AT </td>
+ </tr>
+
+<tr class="a">
+
+<td>AUTOGENERATED </td>
+
+<td>BETWEEN </td>
+
+<td>BTREE </td>
+
+<td>BY </td>
+
+<td>CASE </td>
+
+<td>CLOSED </td>
+ </tr>
+
+<tr class="b">
+
+<td>CREATE </td>
+
+<td>COMPACTION </td>
+
+<td>COMPACT </td>
+
+<td>CONNECT </td>
+
+<td>CORRELATE </td>
+
+<td>DATASET </td>
+ </tr>
+
+<tr class="a">
+
+<td>COLLECTION </td>
+
+<td>DATAVERSE </td>
+
+<td>DECLARE </td>
+
+<td>DEFINITION </td>
+
+<td>DECLARE </td>
+
+<td>DEFINITION </td>
+ </tr>
+
+<tr class="b">
+
+<td>DELETE </td>
+
+<td>DESC </td>
+
+<td>DISCONNECT </td>
+
+<td>DISTINCT </td>
+
+<td>DROP </td>
+
+<td>ELEMENT </td>
+ </tr>
+
+<tr class="a">
+
+<td>ELEMENT </td>
+
+<td>EXPLAIN </td>
+
+<td>ELSE </td>
+
+<td>ENFORCED </td>
+
+<td>END </td>
+
+<td>EVERY </td>
+ </tr>
+
+<tr class="b">
+
+<td>EXCEPT </td>
+
+<td>EXIST </td>
+
+<td>EXTERNAL </td>
+
+<td>FEED </td>
+
+<td>FILTER </td>
+
+<td>FLATTEN </td>
+ </tr>
+
+<tr class="a">
+
+<td>FOR </td>
+
+<td>FROM </td>
+
+<td>FULL </td>
+
+<td>FUNCTION </td>
+
+<td>GROUP </td>
+
+<td>HAVING </td>
+ </tr>
+
+<tr class="b">
+
+<td>HINTS </td>
+
+<td>IF </td>
+
+<td>INTO </td>
+
+<td>IN </td>
+
+<td>INDEX </td>
+
+<td>INGESTION </td>
+ </tr>
+
+<tr class="a">
+
+<td>INNER </td>
+
+<td>INSERT </td>
+
+<td>INTERNAL </td>
+
+<td>INTERSECT </td>
+
+<td>IS </td>
+
+<td>JOIN </td>
+ </tr>
+
+<tr class="b">
+
+<td>KEYWORD </td>
+
+<td>LEFT </td>
+
+<td>LETTING </td>
+
+<td>LET </td>
+
+<td>LIKE </td>
+
+<td>LIMIT </td>
+ </tr>
+
+<tr class="a">
+
+<td>LOAD </td>
+
+<td>NODEGROUP </td>
+
+<td>NGRAM </td>
+
+<td>NOT </td>
+
+<td>OFFSET </td>
+
+<td>ON </td>
+ </tr>
+
+<tr class="b">
+
+<td>OPEN </td>
+
+<td>OR </td>
+
+<td>ORDER </td>
+
+<td>OUTER </td>
+
+<td>OUTPUT </td>
+
+<td>PATH </td>
+ </tr>
+
+<tr class="a">
+
+<td>POLICY </td>
+
+<td>PRE-SORTED </td>
+
+<td>PRIMARY </td>
+
+<td>RAW </td>
+
+<td>REFRESH </td>
+
+<td>RETURN </td>
+ </tr>
+
+<tr class="b">
+
+<td>RTREE </td>
+
+<td>RUN </td>
+
+<td>SATISFIES </td>
+
+<td>SECONDARY </td>
+
+<td>SELECT </td>
+
+<td>SET </td>
+ </tr>
+
+<tr class="a">
+
+<td>SOME </td>
+
+<td>TEMPORARY </td>
+
+<td>THEN </td>
+
+<td>TYPE </td>
+
+<td>UNKNOWN </td>
+
+<td>UNNEST </td>
+ </tr>
+
+<tr class="b">
+
+<td>UPDATE </td>
+
+<td>USE </td>
+
+<td>USING </td>
+
+<td>VALUE </td>
+
+<td>WHEN </td>
+
+<td>WHERE </td>
+ </tr>
+
+<tr class="a">
+
+<td>WITH </td>
+
+<td>WRITE </td>
+
+<td> </td>
+
+<td> </td>
+
+<td> </td>
+
+<td> </td>
+ </tr>
+ </tbody>
+</table>
+<!-- ! 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.
+ ! --></div></div></div></div>
+<div class="section">
+<h2><a name="Appendix_2._Performance_Tuning"></a><a name="Performance_tuning" id="Performance_tuning">Appendix 2. Performance Tuning</a></h2>
+<!-- ! 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.
+ ! -->
+<p>The SET statement can be used to override some cluster-wide configuration parameters for a specific request:</p>
+
+<div class="source">
+<div class="source">
+<pre> SET <IDENTIFIER> <STRING_LITERAL>
+</pre></div></div>
+<p>As parameter identifiers are qualified names (containing a ‘.’) they have to be escaped using backticks (``). Note that changing query parameters will not affect query correctness but only impact performance characteristics, such as response time and throughput.</p></div>
+<div class="section">
+<h2><a name="Parallelism_Parameter"></a><a name="Parallelism_parameter" id="Parallelism_parameter">Parallelism Parameter</a></h2>
+<p>The system can execute each request using multiple cores on multiple machines (a.k.a., partitioned parallelism) in a cluster. A user can manually specify the maximum execution parallelism for a request to scale it up and down using the following parameter:</p>
+
+<ul>
+
+<li>
+<p><b>compiler.parallelism</b>: the maximum number of CPU cores can be used to process a query. There are three cases of the value <i>p</i> for compiler.parallelism:</p>
+
+<ul>
+
+<li><i>p</i> < 0 or <i>p</i> > the total number of cores in a cluster: the system will use all available cores in the cluster;</li>
+ </ul>
+
+<ul>
+
+<li><i>p</i> = 0 (the default): the system will use the storage parallelism (the number of partitions of stored datasets) as the maximum parallelism for query processing;</li>
+ </ul>
+
+<ul>
+
+<li>all other cases: the system will use the user-specified number as the maximum number of CPU cores to use for executing the query.</li>
+ </ul></li>
+</ul>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SET `compiler.parallelism` "16"
+
+SELECT u.name AS uname, m.message AS message
+FROM GleambookUsers u JOIN GleambookMessages m ON m.authorId = u.id;
+</pre></div></div></div></div></div></div>
+<div class="section">
+<h2><a name="Memory_Parameters"></a><a name="Memory_parameters" id="Memory_parameters">Memory Parameters</a></h2>
+<p>In the system, each blocking runtime operator such as join, group-by and order-by works within a fixed memory budget, and can gracefully spill to disks if the memory budget is smaller than the amount of data they have to hold. A user can manually configure the memory budget of those operators within a query. The supported configurable memory parameters are:</p>
+
+<ul>
+
+<li>
+<p><b>compiler.groupmemory</b>: the memory budget that each parallel group-by operator instance can use; 32MB is the default budget.</p></li>
+
+<li>
+<p><b>compiler.sortmemory</b>: the memory budget that each parallel sort operator instance can use; 32MB is the default budget.</p></li>
+
+<li>
+<p><b>compiler.joinmemory</b>: the memory budget that each parallel hash join operator instance can use; 32MB is the default budget.</p></li>
+</ul>
+<p>For each memory budget value, you can use a 64-bit integer value with a 1024-based binary unit suffix (for example, B, KB, MB, GB). If there is no user-provided suffix, “B” is the default suffix. See the following examples.</p>
+<div class="section">
+<div class="section">
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SET `compiler.groupmemory` "64MB"
+
+SELECT msg.authorId, COUNT(*)
+FROM GleambookMessages msg
+GROUP BY msg.authorId;
+</pre></div></div></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SET `compiler.sortmemory` "67108864"
+
+SELECT VALUE user
+FROM GleambookUsers AS user
+ORDER BY ARRAY_LENGTH(user.friendIds) DESC;
+</pre></div></div></div>
+<div class="section">
+<h5><a name="Example"></a>Example</h5>
+
+<div class="source">
+<div class="source">
+<pre>SET `compiler.joinmemory` "132000KB"
+
+SELECT u.name AS uname, m.message AS message
+FROM GleambookUsers u JOIN GleambookMessages m ON m.authorId = u.id;
+</pre></div></div></div></div></div></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row span12">Copyright © 2017
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+ <?xml version="1.0" encoding="UTF-8"?>
+<div class="row-fluid">Apache AsterixDB, AsterixDB, Apache, the Apache
+ feather logo, and the Apache AsterixDB project logo are either
+ registered trademarks or trademarks of The Apache Software
+ Foundation in the United States and other countries.
+ All other marks mentioned may be trademarks or registered
+ trademarks of their respective owners.</div>
+
+
+ </div>
+ </footer>
+ </body>
+</html>
diff --git a/docs/0.9.2/sqlpp/primer-sqlpp.html b/docs/0.9.2/sqlpp/primer-sqlpp.html
index 38d87c8..e297244 100644
--- a/docs/0.9.2/sqlpp/primer-sqlpp.html
+++ b/docs/0.9.2/sqlpp/primer-sqlpp.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-08-25
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170825" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – AsterixDB 101: An ADM and SQL++ Primer</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-08-25</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.3-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
@@ -889,34 +889,6 @@
{ "chirp": { "chirpId": "8", "user": { "screenName": "NathanGiesen@211", "lang": "en", "friendsCount": 39339, "statusesCount": 473, "name": "Nathan Giesen", "followersCount": 49416 }, "senderLocation": point("46.05,93.34"), "sendTime": datetime("2005-10-14T10:10:00.000Z"), "referredTopics": {{ "product-z", "shortcut-menu" }}, "messageText": " like product-z the shortcut-menu is awesome:)" }, "similarChirps": [ ] }
</pre></div></div></div>
<div class="section">
-<h3><a name="Inserting_New_Data"></a>Inserting New Data</h3>
-<p>In addition to loading and querying data, AsterixDB supports incremental additions to datasets via the SQL++ <i>INSERT</i> statement.</p>
-<p>The following example adds a new chirp by user “<a class="externalLink" href="mailto:NathanGiesen@211">NathanGiesen@211</a>” to the ChirpMessages dataset. (An astute reader may notice that this chirp was issued a half an hour after his last chirp, so his counts have all gone up in the interim, although he appears not to have moved in the last half hour.)</p>
-
-<div class="source">
-<div class="source">
-<pre> USE TinySocial;
-
- INSERT INTO ChirpMessages
- (
- {"chirpId": "13",
- "user":
- {"screenName": "NathanGiesen@211",
- "lang": "en",
- "friendsCount": 39345,
- "statusesCount": 479,
- "name": "Nathan Giesen",
- "followersCount": 49420
- },
- "senderLocation": point("47.44,80.65"),
- "sendTime": datetime("2008-04-26T10:10:35"),
- "referredTopics": {{"chirping"}},
- "messageText": "chirpy chirp, my fellow chirpers!"
- }
- );
-</pre></div></div>
-<p>In general, the data to be inserted may be specified using any valid SQL++ query expression. The insertion of a single object instance, as in this example, is just a special case where the query expression happens to be a object constructor involving only constants.</p></div>
-<div class="section">
<h3><a name="Deleting_Existing_Data"></a>Deleting Existing Data</h3>
<p>In addition to inserting new data, AsterixDB supports deletion from datasets via the SQL++ <i>DELETE</i> statement. The statement supports “searched delete” semantics, and its <i>WHERE</i> clause can involve any valid XQuery expression.</p>
<p>The following example deletes the chirp that we just added from user "<a class="externalLink" href="mailto:NathanGiesen@211"">NathanGiesen@211"</a>. (Easy come, easy go. :-))</p>
diff --git a/docs/0.9.2/udf.html b/docs/0.9.2/udf.html
index 8d9c237..d5d937b 100644
--- a/docs/0.9.2/udf.html
+++ b/docs/0.9.2/udf.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – Support for User Defined Functions in AsterixDB</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
diff --git a/docs/0.9.2/yarn.html b/docs/0.9.2/yarn.html
index 9b332f0..2431c05 100644
--- a/docs/0.9.2/yarn.html
+++ b/docs/0.9.2/yarn.html
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2017-07-27
+ | Generated by Apache Maven Doxia at 2017-09-14
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20170727" />
+ <meta name="Date-Revision-yyyymmdd" content="20170914" />
<meta http-equiv="Content-Language" content="en" />
<title>AsterixDB – Introduction</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -48,11 +48,11 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2017-07-27</li>
+ <li id="publishDate">Last Published: 2017-09-14</li>
- <li id="projectVersion" class="pull-right">Version: 0.9.2-SNAPSHOT</li>
+ <li id="projectVersion" class="pull-right">Version: 0.9.2</li>
<li class="divider pull-right">|</li>
