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 ch...@apache.org on 2014/07/15 13:50:34 UTC

svn commit: r1610664 - in /jackrabbit/oak/trunk/oak-core/src: main/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoDocumentStore.java test/java/org/apache/jackrabbit/oak/plugins/document/mongo/QueryHintTest.java

Author: chetanm
Date: Tue Jul 15 11:50:33 2014
New Revision: 1610664

URL: http://svn.apache.org/r1610664
Log:
OAK-1966 - Add Hint for selecting more performant index in MongoDocumentStore#query

_modified index would be used if the delta between now and time being queried for is less than 120 secs (configurable via oak.mongo.maxDeltaForModTimeIdxSecs)

Added:
    jackrabbit/oak/trunk/oak-core/src/test/java/org/apache/jackrabbit/oak/plugins/document/mongo/QueryHintTest.java   (with props)
Modified:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoDocumentStore.java

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoDocumentStore.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoDocumentStore.java?rev=1610664&r1=1610663&r2=1610664&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoDocumentStore.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoDocumentStore.java Tue Jul 15 11:50:33 2014
@@ -140,6 +140,13 @@ public class MongoDocumentStore implemen
 
     private final long maxReplicationLagMillis;
 
+    /**
+     * Duration in seconds under which queries would use index on _modified field
+     * If set to -1 then modifiedTime index would not be used
+     */
+    private final long maxDeltaForModTimeIdxSecs =
+            Long.getLong("oak.mongo.maxDeltaForModTimeIdxSecs",120);
+
     private String lastReadWriteMode;
 
     public MongoDocumentStore(DB db, DocumentMK.Builder builder) {
@@ -194,6 +201,8 @@ public class MongoDocumentStore implemen
 
         cacheStats = new CacheStats(nodesCache, "Document-Documents", builder.getWeigher(),
                 builder.getDocumentCacheSize());
+        LOG.info("Configuration maxReplicationLagMillis {}, " +
+                "maxDeltaForModTimeIdxSecs {}",maxReplicationLagMillis, maxDeltaForModTimeIdxSecs);
     }
 
     private static void checkVersion(DB db) {
@@ -413,16 +422,24 @@ public class MongoDocumentStore implemen
         QueryBuilder queryBuilder = QueryBuilder.start(Document.ID);
         queryBuilder.greaterThan(fromKey);
         queryBuilder.lessThan(toKey);
+
+        DBObject hint = new BasicDBObject(NodeDocument.ID, 1);
+
         if (indexedProperty != null) {
             queryBuilder.and(indexedProperty);
             queryBuilder.greaterThanEquals(startValue);
+
+            if (NodeDocument.MODIFIED_IN_SECS.equals(indexedProperty)
+                    && canUseModifiedTimeIdx(startValue)) {
+                hint = new BasicDBObject(NodeDocument.MODIFIED_IN_SECS, -1);
+            }
         }
         DBObject query = queryBuilder.get();
         String parentId = Utils.getParentIdFromLowerLimit(fromKey);
         TreeLock lock = acquireExclusive(parentId != null ? parentId : "");
         long start = start();
         try {
-            DBCursor cursor = dbCollection.find(query).sort(BY_ID_ASC);
+            DBCursor cursor = dbCollection.find(query).sort(BY_ID_ASC).hint(hint);
             ReadPreference readPreference =
                     getMongoReadPreference(collection, parentId, getDefaultReadPreference(collection));
 
@@ -472,6 +489,13 @@ public class MongoDocumentStore implemen
         }
     }
 
+    boolean canUseModifiedTimeIdx(long modifiedTimeInSecs) {
+        if (maxDeltaForModTimeIdxSecs < 0) {
+            return false;
+        }
+        return (NodeDocument.getModifiedInSecs(getTime()) - modifiedTimeInSecs) <= maxDeltaForModTimeIdxSecs;
+    }
+
     @Override
     public <T extends Document> void remove(Collection<T> collection, String key) {
         log("remove", key);
@@ -840,6 +864,10 @@ public class MongoDocumentStore implemen
         return cacheStats;
     }
 
