You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by mk...@apache.org on 2022/11/02 07:43:06 UTC

[jackrabbit-oak] branch trunk updated: Oak-9958: Deprecate native queries (#723)

This is an automated email from the ASF dual-hosted git repository.

mkataria pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git


The following commit(s) were added to refs/heads/trunk by this push:
     new e44d4fac73 Oak-9958: Deprecate native queries (#723)
e44d4fac73 is described below

commit e44d4fac73e4fa7a705a404e4b6de4c2ac635e98
Author: Mohit Kataria <mk...@apache.org>
AuthorDate: Wed Nov 2 13:13:01 2022 +0530

    Oak-9958: Deprecate native queries (#723)
---
 .../apache/jackrabbit/oak/query/SQL2Parser.java    |  1 +
 oak-doc/src/site/markdown/query/lucene.md          |  1 +
 oak-doc/src/site/markdown/query/query-engine.md    |  2 +-
 .../oak/plugins/index/IndexQueryCommonTest.java    | 28 ++++++++++++++++++++++
 4 files changed, 31 insertions(+), 1 deletion(-)

diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/query/SQL2Parser.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/query/SQL2Parser.java
index 6e995844e8..59f34aa00c 100644
--- a/oak-core/src/main/java/org/apache/jackrabbit/oak/query/SQL2Parser.java
+++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/query/SQL2Parser.java
@@ -636,6 +636,7 @@ public class SQL2Parser {
                 }
             }
         } else if ("NATIVE".equalsIgnoreCase(functionName)) {
+            LOG.warn("Native queries are deprecated. Query:{}", statement);
             String selectorName;
             if (currentTokenType == IDENTIFIER) {
                 selectorName = readName();
diff --git a/oak-doc/src/site/markdown/query/lucene.md b/oak-doc/src/site/markdown/query/lucene.md
index 307fa9b1d4..a12dfb027d 100644
--- a/oak-doc/src/site/markdown/query/lucene.md
+++ b/oak-doc/src/site/markdown/query/lucene.md
@@ -1188,6 +1188,7 @@ See also [OAK-8971][OAK-8971].
 
 
 ### <a name="native-query"></a>Native Query and Index Selection
+`@deprecated Oak 1.46`
 
 Oak query engine supports native queries like
 
diff --git a/oak-doc/src/site/markdown/query/query-engine.md b/oak-doc/src/site/markdown/query/query-engine.md
index ce662539a5..cbf43b15ea 100644
--- a/oak-doc/src/site/markdown/query/query-engine.md
+++ b/oak-doc/src/site/markdown/query/query-engine.md
@@ -516,7 +516,7 @@ The SimpleExcerptProvider is also used for queries that don't use
 a Lucene index, or if the query uses a Lucene index, but excerpts are not configured there.
 
 ### Native Queries
-
+`@deprecated Oak 1.46`
 To take advantage of features that are available in full-text index implementations
 such as Apache Lucene and Apache Lucene Solr, so called `native` constraints are supported.
 Such constraints are passed directly to the full-text index. This is supported
diff --git a/oak-search/src/test/java/org/apache/jackrabbit/oak/plugins/index/IndexQueryCommonTest.java b/oak-search/src/test/java/org/apache/jackrabbit/oak/plugins/index/IndexQueryCommonTest.java
index ce1c2577e8..413e51db91 100644
--- a/oak-search/src/test/java/org/apache/jackrabbit/oak/plugins/index/IndexQueryCommonTest.java
+++ b/oak-search/src/test/java/org/apache/jackrabbit/oak/plugins/index/IndexQueryCommonTest.java
@@ -21,10 +21,17 @@ import org.apache.jackrabbit.oak.api.Tree;
 import org.apache.jackrabbit.oak.api.Type;
 import org.apache.jackrabbit.oak.api.ResultRow;
 import org.apache.jackrabbit.oak.api.Result;
+import org.apache.jackrabbit.oak.commons.junit.LogCustomizer;
 import org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants;
 import org.apache.jackrabbit.oak.query.AbstractQueryTest;
+import org.apache.jackrabbit.oak.query.SQL2Parser;
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.Before;
 import org.junit.Ignore;
 import org.junit.Test;
+import org.slf4j.event.Level;
+
 import java.text.ParseException;
 import java.util.*;
 
@@ -53,6 +60,21 @@ public abstract class IndexQueryCommonTest extends AbstractQueryTest {
     private Tree indexDefn;
     protected IndexOptions indexOptions;
     protected TestRepository repositoryOptionsUtil;
+    private LogCustomizer logCustomizer;
+    private final String nativeWarnLog = "Native queries are deprecated. Query:";
+
+    @Before
+    public void setupLogger(){
+        logCustomizer = LogCustomizer.forLogger(SQL2Parser.class.getName()).enable(Level.WARN)
+                        .contains(nativeWarnLog).create();
+        logCustomizer.starting();
+    }
+
+    @After
+    public void closeLogger(){
+        logCustomizer.finished();
+    }
+
 
     @Override
     protected void createTestIndexNode() throws Exception {
@@ -366,6 +388,9 @@ public abstract class IndexQueryCommonTest extends AbstractQueryTest {
             assertEquals("/test/a", result.next());
             assertFalse(result.hasNext());
         });
+        Assert.assertNotEquals(0, logCustomizer.getLogs().size());
+        Assert.assertTrue("native query WARN message is not present, message in Logger is "
+                +  logCustomizer.getLogs(), logCustomizer.getLogs().get(0).contains(nativeQueryString));
     }
 
     @Test
@@ -385,6 +410,9 @@ public abstract class IndexQueryCommonTest extends AbstractQueryTest {
             assertEquals("/test/b", result.next());
             assertFalse(result.hasNext());
         });
+        Assert.assertNotEquals(0, logCustomizer.getLogs().size());
+        Assert.assertTrue("native query WARN message is not present, message in Logger is "
+                +  logCustomizer.getLogs(), logCustomizer.getLogs().get(0).contains(nativeWarnLog));
     }
 
     @Test