spark-instrumented-optimizer/docs/_data/menu-sql.yaml
Wenchen Fan 4b015e8d7d [SPARK-36535][SQL] Refine the sql reference doc
### What changes were proposed in this pull request?

Refine the SQL reference doc:
- remove useless subitems in the sidebar
- remove useless sub-menu-pages (e.g. `sql-ref-syntax-aux.md`)
- avoid using `#####` in `sql-ref-literals.md`

### Why are the changes needed?

The subitems in the sidebar are quite useless, as the menu page serves the same functionalities:
<img width="1040" alt="WX20210817-2358402x" src="https://user-images.githubusercontent.com/3182036/129765924-d7e69bc1-e351-4581-a6de-f2468022f372.png">
It's also extra work to keep the manu page and sidebar subitems in sync (The ANSI compliance page is already out of sync).

The sub-menu-pages are only referenced by the sidebar, and duplicates the content of the menu page. As a result, the `sql-ref-syntax-aux.md` is already outdated compared to the menu page. It's easier to just look at the menu page.

The `#####` is not rendered properly:
<img width="776" alt="WX20210818-0001192x" src="https://user-images.githubusercontent.com/3182036/129766760-6f385443-e597-44aa-888d-14d128d45f84.png">
It's better to avoid using it.

### Does this PR introduce _any_ user-facing change?

No

### How was this patch tested?

N/A

Closes #33767 from cloud-fan/doc.

Authored-by: Wenchen Fan <wenchen@databricks.com>
Signed-off-by: Dongjoon Hyun <dhyun@apple.com>
2021-08-17 12:46:38 -07:00

101 lines
3.8 KiB
YAML

- text: Getting Started
url: sql-getting-started.html
subitems:
- text: "Starting Point: SparkSession"
url: sql-getting-started.html#starting-point-sparksession
- text: Creating DataFrames
url: sql-getting-started.html#creating-dataframes
- text: Untyped Dataset Operations (DataFrame operations)
url: sql-getting-started.html#untyped-dataset-operations-aka-dataframe-operations
- text: Running SQL Queries Programmatically
url: sql-getting-started.html#running-sql-queries-programmatically
- text: Global Temporary View
url: sql-getting-started.html#global-temporary-view
- text: Creating Datasets
url: sql-getting-started.html#creating-datasets
- text: Interoperating with RDDs
url: sql-getting-started.html#interoperating-with-rdds
- text: Scalar Functions
url: sql-getting-started.html#scalar-functions
- text: Aggregations
url: sql-getting-started.html#aggregations
- text: Data Sources
url: sql-data-sources.html
subitems:
- text: "Generic Load/Save Functions"
url: sql-data-sources-load-save-functions.html
- text: "Generic File Source Options"
url: sql-data-sources-generic-options.html
- text: Parquet Files
url: sql-data-sources-parquet.html
- text: ORC Files
url: sql-data-sources-orc.html
- text: JSON Files
url: sql-data-sources-json.html
- text: CSV Files
url: sql-data-sources-csv.html
- text: Text Files
url: sql-data-sources-text.html
- text: Hive Tables
url: sql-data-sources-hive-tables.html
- text: JDBC To Other Databases
url: sql-data-sources-jdbc.html
- text: Avro Files
url: sql-data-sources-avro.html
- text: Whole Binary Files
url: sql-data-sources-binaryFile.html
- text: Troubleshooting
url: sql-data-sources-troubleshooting.html
- text: Performance Tuning
url: sql-performance-tuning.html
subitems:
- text: Caching Data In Memory
url: sql-performance-tuning.html#caching-data-in-memory
- text: Other Configuration Options
url: sql-performance-tuning.html#other-configuration-options
- text: Join Strategy Hints for SQL Queries
url: sql-performance-tuning.html#join-strategy-hints-for-sql-queries
- text: Coalesce Hints for SQL Queries
url: sql-performance-tuning.html#coalesce-hints-for-sql-queries
- text: Adaptive Query Execution
url: sql-performance-tuning.html#adaptive-query-execution
- text: Distributed SQL Engine
url: sql-distributed-sql-engine.html
subitems:
- text: "Running the Thrift JDBC/ODBC server"
url: sql-distributed-sql-engine.html#running-the-thrift-jdbcodbc-server
- text: Running the Spark SQL CLI
url: sql-distributed-sql-engine.html#running-the-spark-sql-cli
- text: PySpark Usage Guide for Pandas with Apache Arrow
url: sql-pyspark-pandas-with-arrow.html
- text: Migration Guide
url: sql-migration-old.html
- text: SQL Reference
url: sql-ref.html
subitems:
- text: ANSI Compliance
url: sql-ref-ansi-compliance.html
- text: Data Types
url: sql-ref-datatypes.html
- text: Datetime Pattern
url: sql-ref-datetime-pattern.html
- text: Functions
url: sql-ref-functions.html
- text: Identifiers
url: sql-ref-identifier.html
- text: Literals
url: sql-ref-literals.html
- text: Null Semantics
url: sql-ref-null-semantics.html
- text: SQL Syntax
url: sql-ref-syntax.html
subitems:
- text: Data Definition Statements
url: sql-ref-syntax.html#ddl-statements
- text: Data Manipulation Statements
url: sql-ref-syntax.html#dml-statements
- text: Data Retrieval(Queries)
url: sql-ref-syntax.html#data-retrieval-statements
- text: Auxiliary Statements
url: sql-ref-syntax.html#auxiliary-statements