[SPARK-33838][SQL][DOCS] Comment the PURGE
option in the DropTable and in AlterTableDropPartition commands
### What changes were proposed in this pull request? Add comments for the `PURGE` option to the logical nodes `DropTable` and `AlterTableDropPartition`. ### Why are the changes needed? To improve code maintenance. ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? By running `./dev/scalastyle` Closes #30837 from MaxGekk/comment-purge-logical-node. Authored-by: Max Gekk <max.gekk@gmail.com> Signed-off-by: Wenchen Fan <wenchen@databricks.com>
This commit is contained in:
parent
69aa727ff4
commit
661ac10901
|
@ -410,6 +410,14 @@ case class Assignment(key: Expression, value: Expression) extends Expression wit
|
|||
|
||||
/**
|
||||
* The logical plan of the DROP TABLE command.
|
||||
*
|
||||
* If the `PURGE` option is set, the table catalog must remove table data by skipping the trash
|
||||
* even when the catalog has configured one. The option is applicable only for managed tables.
|
||||
*
|
||||
* The syntax of this command is:
|
||||
* {{{
|
||||
* DROP TABLE [IF EXISTS] table [PURGE];
|
||||
* }}}
|
||||
*/
|
||||
case class DropTable(
|
||||
child: LogicalPlan,
|
||||
|
@ -657,9 +665,12 @@ case class AlterTableAddPartition(
|
|||
* The logical plan of the ALTER TABLE DROP PARTITION command.
|
||||
* This may remove the data and metadata for this partition.
|
||||
*
|
||||
* If the `PURGE` option is set, the table catalog must remove partition data by skipping the trash
|
||||
* even when the catalog has configured one. The option is applicable only for managed tables.
|
||||
*
|
||||
* The syntax of this command is:
|
||||
* {{{
|
||||
* ALTER TABLE table DROP [IF EXISTS] PARTITION spec1[, PARTITION spec2, ...];
|
||||
* ALTER TABLE table DROP [IF EXISTS] PARTITION spec1[, PARTITION spec2, ...] [PURGE];
|
||||
* }}}
|
||||
*/
|
||||
case class AlterTableDropPartition(
|
||||
|
|
Loading…
Reference in a new issue