mirrors/datafusion-sqlparse
1
0
Fork 0
mirror of https://github.com/apache/datafusion-sqlparser-rs.git synced 2025-09-03 20:50:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Improve documentation on verified_* methods (#828)

Browse source
This commit is contained in:
Andrew Lamb 2023-03-07 13:07:29 +01:00 • committed by GitHub
parent 5f815c2b08
commit 9ea396d0da
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

42
src/test_utils.rs
View file

@ -68,17 +68,25 @@ impl TestedDialects {
}) })
} }
/// Parses a single SQL string into multiple statements, ensuring
/// the result is the same for all tested dialects.
pub fn parse_sql_statements(&self, sql: &str) -> Result<Vec<Statement>, ParserError> { pub fn parse_sql_statements(&self, sql: &str) -> Result<Vec<Statement>, ParserError> {
self.one_of_identical_results(|dialect| Parser::parse_sql(dialect, sql)) self.one_of_identical_results(|dialect| Parser::parse_sql(dialect, sql))
// To fail the `ensure_multiple_dialects_are_tested` test: // To fail the `ensure_multiple_dialects_are_tested` test:
// Parser::parse_sql(&**self.dialects.first().unwrap(), sql) // Parser::parse_sql(&**self.dialects.first().unwrap(), sql)
} }
/// Ensures that `sql` parses as a single statement and returns it. /// Ensures that `sql` parses as a single [Statement] for all tested
/// If non-empty `canonical` SQL representation is provided, /// dialects.
/// additionally asserts that parsing `sql` results in the same parse ///
/// tree as parsing `canonical`, and that serializing it back to string /// If `canonical` is non empty,this function additionally asserts
/// results in the `canonical` representation. /// that:
///
/// 1. parsing `sql` results in the same [`Statement`] as parsing
/// `canonical`.
///
/// 2. re-serializing the result of parsing `sql` produces the same
/// `canonical` sql string
pub fn one_statement_parses_to(&self, sql: &str, canonical: &str) -> Statement { pub fn one_statement_parses_to(&self, sql: &str, canonical: &str) -> Statement {
let mut statements = self.parse_sql_statements(sql).unwrap(); let mut statements = self.parse_sql_statements(sql).unwrap();
assert_eq!(statements.len(), 1); assert_eq!(statements.len(), 1);
@ -94,14 +102,16 @@ impl TestedDialects {
only_statement only_statement
} }
/// Ensures that `sql` parses as a single [Statement], and is not modified /// Ensures that `sql` parses as a single [Statement], and that
/// after a serialization round-trip. /// re-serializing the parse result produces the same `sql`
pub fn verified_stmt(&self, query: &str) -> Statement { /// string (is not modified after a serialization round-trip).
self.one_statement_parses_to(query, query) pub fn verified_stmt(&self, sql: &str) -> Statement {
self.one_statement_parses_to(sql, sql)
} }
/// Ensures that `sql` parses as a single [Query], and is not modified /// Ensures that `sql` parses as a single [Query], and that
/// after a serialization round-trip. /// re-serializing the parse result produces the same `sql`
/// string (is not modified after a serialization round-trip).
pub fn verified_query(&self, sql: &str) -> Query { pub fn verified_query(&self, sql: &str) -> Query {
match self.verified_stmt(sql) { match self.verified_stmt(sql) {
Statement::Query(query) => *query, Statement::Query(query) => *query,
@ -109,8 +119,9 @@ impl TestedDialects {
} }
} }
/// Ensures that `sql` parses as a single [Select], and is not modified /// Ensures that `sql` parses as a single [Select], and that
/// after a serialization round-trip. /// re-serializing the parse result produces the same `sql`
/// string (is not modified after a serialization round-trip).
pub fn verified_only_select(&self, query: &str) -> Select { pub fn verified_only_select(&self, query: &str) -> Select {
match *self.verified_query(query).body { match *self.verified_query(query).body {
SetExpr::Select(s) => *s, SetExpr::Select(s) => *s,
@ -118,8 +129,9 @@ impl TestedDialects {
} }
} }
/// Ensures that `sql` parses as an expression, and is not modified /// Ensures that `sql` parses as an [`Expr`], and that
/// after a serialization round-trip. /// re-serializing the parse result produces the same `sql`
/// string (is not modified after a serialization round-trip).
pub fn verified_expr(&self, sql: &str) -> Expr { pub fn verified_expr(&self, sql: &str) -> Expr {
let ast = self let ast = self
.run_parser_method(sql, |parser| parser.parse_expr()) .run_parser_method(sql, |parser| parser.parse_expr())