Support redshift's columns definition list for system information fun…

…ctions (#769)

* parsing of redshift's column definition list for
pg_get_late_binding_view_cols
pg_get_cols
pg_get_grantee_by_iam_role
pg_get_iam_role_by_user

* Renamed ColsDefinition to TableAliasDefinition

added generic dialect

* Tests fixed

* Visitor for IdentPair

* Parsing redshift table alias based on indentifier and
parentheses instead of function name

* fix clippy

---------

Co-authored-by: Maciej Skrzypkowski <maciej.skrzypkowski@satoricyber.com>
Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

src/ast/mod.rs

@@ -4141,6 +4141,35 @@ impl fmt::Display for SearchModifier {
     }
 }
 
+/// A result table definition i.e. `cols(view_schema name, view_name name, col_name name, col_type varchar, col_num int)`
+/// used for redshift functions: pg_get_late_binding_view_cols, pg_get_cols, pg_get_grantee_by_iam_role,pg_get_iam_role_by_user
+#[derive(Debug, Clone, PartialEq, PartialOrd, Eq, Ord, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "visitor", derive(Visit, VisitMut))]
+pub struct TableAliasDefinition {
+    pub name: Ident,
+    pub args: Vec<IdentPair>,
+}
+
+impl fmt::Display for TableAliasDefinition {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        write!(f, "{}({})", self.name, display_comma_separated(&self.args))?;
+        Ok(())
+    }
+}
+
+#[derive(Debug, Clone, PartialEq, PartialOrd, Eq, Ord, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "visitor", derive(Visit, VisitMut))]
+pub struct IdentPair(pub Ident, pub Ident);
+
+impl fmt::Display for IdentPair {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        write!(f, "{} {}", self.0, self.1)?;
+        Ok(())
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

src/ast/query.rs

@@ -580,6 +580,9 @@ pub enum TableFactor {
         /// vector of arguments, in the case of a table-valued function call,
         /// whereas it's `None` in the case of a regular table name.
         args: Option<Vec<FunctionArg>>,
+        /// A table alias definition i.e. `cols(view_schema name, view_name name, col_name name, col_type varchar, col_num int)`
+        /// used for redshift functions: pg_get_late_binding_view_cols, pg_get_cols, pg_get_grantee_by_iam_role,pg_get_iam_role_by_user)
+        columns_definition: Option<TableAliasDefinition>,
         /// MSSQL-specific `WITH (...)` hints such as NOLOCK.
         with_hints: Vec<Expr>,
     },
@@ -628,6 +631,7 @@ impl fmt::Display for TableFactor {
                 name,
                 alias,
                 args,
+                columns_definition,
                 with_hints,
             } => {
                 write!(f, "{name}")?;
@@ -637,6 +641,9 @@ impl fmt::Display for TableFactor {
                 if let Some(alias) = alias {
                     write!(f, " AS {alias}")?;
                 }
+                if let Some(columns_definition) = columns_definition {
+                    write!(f, " {columns_definition}")?;
+                }
                 if !with_hints.is_empty() {
                     write!(f, " WITH ({})", display_comma_separated(with_hints))?;
                 }

src/keywords.rs

@@ -669,6 +669,7 @@ pub const RESERVED_FOR_TABLE_ALIAS: &[Keyword] = &[
     Keyword::OUTER,
     Keyword::SET,
     Keyword::QUALIFY,
+    Keyword::AS,
 ];
 
 /// Can't be used as a column alias, so that `SELECT <expr> alias`
@@ -698,4 +699,5 @@ pub const RESERVED_FOR_COLUMN_ALIAS: &[Keyword] = &[
     // Reserved only as a column alias in the `SELECT` clause
     Keyword::FROM,
     Keyword::INTO,
+    Keyword::AS,
 ];

src/parser.rs

@@ -5649,6 +5649,7 @@ impl<'a> Parser<'a> {
             } else {
                 None
             };
+            let columns_definition = self.parse_redshift_columns_definition_list()?;
             let alias = self.parse_optional_table_alias(keywords::RESERVED_FOR_TABLE_ALIAS)?;
             // MSSQL-specific table hints:
             let mut with_hints = vec![];
@@ -5665,11 +5666,56 @@ impl<'a> Parser<'a> {
                 name,
                 alias,
                 args,
+                columns_definition,
                 with_hints,
             })
         }
     }
 
