huaxingao commented on a change in pull request #26635: [SPARK-28812][SQL][DOC]
Document SHOW PARTITIONS in SQL Reference
URL: https://github.com/apache/spark/pull/26635#discussion_r349816767
##########
File path: docs/sql-ref-syntax-aux-show-partitions.md
##########
@@ -18,5 +18,96 @@ license: |
See the License for the specific language governing permissions and
limitations under the License.
---
+### Description
-**This page is under construction**
+The `SHOW PARTITIONS` statement is used to list partitions of a table. An
optional
+partition spec may be specified to return the partitions matching the supplied
+partition spec.
+
+### Syntax
+{% highlight sql %}
+SHOW PARTITIONS table_identifier [partition_spec]
Review comment:
I slightly prefer to have the full syntax at the syntax section without
having a second layer of sub-syntax at the parameters section.
@srowen Do you have a preference?
I took a look of SHOW TABLE, ALTER TABLE, TRUNCATE TABLE, the syntax
partition_spec is not consistent among them, either. For the most common
parameters, such as partition_spec, table_name, database_name, etc. we need to
have an agreed syntax, and then use the same syntax for all the commands. I
guess I will need to spend some time to take care of the consistency.
----------------------------------------------------------------
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]
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
