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
#![deny(warnings)] //! Inquerest can parse complex url query into a SQL abstract syntax tree. //! //! Example this url: //! ```no_run,ignore //! /person?age=lt.42&(student=eq.true|gender=eq.'M')&group_by=sum(age),grade,gender&having=min(age)=gt.42&order_by=age.desc,height.asc&page=20&page_size=100 //! ``` //! will be parsed into: //! //! ```rust,ignore //! Select { //! from_table: FromTable { //! from: Table { //! name: "person", //! }, //! join: None, //! }, //! filter: Some( //! BinaryOperation( //! BinaryOperation { //! left: BinaryOperation( //! BinaryOperation { //! left: Column( //! Column { //! name: "age", //! }, //! ), //! operator: Lt, //! right: Value( //! Number( //! 42.0, //! ), //! ), //! }, //! ), //! operator: And, //! right: Nested( //! BinaryOperation( //! BinaryOperation { //! left: BinaryOperation( //! BinaryOperation { //! left: Column( //! Column { //! name: "student", //! }, //! ), //! operator: Eq, //! right: Value( //! Bool( //! true, //! ), //! ), //! }, //! ), //! operator: Or, //! right: BinaryOperation( //! BinaryOperation { //! left: Column( //! Column { //! name: "gender", //! }, //! ), //! operator: Eq, //! right: Value( //! String( //! "M", //! ), //! ), //! }, //! ), //! }, //! ), //! ), //! }, //! ), //! ), //! group_by: Some( //! [ //! Function( //! Function { //! name: "sum", //! params: [ //! Column( //! Column { //! name: "age", //! }, //! ), //! ], //! }, //! ), //! Column( //! Column { //! name: "grade", //! }, //! ), //! Column( //! Column { //! name: "gender", //! }, //! ), //! ], //! ), //! having: Some( //! BinaryOperation( //! BinaryOperation { //! left: Function( //! Function { //! name: "min", //! params: [ //! Column( //! Column { //! name: "age", //! }, //! ), //! ], //! }, //! ), //! operator: Gt, //! right: Value( //! Number( //! 42.0, //! ), //! ), //! }, //! ), //! ), //! projection: None, //! order_by: Some( //! [ //! Order { //! expr: Column( //! Column { //! name: "age", //! }, //! ), //! direction: Some( //! Desc, //! ), //! }, //! Order { //! expr: Column( //! Column { //! name: "height", //! }, //! ), //! direction: Some( //! Asc, //! ), //! }, //! ], //! ), //! range: Some( //! Page( //! Page { //! page: 20, //! page_size: 100, //! }, //! ), //! ), //! } //! ``` //! Which translate to the sql statement: //! ```sql //! SELECT * FROM person WHERE age < 42 AND (student = true OR gender = 'M') GROUP BY sum(age), grade, gender HAVING min(age) > 42 ORDER BY age DESC, height ASC LIMIT 100 OFFSET 1900 ROWS //! ``` //! Note: However, you don't want to convert to the sql statement directly to avoid sql injection //! attack. You need to validate the tables and columns if it is allowed to be accessed by the //! user. You also need to extract the values yourself and supply it as a parameterized value into //! your ORM. //! //! #### Please support this project: //! [](https://www.patreon.com/ivanceras) pub use restq; pub use restq::{ ast::{Expr, Select}, parser::filter_expr, to_chars, Error, }; /// Parse a path and query in a url to a Select AST /// Example: /// ```rust /// use inquerest::*; /// /// let url = "/person?age=lt.42&(student=eq.true|gender=eq.'M')&group_by=sum(age),grade,gender&having=min(age)=gt.42&order_by=age.desc,height.asc&page=20&page_size=100"; /// let query = inquerest::parse_query(url); /// println!("query: {:#?}", query); /// println!( /// "sql query: {}", /// query.unwrap().into_sql_statement(None).unwrap().to_string() /// ); /// ``` pub fn parse_query(input: &str) -> Result<Select, Error> { let input_chars = to_chars(input); restq::parse_select_chars(&input_chars) } /// Parse the query in a url to an Expression /// /// Example: /// ```rust /// use inquerest::*; /// /// let filter = "age=lt.42&(student=eq.true|gender=eq.'M')&group_by=sum(age),grade,gender&having=min(age)=gt.42&order_by=age.desc,height.asc&page=20&page_size=100"; /// let result = parse_filter(filter); /// println!("filter_only: {:#?}", result); /// ``` pub fn parse_filter(input: &str) -> Result<Expr, Error> { let input_chars = to_chars(input); parse_filter_chars(&input_chars) } fn parse_filter_chars(input: &[char]) -> Result<Expr, Error> { Ok(filter_expr().parse(input)?) }