ODIn/spark-instrumented-optimizer
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[SPARK-33687][SQL][DOC][FOLLOWUP] Merge the doc pages of ANALYZE TABLE and ANALYZE TABLES

Browse source 
### What changes were proposed in this pull request?

This is a followup of https://github.com/apache/spark/pull/30648

ANALYZE TABLE and TABLES are essentially the same command, it's weird to put them in 2 different doc pages. This PR proposes to merge them into one doc page.

### Why are the changes needed?

simplify the doc

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

no

### How was this patch tested?

N/A

Closes #33781 from cloud-fan/doc.

Authored-by: Wenchen Fan <wenchen@databricks.com>
Signed-off-by: Wenchen Fan <wenchen@databricks.com>
(cherry picked from commit 07d173a8b0)
Signed-off-by: Wenchen Fan <wenchen@databricks.com>
This commit is contained in:
Wenchen Fan 2021-08-19 11:04:05 +08:00
parent 3d69d0d003
commit 8f3b4c4b7d
4 changed files with 71 additions and 150 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

87
docs/sql-ref-syntax-aux-analyze-table.md
View file

@ -21,7 +21,8 @@ license: |
### Description
The `ANALYZE TABLE` statement collects statistics about the table to be used by the query optimizer to find a better query execution plan.
The `ANALYZE TABLE` statement collects statistics about one specific table or all the tables in one specified database,
that are to be used by the query optimizer to find a better query execution plan.
### Syntax
@ -30,6 +31,10 @@ ANALYZE TABLE table_identifier [ partition_spec ]
COMPUTE STATISTICS [ NOSCAN | FOR COLUMNS col [ , ... ] | FOR ALL COLUMNS ]
```
```sql
ANALYZE TABLES [ { FROM | IN } database_name ] COMPUTE STATISTICS [ NOSCAN ]
```
### Parameters
* **table_identifier**
@ -45,22 +50,31 @@ ANALYZE TABLE table_identifier [ partition_spec ]
**Syntax:** `PARTITION ( partition_col_name [ = partition_col_val ] [ , ... ] )`
* **[ NOSCAN `|` FOR COLUMNS col [ , ... ] `|` FOR ALL COLUMNS ]**
* **{ FROM `|` IN } database_name**
* If no analyze option is specified, `ANALYZE TABLE` collects the table's number of rows and size in bytes.
* **NOSCAN**
Specifies the name of the database to be analyzed. Without a database name, `ANALYZE` collects all tables in the current database that the current user has permission to analyze.
Collects only the table's size in bytes (which does not require scanning the entire table).
* **FOR COLUMNS col [ , ... ] `|` FOR ALL COLUMNS**
* **NOSCAN**
Collects column statistics for each column specified, or alternatively for every column, as well as table statistics.
Collects only the table's size in bytes (which does not require scanning the entire table).
* **FOR COLUMNS col [ , ... ] `|` FOR ALL COLUMNS**
Collects column statistics for each column specified, or alternatively for every column, as well as table statistics.
If no analyze option is specified, both number of rows and size in bytes are collected.
### Examples
```sql
CREATE DATABASE school_db;
USE school_db;
CREATE TABLE teachers (name STRING, teacher_id INT);
INSERT INTO teachers VALUES ('Tom', 1), ('Jerry', 2);
CREATE TABLE students (name STRING, student_id INT) PARTITIONED BY (student_id);
INSERT INTO students PARTITION (student_id = 111111) VALUES ('Mark');
INSERT INTO students PARTITION (student_id = 222222) VALUES ('John');
INSERT INTO students VALUES ('Mark', 111111), ('John', 222222);
ANALYZE TABLE students COMPUTE STATISTICS NOSCAN;
@ -73,7 +87,6 @@ DESC EXTENDED students;
| ...| ...| ...|
| Statistics| 864 bytes| |
| ...| ...| ...|
| Partition Provider| Catalog| |
+--------------------+--------------------+-------+
ANALYZE TABLE students COMPUTE STATISTICS;
@ -87,7 +100,6 @@ DESC EXTENDED students;
| ...| ...| ...|
| Statistics| 864 bytes, 2 rows| |
| ...| ...| ...|
| Partition Provider| Catalog| |
+--------------------+--------------------+-------+
ANALYZE TABLE students PARTITION (student_id = 111111) COMPUTE STATISTICS;
@ -101,7 +113,6 @@ DESC EXTENDED students PARTITION (student_id = 111111);
| ...| ...| ...|
|Partition Statistics| 432 bytes, 1 rows| |
| ...| ...| ...|
| OutputFormat|org.apache.hadoop...| |
+--------------------+--------------------+-------+
ANALYZE TABLE students COMPUTE STATISTICS FOR COLUMNS name;
@ -121,8 +132,52 @@ DESC EXTENDED students name;
| max_col_len| 4|
| histogram| NULL|
+--------------+----------+
ANALYZE TABLES IN school_db COMPUTE STATISTICS NOSCAN;
DESC EXTENDED teachers;
+--------------------+--------------------+-------+
| col_name| data_type|comment|
+--------------------+--------------------+-------+
| name| string| null|
| teacher_id| int| null|
| ...| ...| ...|
| Statistics| 1382 bytes| |
| ...| ...| ...|
+--------------------+--------------------+-------+
DESC EXTENDED students;
+--------------------+--------------------+-------+
| col_name| data_type|comment|
+--------------------+--------------------+-------+
| name| string| null|
| student_id| int| null|
| ...| ...| ...|
| Statistics| 864 bytes| |
| ...| ...| ...|
+--------------------+--------------------+-------+
ANALYZE TABLES COMPUTE STATISTICS;
DESC EXTENDED teachers;
+--------------------+--------------------+-------+
| col_name| data_type|comment|
+--------------------+--------------------+-------+
| name| string| null|
| teacher_id| int| null|
| ...| ...| ...|
| Statistics| 1382 bytes, 2 rows| |
| ...| ...| ...|
+--------------------+--------------------+-------+
DESC EXTENDED students;
+--------------------+--------------------+-------+
| col_name| data_type|comment|
+--------------------+--------------------+-------+
| name| string| null|
| student_id| int| null|
| ...| ...| ...|
| Statistics| 864 bytes, 2 rows| |
| ...| ...| ...|
+--------------------+--------------------+-------+
```
### Related Statements
* [ANALYZE TABLES](sql-ref-syntax-aux-analyze-tables.html)

110
docs/sql-ref-syntax-aux-analyze-tables.md
View file

@ -1,110 +0,0 @@
---
layout: global
title: ANALYZE TABLES
displayTitle: ANALYZE TABLES
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.
---
### Description
The `ANALYZE TABLES` statement collects statistics about all the tables in a specified database to be used by the query optimizer to find a better query execution plan.
### Syntax
```sql
ANALYZE TABLES [ { FROM | IN } database_name ] COMPUTE STATISTICS [ NOSCAN ]
```
### Parameters
* **{ FROM `|` IN } database_name**
Specifies the name of the database to be analyzed. Without a database name, `ANALYZE` collects all tables in the current database that the current user has permission to analyze.
* **[ NOSCAN ]**
Collects only the table's size in bytes (which does not require scanning the entire table).
### Examples
```sql
CREATE DATABASE school_db;
USE school_db;
CREATE TABLE teachers (name STRING, teacher_id INT);
INSERT INTO teachers VALUES ('Tom', 1), ('Jerry', 2);
CREATE TABLE students (name STRING, student_id INT, age SHORT);
INSERT INTO students VALUES ('Mark', 111111, 10), ('John', 222222, 11);
ANALYZE TABLES IN school_db COMPUTE STATISTICS NOSCAN;
DESC EXTENDED teachers;
+--------------------+--------------------+-------+
| col_name| data_type|comment|
+--------------------+--------------------+-------+
| name| string| null|
| teacher_id| int| null|
| ...| ...| ...|
| Provider| parquet| |
| Statistics| 1382 bytes| |
| ...| ...| ...|
+--------------------+--------------------+-------+
DESC EXTENDED students;
+--------------------+--------------------+-------+
| col_name| data_type|comment|
+--------------------+--------------------+-------+
| name| string| null|
| student_id| int| null|
| age| smallint| null|
| ...| ...| ...|
| Statistics| 1828 bytes| |
| ...| ...| ...|
+--------------------+--------------------+-------+
ANALYZE TABLES COMPUTE STATISTICS;
DESC EXTENDED teachers;
+--------------------+--------------------+-------+
| col_name| data_type|comment|
+--------------------+--------------------+-------+
| name| string| null|
| teacher_id| int| null|
| ...| ...| ...|
| Provider| parquet| |
| Statistics| 1382 bytes, 2 rows| |
| ...| ...| ...|
+--------------------+--------------------+-------+
DESC EXTENDED students;
+--------------------+--------------------+-------+
| col_name| data_type|comment|
+--------------------+--------------------+-------+
| name| string| null|
| student_id| int| null|
| age| smallint| null|
| ...| ...| ...|
| Provider| parquet| |
| Statistics| 1828 bytes, 2 rows| |
| ...| ...| ...|
+--------------------+--------------------+-------+
```
### Related Statements
* [ANALYZE TABLE](sql-ref-syntax-aux-analyze-table.html)

23
docs/sql-ref-syntax-aux-analyze.md
View file

@ -1,23 +0,0 @@
---
layout: global
title: Analyze Statement
displayTitle: Analyze Statement
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.
---
* [ANALYZE TABLE statement](sql-ref-syntax-aux-analyze-table.html)
* [ANALYZE TABLES statement](sql-ref-syntax-aux-analyze-tables.html)

1
docs/sql-ref-syntax.md
View file

@ -90,7 +90,6 @@ ability to generate logical and physical plan for a given query using
* [ADD FILE](sql-ref-syntax-aux-resource-mgmt-add-file.html)
* [ADD JAR](sql-ref-syntax-aux-resource-mgmt-add-jar.html)
* [ANALYZE TABLE](sql-ref-syntax-aux-analyze-table.html)
* [ANALYZE TABLES](sql-ref-syntax-aux-analyze-tables.html)
* [CACHE TABLE](sql-ref-syntax-aux-cache-cache-table.html)
* [CLEAR CACHE](sql-ref-syntax-aux-cache-clear-cache.html)
* [DESCRIBE DATABASE](sql-ref-syntax-aux-describe-database.html)