Merge pull request #31887 from ggevay/show-redacted-create

ggevay · web-flow · commit 6cf4a375e127 · 2025-03-17T22:59:42.000+01:00
Implement `SHOW REDACTED CREATE ...`
diff --git a/doc/user/content/sql/show-create-connection.md b/doc/user/content/sql/show-create-connection.md
@@ -11,9 +11,11 @@ menu:
 ## Syntax
 
 ```sql
-SHOW CREATE CONNECTION <connection_name>
+SHOW [REDACTED] CREATE CONNECTION <connection_name>
 ```
 
+{{< yaml-table data="show_create_redacted_option" >}}
+
 For available connection names, see [`SHOW CONNECTIONS`](/sql/show-connections).
 
 ## Examples
diff --git a/doc/user/content/sql/show-create-index.md b/doc/user/content/sql/show-create-index.md
@@ -11,9 +11,11 @@ menu:
 ## Syntax
 
 ```sql
-SHOW CREATE INDEX <index_name>
+SHOW [REDACTED] CREATE INDEX <index_name>
 ```
 
+{{< yaml-table data="show_create_redacted_option" >}}
+
 For available index names, see [`SHOW INDEXES`](/sql/show-indexes).
 
 ## Examples
diff --git a/doc/user/content/sql/show-create-materialized-view.md b/doc/user/content/sql/show-create-materialized-view.md
@@ -11,9 +11,11 @@ menu:
 ## Syntax
 
 ```sql
-SHOW CREATE MATERIALIZED VIEW <view_name>
+SHOW [REDACTED] CREATE MATERIALIZED VIEW <view_name>
 ```
 
+{{< yaml-table data="show_create_redacted_option" >}}
+
 For available materialized view names, see [`SHOW MATERIALIZED VIEWS`](/sql/show-materialized-views).
 
 ## Examples
diff --git a/doc/user/content/sql/show-create-sink.md b/doc/user/content/sql/show-create-sink.md
@@ -11,9 +11,11 @@ menu:
 ## Syntax
 
 ```sql
-SHOW CREATE SINK <sink_name>
+SHOW [REDACTED] CREATE SINK <sink_name>
 ```
 
+{{< yaml-table data="show_create_redacted_option" >}}
+
 For available sink names, see [`SHOW SINKS`](/sql/show-sinks).
 
 ## Examples
diff --git a/doc/user/content/sql/show-create-source.md b/doc/user/content/sql/show-create-source.md
@@ -11,9 +11,11 @@ menu:
 ## Syntax
 
 ```sql
-SHOW CREATE SOURCE <source_name>
+SHOW [REDACTED] CREATE SOURCE <source_name>
 ```
 
+{{< yaml-table data="show_create_redacted_option" >}}
+
 For available source names, see [`SHOW SOURCES`](/sql/show-sources).
 
 ## Examples
diff --git a/doc/user/content/sql/show-create-table.md b/doc/user/content/sql/show-create-table.md
@@ -11,9 +11,11 @@ menu:
 ## Syntax
 
 ```sql
-SHOW CREATE TABLE <table_name>
+SHOW [REDACTED] CREATE TABLE <table_name>
 ```
 
+{{< yaml-table data="show_create_redacted_option" >}}
+
 For available table names, see [`SHOW TABLES`](/sql/show-tables).
 
 ## Examples
diff --git a/doc/user/content/sql/show-create-view.md b/doc/user/content/sql/show-create-view.md
@@ -11,9 +11,11 @@ menu:
 ## Syntax
 
 ```sql
-SHOW CREATE VIEW <view_name>
+SHOW [REDACTED] CREATE VIEW <view_name>
 ```
 
+{{< yaml-table data="show_create_redacted_option" >}}
+
 For available view names, see [`SHOW VIEWS`](/sql/show-views).
 
 ## Examples
diff --git a/doc/user/data/show_create_redacted_option.yml b/doc/user/data/show_create_redacted_option.yml
@@ -0,0 +1,7 @@
+columns:
+  - column: Option
+  - column: Description
+
+rows:
+  - Option: "**REDACTED**"
+    Description: "If specified, literals will be redacted."
diff --git a/src/sql-parser/src/ast/defs/statement.rs b/src/sql-parser/src/ast/defs/statement.rs
@@ -3561,98 +3561,134 @@ impl<T: AstInfo> AstDisplay for ShowColumnsStatement<T> {
 }
 impl_display_t!(ShowColumnsStatement);
 
