implemented optimize for, fixes #348

Author: wumpz

src/main/java/net/sf/jsqlparser/statement/select/OptimizeFor.java

@@ -0,0 +1,47 @@
+/*
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2019 JSQLParser
+ * %%
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation, either version 2.1 of the
+ * License, or (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Lesser Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Lesser Public
+ * License along with this program.  If not, see
+ * <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ * #L%
+ */
+package net.sf.jsqlparser.statement.select;
+
+/**
+ * A optimize for clause.
+ */
+public class OptimizeFor {
+
+    private long rowCount;
+
+    public OptimizeFor(long rowCount) {
+        this.rowCount = rowCount;
+    }
+
+    public long getRowCount() {
+        return rowCount;
+    }
+
+    public void setRowCount(long l) {
+        rowCount = l;
+    }
+
+    @Override
+    public String toString() {
+        return " OPTIMIZE FOR " + rowCount + " ROWS";
+    }
+}

src/main/java/net/sf/jsqlparser/statement/select/PlainSelect.java

@@ -21,16 +21,15 @@
  */
 package net.sf.jsqlparser.statement.select;
 
-import net.sf.jsqlparser.expression.Expression;
-import net.sf.jsqlparser.expression.OracleHierarchicalExpression;
-import net.sf.jsqlparser.expression.OracleHint;
-import net.sf.jsqlparser.schema.Table;
-import net.sf.jsqlparser.parser.ASTNodeAccessImpl;
-
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Iterator;
 import java.util.List;
+import net.sf.jsqlparser.expression.Expression;
+import net.sf.jsqlparser.expression.OracleHierarchicalExpression;
+import net.sf.jsqlparser.expression.OracleHint;
+import net.sf.jsqlparser.parser.ASTNodeAccessImpl;
+import net.sf.jsqlparser.schema.Table;
 
 /**
  * The core of a "SELECT" statement (no UNION, no ORDER BY)
@@ -49,6 +48,7 @@ public class PlainSelect extends ASTNodeAccessImpl implements SelectBody {
     private Limit limit;
     private Offset offset;
     private Fetch fetch;
+    private OptimizeFor optimizeFor;
     private Skip skip;
     private First first;
     private Top top;
@@ -169,6 +169,14 @@ public void setFetch(Fetch fetch) {
         this.fetch = fetch;
     }
 
+    public OptimizeFor getOptimizeFor() {
+        return optimizeFor;
+    }
+
+    public void setOptimizeFor(OptimizeFor optimizeFor) {
+        this.optimizeFor = optimizeFor;
+    }
+
     public Top getTop() {
         return top;
     }
@@ -377,6 +385,9 @@ public String toString() {
                     sql.append(wait);
                 }
             }
+            if (optimizeFor != null) {
+                sql.append(optimizeFor);
+            }
         } else {
             //without from
             if (where != null) {

src/main/java/net/sf/jsqlparser/util/deparser/SelectDeParser.java

@@ -21,7 +21,6 @@
  */
 package net.sf.jsqlparser.util.deparser;
 
-import java.util.*;
 import net.sf.jsqlparser.expression.*;
 import net.sf.jsqlparser.schema.*;
 import net.sf.jsqlparser.statement.select.*;
@@ -188,6 +187,9 @@ public void visit(PlainSelect plainSelect) {
                 buffer.append(plainSelect.getWait());
             }
         }
+        if (plainSelect.getOptimizeFor() != null) {
+            deparseOptimizeFor(plainSelect.getOptimizeFor());
+        }
         if (plainSelect.isUseBrackets()) {
             buffer.append(")");
         }
@@ -479,4 +481,10 @@ public void visit(ParenthesisFromItem parenthesis) {
     public void visit(ValuesStatement values) {
         new ValuesStatementDeParser(expressionVisitor, buffer).deParse(values);
     }
+
+    private void deparseOptimizeFor(OptimizeFor optimizeFor) {
+        buffer.append(" OPTIMIZE FOR ");
+        buffer.append(optimizeFor.getRowCount());
+        buffer.append(" ROWS");
+    }
 }