+    fn parse_redshift_columns_definition_list(
+        &mut self,
+    ) -> Result<Option<TableAliasDefinition>, ParserError> {
+        if !dialect_of!(self is RedshiftSqlDialect | GenericDialect) {
+            return Ok(None);
+        }
+
+        if let Some(col_definition_list_name) = self.parse_optional_columns_definition_list_alias()
+        {
+            if self.consume_token(&Token::LParen) {
+                let names = self.parse_comma_separated(Parser::parse_ident_pair)?;
+                self.expect_token(&Token::RParen)?;
+                Ok(Some(TableAliasDefinition {
+                    name: col_definition_list_name,
+                    args: names,
+                }))
+            } else {
+                self.prev_token();
+                Ok(None)
+            }
+        } else {
+            Ok(None)
+        }
+    }
+
+    fn parse_optional_columns_definition_list_alias(&mut self) -> Option<Ident> {
+        match self.next_token().token {
+            Token::Word(w) if !keywords::RESERVED_FOR_TABLE_ALIAS.contains(&w.keyword) => {
+                Some(w.to_ident())
+            }
+            _ => {
+                self.prev_token();
+                None
+            }
+        }
+    }
+
+    fn parse_ident_pair(&mut self) -> Result<IdentPair, ParserError> {
+        Ok(IdentPair(
+            self.parse_identifier()?,
+            self.parse_identifier()?,
+        ))
+    }
+
     pub fn parse_derived_table_factor(
         &mut self,
         lateral: IsLateral,

src/test_utils.rs

@@ -185,6 +185,7 @@ pub fn table(name: impl Into<String>) -> TableFactor {
         name: ObjectName(vec![Ident::new(name.into())]),
         alias: None,
         args: None,
+        columns_definition: None,
         with_hints: vec![],
     }
 }

tests/sqlparser_bigquery.rs

@@ -44,6 +44,7 @@ fn parse_table_identifiers() {
                     name: ObjectName(expected),
                     alias: None,
                     args: None,
+                    columns_definition: None,
                     with_hints: vec![],
                 },
                 joins: vec![]

tests/sqlparser_clickhouse.rs

@@ -60,6 +60,7 @@ fn parse_map_access_expr() {
                     name: ObjectName(vec![Ident::new("foos")]),
                     alias: None,
                     args: None,
+                    columns_definition: None,
                     with_hints: vec![],
                 },
                 joins: vec![]
@@ -164,11 +165,13 @@ fn parse_delimited_identifiers() {
             name,
             alias,
             args,
+            columns_definition,
             with_hints,
         } => {
             assert_eq!(vec![Ident::with_quote('"', "a table")], name.0);
             assert_eq!(Ident::with_quote('"', "alias"), alias.unwrap().name);
             assert!(args.is_none());
+            assert!(columns_definition.is_none());
             assert!(with_hints.is_empty());
         }
         _ => panic!("Expecting TableFactor::Table"),

tests/sqlparser_common.rs

@@ -210,6 +210,7 @@ fn parse_update_set_from() {
                     name: ObjectName(vec![Ident::new("t1")]),
                     alias: None,
                     args: None,
+                    columns_definition: None,
                     with_hints: vec![],
                 },
                 joins: vec![],
@@ -236,6 +237,7 @@ fn parse_update_set_from() {
                                     name: ObjectName(vec![Ident::new("t1")]),
                                     alias: None,
                                     args: None,
+                                    columns_definition: None,
                                     with_hints: vec![],
                                 },
                                 joins: vec![],
@@ -298,6 +300,7 @@ fn parse_update_with_table_alias() {
                             columns: vec![],
                         }),
                         args: None,
+                        columns_definition: None,
                         with_hints: vec![],
                     },
                     joins: vec![],
@@ -353,6 +356,7 @@ fn parse_delete_statement() {
                     name: ObjectName(vec![Ident::with_quote('"', "table")]),
                     alias: None,
                     args: None,
+                    columns_definition: None,
                     with_hints: vec![],
                 },
                 table_name
@@ -379,6 +383,7 @@ fn parse_where_delete_statement() {
                     name: ObjectName(vec![Ident::new("foo")]),
                     alias: None,
                     args: None,
+                    columns_definition: None,
                     with_hints: vec![],
                 },
                 table_name,
@@ -419,6 +424,7 @@ fn parse_where_delete_with_alias_statement() {
                         columns: vec![],
                     }),
                     args: None,
+                    columns_definition: None,
                     with_hints: vec![],
                 },
                 table_name,
@@ -432,6 +438,7 @@ fn parse_where_delete_with_alias_statement() {
                         columns: vec![],
                     }),
                     args: None,
+                    columns_definition: None,
                     with_hints: vec![],
                 }),
                 using
@@ -3447,6 +3454,7 @@ fn parse_interval_and_or_xor() {
                     }]),
                     alias: None,
                     args: None,
+                    columns_definition: None,
                     with_hints: vec![],
                 },
                 joins: vec![],
