[
https://issues.apache.org/jira/browse/BEAM-6916?focusedWorklogId=240322&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-240322
]
ASF GitHub Bot logged work on BEAM-6916:
----------------------------------------
Author: ASF GitHub Bot
Created on: 10/May/19 16:47
Start Date: 10/May/19 16:47
Worklog Time Spent: 10m
Work Description: melap commented on pull request #8455: [BEAM-6916]
Reorg Beam SQL docs and add Calcite section
URL: https://github.com/apache/beam/pull/8455#discussion_r282677350
##########
File path: website/src/documentation/dsls/sql/calcite/overview.md
##########
@@ -0,0 +1,85 @@
+---
+layout: section
+title: "Beam SQL in Calcite: Overview"
+section_menu: section-menu/sdks.html
+permalink: /documentation/dsls/sql/calcite/overview/
+---
+<!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+# Beam SQL in Calcite: Overview
+
+[Apache Calcite](http://calcite.apache.org) is a widespread SQL dialect used in
+big data processing with some streaming enhancements. Calcite provides the
+basic dialect underlying Beam SQL.
+
+The following table summarizes Apache Calcite operators and functions
supported by Beam SQL.
+
+<table class="table-bordered table-striped">
+ <tr><th>Operators and functions</th><th>Beam SQL support status</th></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#operator-precedence";>Operator
precedence</a></td><td>Yes</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#comparison-operators";>Comparison
operators</a></td><td class="style1">Yes</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#logical-operators";>Logical
operators</a></td><td>Yes</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#arithmetic-operators-and-functions";>Arithmetic
operators and functions</a></td><td>Yes</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#character-string-operators-and-functions";>Character
string operators and functions</a></td><td>Yes</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#binary-string-operators-and-functions";>Binary
string operators and functions</a></td><td>No</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#datetime-functions";>Date/time
functions</a></td><td>Yes</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#system-functions";>System
functions</a></td><td>No</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#conditional-functions-and-operators";>Conditional
functions and operators</a></td><td>Yes</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#type-conversion";>Type
conversion</a></td><td>Yes</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#value-constructors";>Value
constructors</a></td><td>No, except array</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#collection-functions";>Collection
functions</a></td><td>No</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#period-predicates";>Period
predicates</a></td><td>No</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#jdbc-function-escape";>JDBC
function escape</a></td><td>No</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#aggregate-functions";>Aggregate
functions</a></td>
+<td>Use Beam SQL <a
href="https://beam.apache.org/documentation/dsls/sql/calcite/aggregate-functions/";>aggregate
functions</a></td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#window-functions";>Window
functions</a></td><td>No</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#grouping-functions";>Grouping
functions</a></td><td>No</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#grouped-window-functions";>Grouped
window functions</a></td><td>Use Beam SQL <a
href="https://beam.apache.org/documentation/dsls/sql/windowing-and-triggering/";>windowing
and triggering</a></td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#grouped-auxiliary-functions";>Grouped
auxiliary functions</a></td><td>Yes, except SESSION_END</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#spatial-functions";>Spatial
functions</a></td><td>No</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#geometry-creation-functions-3d";>Geometry
creation functions (3D)</a></td><td>No</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#geometry-predicates";>Geometry
predicates</a></td><td>No</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#json-functions";>JSON
functions</a></td><td>No</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#user-defined-functions";>User-defined
functions</a></td>
+<td>Use Beam SQL <a
href="https://beam.apache.org/documentation/dsls/sql/user-defined-functions/";>user-defined
functions</a>. You cannot call functions with <a
href="http://calcite.apache.org/docs/reference.html#calling-functions-with-named-and-optional-parameters";>named
and optional parameters</a>.</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#match_recognize";>MATCH_RECOGNIZE</a></td><td>No</td></tr>
+<tr><td><a
href="http://calcite.apache.org/docs/reference.html#ddl-extensions";>DDL
Extensions</a></td><td>Use Beam SQL <a
href="https://beam.apache.org/documentation/dsls/sql/create-external-table/";>CREATE
EXTERNAL TABLE</a></td></tr>
+</table>
+
+We have added additional extensions to
+make it easy to leverage Beam's unified batch/streaming model and support
+for complex data types.
+
+## Query syntax
+Query statements scan one or more tables or expressions and return the
computed result rows.
+The [Query syntax]({{ site.baseurl
+}}/documentation/dsls/sql/calcite/query-syntax) page describes Beam SQL's
syntax for queries when using Apache Calcite.
+
+## Data types
+Beam SQL supports standard SQL scalar data types as well as extensions
including arrays, maps, and nested rows.
+Read about supported [data types]({{ site.baseurl
+}}/documentation/dsls/sql/calcite/data-types) in Beam SQL when using Apache
Calcite.
+
+## Lexical structure
+A Beam SQL statement comprises a series of tokens.
+The [Lexical structure]({{ site.baseurl
+}}/documentation/dsls/sql/calcite/lexical) page documents Beam SQL's lexical
structure when using Apache Calcite.
+
+## Scalar functions
+Read about built-in [scalar functions]({{ site.baseurl
+}}/documentation/dsls/sql/calcite/scalar-functions) supported by Beam SQL when
using Apache Calcite.
+
+## Aggregate functions
Review comment:
since this is listed in the above functions table, might not need this
section
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 240322)
Time Spent: 2h 10m (was: 2h)
Remaining Estimate: 165h 50m (was: 166h)
> Reorganize Beam SQL docs
> ------------------------
>
> Key: BEAM-6916
> URL: https://issues.apache.org/jira/browse/BEAM-6916
> Project: Beam
> Issue Type: New Feature
> Components: website
> Reporter: Rose Nguyen
> Assignee: Rose Nguyen
> Priority: Minor
> Original Estimate: 168h
> Time Spent: 2h 10m
> Remaining Estimate: 165h 50m
>
> This page describes the Calcite SQL dialect supported by Beam SQL.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
