[SPARK-28734][DOC] Initial table of content in the left hand side bar…

… for SQL doc ## What changes were proposed in this pull request? This is a initial PR that creates the table of content for SQL reference guide. The left side bar will displays additional menu items corresponding to supported SQL constructs. One this PR is merged, we will fill in the content incrementally. Additionally this PR contains a minor change to make the left sidebar scrollable. Currently it is not possible to scroll in the left hand side window. ## How was this patch tested? Used jekyll build and serve to verify. Closes #25459 from dilipbiswal/ref-doc. Authored-by: Dilip Biswal <dbiswal@us.ibm.com> Signed-off-by: gatorsmile <gatorsmile@gmail.com>
apache · Aug 19, 2019 · a5df5ff · a5df5ff
1 parent d75a11d
commit a5df5ff
Show file tree

Hide file tree

Showing 74 changed files with 1,781 additions and 33 deletions.
diff --git a/docs/_data/menu-sql.yaml b/docs/_data/menu-sql.yaml
@@ -72,12 +72,164 @@
       url: sql-migration-guide-hive-compatibility.html
     - text: SQL Reserved/Non-Reserved Keywords
       url: sql-reserved-and-non-reserved-keywords.html
-- text: Reference
-  url: sql-reference.html
+
+- text: SQL Reference
+  url: sql-ref.html
   subitems:
     - text: Data Types
-      url: sql-reference.html#data-types
+      url: sql-ref-datatypes.html
     - text: NaN Semantics
