lib/sql_parser.mly

   1 /*
   2   Simple SQL parser
   3 */
   4
   5
   6 %{
   7   open Sql
   8   open Sql.Type
   9   open Sql.Constraint
  10   open Syntax
  11
  12   (* preserve order *)
  13   let make_limit l =
  14     let param = function
  15       | _, `Const _ -> None
  16       | x, `Param (None,pos) -> Some ((Some (match x with `Limit -> "limit" | `Offset -> "offset"),pos),Int)
  17       | _, `Param p -> Some (p,Int)
  18     in
  19     list_filter_map param l, List.mem (`Limit,`Const 1) l
  20
  21   let poly ret args = Fun (F (Typ ret, List.map (fun _ -> Var 0) args), args)
  22 %}
  23
  24 %token <int> INTEGER
  25 %token <string> IDENT TEXT BLOB
  26 %token <float> FLOAT
  27 %token <Sql.param_id> PARAM
  28 %token <Sql.Type.func> FUNCTION
  29 %token LPAREN RPAREN COMMA EOF DOT NULL
  30 %token CONFLICT_ALGO
  31 %token SELECT INSERT OR INTO CREATE UPDATE VIEW TABLE VALUES WHERE ASTERISK DISTINCT ALL ANY SOME
  32        LIMIT ORDER BY DESC ASC EQUAL DELETE FROM DEFAULT OFFSET SET JOIN LIKE_OP LIKE
  33        EXCL TILDE NOT BETWEEN AND ESCAPE USING UNION EXCEPT INTERSECT AS
  34        CONCAT_OP JOIN_TYPE1 JOIN_TYPE2 NATURAL CROSS REPLACE IN GROUP HAVING
  35        UNIQUE PRIMARY KEY FOREIGN AUTOINCREMENT ON CONFLICT TEMPORARY IF EXISTS
  36        PRECISION UNSIGNED ZEROFILL VARYING CHARSET NATIONAL ASCII UNICODE COLLATE BINARY CHARACTER
  37        DATETIME_FUNC DATE TIME TIMESTAMP ALTER ADD COLUMN CASCADE RESTRICT DROP
  38        GLOBAL LOCAL VALUE REFERENCES CHECK CONSTRAINT IGNORED AFTER INDEX FULLTEXT FIRST
  39        CASE WHEN THEN ELSE END CHANGE MODIFY DELAYED ENUM FOR SHARE MODE LOCK
  40        OF WITH NOWAIT ACTION NO IS INTERVAL
  41 %token MICROSECOND SECOND MINUTE HOUR DAY WEEK MONTH QUARTER YEAR
  42        SECOND_MICROSECOND MINUTE_MICROSECOND MINUTE_SECOND
  43        HOUR_MICROSECOND HOUR_SECOND HOUR_MINUTE
  44        DAY_MICROSECOND DAY_SECOND DAY_MINUTE DAY_HOUR
  45        YEAR_MONTH FALSE TRUE DUPLICATE
  46 %token NUM_DIV_OP NUM_BIT_OP NUM_EQ_OP NUM_CMP_OP PLUS MINUS
  47 %token T_INTEGER T_BLOB T_TEXT T_FLOAT T_BOOLEAN T_DATETIME
  48
  49 (*
  50 %left COMMA_JOIN
  51 %left JOIN_JOIN
  52 *)
  53 (* FIXME precedence of COMMA and JOIN *)
  54
  55 %left OR
  56 %left AND
  57 %nonassoc EQUAL NUM_EQ_OP
  58 %nonassoc NUM_CMP_OP
  59 %nonassoc NUM_BIT_OP
  60 %left PLUS MINUS
  61 %left ASTERISK NUM_DIV_OP
  62 %left CONCAT_OP
  63 %nonassoc UNARY_MINUS
  64
  65 %type <Sql.expr> expr
  66
  67 %start <Sql.stmt> input
  68
  69 %%
  70
  71 input: statement EOF { $1 }
  72
  73 if_not_exists: IF NOT EXISTS { }
  74 if_exists: IF EXISTS {}
  75 temporary: either(GLOBAL,LOCAL)? TEMPORARY { }
  76
  77 statement: CREATE ioption(temporary) TABLE ioption(if_not_exists) name=IDENT schema=table_definition
  78               {
  79                 Create (name,`Schema schema)
  80               }
  81          | CREATE either(TABLE,VIEW) name=IDENT AS select=maybe_parenth(select_stmt)
  82               {
  83                 Create (name,`Select select)
  84               }
  85          | ALTER TABLE name=table_name actions=commas(alter_action)
  86               {
  87                 Alter (name,actions)
  88               }
  89          | DROP TABLE if_exists? name=IDENT
  90               {
  91                 Drop name
  92               }
  93          | CREATE UNIQUE? INDEX if_not_exists? name=table_name ON table=table_name cols=sequence(index_column)
  94               {
  95                 CreateIndex (name, table, cols)
  96               }
  97          | select_stmt { Select $1 }
  98          | insert_cmd target=IDENT names=sequence(IDENT)? VALUES values=sequence(expr)? ss=on_duplicate?
  99               {
 100                 Insert { target; action=`Values (names, values); on_duplicate=ss; }
 101               }
 102          | insert_cmd target=IDENT names=sequence(IDENT)? select=maybe_parenth(select_stmt) ss=on_duplicate?
 103               {
 104                 Insert { target; action=`Select (names, select); on_duplicate=ss; }
 105               }
 106          | insert_cmd target=IDENT SET set=commas(set_column)? ss=on_duplicate?
 107               {
 108                 Insert { target; action=`Set set; on_duplicate=ss; }
 109               }
 110          | update_cmd table=IDENT SET ss=commas(set_column) w=where? o=loption(order) lim=loption(limit)
 111               {
 112                 Update (table,ss,w,o,lim)
 113               }
 114          /* http://dev.mysql.com/doc/refman/5.1/en/update.html multi-table syntax */
 115          | update_cmd tables=commas(source) SET ss=commas(set_column) w=where?
 116               {
 117                 UpdateMulti (tables,ss,w)
 118               }
 119          | DELETE FROM table=IDENT w=where?
 120               {
 121                 Delete (table,w)
 122               }
 123          | SET name=IDENT EQUAL e=expr
 124               {
 125                 Set (name, e)
 126               }
 127
 128 table_name: name=IDENT | IDENT DOT name=IDENT { name } (* FIXME db name *)
 129 index_prefix: LPAREN n=INTEGER RPAREN { n }
 130 index_column: name=IDENT index_prefix? collate? order_type? { name }
 131
 132 table_definition: t=sequence_(column_def1) table_def_done { list_filter_map (function `Attr a -> Some a | `Constraint _ | `Index _ -> None) t }
 133                 | LIKE name=maybe_parenth(IDENT) { Tables.get name |> snd } (* mysql *)
 134
 135 (* ugly, can you fixme? *)
 136 (* ignoring everything after RPAREN (NB one look-ahead token) *)
 137 table_def_done: table_def_done1 RPAREN IGNORED* { Parser_state.mode_normal () }
 138 table_def_done1: { Parser_state.mode_ignore () }
 139
 140 select_stmt: select_core other=list(preceded(compound_op,select_core)) o=loption(order) lim=limit_t? select_row_locking?
 141               {
 142                 { select = ($1, other); order=o; limit=lim; }
 143               }
 144
 145 select_core: SELECT select_type? r=commas(column1) f=from?  w=where?  g=loption(group) h=having?
 146               {
 147                 { columns=r; from=f; where=w; group=g; having=h; }
 148               }
 149
 150 table_list: src=source joins=join_source* { (src,joins) }
 151
 152 join_source: NATURAL maybe_join_type JOIN src=source { src,`Natural }
 153            | CROSS JOIN src=source { src,`Cross }
 154            | qualified_join src=source cond=join_cond { src,cond }
 155
 156 qualified_join: COMMA | maybe_join_type JOIN { }
 157
 158 join_cond: ON e=expr { `Search e }
 159          | USING l=sequence(IDENT) { `Using l }
 160          | (* *) { `Default }
 161
 162 source1: IDENT { `Table $1 }
 163        | LPAREN s=select_core RPAREN { `Select s }
 164
 165 source: src=source1 alias=maybe_as { src, alias }
 166
 167 insert_cmd: INSERT DELAYED? OR? conflict_algo INTO | INSERT INTO | REPLACE INTO { }
 168 update_cmd: UPDATE | UPDATE OR conflict_algo { }
 169 conflict_algo: CONFLICT_ALGO | REPLACE { }
 170 on_duplicate: ON DUPLICATE KEY UPDATE ss=commas(set_column) { ss }
 171
 172 select_type: DISTINCT | ALL { }
 173
 174 select_row_locking:
 175     for_update_or_share+
 176       { }
 177   | LOCK IN SHARE MODE
 178       { }
 179
 180 for_update_or_share:
 181   FOR either(UPDATE, SHARE) update_or_share_of? NOWAIT? with_lock? { }
 182
 183 update_or_share_of: OF commas(IDENT) { }
 184
 185 with_lock: WITH LOCK { }
 186
 187 int_or_param: i=INTEGER { `Const i }
 188             | p=PARAM { `Param p }
 189
 190 limit_t: LIMIT lim=int_or_param { make_limit [`Limit,lim] }
 191        | LIMIT ofs=int_or_param COMMA lim=int_or_param { make_limit [`Offset,ofs; `Limit,lim] }
 192        | LIMIT lim=int_or_param OFFSET ofs=int_or_param { make_limit [`Limit,lim; `Offset,ofs] }
 193
 194 limit: limit_t { fst $1 }
 195
 196 order: ORDER BY l=commas(terminated(expr,order_type?)) { l }
 197 order_type: DESC | ASC { }
 198
 199 from: FROM t=table_list { t }
 200 where: WHERE e=expr { e }
 201 group: GROUP BY l=expr_list { l }
 202 having: HAVING e=expr { e }
 203
 204 column1:
 205        | IDENT DOT ASTERISK { Sql.AllOf $1 }
 206        | ASTERISK { Sql.All }
 207        | e=expr m=maybe_as { Sql.Expr (e,m) }
 208
 209 maybe_as: AS? name=IDENT { Some name }
 210         | { None }
 211
 212 maybe_parenth(X): x=X | LPAREN x=X RPAREN { x }
 213
 214 alter_action: ADD COLUMN? col=maybe_parenth(column_def) pos=alter_pos { `Add (col,pos) }
 215             | ADD index_type IDENT? sequence(IDENT) { `None }
 216             | DROP INDEX IDENT { `None }
 217             | DROP PRIMARY KEY { `None }
 218             | DROP COLUMN? col=IDENT drop_behavior? { `Drop col } (* FIXME behavior? *)
 219             | CHANGE COLUMN? old_name=IDENT column=column_def pos=alter_pos { `Change (old_name,column,pos) }
 220             | MODIFY COLUMN? column=column_def pos=alter_pos { `Change (column.name,column,pos) }
 221             | SET IDENT IDENT { `None }
 222 index_type: INDEX | FULLTEXT | PRIMARY KEY { }
 223 alter_pos: AFTER col=IDENT { `After col }
 224          | FIRST { `First }
 225          | { `Default }
 226 drop_behavior: CASCADE | RESTRICT { }
 227
 228 column_def: name=IDENT t=sql_type? column_def_extra*
 229     { attr name (match t with Some x -> x | None -> Int) }
 230
 231 column_def1: c=column_def { `Attr c }
 232            | pair(CONSTRAINT,IDENT)? c=table_constraint_1 { `Constraint c }
 233            | INDEX cols=sequence(index_column) { `Index cols }
 234
 235 on_conflict: ON CONFLICT algo=conflict_algo { algo }
 236 column_def_extra: PRIMARY KEY { Some PrimaryKey }
 237                 | NOT NULL { Some NotNull }
 238                 | NULL { None }
 239                 | UNIQUE { Some Unique }
 240                 | AUTOINCREMENT { Some Autoincrement }
 241                 | on_conflict { None }
 242                 | CHECK LPAREN expr RPAREN { None }
 243                 | DEFAULT default_value { None } (* FIXME check type with column *)
 244                 | COLLATE IDENT { None }
 245
 246 default_value: single_literal_value | datetime_value { } (* sub expr ? *)
 247
 248 (* FIXME check columns *)
 249 table_constraint_1:
 250       | some_key IDENT? key_arg { [] }
 251       | FOREIGN KEY IDENT? sequence(IDENT) REFERENCES IDENT sequence(IDENT)?
 252         reference_action_clause*
 253           { [] }
 254       | CHECK LPAREN expr RPAREN { [] }
 255
 256 reference_action_clause:
 257   ON either(DELETE, UPDATE) reference_action { }
 258
 259 reference_action:
 260   RESTRICT | CASCADE | SET NULL | NO ACTION | SET DEFAULT { }
 261
 262 some_key: UNIQUE KEY? | PRIMARY? KEY | FULLTEXT KEY { }
 263 key_arg: LPAREN VALUE RPAREN | sequence(IDENT) { }
 264
 265 set_column: name=attr_name EQUAL e=expr { name,e }
 266
 267 (* expr: expr1 { $1 |> Syntax.expr_to_string |> prerr_endline; $1 } *)
 268
 269 anyall: ANY | ALL | SOME { }
 270
 271 mnot(X): NOT x = X | x = X { x }
 272
 273 attr_name: cname=IDENT { { cname; tname=None} }
 274          | table=IDENT DOT cname=IDENT
 275          | IDENT DOT table=IDENT DOT cname=IDENT { {cname; tname=Some table} } (* FIXME database identifier *)
 276
 277 expr:
 278       expr numeric_bin_op expr %prec PLUS { Fun ((Ret Any),[$1;$3]) } (* TODO default Int *)
 279     | expr boolean_bin_op expr %prec AND { Fun ((fixed Bool [Bool;Bool]),[$1;$3]) }
 280     | e1=expr comparison_op anyall? e2=expr %prec EQUAL { poly Bool [e1;e2] }
 281     | expr CONCAT_OP expr { Fun ((fixed Text [Text;Text]),[$1;$3]) }
 282     | e1=expr mnot(like) e2=expr e3=escape?
 283       {
 284         match e3 with
 285         | None -> Fun ((fixed Bool [Text; Text]), [e1;e2])
 286         | Some e3 -> Fun ((fixed Bool [Text; Text; Text]), [e1;e2;e3])
 287       }
 288     | unary_op expr { $2 }
 289     | MINUS expr %prec UNARY_MINUS { $2 }
 290     | INTERVAL expr interval_unit { Fun (fixed Datetime [Int], [$2]) }
 291     | LPAREN expr RPAREN { $2 }
 292     | attr_name { Column $1 }
 293     | v=literal_value | v=datetime_value { v }
 294     | e1=expr mnot(IN) l=sequence(expr) { poly Bool (e1::l) }
 295     | e1=expr mnot(IN) LPAREN select=select_stmt RPAREN
 296       {
 297         Fun ((Poly Bool),[e1; Select (select, true)])
 298       }
 299     | e1=expr IN table=IDENT { Tables.check table; e1 }
 300     | LPAREN select=select_stmt RPAREN { Select (select, true) }
 301     | PARAM { Param ($1,Any) }
 302     | f=FUNCTION LPAREN p=func_params RPAREN { Fun (f,p) }
 303     | expr IS NOT? NULL { Fun (Ret Bool, [$1]) }
 304     | expr mnot(BETWEEN) expr AND expr { poly Bool [$1;$3;$5] }
 305     | mnot(EXISTS) LPAREN select=select_stmt RPAREN { Fun ((Ret Bool),[Select (select,false)]) } (* FIXME Poly Bool *)
 306     | CASE e1=expr? branches=nonempty_list(case_branch) e2=preceded(ELSE,expr)? END (* FIXME typing *)
 307       {
 308         let maybe f = function None -> [] | Some x -> [f x] in
 309         let t_args =
 310           match e1 with
 311           | None -> (List.flatten @@ List.map (fun _ -> [Typ Bool; Var 1]) branches)
 312           | Some _ -> [Var 0] @ (List.flatten @@ List.map (fun _ -> [Var 0; Var 1]) branches)
 313         in
 314         let t_args = t_args @ maybe (fun _ -> Var 1) e2 in
 315         let v_args = maybe Prelude.identity e1 @ List.flatten branches @ maybe Prelude.identity e2 in
 316         Fun (F (Var 1, t_args), v_args)
 317       }
 318
 319 case_branch: WHEN e1=expr THEN e2=expr { [e1;e2] }
 320 like: LIKE | LIKE_OP { }
 321
 322 datetime_value: | DATETIME_FUNC | DATETIME_FUNC LPAREN INTEGER? RPAREN { Value Datetime }
 323
 324 literal_value:
 325     | TEXT { Value Text }
 326     | BLOB { Value Blob }
 327     | INTEGER { Value Int }
 328     | FLOAT { Value Float }
 329     | TRUE
 330     | FALSE { Value Bool }
 331     | DATE TEXT
 332     | TIME TEXT
 333     | TIMESTAMP TEXT { Value Datetime }
 334     | NULL { Value Any } (* he he *)
 335
 336 single_literal_value:
 337     | literal_value { $1 }
 338     | MINUS INTEGER { Value Int }
 339     | MINUS FLOAT { Value Float }
 340
 341 expr_list: l=commas(expr) { l }
 342 func_params: expr_list { $1 }
 343            | ASTERISK { [] }
 344            | (* *) { [] }
 345 escape: ESCAPE expr { $2 }
 346 numeric_bin_op: PLUS | MINUS | ASTERISK | NUM_DIV_OP | NUM_BIT_OP { }
 347 comparison_op: EQUAL | NUM_CMP_OP | NUM_EQ_OP { }
 348 boolean_bin_op: AND | OR { }
 349
 350 unary_op: EXCL { }
 351         | TILDE { }
 352         | NOT { }
 353
 354 interval_unit: MICROSECOND | SECOND | MINUTE | HOUR | DAY | WEEK | MONTH | QUARTER | YEAR
 355              | SECOND_MICROSECOND | MINUTE_MICROSECOND | MINUTE_SECOND
 356              | HOUR_MICROSECOND | HOUR_SECOND | HOUR_MINUTE
 357              | DAY_MICROSECOND | DAY_SECOND | DAY_MINUTE | DAY_HOUR
 358              | YEAR_MONTH { }
 359
 360 sql_type_flavor: T_INTEGER UNSIGNED? ZEROFILL? { Int }
 361                | binary { Blob }
 362                | NATIONAL? text VARYING? charset? collate? { Text }
 363                | ENUM sequence(TEXT) charset? collate? { Text }
 364                | T_FLOAT PRECISION? { Float }
 365                | T_BOOLEAN { Bool }
 366                | T_DATETIME | YEAR | DATE | TIME | TIMESTAMP { Datetime }
 367
 368 binary: T_BLOB | BINARY | BINARY VARYING { }
 369 text: T_TEXT | T_TEXT LPAREN INTEGER RPAREN | CHARACTER { }
 370
 371 %inline either(X,Y): X | Y { }
 372 %inline commas(X): l=separated_nonempty_list(COMMA,X) { l }
 373 (* (x1,x2,...,xn) *)
 374 %inline sequence_(X): LPAREN l=commas(X) { l }
 375 %inline sequence(X): l=sequence_(X) RPAREN { l }
 376
 377 charset: CHARSET either(IDENT,BINARY) | CHARACTER SET either(IDENT,BINARY) | ASCII | UNICODE { }
 378 collate: COLLATE IDENT { }
 379
 380 sql_type: t=sql_type_flavor
 381         | t=sql_type_flavor LPAREN INTEGER RPAREN UNSIGNED?
 382         | t=sql_type_flavor LPAREN INTEGER COMMA INTEGER RPAREN
 383         { t }
 384
 385 compound_op: UNION ALL? | EXCEPT | INTERSECT { }
 386
 387 maybe_join_type: JOIN_TYPE1? JOIN_TYPE2? { }
 388