comments

apache · Dec 11, 2019 · 9b272b6 · 9b272b6
1 parent e489e62
commit 9b272b6
Showing 1 changed file with 16 additions and 3 deletions.
diff --git a/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/plans/logical/v2Commands.scala b/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/plans/logical/v2Commands.scala
@@ -456,12 +456,25 @@ case class ShowTableProperties(
 }
 
 /**
- * The logical plan of the COMMENT ON (DATABASE|SCHEMA|NAMESPACE) ... IS ... command that works for
- * v2 catalogs.
+ * The logical plan that defines or changes the comment of an NAMESPACE for v2 catalogs.
+ *
+ * {{{
+ *   COMMENT ON (DATABASE|SCHEMA|NAMESPACE) namespaceIdentifier IS ('text' | NULL)
+ * }}}
+ *
+ * where the `text` is the new comment written as a string literal; or `NULL` to drop the comment.
+ *
  */
 case class CommentOnNamespace(namespace: Seq[String], comment: String) extends Command
 
 /**
- * The logical plan of the COMMENT ON TABLE ... IS ... command that works for v2 catalogs.
+ * The logical plan that defines or changes the comment of an TABLE for v2 catalogs.
+ *
+ * {{{
+ *   COMMENT ON TABLE tableIdentifier IS ('text' | NULL)
+ * }}}
+ *
+ * where the `text` is the new comment written as a string literal; or `NULL` to drop the comment.
+ *
  */
 case class CommentOnTable(namespace: Seq[String], comment: String) extends Command