kite_sql/parser/mod.rs
1// Copyright 2024 KipData/KiteSQL
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use sqlparser::parser::ParserError;
16use sqlparser::{ast::Statement, dialect::PostgreSqlDialect, parser::Parser};
17
18const DIALECT: PostgreSqlDialect = PostgreSqlDialect {};
19
20/// Parse a string to a collection of statements.
21///
22/// # Example
23/// ```rust
24/// use kite_sql::parser::parse_sql;
25/// let sql = "SELECT a, b, 123, myfunc(b) \
26/// FROM table_1 \
27/// WHERE a > b AND b < 100 \
28/// ORDER BY a DESC, b";
29/// let ast = parse_sql(sql).unwrap();
30/// println!("{:?}", ast);
31/// ```
32pub fn parse_sql<S: AsRef<str>>(sql: S) -> Result<Vec<Statement>, ParserError> {
33 Parser::parse_sql(&DIALECT, sql.as_ref())
34}