-      url: sql-reference.html#nan-semantics
-    - text: Arithmetic operations
-      url: sql-reference.html#arithmetic-operations
+      url: sql-ref-nan-semantics.html
+    - text: SQL Syntax
+      url: sql-ref-syntax.html
+      subitems:
+        - text: Data Definition Statements
+          url: sql-ref-syntax-ddl.html
+          subitems:
+            - text: ALTER DATABASE
+              url: sql-ref-syntax-ddl-alter-database.html
+            - text: ALTER TABLE
+              url: sql-ref-syntax-ddl-alter-table.html
+            - text: ALTER VIEW
+              url: sql-ref-syntax-ddl-alter-view.html
+            - text: CREATE DATABASE
+              url: sql-ref-syntax-ddl-create-database.html
+            - text: CREATE FUNCTION
+              url: sql-ref-syntax-ddl-create-function.html
+            - text: CREATE TABLE
+              url: sql-ref-syntax-ddl-create-table.html
+            - text: CREATE VIEW
+              url: sql-ref-syntax-ddl-create-view.html
+            - text: DROP DATABASE
+              url: sql-ref-syntax-ddl-drop-database.html
+            - text: DROP FUNCTION
+              url: sql-ref-syntax-ddl-drop-function.html
+            - text: DROP TABLE
+              url: sql-ref-syntax-ddl-drop-table.html
+            - text: DROP VIEW
+              url: sql-ref-syntax-ddl-drop-view.html
+            - text: TRUNCATE TABLE
+              url: sql-ref-syntax-ddl-truncate-table.html
+            - text: REPAIR TABLE
+              url: sql-ref-syntax-ddl-repair-table.html
+        - text: Data Manipulation Statements
+          url: sql-ref-syntax-dml.html
+          subitems:
+            - text: INSERT
+              url: sql-ref-syntax-dml-insert.html
+            - text: LOAD
+              url: sql-ref-syntax-dml-load.html
+        - text: Data Retrieval(Queries)
+          url: sql-ref-syntax-qry.html
+          subitems:
+            - text: SELECT 
+              url: sql-ref-syntax-qry-select.html 
+              subitems:
+                - text: DISTINCT Clause
+                  url: sql-ref-syntax-qry-select-distinct.html
+                - text: Joins
+                  url: sql-ref-syntax-qry-select-join.html
+                - text: ORDER BY Clause 
+                  url: sql-ref-syntax-qry-select-orderby.html
+                - text: GROUP BY Clause 
+                  url: sql-ref-syntax-qry-select-groupby.html
+                - text: HAVING Clause 
+                  url: sql-ref-syntax-qry-select-having.html
+                - text: LIMIT Clause 
+                  url: sql-ref-syntax-qry-select-limit.html
+                - text: Set operations
+                  url: sql-ref-syntax-qry-select-setops.html
+                - text: Common Table Expression(CTE)
+                  url: sql-ref-syntax-qry-select-cte.html
+                - text: Subqueries
+                  url: sql-ref-syntax-qry-select-subqueries.html
+                - text: Query hints
+                  url: sql-ref-syntax-qry-select-hints.html
+            - text: SAMPLING
+              url: sql-ref-syntax-qry-sampling.html
+            - text: WINDOWING ANALYTIC FUNCTIONS 
+              url: sql-ref-syntax-qry-window.html
+            - text: AGGREGATION (CUBE/ROLLUP/GROUPING)
+              url: sql-ref-syntax-qry-aggregation.html
+            - text: EXPLAIN
+              url: sql-ref-syntax-qry-explain.html
+        - text: Auxilarry Statements
+          url: sql-ref-syntax-aux.html
+          subitems:
+            - text: Analyze statement
+              url: sql-ref-syntax-aux-analyze.html
+              subitems: 
+                - text: ANALYZE TABLE
+                  url: sql-ref-syntax-aux-analyze-table.html
+            - text: Caching statements 
+              url: sql-ref-syntax-aux-cache.html
+              subitems:
+                - text: CACHE TABLE
+                  url: sql-ref-syntax-aux-cache-cache-table.html
+                - text: UNCACHE TABLE
+                  url: sql-ref-syntax-aux-cache-uncache-table.html
+                - text: CLEAR CACHE
+                  url: sql-ref-syntax-aux-cache-clear-cache.html
+            - text: Describe Commands
+              url: sql-ref-syntax-aux-describe.html
+              subitems:
+                - text: DESCRIBE DATABASE
+                  url: sql-ref-syntax-aux-describe-database.html
+                - text: DESCRIBE TABLE
+                  url: sql-ref-syntax-aux-describe-table.html
+                - text: DESCRIBE FUNCTION
+                  url: sql-ref-syntax-aux-describe-function.html
+                - text: DESCRIBE QUERY
+                  url: sql-ref-syntax-aux-describe-query.html
+            - text: Show commands
+              url: sql-ref-syntax-aux-show.html
+              subitems:
+                - text: SHOW COLUMNS 
+                  url: sql-ref-syntax-aux-show-columns.html
+                - text: SHOW DATABASES
+                  url: sql-ref-syntax-aux-show-databases.html
+                - text: SHOW FUNCTIONS
+                  url: sql-ref-syntax-aux-show-functions.html
+                - text: SHOW TABLE
+                  url: sql-ref-syntax-aux-show-table.html
+                - text: SHOW TABLES
+                  url: sql-ref-syntax-aux-show-tables.html
+                - text: SHOW TBLPROPERTIES
+                  url: sql-ref-syntax-aux-show-tblproperties.html
+                - text: SHOW PARTITIONS 
+                  url: sql-ref-syntax-aux-show-partitions.html
+                - text: SHOW CREATE TABLE
+                  url: sql-ref-syntax-aux-show-create-table.html
+            - text: Configuration Management Commands
+              url: sql-ref-syntax-aux-conf-mgmt.html
+              subitems:
+                - text: SET 
+                  url: sql-ref-syntax-aux-conf-mgmt-set.html
+                - text: RESET
+                  url: sql-ref-syntax-aux-conf-mgmt-reset.html
+            - text: Resource Management Commands
+              url: sql-ref-syntax-aux-resource-mgmt.html
+              subitems:
+                - text: ADD FILE
+                  url: sql-ref-syntax-aux-resource-mgmt-add-file.html
+                - text: ADD JAR
+                  url: sql-ref-syntax-aux-resource-mgmt-add-jar.html
+    - text: Functions
+      url: sql-ref-functions.html
+      subitems:
+        - text: Builtin Functions
+          url: sql-ref-functions-builtin.html
+          subitems:
+            - text: Scalar functions
+              url: sql-ref-functions-builtin-scalar.html
+            - text: Aggregate functions
+              url: sql-ref-functions-builtin-aggregate.html
+        - text: User defined Functions
+          url: sql-ref-functions-udf.html
+          subitems:
+            - text: Scalar functions
+              url: sql-ref-functions-udf-scalar.html
+            - text: Aggregate functions
+              url: sql-ref-functions-udf-aggregate.html
+    - text: Arthmetic operations
+      url: sql-ref-arithmetic-ops.html
diff --git a/docs/css/main.css b/docs/css/main.css
@@ -196,11 +196,14 @@ a.anchorjs-link:hover { text-decoration: none; }
   width: 210px;
   float: left;
   position: fixed;