+    long getMaxDeltaForModTimeIdxSecs() {
+        return maxDeltaForModTimeIdxSecs;
+    }
+
     Iterable<? extends Map.Entry<CacheValue, ? extends CachedNodeDocument>> getCacheEntries() {
         if (nodesCache instanceof OffHeapCache) {
             return Iterables.concat(nodesCache.asMap().entrySet(),

Added: jackrabbit/oak/trunk/oak-core/src/test/java/org/apache/jackrabbit/oak/plugins/document/mongo/QueryHintTest.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/test/java/org/apache/jackrabbit/oak/plugins/document/mongo/QueryHintTest.java?rev=1610664&view=auto
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/test/java/org/apache/jackrabbit/oak/plugins/document/mongo/QueryHintTest.java (added)
+++ jackrabbit/oak/trunk/oak-core/src/test/java/org/apache/jackrabbit/oak/plugins/document/mongo/QueryHintTest.java Tue Jul 15 11:50:33 2014
@@ -0,0 +1,118 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.jackrabbit.oak.plugins.document.mongo;
+
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+import java.util.logging.Handler;
+import java.util.logging.Level;
+import java.util.logging.LogRecord;
+import java.util.logging.Logger;
+
+import com.google.common.collect.Lists;
+import org.apache.jackrabbit.oak.plugins.document.Collection;
+import org.apache.jackrabbit.oak.plugins.document.DocumentMK;
+import org.apache.jackrabbit.oak.plugins.document.MongoUtils;
+import org.apache.jackrabbit.oak.plugins.document.NodeDocument;
+import org.apache.jackrabbit.oak.plugins.document.util.MongoConnection;
+import org.apache.jackrabbit.oak.plugins.document.util.Utils;
+import org.apache.jackrabbit.oak.stats.Clock;
+import org.junit.After;
+import org.junit.Assume;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+public class QueryHintTest {
+    final Logger TRACE_LOGGER = Logger.getLogger( "com.mongodb.TRACE" );
+    final TestHandler testHandler = new TestHandler();
+
+    private MongoDocumentStore mongoDS;
+
+    private Clock clock;
+
+    @BeforeClass
+    public static void checkMongoDbAvailable() {
+        Assume.assumeNotNull(MongoUtils.getConnection());
+    }
+
+    @Before
+    public void prepareStores() throws Exception {
+        clock = new Clock.Virtual();
+        MongoConnection mc = MongoUtils.getConnection();
+        mongoDS = new MongoDocumentStore(mc.getDB(), new DocumentMK.Builder());
+        mongoDS.setClock(clock);
+        TRACE_LOGGER.addHandler(testHandler);
+        TRACE_LOGGER.setLevel(Level.FINEST);
+    }
+
+    @Test
+    public void testHints() throws Exception{
+        long delta = mongoDS.getMaxDeltaForModTimeIdxSecs();
+        clock.waitUntil(TimeUnit.SECONDS.toMillis(delta + 10));
+
+        assertFalse(mongoDS.canUseModifiedTimeIdx(1));
+
+        //For recently modified should be true
+        assertTrue(mongoDS.canUseModifiedTimeIdx(10));
+
+        mongoDS.query(Collection.NODES,
+                Utils.getKeyLowerLimit("/"),
+                Utils.getKeyUpperLimit("/"),
+                NodeDocument.MODIFIED_IN_SECS,
+                50,
+                10);
+        //TODO Use log message for better assert on
+        //what hint is used
+        //System.out.println(testHandler.records);
+    }
+
+    @After
+    public void cleanup(){
+        TRACE_LOGGER.removeHandler(testHandler);
+        testHandler.close();
+        TRACE_LOGGER.setLevel(null);
+    }
+
+    private static class TestHandler extends Handler {
+        final List<String> records = Lists.newArrayList();
+
+        @Override
+        public void publish(LogRecord record) {
+            String msg = record.getMessage();
+            if(msg != null && msg.startsWith("find:")) {
+                String json = msg.substring(msg.indexOf('{'));
+                records.add(json);
+            }
+        }
+
+        @Override
+        public void flush() {
+        }
+
+        @Override
+        public void close() throws SecurityException {
+            records.clear();
+        }
+    }
+}

Propchange: jackrabbit/oak/trunk/oak-core/src/test/java/org/apache/jackrabbit/oak/plugins/document/mongo/QueryHintTest.java
------------------------------------------------------------------------------
    svn:eol-style = native