Skip to content

Fix placeholder spans #1979

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

Merged
merged 4 commits into from
Aug 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
23 changes: 23 additions & 0 deletions src/ast/spans.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2512,4 +2512,27 @@ pub mod tests {
"CASE 1 WHEN 2 THEN 3 ELSE 4 END"
);
}

#[test]
fn test_placeholder_span() {
let sql = "\nSELECT\n :fooBar";
let r = Parser::parse_sql(&GenericDialect, sql).unwrap();
assert_eq!(1, r.len());
match &r[0] {
Statement::Query(q) => {
let col = &q.body.as_select().unwrap().projection[0];
match col {
SelectItem::UnnamedExpr(Expr::Value(ValueWithSpan {
value: Value::Placeholder(s),
span,
})) => {
assert_eq!(":fooBar", s);
assert_eq!(&Span::new((3, 3).into(), (3, 10).into()), span);
}
_ => panic!("expected unnamed expression; got {col:?}"),
}
}
stmt => panic!("expected query; got {stmt:?}"),
}
}
}
25 changes: 19 additions & 6 deletions src/parser/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9584,16 +9584,21 @@ impl<'a> Parser<'a> {
Token::HexStringLiteral(ref s) => ok_value(Value::HexStringLiteral(s.to_string())),
Token::Placeholder(ref s) => ok_value(Value::Placeholder(s.to_string())),
tok @ Token::Colon | tok @ Token::AtSign => {
// Not calling self.parse_identifier(false)? because only in placeholder we want to check numbers as idfentifies
// This because snowflake allows numbers as placeholders
let next_token = self.next_token();
// 1. Not calling self.parse_identifier(false)?
// because only in placeholder we want to check
// numbers as idfentifies. This because snowflake
// allows numbers as placeholders
// 2. Not calling self.next_token() to enforce `tok`
// be followed immediately by a word/number, ie.
// without any whitespace in between
let next_token = self.next_token_no_skip().unwrap_or(&EOF_TOKEN).clone();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understand the intent correctly is this saying that e.g. SELECT :foo is to be parsed as a placeholder but SELECT : foo should not? If so I think it would be good to mention that in a comment. Also can we add a test case to demonstrate this change?

let ident = match next_token.token {
Token::Word(w) => Ok(w.into_ident(next_token.span)),
Token::Number(w, false) => Ok(Ident::new(w)),
Token::Number(w, false) => Ok(Ident::with_span(next_token.span, w)),
_ => self.expected("placeholder", next_token),
}?;
let placeholder = tok.to_string() + &ident.value;
ok_value(Value::Placeholder(placeholder))
Ok(Value::Placeholder(tok.to_string() + &ident.value)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a test case for this to avoid future regressions? we have some span test cases here that we could add to

.with_span(Span::new(span.start, ident.span.end)))
}
unexpected => self.expected(
"a value",
Expand Down Expand Up @@ -17494,4 +17499,12 @@ mod tests {
canonical,
);
}

#[test]
fn test_placeholder_invalid_whitespace() {
for w in [" ", "/*invalid*/"] {
let sql = format!("\nSELECT\n :{w}fooBar");
assert!(Parser::parse_sql(&GenericDialect, &sql).is_err());
}
}
}
Loading