-/// `SHOW CREATE VIEW <view>`
+/// `SHOW [REDACTED] CREATE VIEW <view>`
 #[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
 pub struct ShowCreateViewStatement<T: AstInfo> {
     pub view_name: T::ItemName,
+    pub redacted: bool,
 }
 
 impl<T: AstInfo> AstDisplay for ShowCreateViewStatement<T> {
     fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
-        f.write_str("SHOW CREATE VIEW ");
+        f.write_str("SHOW ");
+        if self.redacted {
+            f.write_str("REDACTED ");
+        }
+        f.write_str("CREATE VIEW ");
         f.write_node(&self.view_name);
     }
 }
 impl_display_t!(ShowCreateViewStatement);
 
-/// `SHOW CREATE MATERIALIZED VIEW <name>`
+/// `SHOW [REDACTED] CREATE MATERIALIZED VIEW <name>`
 #[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
 pub struct ShowCreateMaterializedViewStatement<T: AstInfo> {
     pub materialized_view_name: T::ItemName,
+    pub redacted: bool,
 }
 
 impl<T: AstInfo> AstDisplay for ShowCreateMaterializedViewStatement<T> {
     fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
-        f.write_str("SHOW CREATE MATERIALIZED VIEW ");
+        f.write_str("SHOW ");
+        if self.redacted {
+            f.write_str("REDACTED ");
+        }
+        f.write_str("CREATE MATERIALIZED VIEW ");
         f.write_node(&self.materialized_view_name);
     }
 }
 impl_display_t!(ShowCreateMaterializedViewStatement);
 
-/// `SHOW CREATE SOURCE <source>`
+/// `SHOW [REDACTED] CREATE SOURCE <source>`
 #[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
 pub struct ShowCreateSourceStatement<T: AstInfo> {
     pub source_name: T::ItemName,
+    pub redacted: bool,
 }
 
 impl<T: AstInfo> AstDisplay for ShowCreateSourceStatement<T> {
     fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
-        f.write_str("SHOW CREATE SOURCE ");
+        f.write_str("SHOW ");
+        if self.redacted {
+            f.write_str("REDACTED ");
+        }
+        f.write_str("CREATE SOURCE ");
         f.write_node(&self.source_name);
     }
 }
 impl_display_t!(ShowCreateSourceStatement);
 
-/// `SHOW CREATE TABLE <table>`
+/// `SHOW [REDACTED] CREATE TABLE <table>`
 #[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
 pub struct ShowCreateTableStatement<T: AstInfo> {
     pub table_name: T::ItemName,
+    pub redacted: bool,
 }
 
 impl<T: AstInfo> AstDisplay for ShowCreateTableStatement<T> {
     fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
-        f.write_str("SHOW CREATE TABLE ");
+        f.write_str("SHOW ");
+        if self.redacted {
+            f.write_str("REDACTED ");
+        }
+        f.write_str("CREATE TABLE ");
         f.write_node(&self.table_name);
     }
 }
 impl_display_t!(ShowCreateTableStatement);
 
-/// `SHOW CREATE SINK <sink>`
+/// `SHOW [REDACTED] CREATE SINK <sink>`
 #[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
 pub struct ShowCreateSinkStatement<T: AstInfo> {
     pub sink_name: T::ItemName,
+    pub redacted: bool,
 }
 
 impl<T: AstInfo> AstDisplay for ShowCreateSinkStatement<T> {
     fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
-        f.write_str("SHOW CREATE SINK ");
+        f.write_str("SHOW ");
+        if self.redacted {
+            f.write_str("REDACTED ");
+        }
+        f.write_str("CREATE SINK ");
         f.write_node(&self.sink_name);
     }
 }
 impl_display_t!(ShowCreateSinkStatement);
 
-/// `SHOW CREATE INDEX <index>`
+/// `SHOW [REDACTED] CREATE INDEX <index>`
 #[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
 pub struct ShowCreateIndexStatement<T: AstInfo> {
     pub index_name: T::ItemName,
+    pub redacted: bool,
 }
 
 impl<T: AstInfo> AstDisplay for ShowCreateIndexStatement<T> {
     fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
-        f.write_str("SHOW CREATE INDEX ");
+        f.write_str("SHOW ");
+        if self.redacted {
+            f.write_str("REDACTED ");
+        }
+        f.write_str("CREATE INDEX ");
         f.write_node(&self.index_name);
     }
 }
 impl_display_t!(ShowCreateIndexStatement);
 