src/main/jjtree/net/sf/jsqlparser/parser/JSqlParserCC.jjt

@@ -249,6 +249,7 @@ TOKEN: /* SQL Keywords. prefixed with K_ to avoid name clashes */
 |   <K_ORDER:"ORDER">
 |   <K_OUTER:"OUTER">
 |   <K_OVER:"OVER">
+|   <K_OPTIMIZE: "OPTIMIZE" >
 |   <K_PARTITION:"PARTITION">
 |   <K_PERCENT:"PERCENT">
 |   <K_PIVOT:"PIVOT">
@@ -1097,7 +1098,7 @@ String RelObjectNameExt():
   String result=null;
 } 
 {
-    ( result=RelObjectName() | tk=<K_LEFT> | tk=<K_RIGHT> | tk=<K_SET> | tk=<K_DOUBLE> | tk=<K_IF>)
+    ( result=RelObjectName() | tk=<K_LEFT> | tk=<K_RIGHT> | tk=<K_SET> | tk=<K_DOUBLE> | tk=<K_IF> | <K_OPTIMIZE>)
     {
         if (tk!=null) result=tk.image;
         return result;
@@ -1181,6 +1182,7 @@ PlainSelect PlainSelect() #PlainSelect:
     Limit limit = null;
     Offset offset = null;
     Fetch fetch = null;
+    OptimizeFor optimize = null;
     Top top = null;
         Skip skip = null;
         First first = null;
@@ -1189,6 +1191,7 @@ PlainSelect PlainSelect() #PlainSelect:
     Table updateTable = null;
     Wait wait = null;
     boolean mySqlSqlCalcFoundRows = false;
+    Token token;
 }
 {
     <K_SELECT>
@@ -1243,6 +1246,8 @@ PlainSelect PlainSelect() #PlainSelect:
         [ <K_OF> updateTable = Table() { plainSelect.setForUpdateTable(updateTable); } ]
         [ LOOKAHEAD(<K_WAIT>) wait = Wait() { plainSelect.setWait(wait); } ] ]
 
+    [LOOKAHEAD(<K_OPTIMIZE>) optimize = OptimizeFor() { plainSelect.setOptimizeFor(optimize); } ]
+
     {
         plainSelect.setSelectItems(selectItems);
         plainSelect.setFromItem(fromItem);
@@ -1995,6 +2000,18 @@ Fetch Fetch():
     }
 }
 
+OptimizeFor OptimizeFor():
+{
+    Token token;
+    LongValue value;
+}
+{
+    <K_OPTIMIZE> <K_FOR> token=<S_LONG> <K_ROWS> { value = new LongValue(token.image); }
+    {
+        return new OptimizeFor(value.getValue());
+    }
+}
+
 // according to http://technet.microsoft.com/en-us/library/ms189463.aspx
 Top Top():
 {

src/test/java/net/sf/jsqlparser/statement/select/SelectTest.java

@@ -3350,6 +3350,11 @@ public void testCaseThenCondition5() throws JSQLParserException {
         assertSqlCanBeParsedAndDeparsed("SELECT * FROM col WHERE CASE WHEN a = 'c' THEN a IN (SELECT id FROM mytable) ELSE b IN (SELECT id FROM mytable) END");
     }
 
+    @Test
+    public void testOptimizeForIssue348() throws JSQLParserException {
+        assertSqlCanBeParsedAndDeparsed("SELECT * FROM EMP ORDER BY SALARY DESC OPTIMIZE FOR 20 ROWS");
+    }
+
     @Test
     public void testRawStringExpressionIssue656() throws JSQLParserException {
         for (String c : new String[]{"u", "e", "n", "r", "b", "rb"}) {