@@ -3893,6 +3901,7 @@ fn parse_implicit_join() {
                     name: ObjectName(vec!["t1".into()]),
                     alias: None,
                     args: None,
+                    columns_definition: None,
                     with_hints: vec![],
                 },
                 joins: vec![],
@@ -3902,6 +3911,7 @@ fn parse_implicit_join() {
                     name: ObjectName(vec!["t2".into()]),
                     alias: None,
                     args: None,
+                    columns_definition: None,
                     with_hints: vec![],
                 },
                 joins: vec![],
@@ -3919,13 +3929,15 @@ fn parse_implicit_join() {
                     name: ObjectName(vec!["t1a".into()]),
                     alias: None,
                     args: None,
+                    columns_definition: None,
                     with_hints: vec![],
                 },
                 joins: vec![Join {
                     relation: TableFactor::Table {
                         name: ObjectName(vec!["t1b".into()]),
                         alias: None,
                         args: None,
+                        columns_definition: None,
                         with_hints: vec![],
                     },
                     join_operator: JoinOperator::Inner(JoinConstraint::Natural),
@@ -3936,13 +3948,15 @@ fn parse_implicit_join() {
                     name: ObjectName(vec!["t2a".into()]),
                     alias: None,
                     args: None,
+                    columns_definition: None,
                     with_hints: vec![],
                 },
                 joins: vec![Join {
                     relation: TableFactor::Table {
                         name: ObjectName(vec!["t2b".into()]),
                         alias: None,
                         args: None,
+                        columns_definition: None,
                         with_hints: vec![],
                     },
                     join_operator: JoinOperator::Inner(JoinConstraint::Natural),
@@ -3963,6 +3977,7 @@ fn parse_cross_join() {
                 name: ObjectName(vec![Ident::new("t2")]),
                 alias: None,
                 args: None,
+                columns_definition: None,
                 with_hints: vec![],
             },
             join_operator: JoinOperator::CrossJoin,
@@ -3983,6 +3998,7 @@ fn parse_joins_on() {
                 name: ObjectName(vec![Ident::new(relation.into())]),
                 alias,
                 args: None,
+                columns_definition: None,
                 with_hints: vec![],
             },
             join_operator: f(JoinConstraint::On(Expr::BinaryOp {
@@ -4052,6 +4068,7 @@ fn parse_joins_using() {
                 name: ObjectName(vec![Ident::new(relation.into())]),
                 alias,
                 args: None,
+                columns_definition: None,
                 with_hints: vec![],
             },
             join_operator: f(JoinConstraint::Using(vec!["c1".into()])),
@@ -4113,6 +4130,7 @@ fn parse_natural_join() {
                 name: ObjectName(vec![Ident::new("t2")]),
                 alias,
                 args: None,
+                columns_definition: None,
                 with_hints: vec![],
             },
             join_operator: f(JoinConstraint::Natural),
@@ -4377,6 +4395,7 @@ fn parse_derived_tables() {
                         name: ObjectName(vec!["t2".into()]),
                         alias: None,
                         args: None,
+                        columns_definition: None,
                         with_hints: vec![],
                     },
                     join_operator: JoinOperator::Inner(JoinConstraint::Natural),
@@ -5668,6 +5687,7 @@ fn parse_merge() {
                         columns: vec![],
                     }),
                     args: None,
+                    columns_definition: None,
                     with_hints: vec![],
                 }
             );
@@ -5691,6 +5711,7 @@ fn parse_merge() {
                                     name: ObjectName(vec![Ident::new("s"), Ident::new("foo")]),
                                     alias: None,
                                     args: None,
+                                    columns_definition: None,
                                     with_hints: vec![],
                                 },
                                 joins: vec![],

tests/sqlparser_hive.rs

@@ -320,11 +320,13 @@ fn parse_delimited_identifiers() {
             name,
             alias,
             args,
+            columns_definition,
             with_hints,
         } => {
             assert_eq!(vec![Ident::with_quote('"', "a table")], name.0);
             assert_eq!(Ident::with_quote('"', "alias"), alias.unwrap().name);
             assert!(args.is_none());
+            assert!(columns_definition.is_none());
             assert!(with_hints.is_empty());
         }
         _ => panic!("Expecting TableFactor::Table"),

tests/sqlparser_mssql.rs

@@ -152,11 +152,13 @@ fn parse_delimited_identifiers() {
             name,
             alias,
             args,
+            columns_definition,
             with_hints,
         } => {
             assert_eq!(vec![Ident::with_quote('"', "a table")], name.0);
             assert_eq!(Ident::with_quote('"', "alias"), alias.unwrap().name);
             assert!(args.is_none());
+            assert!(columns_definition.is_none());
             assert!(with_hints.is_empty());
         }
         _ => panic!("Expecting TableFactor::Table"),