+/// `SHOW [REDACTED] CREATE CONNECTION <connection>`
 #[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
 pub struct ShowCreateConnectionStatement<T: AstInfo> {
     pub connection_name: T::ItemName,
+    pub redacted: bool,
 }
 
 impl<T: AstInfo> AstDisplay for ShowCreateConnectionStatement<T> {
     fn fmt<W: fmt::Write>(&self, f: &mut AstFormatter<W>) {
-        f.write_str("SHOW CREATE CONNECTION ");
+        f.write_str("SHOW ");
+        if self.redacted {
+            f.write_str("REDACTED ");
+        }
+        f.write_str("CREATE CONNECTION ");
         f.write_node(&self.connection_name);
     }
 }
diff --git a/src/sql-parser/src/ast/display.rs b/src/sql-parser/src/ast/display.rs
@@ -67,12 +67,15 @@ where
 }
 
 /// Describes the context in which to print an AST.
+///
+/// TODO: Currently, only the simple format can be redacted, but, ideally, whether it's redacted and
+///       whether it's stable would be orthogonal settings.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub enum FormatMode {
     /// Simple is the normal way of printing for human consumption. Identifiers are quoted only if
-    /// necessary and sensative information is redacted.
+    /// necessary and sensitive information is not redacted.
     Simple,
-    /// SimpleRedacted is like Simple, but strips out string and number literals.
+    /// SimpleRedacted is like Simple, but strips out literals, e.g. strings and numbers.
     /// This makes SQL queries be "usage data", rather than "customer data" according to our
     /// data management policy, allowing us to introspect it.
     SimpleRedacted,
diff --git a/src/sql-parser/src/parser.rs b/src/sql-parser/src/parser.rs
@@ -7720,6 +7720,14 @@ impl<'a> Parser<'a> {
     }
 
     fn parse_show(&mut self) -> Result<ShowStatement<Raw>, ParserError> {
+        let redacted = self.parse_keyword(REDACTED);
+        if redacted && !self.peek_keyword(CREATE) {
+            return parser_err!(
+                self,
+                self.peek_pos(),
+                "SHOW REDACTED is only supported for SHOW REDACTED CREATE ..."
+            );
+        }
         if self.parse_one_of_keywords(&[COLUMNS, FIELDS]).is_some() {
             self.parse_show_columns()
         } else if self.parse_keyword(OBJECTS) {
@@ -7860,36 +7868,50 @@ impl<'a> Parser<'a> {
         } else if self.parse_keywords(&[CREATE, VIEW]) {
             Ok(ShowStatement::ShowCreateView(ShowCreateViewStatement {
                 view_name: self.parse_raw_name()?,
+                redacted,
             }))
         } else if self.parse_keywords(&[CREATE, MATERIALIZED, VIEW]) {
             Ok(ShowStatement::ShowCreateMaterializedView(
                 ShowCreateMaterializedViewStatement {
                     materialized_view_name: self.parse_raw_name()?,
+                    redacted,
                 },
             ))
         } else if self.parse_keywords(&[CREATE, SOURCE]) {
             Ok(ShowStatement::ShowCreateSource(ShowCreateSourceStatement {
                 source_name: self.parse_raw_name()?,
+                redacted,
             }))
         } else if self.parse_keywords(&[CREATE, TABLE]) {
             Ok(ShowStatement::ShowCreateTable(ShowCreateTableStatement {
                 table_name: self.parse_raw_name()?,
+                redacted,
             }))
         } else if self.parse_keywords(&[CREATE, SINK]) {
             Ok(ShowStatement::ShowCreateSink(ShowCreateSinkStatement {
                 sink_name: self.parse_raw_name()?,
+                redacted,
             }))
         } else if self.parse_keywords(&[CREATE, INDEX]) {
             Ok(ShowStatement::ShowCreateIndex(ShowCreateIndexStatement {
                 index_name: self.parse_raw_name()?,
+                redacted,
             }))
         } else if self.parse_keywords(&[CREATE, CONNECTION]) {
             Ok(ShowStatement::ShowCreateConnection(
                 ShowCreateConnectionStatement {
                     connection_name: self.parse_raw_name()?,
+                    redacted,
                 },
             ))
         } else if self.parse_keywords(&[CREATE, CLUSTER]) {
+            if redacted {
+                return parser_err!(
+                    self,
+                    self.peek_prev_pos(),
+                    "SHOW REDACTED CREATE CLUSTER is not supported"
+                );
+            }
             Ok(ShowStatement::ShowCreateCluster(
                 ShowCreateClusterStatement {
                     cluster_name: RawClusterName::Unresolved(self.parse_identifier()?),
diff --git a/src/sql-parser/tests/testdata/show b/src/sql-parser/tests/testdata/show
diff --git a/src/sql/src/plan/statement/show.rs b/src/sql/src/plan/statement/show.rs
diff --git a/test/sqllogictest/redacted.slt b/test/sqllogictest/redacted.slt
