Till Westmann has submitted this change and it was merged. Change subject: add SQL++ docs ......................................................................
add SQL++ docs Change-Id: I234164c7b9fe834041feaa54482c505a697e92d8 Reviewed-on: https://asterix-gerrit.ics.uci.edu/1156 Sonar-Qube: Jenkins <[email protected]> Reviewed-by: Yingyi Bu <[email protected]> Tested-by: Jenkins <[email protected]> Integration-Tests: Jenkins <[email protected]> --- M asterixdb/asterix-doc/pom.xml A asterixdb/asterix-doc/src/main/markdown/sqlpp/0_toc.md A asterixdb/asterix-doc/src/main/markdown/sqlpp/1_intro.md A asterixdb/asterix-doc/src/main/markdown/sqlpp/2_expr.md A asterixdb/asterix-doc/src/main/markdown/sqlpp/3_query.md A asterixdb/asterix-doc/src/main/markdown/sqlpp/4_ddl.md 6 files changed, 1,725 insertions(+), 0 deletions(-) Approvals: Yingyi Bu: Looks good to me, approved Jenkins: Verified; No violations found; Verified diff --git a/asterixdb/asterix-doc/pom.xml b/asterixdb/asterix-doc/pom.xml index 5b18c79..ab28e81 100644 --- a/asterixdb/asterix-doc/pom.xml +++ b/asterixdb/asterix-doc/pom.xml @@ -44,6 +44,28 @@ <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-antrun-plugin</artifactId> + <version>1.8</version> + <executions> + <execution> + <id>concat</id> + <phase>pre-site</phase> + <configuration> + <target> + <concat destfile="${project.build.directory}/generated-site/markdown/sqlpp/manual.md"> + <filelist dir="${project.basedir}/src/main/markdown/sqlpp" + files="0_toc.md,1_intro.md,2_expr.md,3_query.md,4_ddl.md"/> + </concat> + </target> + </configuration> + <goals> + <goal>run</goal> + </goals> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>3.4</version> <configuration> diff --git a/asterixdb/asterix-doc/src/main/markdown/sqlpp/0_toc.md b/asterixdb/asterix-doc/src/main/markdown/sqlpp/0_toc.md new file mode 100644 index 0000000..e397db5 --- /dev/null +++ b/asterixdb/asterix-doc/src/main/markdown/sqlpp/0_toc.md @@ -0,0 +1,69 @@ +# The SQL++ Query Language + +## <a id="toc">Table of Contents</a> ## + +* [1. Introduction](#Introduction) +* [2. Expressions](#Expressions) + * [Primary expressions](#Primary_expressions) + * [Literals](#Literals) + * [Variable references](#Variable_references) + * [Parenthesized expressions](#Parenthesized_expressions) + * [Function call expressions](#Function_call_expressions) + * [Constructors](#Constructors) + * [Path expressions](#Path_expressions) + * [Operator expressions](#Operator_expressions) + * [Arithmetic operators](#Arithmetic_operators) + * [Collection operators](#Collection_operators) + * [Comparison operators](#Comparison_operators) + * [Logical operators](#Logical_operators) + * [Case expressions](#Case_expressions) + * [Quantified expressions](#Quantified_expressions) +* [3. Queries](#Queries) + * [SELECT statements](#SELECT_statements) + * [SELECT clauses](#Select_clauses) + * [Select element/value/raw](#Select_element) + * [SQL-style select](#SQL_select) + * [Select *](#Select_star) + * [Select distinct](#Select_distinct) + * [Unnamed projections](#Unnamed_projections) + * [Abbreviatory field access expressions](#Abbreviatory_field_access_expressions) + * [UNNEST clauses](#Unnest_clauses) + * [Inner unnests](#Inner_unnests) + * [Left outer unnests](#Left_outer_unnests) + * [Expressing joins using unnests](#Expressing_joins_using_unnests) + * [FROM clauses](#From_clauses) + * [Binding expressions](#Binding_expressions) + * [Multiple from terms](#Multiple_from_terms) + * [Expressing joins using from terms](#Expressing_joins_using_from_terms) + * [Implicit binding variables](#Implicit_binding_variables) + * [JOIN clauses](#Join_clauses) + * [Inner joins](#Inner_joins) + * [Left outer joins](#Left_outer_joins) + * [GROUP BY clauses](#Group_By_clauses) + * [Group variables](#Group_variables) + * [Implicit group key variables](#Implicit_group_key_variables) + * [Implicit group variables](#Implicit_group_variables) + * [Aggregation functions](#Aggregation_functions) + * [SQL-92 aggregation functions](#SQL-92_aggregation_functions) + * [SQL-92 compliant GROUP BY aggregations](#SQL-92_compliant_gby) + * [Column aliases](#Column_aliases) + * [WHERE clauases and HAVING clauses](#Where_having_clauses) + * [ORDER BY clauses](#Order_By_clauses) + * [LIMIT clauses](#Limit_clauses) + * [WITH clauses](#With_clauses) + * [LET clauses](#Let_clauses) + * [UNION ALL](#Union_all) + * [MISSING in query results](#Missing_in_query_results) + * [SQL++ Vs. SQL-92](#Vs_SQL-92) +* [4. DDL and DML statements](#DDL_and_DML_statements) + * [Declarations](#Declarations) + * [Lifecycle management statements](#Lifecycle_management_statements) + * [Dataverses](#Dataverses) + * [Datasets](#Datasets) + * [Types](#Types) + * [Functions](#Functions) + * [Modification statements](#Modification_statements) + * [Inserts](#Inserts) + * [Upserts](#Upserts) + * [Deletes](#Deletes) + diff --git a/asterixdb/asterix-doc/src/main/markdown/sqlpp/1_intro.md b/asterixdb/asterix-doc/src/main/markdown/sqlpp/1_intro.md new file mode 100644 index 0000000..cfd3c61 --- /dev/null +++ b/asterixdb/asterix-doc/src/main/markdown/sqlpp/1_intro.md @@ -0,0 +1,6 @@ +# <a id="Introduction">1. Introduction</a><font size="4"/> + +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 there are also differences due to the data model that the language is designed to serve. (SQL was designed in the 1970's for interacting with the flat, schema-ified world of relational databases, while SQL++ is designed for the nested, schema-less/schema-optional world of modern NoSQL systems.) In particular, SQL++ in the context of Apache AsterixDB is intended for working with the Asterix Data Model (ADM), which is a data model aimed at a superset of JSON with an enriched and flexible type system. + +New AsterixDB users are encouraged to read and work through the (friendlier) guide "AsterixDB 101: An ADM and SQL++ Primer" before attempting to make use of this document. In addition, readers are advised to read and understand the Asterix Data Model (ADM) reference guide since a basic understanding of ADM concepts is a prerequisite to understanding SQL++. 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. + diff --git a/asterixdb/asterix-doc/src/main/markdown/sqlpp/2_expr.md b/asterixdb/asterix-doc/src/main/markdown/sqlpp/2_expr.md new file mode 100644 index 0000000..0e834e6 --- /dev/null +++ b/asterixdb/asterix-doc/src/main/markdown/sqlpp/2_expr.md @@ -0,0 +1,294 @@ +# <a id="Expressions">2. Expressions</a> + + Expression ::= OperatorExpression | CaseExpression | QuantifiedExpression + +SQL++ is a highly composable expression language. Each SQL++ expression returns zero or more Asterix Data Model (ADM) 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. + +## <a id="Primary_expressions">Primary Expressions</a> + + PrimaryExpr ::= Literal + | VariableReference + | ParenthesizedExpression + | FunctionCallExpression + | Constructor + +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 Asterix Data Model (such as a newly constructed ADM record or list of ADM instances). + +### <a id="Literals">Literals</a> + + Literal ::= StringLiteral + | IntegerLiteral + | FloatLiteral + | DoubleLiteral + | <NULL> + | <MISSING> + | <TRUE> + | <FALSE> + StringLiteral ::= "\'" (<ESCAPE_APOS> | ~["\'"])* "\'" + | "\"" (<ESCAPE_APOS> | ~["\'"])* "\"" + <ESCAPE_APOS> ::= "\\\'" + IntegerLiteral ::= <DIGITS> + <DIGITS> ::= ["0" - "9"]+ + FloatLiteral ::= <DIGITS> ( "f" | "F" ) + | <DIGITS> ( "." <DIGITS> ( "f" | "F" ) )? + | "." <DIGITS> ( "f" | "F" ) + DoubleLiteral ::= <DIGITS> + | <DIGITS> ( "." <DIGITS> )? + | "." <DIGITS> + +> MC: I tentatively deleted the following unused ESCAPE_QUOTE definition: <ESCAPE_QUOT> ::= "\\\"" +> <ESCAPE_QUOT> ::= "\\\"" +> Also, I moved the DelimitedIdentifier down further per TW's suggestion. + +Literals (constants) in SQL++ can be strings, integers, floating point values, double values, boolean constants, or special constant values like `NULL` and `MISSING`. The `NULL` value is like a `NULL` in SQL; it is used to represent an unknown field value. The specialy value `MISSING` is only meaningful in the context of SQL++ field accesses; it occurs when the accessed field simply does not exist at all in a record being accessed. + +The following are some simple examples of SQL++ literals. + +##### Examples + + 'a string' + "test string" + 42 + +Different from standard SQL, double quotes play the same role as single quotes and may be used for string literals in SQL++. + +### <a id="Variable_references">Variable References</a> + + VariableReference ::= <IDENTIFIER>|<DelimitedIdentifier> + <IDENTIFIER> ::= <LETTER> (<LETTER> | <DIGIT> | "_" | "$")* + <LETTER> ::= ["A" - "Z", "a" - "z"] + DelimitedIdentifier ::= "\`" (<ESCAPE_APOS> | ~["\'"])* "\`" + +A variable in SQL++ can be bound to any legal ADM 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 `FROM`, `WITH` or `LET` clauses of a `SELECT` statement or from an input parameter in the context of a function body.) Backticks, e.g., \`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. + +##### Examples + + tweet + id + `SELECT` + `my-function` + +### <a id="Parenthesized_expressions">Parenthesized expressions</a> + + ParenthesizedExpression ::= "(" Expression ")" | Subquery + +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. + +The following expression evaluates to the value 2. + +##### Example + + ( 1 + 1 ) + +### <a id="Function_call_expressions">Function call expressions</a> + + FunctionCallExpression ::= FunctionName "(" ( Expression ( "," Expression )* )? ")" + +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 ADM value resulting from the evaluation of its body expression with the given parameter bindings; the parameter value bindings can themselves be any SQL++ expressions. + +The following example is a (built-in) function call expression whose value is 8. + +##### Example + + length('a string') + +### <a id="Constructors">Constructors</a> + + ListConstructor ::= OrderedListConstructor | UnorderedListConstructor + OrderedListConstructor ::= "[" ( Expression ( "," Expression )* )? "]" + UnorderedListConstructor ::= "{{" ( Expression ( "," Expression )* )? "}}" + RecordConstructor ::= "{" ( FieldBinding ( "," FieldBinding )* )? "}" + FieldBinding ::= Expression ":" Expression + +A major feature of SQL++ is its ability to construct new ADM data instances. This is accomplished using its constructors for each of the major ADM complex object structures, namely lists (ordered or unordered) and records. Ordered lists are like JSON arrays, while unordered lists have multiset (bag) semantics. Records are built from attributes that are field-name/field-value pairs, again like JSON. (See the AsterixDB Data Model document for more details on each.) + +The following examples illustrate how to construct a new ordered list with 3 items, a new record with 2 fields, and a new unordered list with 4 items, respectively. List elements can be homogeneous (as in the first example), which is the common case, or they may be heterogeneous (as in the third example). The data values and field name values used to construct lists and records in constructors are all simply SQL++ expressions. Thus, the list 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). + +##### Examples + + [ 'a', 'b', 'c' ] + + { + 'project name': 'AsterixDB', + 'project members': [ 'vinayakb', 'dtabass', 'chenli', 'tsotras' ] + } + + {{ 42, "forty-two!", { "rank": "Captain", "name": "America" }, 3.14159 }} + +### <a id="Path_expressions">Path expressions</a> + + PathExpression ::= PrimaryExpression ( Field | Index )* + Field ::= "." Identifier + Index ::= "[" ( Expression | "?" ) "]" + +Components of complex types in ADM 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, e.g., a record or list instance. For records, path access is based on field names. For ordered lists, 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 ordered list. Attempts to access non-existent fields or out-of-bound list elements produce the special value `MISSING`. + +The following examples illustrate field access for a record, index-based element access for an ordered list, and also a composition thereof. + +##### Examples + + ({"name": "MyABCs", "list": [ "a", "b", "c"]}).list + + (["a", "b", "c"])[2] + + ({"name": "MyABCs", "list": [ "a", "b", "c"]}).list[2] + +### <a id="Operator_expressions">Operator expressions</a> + +Operators perform a specific operation on the input values or expressions. The syntax of an operator expression is as follows: + + OperatorExpression ::= PathExpression + | Operator OperatorExpression + | OperatorExpression Operator (OperatorExpression)? + | OperatorExpression <BETWEEN> OperatorExpression <AND> OperatorExpression + +SQL++ provides a full set of operators that you can use within its statements. Here are the categories of operators: + +* [Arithmetic operators](#Arithmetic_operators), to perform basic mathematical operations; +* [Collection operators](#Collection_operators), to evaluate expressions on collections or objects; +* [Comparison operators](#Comparison_operators), to compare two expressions; +* [Logical Operators](#Logical_operators), to combine operators using Boolean logic. + +The following table summarizes the precedence order (from higher to lower) of the major unary and binary operators: + +| Operator | Operation | +|-----------------------------------------------------------------------------|-----------| +| EXISTS, NOT EXISTS | collection emptiness testing | +| ^ | exponentiation | +| *, / | multiplication, division | +| +, - | addition, subtraction | +| || | string concatenation | +| IS NULL, IS NOT NULL, IS MISSING, IS NOT MISSING, <br/>IS UNKNOWN, IS NOT UNKNOWN| unknown value comparison | +| BETWEEN, NOT BETWEEN | range comparison (inclusive on both sides) | +| =, !=, <, >, <=, >=, LIKE, NOT LIKE, IN, NOT IN | comparison | +| NOT | logical negation | +| AND | conjunction | +| OR | disjunction | + +### <a id="Arithmetic_operators">Arithmetic operators</a> +Arithemtic operators are used to exponentiate, add, subtract, multiply, and divide numeric values, or concatenate string values. + +| Operator | Purpose | Example | +|--------------|-------------------------------------------------------------------------|------------| +| +, - | As unary operators, they denote a <br/>positive or negative expression | SELECT VALUE -1; | +| +, - | As binary operators, they add or subtract | SELECT VALUE 1 + 2; | +| *, / | Multiply, divide | SELECT VALUE 4 / 2.0; | +| ^ | Exponentiation | SELECT VALUE 2^3; | +| || | String concatenation | SELECT VALUE "ab"||"c"||"d"; | + +### <a id="Collection_operators">Collection operators</a> +Collection operators are used for membership tests (IN, NOT IN) or empty collection tests (EXISTS, NOT EXISTS). + +| Operator | Purpose | Example | +|------------|----------------------------------------------|------------| +| IN | Membership test | SELECT * FROM ChirpMessages cm <br/>WHERE cm.user.lang IN ["en", "de"]; | +| NOT IN | Non-membership test | SELECT * FROM ChirpMessages cm <br/>WHERE cm.user.lang NOT IN ["en"]; | +| EXISTS | Check whether a collection is not empty | SELECT * FROM ChirpMessages cm <br/>WHERE EXISTS cm.referredTopics; | +| NOT EXISTS | Check whether a collection is empty | SELECT * FROM ChirpMessages cm <br/>WHERE NOT EXISTS cm.referredTopics; | + +### <a id="Comparison_operators">Comparison operators</a> +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 record - 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 records 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. + +##### Examples +{"name": "Jack", "friend": "Jill"} + +{"name": "Jake", "friend": NULL} + +{"name": "Joe"} + +The following table enumerates all of SQL++'s comparison operators. + +| Operator | Purpose | Example | +|----------------|--------------------------------------------|------------| +| IS NULL | Test if a value is NULL | SELECT * FROM ChirpMessages cm <br/>WHERE cm.user.name IS NULL; | +| IS NOT NULL | Test if a value is not NULL | SELECT * FROM ChirpMessages cm <br/>WHERE cm.user.name IS NOT NULL; | +| IS MISSING | Test if a value is MISSING | SELECT * FROM ChirpMessages cm <br/>WHERE cm.user.name IS MISSING; | +| IS NOT MISSING | Test if a value is not MISSING | SELECT * FROM ChirpMessages cm <br/>WHERE cm.user.name IS NOT MISSING;| +| IS UNKNOWN | Test if a value is NULL or MISSING | SELECT * FROM ChirpMessages cm <br/>WHERE cm.user.name IS UNKNOWN; | +| IS NOT UNKNOWN | Test if a value is neither NULL nor MISSING | SELECT * FROM ChirpMessages cm <br/>WHERE cm.user.name IS NOT UNKNOWN;| +| BETWEEN | 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. | SELECT * FROM ChirpMessages cm <br/>WHERE cm.chirpId BETWEEN 10 AND 20;| +| = | Equality test | SELECT * FROM ChirpMessages cm <br/>WHERE cm.chirpId=10; | +| != | Inequality test | SELECT * FROM ChirpMessages cm <br/>WHERE cm.chirpId!=10;| +| < | Less than | SELECT * FROM ChirpMessages cm <br/>WHERE cm.chirpId<10; | +| > | Greater than | SELECT * FROM ChirpMessages cm <br/>WHERE cm.chirpId>10; | +| <= | Less than or equal to | SELECT * FROM ChirpMessages cm <br/>WHERE cm.chirpId<=10; | +| >= | Greater than or equal to | SELECT * FROM ChirpMessages cm <br/>WHERE cm.chirpId>=10; | +| LIKE | 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. | SELECT * FROM ChirpMessages cm <br/>WHERE cm.user.name LIKE "%Giesen%";| +| NOT LIKE | 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. | SELECT * FROM ChirpMessages cm <br/>WHERE cm.user.name NOT LIKE "%Giesen%";| + +The following table summarizes how the missing value comparison operators work. + +| Operator | Non-NULL/Non-MISSING value | NULL | MISSING | +|----------|----------------|------|---------| +| IS NULL | FALSE | TRUE | MISSING | +| IS NOT NULL | TRUE | FALSE | MISSING | +| IS MISSING | FALSE | FALSE | TRUE | +| IS NOT MISSING | TRUE | TRUE | FALSE | +| IS UNKNOWN | FALSE | TRUE | TRUE | +| IS NOT UNKNOWN | TRUE | FALSE | FALSE| + +### <a id="Logical_operators">Logical operators</a> +Logical operators perform logical `NOT`, `AND`, and `OR` operations over Boolean values (`TRUE` and `FALSE`) plus `NULL` and `MISSING`. + +| Operator | Purpose | Example | +|----------|-----------------------------------------------------------------------------|------------| +| NOT | Returns true if the following condition is false, otherwise returns false | SELECT VALUE NOT TRUE; | +| AND | Returns true if both branches are true, otherwise returns false | SELECT VALUE TRUE AND FALSE; | +| OR | Returns true if one branch is true, otherwise returns false | SELECT VALUE FALSE OR FALSE; | + +The following table is the truth table for `AND` and `OR`. + +| A | B | A AND B | A OR B | +|----|----|----------|--------| +| TRUE | TRUE | TRUE | TRUE | +| TRUE | FALSE | FALSE | TRUE | +| TRUE | NULL | NULL | TRUE | +| TRUE | MISSING | MISSING | TRUE | +| FALSE | FALSE | FALSE | FALSE | +| FALSE | NULL | FALSE | NULL | +| FALSE | MISSING | FALSE | MISSING | +| NULL | NULL | NULL | NULL | +| NULL | MISSING | MISSING | NULL | +| MISSING | MISSING | MISSING | MISSING | + +The following table demonstrates the results of `NOT` on all possible inputs. + +| A | NOT A | +|----|----| +| TRUE | FALSE | +| FALSE | TRUE | +| NULL | NULL | +| MISSING | MISSING | + +### <a id="Case_expressions">Case expressions</a> + + CaseExpression ::= SimpleCaseExpression | SearchedCaseExpression + SimpleCaseExpression ::= <CASE> Expression ( <WHEN> Expression <THEN> Expression )+ ( <ELSE> Expression )? <END> + SearchedCaseExpression ::= <CASE> ( <WHEN> Expression <THEN> Expression )+ ( <ELSE> Expression )? <END> + +In a simple `CASE` expression, the query evaluator searches for the first `WHEN` ... `THEN` pair in which the `WHEN` expression is equal to the expression following `CASE` and returns the expression following `THEN`. If none of the `WHEN` ... `THEN` pairs meet this condition, and an `ELSE` branch exists, it returns the `ELSE` expression. Otherwise, `NULL` is returned. + +In a searched CASE expression, the query evaluator searches from left to right until it finds a `WHEN` expression that is evaluated to `TRUE`, and then returns its corresponding `THEN` expression. If no condition is found to be `TRUE`, and an `ELSE` branch exists, it returns the `ELSE` expression. Otherwise, it returns `NULL`. + +The following example illustrates the form of a case expression. +##### Example + + CASE (2 < 3) WHEN true THEN "yes" ELSE "no" END + +### <a id="Quantified_expressions">Quantified expressions</a> + + QuantifiedExpression ::= ( <SOME> | <EVERY> ) Variable <IN> Expression ( "," Variable "in" Expression )* + <SATISFIES> Expression + +Quantified expressions are used for expressing existential or universal predicates involving the elements of a collection. + +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 `FALSE` and second example yields `TRUE`. + +It is useful to note that if the set were instead the empty set, the first expression would yield `TRUE` ("every" value in an empty set satisfies the condition) while the second expression would yield `FALSE` (since there isn't "some" value, as there are no values in the set, that satisfies the condition). + +##### Examples + + EVERY x IN [ 1, 2, 3 ] SATISFIES x < 3 + SOME x IN [ 1, 2, 3 ] SATISFIES x < 3 + + diff --git a/asterixdb/asterix-doc/src/main/markdown/sqlpp/3_query.md b/asterixdb/asterix-doc/src/main/markdown/sqlpp/3_query.md new file mode 100644 index 0000000..01aa358 --- /dev/null +++ b/asterixdb/asterix-doc/src/main/markdown/sqlpp/3_query.md @@ -0,0 +1,882 @@ +# <a id="Queries">3. Queries</a> + +A SQL++ query can be any legal SQL++ expression or `SELECT` statement. A SQL++ query always ends with a semicolon. + + Query ::= (Expression | SelectStatement) ";" + +## <a id="SELECT_statements">SELECT statements</a> + +The following shows the (rich) grammar for the `SELECT` statement in SQL++. + +> TW: Should we replace SelectElement with SelectValue? MC: Yes, and done below. + + SelectStatement ::= ( WithClause )? + SelectSetOperation (OrderbyClause )? ( LimitClause )? + SelectSetOperation ::= SelectBlock (<UNION> <ALL> ( SelectBlock | Subquery ) )* + Subquery ::= "(" SelectStatement ")" + + SelectBlock ::= SelectClause + ( FromClause ( WithClause )?)? + ( WhereClause )? + ( GroupbyClause ( LetClause )? ( HavingClause )? )? + | + FromClause ( WithClause )? + ( WhereClause )? + ( GroupbyClause ( WithClause )? ( 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)? ( <AT> Variable )? + ( ( JoinType )? ( JoinClause | UnnestClause ) )* + + JoinClause ::= <JOIN> Expression (( <AS> )? Variable)? (<AT> 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 )? + +In this section, we will make use of two stored collections of records (datasets in ADM parlance), `GleambookUsers` and `GleambookMessages`, in a series of running examples to explain `SELECT` queries. The contents of the example collections are as follows: + +`GleambookUsers` collection: + + {"id":1,"alias":"Margarita","name":"MargaritaStoddard","nickname":"Mags","userSince":datetime("2012-08-20T10:10:00"),"friendIds":{{2,3,6,10}},"employment":[{"organizationName":"Codetechno","start-date":date("2006-08-06")},{"organizationName":"geomedia","start-date":date("2010-06-17"),"end-date":date("2010-01-26")}],"gender":"F"} + {"id":2,"alias":"Isbel","name":"IsbelDull","nickname":"Izzy","userSince":datetime("2011-01-22T10:10:00"),"friendIds":{{1,4}},"employment":[{"organizationName":"Hexviafind","startDate":date("2010-04-27")}]} + {"id":3,"alias":"Emory","name":"EmoryUnk","userSince":datetime("2012-07-10T10:10:00"),"friendIds":{{1,5,8,9}},"employment":[{"organizationName":"geomedia","startDate":date("2010-06-17"),"endDate":date("2010-01-26")}]} + +`GleambookMessages` collection: + + {"messageId":2,"authorId":1,"inResponseTo":4,"senderLocation":point("41.66,80.87"),"message":" dislike iphone its touch-screen is horrible"} + {"messageId":3,"authorId":2,"inResponseTo":4,"senderLocation":point("48.09,81.01"),"message":" like samsung the plan is amazing"} + {"messageId":4,"authorId":1,"inResponseTo":2,"senderLocation":point("37.73,97.04"),"message":" can't stand at&t the network is horrible:("} + {"messageId":6,"authorId":2,"inResponseTo":1,"senderLocation":point("31.5,75.56"),"message":" like t-mobile its platform is mind-blowing"} + {"messageId":8,"authorId":1,"inResponseTo":11,"senderLocation":point("40.33,80.87"),"message":" like verizon the 3G is awesome:)"} + {"messageId":10,"authorId":1,"inResponseTo":12,"senderLocation":point("42.5,70.01"),"message":" can't stand motorola the touch-screen is terrible"} + {"messageId":11,"authorId":1,"inResponseTo":1,"senderLocation":point("38.97,77.49"),"message":" can't stand at&t its plan is terrible"} + +## <a id="Select_clauses">SELECT Clause</a> +The SQL++ `SELECT` clause always returns a collection value as its result (even if the result is empty or a singleton). + +### <a id="Select_element">SELECT VALUE Clause</a> +The `SELECT VALUE` clause in SQL++ returns a collection that contains the results of evaluating the `VALUE` expression, with one evaluation being performed per "binding tuple" (i.e., per `FROM` clause item) satisfying the statement's selection criteria. +For historical reasons SQL++ also allows the keywords `ELEMENT` or `RAW` to be used in place of `VALUE` (not recommended). +The following example shows a query that selects one user from the GleambookUsers collection. + +##### Example + + SELECT VALUE user + FROM GleambookUsers user + WHERE user.id = 1; + +This query returns: + + [ + { "id": 1, "alias": "Margarita", "name": "MargaritaStoddard", "userSince": datetime("2012-08-20T10:10:00.000Z"), "friendIds": {{ 2, 3, 6, 10 }}, "employment": [ { "organizationName": "Codetechno", "startDate": date("2006-08-06") }, { "organizationName": "geomedia", "startDate": date("2010-06-17"), "endDate": date("2010-01-26") } ], "nickname": "Mags", "gender": "F" } + + ] + +### <a id="SQL_select">SQL-style SELECT</a> +In SQL++, the traditional SQL-style `SELECT` syntax is also supported. +This syntax can also be reformulated in a `SELECT VALUE` based manner in SQL++. +(E.g., `SELECT expA AS fldA, expB AS fldB` is syntactic sugar for `SELECT VALUE { 'fldA': expA, 'fldB': expB }`.) + +##### Example + SELECT user.alias user_alias, user.name user_name + FROM GleambookUsers user + WHERE user.id = 1; + +Returns: + + [ + {"user_alias":"Margarita","user_name":"MargaritaStoddard"} + ] + +### <a id="Select_star">SELECT *</a> +In SQL++, `SELECT *` returns a record 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 `FROM` clause or `GROUP BY` clause in the current enclosing `SELECT` statement, and its field is the value of that binding variable. + +##### Example + + SELECT * + FROM GleambookUsers user; + +Since `user` is the only binding variable generated in the `FROM` clause, this query returns: + + [ + { "user": { "id": 1, "alias": "Margarita", "name": "MargaritaStoddard", "userSince": datetime("2012-08-20T10:10:00.000Z"), "friendIds": {{ 2, 3, 6, 10 }}, "employment": [ { "organizationName": "Codetechno", "startDate": date("2006-08-06") }, { "organizationName": "geomedia", "startDate": date("2010-06-17"), "endDate": date("2010-01-26") } ], "nickname": "Mags", "gender": "F" } }, + { "user": { "id": 2, "alias": "Isbel", "name": "IsbelDull", "userSince": datetime("2011-01-22T10:10:00.000Z"), "friendIds": {{ 1, 4 }}, "employment": [ { "organizationName": "Hexviafind", "startDate": date("2010-04-27") } ], "nickname": "Izzy" } }, + { "user": { "id": 3, "alias": "Emory", "name": "EmoryUnk", "userSince": datetime("2012-07-10T10:10:00.000Z"), "friendIds": {{ 1, 5, 8, 9 }}, "employment": [ { "organizationName": "geomedia", "startDate": date("2010-06-17"), "endDate": date("2010-01-26") } ] } } + ] + +### <a id="Select_distinct">SELECT DISTINCT</a> +SQL++'s `DISTINCT` keyword is used to eliminate duplicate items in results. The following example shows how it works. + +##### Example + + SELECT DISTINCT * FROM [1, 2, 2, 3] AS foo; + +This query returns: + + [ + { "foo": 1 }, + { "foo": 2 }, + { "foo": 3 } + ] + +##### Example + + SELECT DISTINCT VALUE foo FROM [1, 2, 2, 3] AS foo; + +This version of the query returns: + + [ 1, 2, 3 ] + +### <a id="Unnamed_projections">Unnamed projections</a> +Similar to standard SQL, SQL++ supports unnamed projections (a.k.a, unnamed `SELECT` clause items), for which names are generated. +Name generation has three cases: + + * If a projection expression is a variable reference expression, its generated name is the name of the variable. + * If a projection expression is a field access expression, its generated name is the last identifier in the expression. + * For all other cases, the query processor will generate a unique name. + +##### Example + + SELECT substr(user.name, 10), user.alias + FROM GleambookUsers user + WHERE user.id = 1; + +This query outputs: + + [ + { "$1": "Stoddard", "alias": "Margarita" } + ] + +In the result, `$1` is the generated name for `substr(user.name, 1)`, while `alias` is the generated name for `user.alias`. + +### <a id="Abbreviatory_field_access_expressions">Abbreviated Field Access Expressions</a> +As in standard SQL, SQL++ field access expressions can be abbreviated (not recommended) when there is no ambiguity. In the next example, the variable `user` is the only possible variable reference for fields `id`, `name` and `alias` and thus could be omitted in the query. + +##### Example + + SELECT substr(name, 10) AS lname, alias + FROM GleambookUsers user + WHERE id = 1; + +Outputs: + + [ + { "lname": "Stoddard", "alias": "Margarita" } + ] + +## <a id="Unnest_clauses">UNNEST Clause</a> +For each of its input tuples, the `UNNEST` 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. + +### <a id="Inner_unnests">Inner UNNEST</a> +The following example is a query that retrieves the names of the organizations that a selected user has worked for. It uses the `UNNEST` clause to unnest the nested collection `employment` in the user's record. + +##### Example + + SELECT u.id AS userId, e.organizationName AS orgName + FROM GleambookUsers u + UNNEST u.employment e + WHERE u.id = 1; + +This query returns: + + [ + { "userId": 1, "orgName": "Codetechno" }, + { "userId": 1, "orgName": "geomedia" } + ] + +Note that `UNNEST` 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. + +### <a id="Left_outer_unnests">Left outer UNNEST</a> +As an alternative, the `LEFT OUTER UNNEST` clause offers SQL's left outer join semantics. For example, no collection-valued field named `hobbies` exists in the record for the user whose id is 1, but the following query's result still includes user 1. + +##### Example + + SELECT u.id AS userId, h.hobbyName AS hobby + FROM GleambookUsers u + LEFT OUTER UNNEST u.hobbies h + WHERE u.id = 1; + +Returns: + + [ + { "userId": 1 } + ] + +Note that if `u.hobbies` is an empty collection or leads to a `MISSING` (as above) or `NULL` value for a given input tuple, there is no corresponding binding value for variable `h` for an input tuple. A `MISSING` value will be generated for `h` so that the input tuple can still be propagated. + +### <a id="Expressing_joins_using_unnests">Expressing joins using UNNEST</a> +The SQL++ `UNNEST` clause is similar to SQL's `JOIN` 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 record per pair, with result records containing the user's name and an entire message. The query can be thought of as saying "for each Gleambook user, unnest the `GleambookMessages` collection and filter the output with the condition `message.authorId = user.id`". + +##### Example + + SELECT u.name AS uname, m.message AS message + FROM GleambookUsers u + UNNEST GleambookMessages m + WHERE m.authorId = u.id; + +This returns: + + [ + { "uname": "MargaritaStoddard", "message": " can't stand at&t its plan is terrible" }, + { "uname": "MargaritaStoddard", "message": " dislike iphone its touch-screen is horrible" }, + { "uname": "MargaritaStoddard", "message": " can't stand at&t the network is horrible:(" }, + { "uname": "MargaritaStoddard", "message": " like verizon the 3G is awesome:)" }, + { "uname": "MargaritaStoddard", "message": " can't stand motorola the touch-screen is terrible" }, + { "uname": "IsbelDull", "message": " like t-mobile its platform is mind-blowing" }, + { "uname": "IsbelDull", "message": " like samsung the plan is amazing" } + ] + +Similarly, the above query can also be expressed as the `UNNEST`ing of a correlated SQL++ subquery: + +##### Example + + 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; + +## <a id="From_clauses">FROM clauses</a> +A `FROM` clause is used for enumerating (i.e., conceptually iterating over) the contents of collections, as in SQL. + +### <a id="Binding_expressions">Binding expressions</a> +In SQL++, in addition to stored collections, a `FROM` clause can iterate over any intermediate collection returned by a valid SQL++ expression. + +##### Example + + SELECT VALUE foo + FROM [1, 2, 2, 3] AS foo + WHERE foo > 2; + +Returns: + + [ + 3 + ] + +### <a id="Multiple_from_terms">Multiple FROM terms</a> +SQL++ permits correlations among `FROM` terms. Specifically, a `FROM` binding expression can refer to variables defined to its left in the given `FROM` clause. Thus, the first unnesting example above could also be expressed as follows: + +##### Example + + SELECT u.id AS userId, e.organizationName AS orgName + FROM GleambookUsers u, u.employment e + WHERE u.id = 1; + + +### <a id="Expressing_joins_using_from_terms">Expressing joins using FROM terms</a> +Similarly, the join intentions of the other `UNNEST`-based join examples above could be expressed as: + +##### Example + + SELECT u.name AS uname, m.message AS message + FROM GleambookUsers u, GleambookMessages m + WHERE m.authorId = u.id; + +##### Example + + 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; + +Note that the first alternative is one of the SQL-92 approaches to expressing a join. + +### <a id="Implicit_binding_variables">Implicit binding variables</a> + +Similar to standard SQL, SQL++ supports implicit `FROM` binding variables (i.e., aliases), for which a binding variable is generated. SQL++ variable generation falls into three cases: + + * If the binding expression is a variable reference expression, the generated variable's name will be the name of the referenced variable itself. + * If the binding expression is a field access expression, the generated variable's name will be the last identifier in the expression. + * For all other cases, a compilation error will be raised. + +The next two examples show queries that do not provide binding variables in their `FROM` clauses. + +##### Example + + SELECT GleambookUsers.name, GleambookMessages.message + FROM GleambookUsers, GleambookMessages + WHERE GleambookMessages.authorId = GleambookUsers.id; + +Returns: + + [ + { "name": "MargaritaStoddard", "message": " can't stand at&t its plan is terrible" }, + { "name": "MargaritaStoddard", "message": " dislike iphone its touch-screen is horrible" }, + { "name": "MargaritaStoddard", "message": " can't stand at&t the network is horrible:(" }, + { "name": "MargaritaStoddard", "message": " like verizon the 3G is awesome:)" }, + { "name": "MargaritaStoddard", "message": " can't stand motorola the touch-screen is terrible" }, + { "name": "IsbelDull", "message": " like t-mobile its platform is mind-blowing" }, + { "name": "IsbelDull", "message": " like samsung the plan is amazing" } + ] + +##### Example + + SELECT GleambookUsers.name, GleambookMessages.message + FROM GleambookUsers, + ( + SELECT VALUE GleambookMessages + FROM GleambookMessages + WHERE GleambookMessages.authorId = GleambookUsers.id + ); + +Returns: + + Error: Need an alias for the enclosed expression: + (select element $GleambookMessages + from $GleambookMessages as $GleambookMessages + where ($GleambookMessages.authorId = $GleambookUsers.id) + ) + +## <a id="Join_clauses">JOIN clauses</a> +The join clause in SQL++ supports both inner joins and left outer joins from standard SQL. + +### <a id="Inner_joins">Inner joins</a> +Using a `JOIN` clause, the inner join intent from the preceeding examples can also be expressed as follows: + +##### Example + + SELECT u.name AS uname, m.message AS message + FROM GleambookUsers u JOIN GleambookMessages m ON m.authorId = u.id; + +### <a id="Left_outer_joins">Left outer joins</a> +SQL++ supports SQL's notion of left outer join. The following query is an example: + + SELECT u.name AS uname, m.message AS message + FROM GleambookUsers u LEFT OUTER JOIN GleambookMessages m ON m.authorId = u.id; + +Returns: + + [ + { "uname": "MargaritaStoddard", "message": " can't stand at&t its plan is terrible" }, + { "uname": "MargaritaStoddard", "message": " dislike iphone its touch-screen is horrible" }, + { "uname": "MargaritaStoddard", "message": " can't stand at&t the network is horrible:(" }, + { "uname": "MargaritaStoddard", "message": " like verizon the 3G is awesome:)" }, + { "uname": "MargaritaStoddard", "message": " can't stand motorola the touch-screen is terrible" }, + { "uname": "IsbelDull", "message": " like t-mobile its platform is mind-blowing" }, + { "uname": "IsbelDull", "message": " like samsung the plan is amazing" }, + { "uname": "EmoryUnk" } + ] + +For non-matching left-side tuples, SQL++ produces `MISSING` values for the right-side binding variables; that is why the last record in the above result doesn't have a `message` field. Note that this is slightly different from standard SQL, which instead would fill in `NULL` 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. `MISSING`) instead of as being "there but unknown" (i.e., `NULL`). + +The left-outer join query can also be expressed using `LEFT OUTER UNNEST`: + + 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; + +In general, in SQL++, SQL-style join queries can also be expressed by `UNNEST` clauses and left outer join queries can be expressed by `LEFT OUTER UNNESTs`. + +## <a id="Group_By_clauses">GROUP BY clauses</a> +The SQL++ `GROUP BY` clause generalizes standard SQL's grouping and aggregation semantics, but it also retains backward compatibility with the standard (relational) SQL `GROUP BY` and aggregation features. + +### <a id="Group_variables">Group variables</a> +In a `GROUP BY` clause, in addition to the binding variable(s) defined for the grouping key(s), SQL++ allows a user to define a *group variable* by using the clause's `GROUP AS` 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 value will be a set of nested records in which each field of the record is the result of a renamed variable defined in parentheses following the group variable's name. The `GROUP AS` syntax is as follows: + + <GROUP> <AS> Variable ("(" Variable <AS> VariableReference ("," Variable <AS> VariableReference )* ")")? + +##### Example + + SELECT * + FROM GleambookMessages message + GROUP BY message.authorId AS uid GROUP AS msgs(message AS msg); + +This first example query returns: + + [ + { "uid": 1, "msgs": [ { "msg": { "messageId": 8, "authorId": 1, "inResponseTo": 11, "senderLocation": point("40.33,80.87"), "message": " like verizon the 3G is awesome:)" } }, + { "msg": { "messageId": 10, "authorId": 1, "inResponseTo": 12, "senderLocation": point("42.5,70.01"), "message": " can't stand motorola the touch-screen is terrible" } }, + { "msg": { "messageId": 11, "authorId": 1, "inResponseTo": 1, "senderLocation": point("38.97,77.49"), "message": " can't stand at&t its plan is terrible" } }, + { "msg": { "messageId": 2, "authorId": 1, "inResponseTo": 4, "senderLocation": point("41.66,80.87"), "message": " dislike iphone its touch-screen is horrible" } }, + { "msg": { "messageId": 4, "authorId": 1, "inResponseTo": 2, "senderLocation": point("37.73,97.04"), "message": " can't stand at&t the network is horrible:(" } } ] }, + { "uid": 2, "msgs": [ { "msg": { "messageId": 6, "authorId": 2, "inResponseTo": 1, "senderLocation": point("31.5,75.56"), "message": " like t-mobile its platform is mind-blowing" } }, + { "msg": { "messageId": 3, "authorId": 2, "inResponseTo": 4, "senderLocation": point("48.09,81.01"), "message": " like samsung the plan is amazing" } } ] } + ] + +As we can see from the above query result, each group in the example query's output has an associated group +variable value called `msgs` that appears in the `SELECT *`'s result. +This variable contains a collection of records associated with the group; each of the group's `message` values +appears in the `msg` field of the records in the `msgs` collection. + +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 `msg` field of a record. +(That wrapping is useful in more complex cases, but is essentially just in the way here.) +We can use a subquery in the `SELECT` clase to tunnel through the extra nesting and produce the desired result. + +##### Example + + SELECT uid, (SELECT VALUE m.msg FROM msgs m) AS msgs + FROM GleambookMessages message + GROUP BY message.authorId AS uid GROUP AS msgs(message AS msg); + +This variant of the example query returns: + + { "uid": 1, "msgs": [ { "messageId": 8, "authorId": 1, "inResponseTo": 11, "senderLocation": point("40.33,80.87"), "message": " like verizon the 3G is awesome:)" }, + { "messageId": 10, "authorId": 1, "inResponseTo": 12, "senderLocation": point("42.5,70.01"), "message": " can't stand motorola the touch-screen is terrible" }, + { "messageId": 11, "authorId": 1, "inResponseTo": 1, "senderLocation": point("38.97,77.49"), "message": " can't stand at&t its plan is terrible" }, + { "messageId": 2, "authorId": 1, "inResponseTo": 4, "senderLocation": point("41.66,80.87"), "message": " dislike iphone its touch-screen is horrible" }, + { "messageId": 4, "authorId": 1, "inResponseTo": 2, "senderLocation": point("37.73,97.04"), "message": " can't stand at&t the network is horrible:(" } ] }, + { "uid": 2, "msgs": [ { "messageId": 6, "authorId": 2, "inResponseTo": 1, "senderLocation": point("31.5,75.56"), "message": " like t-mobile its platform is mind-blowing" }, + { "messageId": 3, "authorId": 2, "inResponseTo": 4, "senderLocation": point("48.09,81.01"), "message": " like samsung the plan is amazing" } ] } + +Because this is a fairly common case, a third variant with output identical to the second variant is also possible: + +##### Example + + SELECT uid, msg AS msgs + FROM GleambookMessages message + GROUP BY message.authorId AS uid GROUP AS msgs(message AS msg); + +This variant of the query exploits a bit of SQL-style "syntactic sugar" that SQL++ offers to shorten some user queries. +In particular, in the `SELECT` list, the reference to the `GROUP` variable field `msg` -- because it references a field of the group variable -- is allowed but is "pluralized". As a result, the `msg` reference in the `SELECT` list is +implicitly rewritten into the second variant's `SELECT VALUE` subquery. + +The next example shows a more interesting case involving the use of a subquery in the `SELECT` list. +Here the subquery further processes the groups. + +##### Example + + SELECT uid, + (SELECT VALUE m.msg + FROM msgs m + WHERE m.msg.message LIKE '% like%' + ORDER BY m.msg.messageId + LIMIT 2) AS msgs + FROM GleambookMessages message + GROUP BY message.authorId AS uid GROUP AS msgs(message AS msg); + +This example query returns: + + [ + { "uid": 1, "msgs": [ { "messageId": 8, "authorId": 1, "inResponseTo": 11, "senderLocation": point("40.33,80.87"), "message": " like verizon the 3G is awesome:)" } ] }, + { "uid": 2, "msgs": [ { "messageId": 3, "authorId": 2, "inResponseTo": 4, "senderLocation": point("48.09,81.01"), "message": " like samsung the plan is amazing" }, + { "messageId": 6, "authorId": 2, "inResponseTo": 1, "senderLocation": point("31.5,75.56"), "message": " like t-mobile its platform is mind-blowing" } ] } + ] + +### <a id="Implicit_group_key_variables">Implicit grouping key variables</a> +In the SQL++ syntax, providing named binding variables for `GROUP BY` 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: + + * If the grouping key expression is a variable reference expression, the generated variable gets the same name as the referred variable; + * If the grouping key expression is a field access expression, the generated variable gets the same name as the last identifier in the expression; + * For all other cases, the compiler generates a unique variable (but the user query is unable to refer to this generated variable). + +The next example illustrates a query that doesn't provide binding variables for its grouping key expressions. + +##### Example + + SELECT authorId, + (SELECT VALUE m.msg + FROM msgs m + WHERE m.msg.message LIKE '% like%' + ORDER BY m.msg.messageId + LIMIT 2) AS msgs + FROM GleambookMessages message + GROUP BY message.authorId GROUP AS msgs(message AS msg); + +This query returns: + + [ + { "authorId": 1, "msgs": [ { "messageId": 8, "authorId": 1, "inResponseTo": 11, "senderLocation": point("40.33,80.87"), "message": " like verizon the 3G is awesome:)" } ] }, + { "authorId": 2, "msgs": [ { "messageId": 3, "authorId": 2, "inResponseTo": 4, "senderLocation": point("48.09,81.01"), "message": " like samsung the plan is amazing" }, + { "messageId": 6, "authorId": 2, "inResponseTo": 1, "senderLocation": point("31.5,75.56"), "message": " like t-mobile its platform is mind-blowing" } ] } + ] + +Based on the three variable generation rules, the generated variable for the grouping key expression `message.authorId` +is `authorId` (which is how it is referred to in the example's `SELECT` clause). + +### <a id="Implicit_group_variables">Implicit group variables</a> +The group variable itself is also optional in SQL++'s `GROUP BY` syntax. +If a user's query does not declare the name and structure of the group variable using `GROUP AS`, +the query compiler will generate a unique group variable whose fields include all of the +binding variables defined in the `FROM` clause of the current enclosing `SELECT` statement. +(In this case the user's query will not be able to refer to the generated group variable.) + +##### Example + + SELECT uid, + (SELECT m.message + FROM message m + WHERE m.message LIKE '% like%' + ORDER BY m.messageId + LIMIT 2) AS msgs + FROM GleambookMessages message + GROUP BY message.authorId AS uid; + +This query returns: + + [ + { "uid": 1, "msgs": [ { "message": " like verizon the 3G is awesome:)" } ] }, + { "uid": 2, "msgs": [ { "message": " like samsung the plan is amazing" }, + { "message": " like t-mobile its platform is mind-blowing" } ] } + ] + +Note that in the query above, in principle, `message` is not an in-scope variable in the `SELECT` clause. +However, the query above is a syntactically-sugared simplification of the following query and it is thus +legal, executable, and returns the same result: + + SELECT uid, + (SELECT m.message + FROM (SELECT VALUE grp.message FROM `$1` AS grp) AS m + WHERE m.message LIKE '% like%' + ORDER BY m.messageId + LIMIT 2) AS msgs + FROM GleambookMessages message + GROUP BY message.authorId AS uid GROUP AS `$1` (message AS message); + +### <a id="Aggregation_functions">Aggregation functions</a> +In traditional SQL, which doesn't support nested data, grouping always also involves the use of aggregation +compute properties of the groups (e.g., the average number of messages per user rather than the actual set +of messages per user). +Each aggregation function in SQL++ takes a collection (e.g., 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 +`NULL`/`MISSING` values in the input collection or a completely empty input collection: + +| Function | NULL | MISSING | Empty Collection | +|----------------|--------------|--------------|------------------| +| COLL_COUNT | counted | counted | 0 | +| COLL_SUM | returns NULL | returns NULL | returns NULL | +| COLL_MAX | returns NULL | returns NULL | returns NULL | +| COLL_MIN | returns NULL | returns NULL | returns NULL | +| COLL_AVG | returns NULL | returns NULL | returns NULL | +| COLL_SQL-COUNT | not counted | not counted | 0 | +| COLL_SQL-SUM | ignores NULL | ignores NULL | returns NULL | +| COLL_SQL-MAX | ignores NULL | ignores NULL | returns NULL | +| COLL_SQL-MIN | ignores NULL | ignores NULL | returns NULL | +| COLL_SQL-AVG | ignores NULL | ignores NULL | returns NULL | + +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 `UNKNOWN` 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. + +##### Example + + COLL_AVG( + ( + SELECT VALUE len(friendIds) FROM GleambookUsers + ) + ); + +This example returns: + + 3.3333333333333335 + +##### Example + + SELECT uid AS uid, COLL_COUNT(grp) AS msgCnt + FROM GleambookMessages message + GROUP BY message.authorId AS uid GROUP AS grp(message AS msg); + +This query returns: + + [ + { "uid": 1, "msgCnt": 5 }, + { "uid": 2, "msgCnt": 2 } + ] + +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 `COLL_COUNT` to get the cardinality of each +group of messages. + +### <a id="SQL-92_aggregation_functions">SQL-92 aggregation functions</a> +For compatibility with the traditional SQL aggregation functions, SQL++ also offers SQL-92's +aggregation function symbols (`COUNT`, `SUM`, `MAX`, `MIN`, and `AVG`) 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: + +##### Example + + SELECT uid, COUNT(msg) AS msgCnt + FROM GleambookMessages msg + GROUP BY msg.authorId AS uid; + +It is important to realize that `COUNT` is actually **not** a SQL++ built-in aggregation function. +Rather, the `COUNT` query above is using a special "sugared" function symbol that the SQL++ compiler +will rewrite as follows: + + SELECT uid AS uid, `COLL_SQL-COUNT`( (SELECT g.msg FROM `$1` as g) ) AS msgCnt + FROM GleambookMessages msg + GROUP BY msg.authorId AS uid GROUP AS `$1`(msg AS msg); + +> TW: We really need to do something about `COLL_SQL-COUNT`. +> MC: You mean about its name? And inconsistent dashing? I agree...! :-) +> Also, do we need to say anything about the (mandatory) double parens here? + +The same sort of rewritings apply to the function symbols `SUM`, `MAX`, `MIN`, and `AVG`. +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). + +### <a id="SQL-92_compliant_gby">SQL-92 compliant GROUP BY aggregations</a> +SQL++ provides full support for SQL-92 `GROUP BY` aggregation queries. +The following query is such an example: + +##### Example + + SELECT msg.authorId, COUNT(msg) + FROM GleambookMessages msg + GROUP BY msg.authorId; + +This query outputs: + + [ + { "authorId": 1, "$1": 5 }, + { "authorId": 2, "$1": 2 } + ] + +In principle, a `msg` reference in the query's `SELECT` clause would be "sugarized" as a collection +(as described in [Implicit group variables](#Implicit_group_variables)). +However, since the SELECT expression `msg.authorId` 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: + + SELECT authorId AS authorId, COLL_COUNT( (SELECT g.msg FROM `$1` AS g) ) + FROM GleambookMessages msg + GROUP BY msg.authorId AS authorId GROUP AS `$1`(msg AS msg); + +### <a id="Column_aliases">Column aliases</a> +SQL++ also allows column aliases to be used as `GROUP BY` keys or `ORDER BY` keys. + +##### Example + + SELECT msg.authorId AS aid, COUNT(msg) + FROM GleambookMessages msg + GROUP BY aid; + +This query returns: + + [ + { "aid": 1, "$1": 5 }, + { "aid": 2, "$1": 2 } + ] + +## <a id="Where_having_clauses">WHERE clauses and HAVING clauses</a> +Both `WHERE` clauses and `HAVING` clauses are used to filter input data based on a condition expression. +Only tuples for which the condition expression evaluates to `TRUE` are propagated. +Note that if the condition expression evaluates to `NULL` or `MISSING` the input tuple will be disgarded. + +## <a id="Order_By_clauses">ORDER BY clauses</a> +The `ORDER BY` clause is used to globally sort data in either ascending order (i.e., `ASC`) or descending order (i.e., `DESC`). +During ordering, `MISSING` and `NULL` are treated as being smaller than any other value if they are encountered +in the ordering key(s). `MISSING` is treated as smaller than `NULL` if both occur in the data being sorted. +The following example returns all `GleambookUsers` ordered by their friend numbers. + +##### Example + + SELECT VALUE user + FROM GleambookUsers AS user + ORDER BY len(user.friendIds) DESC; + +This query returns: + + [ + { "id": 1, "alias": "Margarita", "name": "MargaritaStoddard", "userSince": datetime("2012-08-20T10:10:00.000Z"), "friendIds": {{ 2, 3, 6, 10 }}, "employment": [ { "organizationName": "Codetechno", "startDate": date("2006-08-06") }, { "organizationName": "geomedia", "startDate": date("2010-06-17"), "endDate": date("2010-01-26") } ], "nickname": "Mags", "gender": "F" }, + { "id": 3, "alias": "Emory", "name": "EmoryUnk", "userSince": datetime("2012-07-10T10:10:00.000Z"), "friendIds": {{ 1, 5, 8, 9 }}, "employment": [ { "organizationName": "geomedia", "startDate": date("2010-06-17"), "endDate": date("2010-01-26") } ] } + { "id": 2, "alias": "Isbel", "name": "IsbelDull", "userSince": datetime("2011-01-22T10:10:00.000Z"), "friendIds": {{ 1, 4 }}, "employment": [ { "organizationName": "Hexviafind", "startDate": date("2010-04-27") } ], "nickname": "Izzy" } + ] + +## <a id="Limit_clauses">LIMIT clauses</a> +The `LIMIT` clause is used to limit the result set to a specified constant size. +The use of the `LIMIT` clause is illustrated in the next example. + +##### Example + + SELECT VALUE user + FROM GleambookUsers AS user + ORDER BY len(user.friendIds) DESC + LIMIT 1; + +This query returns: + + [ + { "id": 1, "alias": "Margarita", "name": "MargaritaStoddard", "userSince": datetime("2012-08-20T10:10:00.000Z"), "friendIds": {{ 2, 3, 6, 10 }}, "employment": [ { "organizationName": "Codetechno", "startDate": date("2006-08-06") }, { "organizationName": "geomedia", "startDate": date("2010-06-17"), "endDate": date("2010-01-26") } ], "nickname": "Mags", "gender": "F" } + ] + +## <a id="With_clauses">WITH clauses</a> +As in standard SQL, `WITH` clauses are available to improve the modularity of a query. +The next query shows an example. + +##### Example + + WITH avgFriendCount AS ( + SELECT VALUE AVG(LEN(user.friendIds)) + FROM GleambookUsers AS user + )[0] + SELECT VALUE user + FROM GleambookUsers user + WHERE LEN(user.friendIds) > avgFriendCount; + +This query returns: + + [ + { "id": 1, "alias": "Margarita", "name": "MargaritaStoddard", "userSince": datetime("2012-08-20T10:10:00.000Z"), "friendIds": {{ 2, 3, 6, 10 }}, "employment": [ { "organizationName": "Codetechno", "startDate": date("2006-08-06") }, { "organizationName": "geomedia", "startDate": date("2010-06-17"), "endDate": date("2010-01-26") } ], "nickname": "Mags", "gender": "F" }, + { "id": 3, "alias": "Emory", "name": "EmoryUnk", "userSince": datetime("2012-07-10T10:10:00.000Z"), "friendIds": {{ 1, 5, 8, 9 }}, "employment": [ { "organizationName": "geomedia", "startDate": date("2010-06-17"), "endDate": date("2010-01-26") } ] } + ] + +The query is equivalent to the following, more complex, inlined form of the query: + + SELECT * + FROM GleambookUsers user + WHERE LEN(user.friendIds) > + ( SELECT VALUE AVG(LEN(user.friendIds)) + FROM GleambookUsers AS user + ) [0]; + +WITH can be particularly useful when a value needs to be used several times in a query. + +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 +a list-valued query expression's result; this is needed above, even though the result is a list of one +element, to "de-listify" the list and obtain the desired scalar for the comparison. + +## <a id="Let_clauses">LET clauses</a> +Similar to `WITH` clauses, `LET` clauses can be useful when a (complex) expression is used several times in a query, such that the query can be more concise. The next query shows an example. + +##### Example + + 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; + +This query lists `GleambookUsers` that have posted `GleambookMessages` and shows all authored messages for each listed user. It returns: + + [ + { "messages": [ { "messageId": 8, "authorId": 1, "inResponseTo": 11, "senderLocation": point("40.33,80.87"), "message": " like verizon the 3G is awesome:)" }, { "messageId": 10, "authorId": 1, "inResponseTo": 12, "senderLocation": point("42.5,70.01"), "message": " can't stand motorola the touch-screen is terrible" }, { "messageId": 11, "authorId": 1, "inResponseTo": 1, "senderLocation": point("38.97,77.49"), "message": " can't stand at&t its plan is terrible" }, { "messageId": 2, "authorId": 1, "inResponseTo": 4, "senderLocation": point("41.66,80.87"), "message": " dislike iphone its touch-screen is horrible" }, { "messageId": 4, "authorId": 1, "inResponseTo": 2, "senderLocation": point("37.73,97.04"), "message": " can't stand at&t the network is horrible:(" } ], "uname": "MargaritaStoddard" }, + { "messages": [ { "messageId": 6, "authorId": 2, "inResponseTo": 1, "senderLocation": point("31.5,75.56"), "message": " like t-mobile its platform is mind-blowing" }, { "messageId": 3, "authorId": 2, "inResponseTo": 4, "senderLocation": point("48.09,81.01"), "message": " like samsung the plan is amazing" } ], "uname": "IsbelDull" } + ] + +This query is equivalent to the following query that does not use the `LET` clause: + + 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 + ); + +## <a id="Union_all">UNION ALL</a> +UNION ALL can be used to combine two input streams into one. Similar to SQL, there is no ordering guarantee on the output stream. However, different from SQL, SQL++ does not inspect what the data looks like on each input stream and allows heterogenity on the output stream and does not enforce schema change on any input streams. The following query is an example: + +##### Example + + SELECT u.name AS uname + FROM GleambookUsers u + WHERE u.id = 2 + UNION ALL + SELECT VALUE m.message + FROM GleambookMessages m + WHERE authorId=2; + +This query returns: + + [ + " like t-mobile its platform is mind-blowing", + " like samsung the plan is amazing", + { "uname": "IsbelDull" } + ] + +## <a id="Subqueries">Subqueries</a> +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 a list of up to two "dislike" messages per user. + +##### Example + + 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); + +For our sample data set, this query returns: + + [ + { "uid": 1, "msgs": [ { "messageId": 2, "authorId": 1, "inResponseTo": 4, "senderLocation": point("41.66,80.87"), "message": " dislike iphone its touch-screen is horrible" } ] }, + { "uid": 2, "msgs": [ ] } + ] + +Note that a subquery, like a top-level `SELECT` 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. + +## <a id="Vs_SQL-92">SQL++ vs. SQL-92</a> +The following matrix is a quick "key differences cheat sheet" for SQL++ and SQL-92. + +| Feature | SQL++ | SQL-92 | +|----------|--------|--------| +| SELECT * | Returns nested records. | Returns flattened concatenated records. | +| Subquery | Returns a collection. | The returned collection of records is cast into a scalar value if the subquery appears in a SELECT list or on one side of a comparison or as input to a function. | +| Left outer join | Fills in `MISSING` for non-matches. | Fills in `NULL`(s) for non-matches. | +| Union All | Allows heterogenous input and does not enforce schema changes on data. | Different input streams have to follow equivalent structural types and output field names for non-first input streams have to be be changed to be the same as that of the first input stream. +| String literal | Double quotes or single quotes. | Single quotes only. | +| Delimited identifiers | Backticks. | Double quotes. | + +For things beyond the cheat sheet, SQL++ is SQL-92 compliant. +Morever, SQL++ offers the following additional features beyond SQL-92 (hence the "++" in its name): + + * Fully composable and functional: A subquery can iterate over any intermediate collection and can appear anywhere in a query. + * Schema-free: The query language does not assume the existence of a fixed schema for any data it processes. + * Correlated FROM terms: A right-side FROM term expression can refer to variables defined by FROM terms on its left. + * Powerful GROUP BY: In addition to a set of aggregate functions as in standard SQL, the groups created by the `GROUP BY` clause are directly usable in nested queries and/or to obtain nested results. + * Generalized SELECT clause: A SELECT clause can return any type of collection, while in SQL-92, a `SELECT` clause has to return a (homogeneous) collection of records. + diff --git a/asterixdb/asterix-doc/src/main/markdown/sqlpp/4_ddl.md b/asterixdb/asterix-doc/src/main/markdown/sqlpp/4_ddl.md new file mode 100644 index 0000000..9dc6947 --- /dev/null +++ b/asterixdb/asterix-doc/src/main/markdown/sqlpp/4_ddl.md @@ -0,0 +1,452 @@ +# <a id="DDL_and_DML_statements">4. DDL and DML statements</a> + + Statement ::= ( SingleStatement ( ";" )? )* <EOF> + SingleStatement ::= DatabaseDeclaration + | FunctionDeclaration + | CreateStatement + | DropStatement + | LoadStatement + | SetStatement + | InsertStatement + | DeleteStatement + | Query ";" + +In addition to queries, the AsterixDB implementation of SQL++ supports 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 in Apache AsterixDB. + +> TW: AsterixDB? +> MC: Good question here - I eradicated the preceding references except in the Intro, which needs a rewrite, but here it is really still about AsterixDB, I think? (Since most of these statements will be hidden in the Couchbase case?) + +## <a id="Declarations">Declarations</a> + + DatabaseDeclaration ::= "USE" Identifier + +The world of data in an AsterixDB instance is organized into data namespaces called **dataverses**. +To set the default dataverse for a series of statements, the USE statement is provided in SQL++. + +As an example, the following statement sets the default dataverse to be "TinySocial". + +##### Example + + USE TinySocial; + +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. + + FunctionDeclaration ::= "DECLARE" "FUNCTION" Identifier ParameterList "{" Expression "}" + ParameterList ::= "(" ( <VARIABLE> ( "," <VARIABLE> )* )? ")" + +The following is a simple example of a temporary SQL++ function definition and its use. + +##### Example + + 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); + +For our sample data set, this returns: + + [ + { "id": 2, "name": "IsbelDull", "friendCount": 2 } + + ] + +## <a id="Lifecycle_management_statements">Lifecycle management statements</a> + + CreateStatement ::= "CREATE" ( DatabaseSpecification + | TypeSpecification + | DatasetSpecification + | IndexSpecification + | FunctionSpecification ) + + QualifiedName ::= Identifier ( "." Identifier )? + DoubleQualifiedName ::= Identifier "." Identifier ( "." Identifier )? + +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. + +### <a id="Dataverses"> Dataverses</a> + + DatabaseSpecification ::= "DATAVERSE" Identifier IfNotExists ( "WITH" "FORMAT" StringLiteral )? + +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. +(Note: The `WITH FORMAT` clause in the syntax above is a placeholder for possible `future functionality +that can safely be ignored here.) + +> MC: Should we get rid of WITH FORMAT? (I think we should - here and in the system - if we ever do it +I would actually expect it to be more fine-grained than the dataverse level.) + +The following example creates a new dataverse named TinySocial if one does not already exist. + +##### Example + + CREATE DATAVERSE TinySocial IF NOT EXISTS; + +### <a id="Types"> Types</a> + + TypeSpecification ::= "TYPE" FunctionOrTypeName IfNotExists "AS" TypeExpr + FunctionOrTypeName ::= QualifiedName + IfNotExists ::= ( <IF> <NOT> <EXISTS> )? + TypeExpr ::= RecordTypeDef | TypeReference | OrderedListTypeDef | UnorderedListTypeDef + RecordTypeDef ::= ( <CLOSED> | <OPEN> )? "{" ( RecordField ( "," RecordField )* )? "}" + RecordField ::= Identifier ":" ( TypeExpr ) ( "?" )? + NestedField ::= Identifier ( "." Identifier )* + IndexField ::= NestedField ( ":" TypeReference )? + TypeReference ::= Identifier + OrderedListTypeDef ::= "[" ( TypeExpr ) "]" + UnorderedListTypeDef ::= "{{" ( TypeExpr ) "}}" + +> TW: How should we refer to the data model? "Asterix Data Model" seems system specific. +> MC: Agreed that this is an issue. Let's first decide and I can handle the issue in a later pass. + +The CREATE TYPE statement is used to create a new named ADM datatype. +This type can then be used to create stored collections or utilized when defining one or more other ADM datatypes. +Much more information about the Asterix Data Model (ADM) is available in the [data model reference guide](datamodel.html) to ADM. +A new type can be a record type, a renaming of another type, an ordered list type, or an unordered list type. +A record type can be defined as being either open or closed. +Instances of a closed record type are not permitted to contain fields other than those specified in the create type statement. +Instances of an open record type may carry additional fields, and open is the default for new types if neither option is specified. + +> MC: I had forgotten about options other than using CREATE TYPE to introduce new record types! (Are all of the other AS TypeExpr possibilities actually well-tested?) + +The following example creates a new ADM record 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 an unordered list of integers. +The employment field is an ordered list of instances of another named record type, EmploymentType. + +##### Example + + CREATE TYPE GleambookUserType AS { + id: int, + alias: string, + name: string, + userSince: datetime, + friendIds: {{ int }}, + employment: [ EmploymentType ] + }; + +The next example creates a new ADM record 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.) + +##### Example + + CREATE TYPE MyUserTupleType AS CLOSED { + id: uuid, + alias: string?, + name: string + }; + +### <a id="Datasets"> Datasets</a> + + 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 + +> TW: Again, a lot of AsterixDB in the following paragraph. +> Also, while I'm sure that this was always like this, the separation of `Configuration` +> from `Properties` looks pretty confusing ... +> MC: Not sure what we should do about all this, actually! (I don't disagree. New JSON syntax coming, too?) + +The CREATE DATASET statement is used to create a new dataset. +Datasets are named, unordered collections of ADM record 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 records. +(The primary key is also used in secondary indexes to identify the indexed primary data records.) + +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 record's primary key field value will be auto-generated by the system. + +> TW: "The Filter-Based LSM Index Acceleration" seems to be quite system specific ... +> MC: Indeed, but that is always inescapable in DDL reference manuals, no? (We have to decide what to say where. :-)) + +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. +(AsterixDB supports Log-Structured Merge tree based physical storage for Internal datasets.) +Apache AsterixDB currently 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 default policy for AsterixDB is the prefix policy except when there is a filter on a dataset, where the preferred policy for filters is the correlated-prefix. + +Another advanced option shown in the syntax above, related to performance and mentioned above, is that a **filter** 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 [Filter-Based LSM Index Acceleration](filters.html) for more information about filters.) + +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 in AsterixDB. +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 (e.g., 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 [Guide to External Data](externaldata.html) for more information on the available adapters.) + +The following example creates an Internal dataset for storing FacefookUserType records. +It specifies that their id field is their primary key. + +#### Example + + CREATE INTERNAL DATASET GleambookUsers(GleambookUserType) PRIMARY KEY id; + +The next example creates another Internal dataset (the default kind when no dataset kind is specified) for storing MyUserTupleType records. +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 record 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. + +#### Example + + CREATE DATASET MyUsers(MyUserTupleType) PRIMARY KEY id AUTOGENERATED; + +The next example creates an External dataset for querying LineItemType records. +The choice of the `hdfs` 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. + +#### Example + + CREATE EXTERNAL DATASET LineItem(LineItemType) USING hdfs ( + ("hdfs"="hdfs://HOST:PORT"), + ("path"="HDFS_PATH"), + ("input-format"="text-input-format"), + ("format"="delimited-text"), + ("delimiter"="|")); + + + +#### Indices + + IndexSpecification ::= <INDEX> Identifier IfNotExists <ON> QualifiedName + "(" ( IndexField ) ( "," IndexField )* ")" ( "type" IndexType "?")? + ( <ENFORCED> )? + IndexType ::= <BTREE> | <RTREE> | <KEYWORD> | <NGRAM> "(" IntegerLiteral ")" + +The CREATE INDEX statement creates a secondary index on one or more fields of a specified dataset. +Supported index types include `BTREE` for totally ordered datatypes, `RTREE` for spatial data, +and `KEYWORD` and `NGRAM` 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. + +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 **and** if the field's type is provided along with its name and if the `ENFORCED` keyword is +specified at the end of the index definition. +`ENFORCING` an open field introduces a check that makes sure that the actual type of the indexed field +(if the optional field exists in the record) always matches this specified (open) field type. + +*Editor's note: The ? shown above after the type is intended to be mandatory, and we need to make that happen.* + +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. + +#### Example + + CREATE INDEX gbAuthorIdx ON GleambookMessages(authorId) TYPE BTREE; + +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. + +#### Example + + CREATE INDEX gbSendTimeIdx ON GleambookMessages(sendTime: datetime?) TYPE BTREE ENFORCED; + +> MC: The above works in my branch (with ? mandatory) but not in the main branch. We need to change that. :-) + +The following example creates a btree index called crpUserScrNameIdx on screenName, +a nested field residing within a record-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) a list-valued field. + +#### Example + + CREATE INDEX crpUserScrNameIdx ON ChirpMessages(user.screenName) TYPE BTREE; + +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 [`spatial-intersect` function](functions.html#spatial-intersect) in a predicate involving the sender-location field. + +#### Example + + CREATE INDEX gbSenderLocIndex ON GleambookMessages("sender-location") TYPE RTREE; + +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 [similarity queries](similarity.html#NGram_Index). + +#### Example + + CREATE INDEX fbUserIdx ON GleambookUsers(name) TYPE NGRAM(3); + +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 [similarity queries](similarity.html#Keyword_Index). + +#### Example + + CREATE INDEX fbMessageIdx ON GleambookMessages(message) TYPE KEYWORD; + +### <a id="Functions"> Functions</a> + +The create function statement creates a **named** 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. + + FunctionSpecification ::= "FUNCTION" FunctionOrTypeName IfNotExists ParameterList "{" Expression "}" + +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). + +##### Example + + CREATE FUNCTION friendInfo(userId) { + (SELECT u.id, u.name, len(u.friendIds) AS friendCount + FROM GleambookUsers u + WHERE u.id = userId)[0] + }; + +#### Removal + + DropStatement ::= "DROP" ( "DATAVERSE" Identifier IfExists + | "TYPE" FunctionOrTypeName IfExists + | "DATASET" QualifiedName IfExists + | "INDEX" DoubleQualifiedName IfExists + | "FUNCTION" FunctionSignature IfExists ) + IfExists ::= ( "IF" "EXISTS" )? + +The DROP statement in SQL++ is the inverse of the CREATE statement. It can be used to drop dataverses, datatypes, datasets, indexes, and functions. + +The following examples illustrate some uses of the DROP statement. + +##### Example + + DROP DATASET GleambookUsers IF EXISTS; + + DROP INDEX GleambookMessages.gbSenderLocIndex; + + DROP TYPE TinySocial2.GleambookUserType; + + DROP FUNCTION friendInfo@1; + + DROP DATAVERSE TinySocial; + +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. +(`friendInfo@1` above denotes the 1-argument function named friendInfo in the current dataverse.) + +### Import/Export Statements + + LoadStatement ::= <LOAD> <DATASET> QualifiedName <USING> AdapterName Configuration ( <PRE-SORTED> )? + +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 [guide to external data](externaldata.html) 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. + +The following example shows how to bulk load the GleambookUsers dataset from an external file containing data that has been prepared in ADM format. + +##### Example + + LOAD DATASET GleambookUsers USING localfs + (("path"="127.0.0.1:///Users/bignosqlfan/tinysocialnew/gbu.adm"),("format"="adm")); + +## <a id="Modification_statements">Modification statements</a> + +### <a id="Inserts">INSERTs</a> + + InsertStatement ::= <INSERT> <INTO> QualifiedName Query + +> TW: AsterixDB-specifc transactions semantics ... +> Also, do we also support `UPSERT`? +> MC: Yes to both. :-) Whoops. Wait, maybe not. We do have upsert in AQL, but not in SQL++ today, it seems. I'll document it anyway...? :-) + +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 record 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. + +In AsterixDB, inserts are processed transactionally. +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. + +##### Example + + INSERT INTO UsersCopy (SELECT VALUE user FROM GleambookUsers user) + +### <a id="Upserts">UPSERTs</a> + + UpsertStatement ::= <UPSERT> <INTO> QualifiedName Query + +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. + +The following example illustrates a query-based upsert operation. + +##### Example + + UPSERT INTO UsersCopy (SELECT VALUE user FROM GleambookUsers user) + +*Editor's note: Upserts currently work in AQL but are apparently disabled at the moment in SQL++. +(@Yingyi, is that indeed the case?)* + +### <a id="Deletes">DELETEs</a> + + DeleteStatement ::= <DELETE> <FROM> QualifiedName ( (<AS>)? Variable )? ( <WHERE> Expression )? + +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. + +Deletes in AsterixDB are processed transactionally. +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. + +The following examples illustrate single-object deletions. + +##### Example + + DELETE FROM GleambookUsers user WHERE user.id = 8; + +##### Example + + DELETE FROM GleambookUsers WHERE id = 5; + -- To view, visit https://asterix-gerrit.ics.uci.edu/1156 To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings Gerrit-MessageType: merged Gerrit-Change-Id: I234164c7b9fe834041feaa54482c505a697e92d8 Gerrit-PatchSet: 3 Gerrit-Project: asterixdb Gerrit-Branch: master Gerrit-Owner: Till Westmann <[email protected]> Gerrit-Reviewer: Jenkins <[email protected]> Gerrit-Reviewer: Till Westmann <[email protected]> Gerrit-Reviewer: Yingyi Bu <[email protected]>
