1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! Parse SQL into an AST
//!
//! This crate provides an lexer and parser that can parse SQL
//! into an Abstract Syntax Tree (AST). Currently primarily focused
//! on MariaDB/Mysql.
//!
//! Example code:
//!
//! ```
//! use sql_parse::{SQLDialect, SQLArguments, ParseOptions, parse_statement};
//!
//! let options = ParseOptions::new()
//! .dialect(SQLDialect::MariaDB)
//! .arguments(SQLArguments::QuestionMark)
//! .warn_unquoted_identifiers(true);
//!
//! let mut issues = Vec::new();
//!
//! let sql = "SELECT `monkey`,
//! FROM `t1` LEFT JOIN `t2` ON `t2`.`id` = `t1.two`
//! WHERE `t1`.`id` = ?";
//!
//! let ast = parse_statement(sql, &mut issues, &options);
//!
//! println!("Issues: {:#?}", issues);
//! println!("AST: {:#?}", ast);
//! ```
//!
#![no_std]
#![forbid(unsafe_code)]
extern crate alloc;
use alloc::vec::Vec;
use lexer::Token;
use parser::Parser;
mod alter;
mod create;
mod data_type;
mod delete;
mod drop;
mod expression;
mod identifier;
mod insert_replace;
mod issue;
mod keywords;
mod lexer;
mod parser;
mod select;
mod span;
mod sstring;
mod statement;
mod update;
pub use data_type::{DataType, DataTypeProperty, Type};
pub use identifier::Identifier;
pub use issue::{Issue, Level};
pub use span::{OptSpanned, Span, Spanned};
pub use sstring::SString;
pub use statement::{Statement, Union, UnionType, UnionWith};
pub use alter::{
AlterSpecification, AlterTable, ForeignKeyOn, ForeignKeyOnAction, ForeignKeyOnType, IndexCol,
IndexOption, IndexType,
};
pub use create::{
CreateAlgorithm, CreateDefinition, CreateFunction, CreateOption, CreateTable, CreateTrigger,
CreateView, TableOption,
};
pub use delete::{Delete, DeleteFlag};
pub use drop::{
DropDatabase, DropEvent, DropFunction, DropProcedure, DropServer, DropTable, DropTrigger,
DropView,
};
pub use expression::{
BinaryOperator, Expression, Function, IdentifierPart, Is, UnaryOperator, Variable, When,
};
pub use insert_replace::{
InsertReplace, InsertReplaceFlag, InsertReplaceType, OnConflict, OnConflictAction,
OnConflictTarget,
};
pub use select::{JoinSpecification, JoinType, Select, SelectExpr, SelectFlag, TableReference};
pub use update::{Update, UpdateFlag};
/// What sql diarect to parse as
#[derive(Clone, Debug)]
pub enum SQLDialect {
/// Parse MariaDB/Mysql SQL
MariaDB,
PostgreSQL,
}
impl SQLDialect {
pub fn is_postgresql(&self) -> bool {
matches!(self, SQLDialect::PostgreSQL)
}
pub fn is_maria(&self) -> bool {
matches!(self, SQLDialect::MariaDB)
}
}
/// What kinds or arguments
#[derive(Clone, Debug)]
pub enum SQLArguments {
/// The statements do not contain arguments
None,
/// Arguments are %s or %d
Percent,
/// Arguments are ?
QuestionMark,
/// Arguments ar #i
Dollar,
}
/// Options used when parsing sql
#[derive(Clone, Debug)]
pub struct ParseOptions {
dialect: SQLDialect,
arguments: SQLArguments,
warn_unquoted_identifiers: bool,
warn_none_capital_keywords: bool,
list_hack: bool,
}
impl Default for ParseOptions {
fn default() -> Self {
Self {
dialect: SQLDialect::MariaDB,
arguments: SQLArguments::None,
warn_none_capital_keywords: false,
warn_unquoted_identifiers: false,
list_hack: false,
}
}
}
impl ParseOptions {
pub fn new() -> Self {
Default::default()
}
/// Change whan SQL dialect to use
pub fn dialect(self, dialect: SQLDialect) -> Self {
Self { dialect, ..self }
}
pub fn get_dialect(&self) -> SQLDialect {
self.dialect.clone()
}
/// Change what kinds of arguments are supplied
pub fn arguments(self, arguments: SQLArguments) -> Self {
Self { arguments, ..self }
}
/// Should we warn about unquoted identifiers
pub fn warn_unquoted_identifiers(self, warn_unquoted_identifiers: bool) -> Self {
Self {
warn_unquoted_identifiers,
..self
}
}
/// Should we warn about unquoted identifiers
pub fn warn_none_capital_keywords(self, warn_none_capital_keywords: bool) -> Self {
Self {
warn_none_capital_keywords,
..self
}
}
/// Parse _LIST_ as special expression
pub fn list_hack(self, list_hack: bool) -> Self {
Self { list_hack, ..self }
}
}
/// Construct an "Internal compiler error" issue, containing the current file and line
#[macro_export]
macro_rules! issue_ice {
( $spanned:expr ) => {{
Issue::err(
alloc::format!("Internal compiler error in {}:{}", file!(), line!()),
$spanned,
)
}};
}
/// Construct an "Not yet implemented" issue, containing the current file and line
#[macro_export]
macro_rules! issue_todo {
( $spanned:expr ) => {{
Issue::err(
alloc::format!("Not yet implemented {}:{}", file!(), line!()),
$spanned,
)
}};
}
/// Parse multiple statements,
/// return an Vec of Statements even if there are parse errors.
/// The statements are free of errors if no Error issues are
/// added to issues
pub fn parse_statements<'a>(
src: &'a str,
issues: &mut Vec<Issue>,
options: &ParseOptions,
) -> Vec<Statement<'a>> {
let mut parser = Parser::new(src, issues, options);
statement::parse_statements(&mut parser)
}
/// Parse a single statement,
/// A statement may be returned even if there where parse errors.
/// The statement is free of errors if no Error issues are
/// added to issues
pub fn parse_statement<'a>(
src: &'a str,
issues: &mut Vec<Issue>,
options: &ParseOptions,
) -> Option<Statement<'a>> {
let mut parser = Parser::new(src, issues, options);
match statement::parse_statement(&mut parser) {
Ok(Some(v)) => {
if parser.token != Token::Eof {
parser.expected_error("Unexpected token after statement")
}
Some(v)
}
Ok(None) => {
parser.expected_error("Statement");
None
}
Err(_) => None,
}
}