+  overflow-y: scroll;
+  top: 0;
+  bottom: 0;
 }
 
 .left-menu {
   padding: 0px;
-  width: 199px;
+  width: 399px;
 }
 
 .left-menu h3 {

diff --git a/docs/sql-ref-arithmetic-ops.md b/docs/sql-ref-arithmetic-ops.md
@@ -0,0 +1,22 @@
+---
+layout: global
+title: Arithmetic Operations
+displayTitle: Arithmetic Operations
+license: |
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+---
+
+Operations performed on numeric types (with the exception of decimal) are not checked for overflow. This means that in case an operation causes an overflow, the result is the same that the same operation returns in a Java/Scala program (eg. if the sum of 2 integers is higher than the maximum value representable, the result is a negative number).
diff --git a/docs/sql-reference.md → docs/sql-ref-datatypes.md b/docs/sql-reference.md → docs/sql-ref-datatypes.md
@@ -1,7 +1,7 @@
 ---
 layout: global
-title: Reference
-displayTitle: Reference
+title: Data Types
+displayTitle: Data Types
 license: |
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
@@ -19,10 +19,6 @@ license: |
   limitations under the License.
 ---
 
-* Table of contents
-{:toc}
-
-## Data Types
 
 Spark SQL and DataFrames support the following data types:
 
@@ -634,25 +630,5 @@ from pyspark.sql.types import *
   </td>
 </tr>
 </table>
-
 </div>
-
 </div>
-
-## NaN Semantics
-
-There is specially handling for not-a-number (NaN) when dealing with `float` or `double` types that
-does not exactly match standard floating point semantics.
-Specifically:
-
- - NaN = NaN returns true.
- - In aggregations, all NaN values are grouped together.
- - NaN is treated as a normal value in join keys.
- - NaN values go last when in ascending order, larger than any other numeric value.
-
-## Arithmetic operations
-
-Operations performed on numeric types (with the exception of `decimal`) are not checked for overflow.
-This means that in case an operation causes an overflow, the result is the same that the same operation
-returns in a Java/Scala program (eg. if the sum of 2 integers is higher than the maximum value representable,
-the result is a negative number).
diff --git a/docs/sql-ref-functions-builtin-aggregate.md b/docs/sql-ref-functions-builtin-aggregate.md
@@ -0,0 +1,22 @@
+---
+layout: global
+title: Builtin Aggregate Functions
+displayTitle: Builtin Aggregate Functions
+license: |
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+---
+
+**This page is under construction**
diff --git a/docs/sql-ref-functions-builtin-scalar.md b/docs/sql-ref-functions-builtin-scalar.md
@@ -0,0 +1,22 @@
+---
+layout: global
+title: Builtin Scalar Functions
+displayTitle: Builtin Scalar Functions
+license: |
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+---
+
+**This page is under construction**
diff --git a/docs/sql-ref-functions-builtin.md b/docs/sql-ref-functions-builtin.md
@@ -0,0 +1,25 @@
+---
+layout: global
+title: Reference
+displayTitle: Reference
+license: |
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+---
+
+Spark SQL is a Apache Spark's module for working with structured data.
+This guide is a reference for Structured Query Language (SQL) for Apache 
+Spark. This document describes the SQL constructs supported by Spark in detail
+along with usage examples when applicable.
diff --git a/docs/sql-ref-functions-udf-aggregate.md b/docs/sql-ref-functions-udf-aggregate.md
@@ -0,0 +1,22 @@
+---
+layout: global
+title: User defined Aggregate Functions (UDAF)
+displayTitle: User defined Aggregate Functions (UDAF)
+license: |
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+---
+
+**This page is under construction**
diff --git a/docs/sql-ref-functions-udf-scalar.md b/docs/sql-ref-functions-udf-scalar.md
@@ -0,0 +1,22 @@
+---
+layout: global
+title: User defined Scalar Functions (UDF)
+displayTitle: User defined Scalar Functions (UDF)
+license: |
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+---
+
+**This page is under construction**