Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for view comments for Snowflake #1287

Merged
merged 4 commits into from
May 30, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/ast/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1958,6 +1958,9 @@ pub enum Statement {
query: Box<Query>,
options: CreateTableOptions,
cluster_by: Vec<Ident>,
/// Snowflake: Views can have comments in Snowflake.
/// <https://docs.snowflake.com/en/sql-reference/sql/create-view#syntax>
comment: Option<String>,
/// if true, has RedShift [`WITH NO SCHEMA BINDING`] clause <https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_VIEW.html>
with_no_schema_binding: bool,
/// if true, has SQLite `IF NOT EXISTS` clause <https://www.sqlite.org/lang_createview.html>
Expand Down Expand Up @@ -3226,6 +3229,7 @@ impl fmt::Display for Statement {
materialized,
options,
cluster_by,
comment,
with_no_schema_binding,
if_not_exists,
temporary,
Expand All @@ -3239,6 +3243,9 @@ impl fmt::Display for Statement {
temporary = if *temporary { "TEMPORARY " } else { "" },
if_not_exists = if *if_not_exists { "IF NOT EXISTS " } else { "" }
)?;
if let Some(comment) = comment {
write!(f, " COMMENT = '{comment}'")?;
bombsimon marked this conversation as resolved.
Show resolved Hide resolved
}
if matches!(options, CreateTableOptions::With(_)) {
write!(f, " {options}")?;
}
Expand Down
16 changes: 16 additions & 0 deletions src/parser/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3903,6 +3903,21 @@ impl<'a> Parser<'a> {
};
}

let comment = if dialect_of!(self is SnowflakeDialect) {
bombsimon marked this conversation as resolved.
Show resolved Hide resolved
if self.parse_keyword(Keyword::COMMENT) {
let _ = self.consume_token(&Token::Eq);
bombsimon marked this conversation as resolved.
Show resolved Hide resolved
let next_token = self.next_token();
match next_token.token {
Token::SingleQuotedString(str) => Some(str),
_ => self.expected("comment", next_token)?,
bombsimon marked this conversation as resolved.
Show resolved Hide resolved
}
} else {
None
}
} else {
None
};

self.expect_keyword(Keyword::AS)?;
let query = self.parse_boxed_query()?;
// Optional `WITH [ CASCADED | LOCAL ] CHECK OPTION` is widely supported here.
Expand All @@ -3923,6 +3938,7 @@ impl<'a> Parser<'a> {
or_replace,
options,
cluster_by,
comment,
with_no_schema_binding,
if_not_exists,
temporary,
Expand Down
2 changes: 2 additions & 0 deletions tests/sqlparser_bigquery.rs
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,7 @@ fn parse_create_view_if_not_exists() {
materialized,
options,
cluster_by,
comment,
with_no_schema_binding: late_binding,
if_not_exists,
temporary,
Expand All @@ -320,6 +321,7 @@ fn parse_create_view_if_not_exists() {
assert!(!or_replace);
assert_eq!(options, CreateTableOptions::None);
assert_eq!(cluster_by, vec![]);
assert!(comment.is_none());
assert!(!late_binding);
assert!(if_not_exists);
assert!(!temporary);
Expand Down
53 changes: 53 additions & 0 deletions tests/sqlparser_common.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6251,6 +6251,7 @@ fn parse_create_view() {
materialized,
options,
cluster_by,
comment,
with_no_schema_binding: late_binding,
if_not_exists,
temporary,
Expand All @@ -6262,6 +6263,7 @@ fn parse_create_view() {
assert!(!or_replace);
assert_eq!(options, CreateTableOptions::None);
assert_eq!(cluster_by, vec![]);
assert!(comment.is_none());
assert!(!late_binding);
assert!(!if_not_exists);
assert!(!temporary);
Expand Down Expand Up @@ -6305,6 +6307,7 @@ fn parse_create_view_with_columns() {
query,
materialized,
cluster_by,
comment,
with_no_schema_binding: late_binding,
if_not_exists,
temporary,
Expand All @@ -6325,6 +6328,7 @@ fn parse_create_view_with_columns() {
assert!(!materialized);
assert!(!or_replace);
assert_eq!(cluster_by, vec![]);
assert!(comment.is_none());
assert!(!late_binding);
assert!(!if_not_exists);
assert!(!temporary);
Expand All @@ -6345,6 +6349,7 @@ fn parse_create_view_temporary() {
materialized,
options,
cluster_by,
comment,
with_no_schema_binding: late_binding,
if_not_exists,
temporary,
Expand All @@ -6356,6 +6361,7 @@ fn parse_create_view_temporary() {
assert!(!or_replace);
assert_eq!(options, CreateTableOptions::None);
assert_eq!(cluster_by, vec![]);
assert!(comment.is_none());
assert!(!late_binding);
assert!(!if_not_exists);
assert!(temporary);
Expand All @@ -6376,6 +6382,7 @@ fn parse_create_or_replace_view() {
query,
materialized,
cluster_by,
comment,
with_no_schema_binding: late_binding,
if_not_exists,
temporary,
Expand All @@ -6387,6 +6394,46 @@ fn parse_create_or_replace_view() {
assert!(!materialized);
assert!(or_replace);
assert_eq!(cluster_by, vec![]);
assert!(comment.is_none());
assert!(!late_binding);
assert!(!if_not_exists);
assert!(!temporary);
}
_ => unreachable!(),
}
}

#[test]
bombsimon marked this conversation as resolved.
Show resolved Hide resolved
fn parse_create_or_replace_with_comment_for_snowflake() {
let sql = "CREATE OR REPLACE VIEW v COMMENT = 'hello, world' AS SELECT 1";
let dialect = test_utils::TestedDialects {
dialects: vec![Box::new(SnowflakeDialect {}) as Box<dyn Dialect>],
options: None,
};

match dialect.verified_stmt(sql) {
Statement::CreateView {
name,
columns,
or_replace,
options,
query,
materialized,
cluster_by,
comment,
with_no_schema_binding: late_binding,
if_not_exists,
temporary,
} => {
assert_eq!("v", name.to_string());
assert_eq!(columns, vec![]);
assert_eq!(options, CreateTableOptions::None);
assert_eq!("SELECT 1", query.to_string());
assert!(!materialized);
assert!(or_replace);
assert_eq!(cluster_by, vec![]);
assert!(comment.is_some());
assert_eq!(comment.expect("expected comment"), "hello, world");
assert!(!late_binding);
assert!(!if_not_exists);
assert!(!temporary);
Expand All @@ -6411,6 +6458,7 @@ fn parse_create_or_replace_materialized_view() {
query,
materialized,
cluster_by,
comment,
with_no_schema_binding: late_binding,
if_not_exists,
temporary,
Expand All @@ -6422,6 +6470,7 @@ fn parse_create_or_replace_materialized_view() {
assert!(materialized);
assert!(or_replace);
assert_eq!(cluster_by, vec![]);
assert!(comment.is_none());
assert!(!late_binding);
assert!(!if_not_exists);
assert!(!temporary);
Expand All @@ -6442,6 +6491,7 @@ fn parse_create_materialized_view() {
materialized,
options,
cluster_by,
comment,
with_no_schema_binding: late_binding,
if_not_exists,
temporary,
Expand All @@ -6453,6 +6503,7 @@ fn parse_create_materialized_view() {
assert_eq!(options, CreateTableOptions::None);
assert!(!or_replace);
assert_eq!(cluster_by, vec![]);
assert!(comment.is_none());
assert!(!late_binding);
assert!(!if_not_exists);
assert!(!temporary);
Expand All @@ -6473,6 +6524,7 @@ fn parse_create_materialized_view_with_cluster_by() {
materialized,
options,
cluster_by,
comment,
with_no_schema_binding: late_binding,
if_not_exists,
temporary,
Expand All @@ -6484,6 +6536,7 @@ fn parse_create_materialized_view_with_cluster_by() {
assert_eq!(options, CreateTableOptions::None);
assert!(!or_replace);
assert_eq!(cluster_by, vec![Ident::new("foo")]);
assert!(comment.is_none());
assert!(!late_binding);
assert!(!if_not_exists);
assert!(!temporary);
Expand Down
2 changes: 2 additions & 0 deletions tests/sqlparser_sqlite.rs
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ fn parse_create_view_temporary_if_not_exists() {
materialized,
options,
cluster_by,
comment,
with_no_schema_binding: late_binding,
if_not_exists,
temporary,
Expand All @@ -178,6 +179,7 @@ fn parse_create_view_temporary_if_not_exists() {
assert!(!or_replace);
assert_eq!(options, CreateTableOptions::None);
assert_eq!(cluster_by, vec![]);
assert!(comment.is_none());
assert!(!late_binding);
assert!(if_not_exists);
assert!(temporary);
Expand Down
Loading