[
https://issues.apache.org/jira/browse/BEAM-7939?focusedWorklogId=326667&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-326667
]
ASF GitHub Bot logged work on BEAM-7939:
----------------------------------------
Author: ASF GitHub Bot
Created on: 11/Oct/19 02:14
Start Date: 11/Oct/19 02:14
Worklog Time Spent: 10m
Work Description: kennknowles commented on pull request #9306:
[BEAM-7939] ZetaSQL dialect documentation
URL: https://github.com/apache/beam/pull/9306#discussion_r333802917
##########
File path: website/src/documentation/dsls/sql/zetasql/overview.md
##########
@@ -0,0 +1,67 @@
+---
+layout: section
+title: "Beam ZetaSQL overview"
+section_menu: section-menu/sdks.html
+permalink: /documentation/dsls/sql/zetasql/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 ZetaSQL overview
+Beam SQL supports a varient of the
[ZetaSQL](https://github.com/google/zetasql) language. ZetaSQL is similar to
the language in BigQuery's SQL framework. This Beam SQL dialect is especially
useful in pipelines that [write to or read from BigQuery
tables](https://beam.apache.org/releases/javadoc/current/org/apache/beam/sdk/io/gcp/bigquery/BigQueryIO.html).
+
+Beam SQL has additional extensions leveraging Beam’s unified batch/streaming
model and processing complex data types. You can use these extensions with all
Beam SQL dialects, including Beam ZetaSQL.
+
+## Query syntax
+Query statements scan tables or expressions and return the computed result
rows. For more information about query statements in Beam ZetaSQL, see the
[Query syntax]({{ site.baseurl
+}}/documentation/dsls/sql/zetasql/query-syntax) reference and [Function call
rules]({{ site.baseurl
+}}/documentation/dsls/sql/zetasql/syntax).
+
+## Lexical structure
+A Beam SQL statement comprises a series of tokens. For more information about
tokens in Beam ZetaSQL, see the [Lexical structure]({{ site.baseurl
+}}/documentation/dsls/sql/zetasql/lexical) reference.
+
+## Data types
+Beam SQL supports standard SQL scalar data types as well as extensions
including arrays, maps, and nested rows. For more information about scalar data
in Beam ZetaSQL, see the [Data types]({{ site.baseurl
}}/documentation/dsls/sql/zetasql/data-types) reference.
+
+## Functions and operators
+The following table summarizes the [ZetaSQL functions and
operators](https://github.com/google/zetasql/blob/master/docs/functions-and-operators.md)
supported by Beam ZetaSQL.
+<table class="table-bordered table-striped">
+ <tr><th>Operators and functions</th><th>Beam ZetaSQL support</th></tr>
+ <tr><td><a
href="https://github.com/google/zetasql/blob/master/docs/conversion_rules.md";>Type
conversion</a></td><td>Yes</td></tr>
+ <tr><td><a
href="https://github.com/google/zetasql/blob/master/docs/aggregate_functions.md";>Aggregate
functions</a></td><td>See Beam SQL <a href="{{ site.baseurl
}}/documentation/dsls/sql/zetasql/aggregate-functions">aggregate
functions</a></td></tr>
Review comment:
Since "Beam SQL" is ambiguous and maybe also redundant, maybe just "See
aggregate functions", etc. The context makes clear that it is ZetaSQL.
----------------------------------------------------------------
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: 326667)
Time Spent: 2h 40m (was: 2.5h)
> Document ZetaSQL dialect in Beam SQL
> ------------------------------------
>
> Key: BEAM-7939
> URL: https://issues.apache.org/jira/browse/BEAM-7939
> Project: Beam
> Issue Type: Improvement
> Components: website
> Reporter: Cyrus Maden
> Assignee: Cyrus Maden
> Priority: Major
> Time Spent: 2h 40m
> Remaining Estimate: 0h
>
> Blocked by BEAM-7832. ZetaSQL dialect source will be merged from #9210.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
