Merge pull request #822 from tomershay/support_full_text_search

Add support for full text search (MATCH..AGAINST)

Author: wumpz

src/main/java/net/sf/jsqlparser/expression/ExpressionVisitor.java

@@ -72,6 +72,8 @@ public interface ExpressionVisitor {
 
     void visit(InExpression inExpression);
 
+    void visit(FullTextSearch fullTextSearch);
+
     void visit(IsNullExpression isNullExpression);
 
     void visit(IsBooleanExpression isBooleanExpression);

src/main/java/net/sf/jsqlparser/expression/ExpressionVisitorAdapter.java

@@ -177,6 +177,13 @@ public void visit(IsNullExpression expr) {
         expr.getLeftExpression().accept(this);
     }
 
+    @Override
+    public void visit(FullTextSearch expr) {
+        for (Column col : expr.getMatchColumns()) {
+            col.accept(this);
+        }
+    }
+
     @Override
     public void visit(IsBooleanExpression expr) {
         expr.getLeftExpression().accept(this);

src/main/java/net/sf/jsqlparser/expression/operators/relational/FullTextSearch.java

@@ -0,0 +1,74 @@
+/*-
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2019 JSQLParser
+ * %%
+ * Dual licensed under GNU LGPL 2.1 or Apache License 2.0
+ * #L%
+ */
+package net.sf.jsqlparser.expression.operators.relational;
+
+import net.sf.jsqlparser.expression.Expression;
+import net.sf.jsqlparser.expression.ExpressionVisitor;
+import net.sf.jsqlparser.expression.StringValue;
+import net.sf.jsqlparser.parser.ASTNodeAccessImpl;
+import net.sf.jsqlparser.schema.Column;
+
+import java.util.Iterator;
+import java.util.List;
+
+public class FullTextSearch extends ASTNodeAccessImpl implements Expression {
+
+    private List<Column> _matchColumns;
+    private StringValue _againstValue;
+    private String _searchModifier;
+
+    public FullTextSearch() {
+
+    }
+
+    public void setMatchColumns(List<Column> columns) {
+        this._matchColumns = columns;
+    }
+
+    public List<Column> getMatchColumns() {
+        return this._matchColumns;
+    }
+
+    public void setAgainstValue(StringValue val) {
+        this._againstValue = val;
+    }
+
+    public StringValue getAgainstValue() {
+        return this._againstValue;
+    }
+
+    public void setSearchModifier(String val) {
+        this._searchModifier = val;
+    }
+
+    public String getSearchModifier() {
+        return this._searchModifier;
+    }
+
+    @Override
+    public void accept(ExpressionVisitor expressionVisitor) {
+        expressionVisitor.visit(this);
+    }
+
+    @Override
+    public String toString() {
+        // Build a list of matched columns
+        String columnsListCommaSeperated = "";
+        Iterator<Column> iterator = this._matchColumns.iterator();
+        while (iterator.hasNext()) {
+            Column col = iterator.next();
+            columnsListCommaSeperated += col.getFullyQualifiedName();
+            if (iterator.hasNext()) {
+                columnsListCommaSeperated += ",";
+            }
+        }
+        return "MATCH (" + columnsListCommaSeperated + ") AGAINST (" + this._againstValue + " " + this._searchModifier + ")";
+    }
+}

src/main/java/net/sf/jsqlparser/util/TablesNamesFinder.java

@@ -276,6 +276,10 @@ public void visit(InExpression inExpression) {
         inExpression.getRightItemsList().accept(this);
     }
 
+    @Override
+    public void visit(FullTextSearch fullTextSearch) {
+    }
+
     @Override
     public void visit(SignedExpression signedExpression) {
         signedExpression.getExpression().accept(this);

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

@@ -203,6 +203,21 @@ public void visit(InExpression inExpression) {
         inExpression.getRightItemsList().accept(this);
     }
 
+    @Override
+    public void visit(FullTextSearch fullTextSearch) {
+        // Build a list of matched columns
+        String columnsListCommaSeperated = "";
+        Iterator<Column> iterator = fullTextSearch.getMatchColumns().iterator();
+        while (iterator.hasNext()) {
+            Column col = iterator.next();
+            columnsListCommaSeperated += col.getFullyQualifiedName();
+            if (iterator.hasNext()) {
+                columnsListCommaSeperated += ",";
+            }
+        }
+        buffer.append("MATCH (" + columnsListCommaSeperated + ") AGAINST (" + fullTextSearch.getAgainstValue() + " " + fullTextSearch.getSearchModifier() + ")");
+    }
+
     @Override
     public void visit(SignedExpression signedExpression) {
         buffer.append(signedExpression.getSign());

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

@@ -107,6 +107,7 @@ TOKEN: /* SQL Keywords. prefixed with K_ to avoid name clashes */
     <K_ACTION: "ACTION">
 |   <K_ADD:"ADD">
 |   <K_ADVANCE:"ADVANCE">
+|   <K_AGAINST:"AGAINST">
 |   <K_ALGORITHM: "ALGORITHM">
 |   <K_ALL:"ALL">
 |   <K_ALTER:"ALTER">
@@ -205,6 +206,7 @@ TOKEN: /* SQL Keywords. prefixed with K_ to avoid name clashes */
 |   <K_LIKE:"LIKE">
 |   <K_LIMIT:"LIMIT">
 |   <K_LOW_PRIORITY : "LOW_PRIORITY">
+|   <K_MATCH: "MATCH">
 |   <K_MATCHED: "MATCHED">
 |   <K_MATERIALIZED:"MATERIALIZED">
 |   <K_MERGE: "MERGE">
@@ -2809,6 +2811,8 @@ Expression PrimaryExpression() #PrimaryExpression:
 
         | LOOKAHEAD(FunctionWithCondParams()) retval = FunctionWithCondParams()
 
+        | LOOKAHEAD(FullTextSearch()) retval = FullTextSearch()
+
         | LOOKAHEAD(Function()) retval=Function() [ LOOKAHEAD(2) retval = AnalyticExpression((Function)retval) ]
 
         | LOOKAHEAD(2) retval = IntervalExpression() { dateExpressionAllowed = false; }
@@ -3224,6 +3228,31 @@ Execute Execute(): {
     }
 }
 
+FullTextSearch FullTextSearch() : {
+    Column col;
+    Token searchModifier;
+    Token againstValue;
+    FullTextSearch fs = new FullTextSearch();
+    List<Column> matchedColumns = new ArrayList<Column>();
+    List<Expression> expList = new ArrayList<Expression>();
+}
+{
+    <K_MATCH> "(" col=Column() { matchedColumns.add(col); } ("," col=Column() { matchedColumns.add(col); } )* ")" <K_AGAINST>
+    "(" againstValue=<S_CHAR_LITERAL> { fs.setAgainstValue(new StringValue(againstValue.image)); }
+        (
+            searchModifier="IN NATURAL LANGUAGE MODE"
+            | searchModifier="IN NATURAL LANGUAGE MODE WITH QUERY EXPANSION"
+            | searchModifier="IN BOOLEAN MODE"
+            | searchModifier="WITH QUERY EXPANSION"
+        )
+        { fs.setSearchModifier(searchModifier.image); }
+    ")"
+    {
+        fs.setMatchColumns(matchedColumns);
+        return fs;
+    }
+}
+
 Function FunctionWithCondParams() #Function: {
     Function retval = new Function();
     String funcName = null;

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

@@ -1852,6 +1852,18 @@ public void testFunctionRight() throws JSQLParserException {
         assertSqlCanBeParsedAndDeparsed(statement);
     }
 
+    @Test
+    public void testOneColumnFullTextSearchMySQL() throws JSQLParserException {
+        String statement = "SELECT MATCH (col1) AGAINST ('test' IN NATURAL LANGUAGE MODE) relevance FROM tbl";
+        assertSqlCanBeParsedAndDeparsed(statement);
+    }
+
+    @Test
+    public void testSeveralColumnsFullTextSearchMySQL() throws JSQLParserException {
+        String statement = "SELECT MATCH (col1,col2,col3) AGAINST ('test' IN NATURAL LANGUAGE MODE) relevance FROM tbl";
+        assertSqlCanBeParsedAndDeparsed(statement);
+    }
+
     @Test
     public void testIsTrue() throws JSQLParserException {
         String statement = "SELECT col FROM tbl WHERE col IS TRUE";