diff --git oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexPlanner.java oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexPlanner.java index c282f2b..c43c064 100644 --- oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexPlanner.java +++ oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexPlanner.java @@ -192,7 +192,9 @@ class IndexPlanner { if (pr.isNullRestriction() && !pd.nullCheckEnabled){ continue; } - indexedProps.add(name); + if (pd.weight != 0) { + indexedProps.add(name); + } result.propDefns.put(name, pd); } } @@ -216,7 +218,7 @@ class IndexPlanner { //TODO Need a way to have better cost estimate to indicate that //this index can evaluate more propertyRestrictions natively (if more props are indexed) //For now we reduce cost per entry - int costPerEntryFactor = indexedProps.size(); + int costPerEntryFactor = result.propDefns.size(); costPerEntryFactor += sortOrder.size(); //this index can evaluate more propertyRestrictions natively (if more props are indexed) @@ -653,6 +655,10 @@ class IndexPlanner { return propDefns.get(pr.propertyName); } + public boolean hasProperty(String propName){ + return propDefns.containsKey(propName); + } + public PropertyDefinition getOrderedProperty(int index){ return sortedProperties.get(index); } diff --git oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexConstants.java oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexConstants.java index 787bf38..48cd2b3 100644 --- oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexConstants.java +++ oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexConstants.java @@ -148,6 +148,8 @@ public interface LuceneIndexConstants { String PROP_SCORER_PROVIDER = "scorerProviderName"; + String PROP_WEIGHT = "weight"; + /** * Integer property indicating that LuceneIndex should be * used in compat mode to specific version diff --git oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/PropertyDefinition.java oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/PropertyDefinition.java index 2673488..4b00980 100644 --- oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/PropertyDefinition.java +++ oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/PropertyDefinition.java @@ -38,6 +38,7 @@ import static org.apache.jackrabbit.oak.commons.PathUtils.elements; import static org.apache.jackrabbit.oak.commons.PathUtils.isAbsolute; import static org.apache.jackrabbit.oak.plugins.index.lucene.LuceneIndexConstants.FIELD_BOOST; import static org.apache.jackrabbit.oak.plugins.index.lucene.LuceneIndexConstants.PROP_IS_REGEX; +import static org.apache.jackrabbit.oak.plugins.index.lucene.LuceneIndexConstants.PROP_WEIGHT; import static org.apache.jackrabbit.oak.plugins.index.lucene.util.ConfigUtil.getOptionalValue; class PropertyDefinition { @@ -93,6 +94,8 @@ class PropertyDefinition { final boolean excludeFromAggregate; + final int weight; + /** * Property name excluding the relativePath. For regular expression based definition * its set to null @@ -115,6 +118,7 @@ class PropertyDefinition { this.name = getName(defn, nodeName); this.relative = isRelativeProperty(name); this.boost = getOptionalValue(defn, FIELD_BOOST, DEFAULT_BOOST); + this.weight = getOptionalValue(defn, PROP_WEIGHT, -1); //By default if a property is defined it is indexed this.index = getOptionalValue(defn, LuceneIndexConstants.PROP_INDEX, true); diff --git oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/util/IndexDefinitionBuilder.java oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/util/IndexDefinitionBuilder.java index 521859e..65bcd8c 100644 --- oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/util/IndexDefinitionBuilder.java +++ oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/util/IndexDefinitionBuilder.java @@ -339,6 +339,11 @@ public final class IndexDefinitionBuilder { return this; } + public PropertyRule weight(int weight){ + propTree.setProperty(LuceneIndexConstants.PROP_WEIGHT, weight); + return this; + } + public IndexRule enclosingRule(){ return indexRule; } diff --git oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexPlannerTest.java oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexPlannerTest.java index bd50d9e..fc66b74 100644 --- oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexPlannerTest.java +++ oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexPlannerTest.java @@ -37,10 +37,12 @@ import static org.apache.jackrabbit.oak.plugins.index.lucene.util.LuceneIndexHel import static org.apache.jackrabbit.oak.plugins.memory.EmptyNodeState.EMPTY_NODE; import static org.apache.jackrabbit.oak.plugins.memory.PropertyStates.createProperty; import static org.apache.jackrabbit.oak.InitialContent.INITIAL_CONTENT; +import static org.hamcrest.Matchers.lessThan; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertThat; import static org.junit.Assert.assertTrue; import java.io.IOException; @@ -57,6 +59,7 @@ import org.apache.jackrabbit.oak.plugins.index.IndexConstants; import org.apache.jackrabbit.oak.plugins.index.lucene.reader.DefaultIndexReader; import org.apache.jackrabbit.oak.plugins.index.lucene.reader.LuceneIndexReader; import org.apache.jackrabbit.oak.plugins.index.lucene.reader.LuceneIndexReaderFactory; +import org.apache.jackrabbit.oak.plugins.index.lucene.util.IndexDefinitionBuilder; import org.apache.jackrabbit.oak.plugins.memory.PropertyValues; import org.apache.jackrabbit.oak.query.NodeStateNodeTypeInfoProvider; import org.apache.jackrabbit.oak.query.ast.NodeTypeInfo; @@ -511,6 +514,43 @@ public class IndexPlannerTest { assertNull(plan); } + @Test + public void indexedButZeroWeightProps() throws Exception{ + IndexDefinitionBuilder defnb = new IndexDefinitionBuilder(); + defnb.indexRule("nt:base").property("foo").propertyIndex().weight(0); + defnb.indexRule("nt:base").property("bar").propertyIndex(); + + IndexDefinition defn = new IndexDefinition(root, defnb.build(), "/foo"); + IndexNode node = createIndexNode(defn); + + FilterImpl filter = createFilter("nt:base"); + filter.restrictProperty("foo", Operator.EQUAL, PropertyValues.newString("a")); + IndexPlanner planner = new IndexPlanner(node, "/foo", filter, Collections.emptyList()); + //Even though foo is indexed it would not be considered for a query involving just foo + assertNull(planner.getPlan()); + + filter = createFilter("nt:base"); + filter.restrictProperty("bar", Operator.EQUAL, PropertyValues.newString("a")); + planner = new IndexPlanner(node, "/foo", filter, Collections.emptyList()); + QueryIndex.IndexPlan plan1 = planner.getPlan(); + assertNotNull(plan1); + + filter = createFilter("nt:base"); + filter.restrictProperty("foo", Operator.EQUAL, PropertyValues.newString("a")); + filter.restrictProperty("bar", Operator.EQUAL, PropertyValues.newString("a")); + planner = new IndexPlanner(node, "/foo", filter, Collections.emptyList()); + QueryIndex.IndexPlan plan2 = planner.getPlan(); + assertNotNull(plan2); + + //For plan2 as 2 props are indexed its costPerEntry should be less than plan1 which + //indexes only one prop + assertThat(plan2.getCostPerEntry(), lessThan(plan1.getCostPerEntry())); + + assertTrue(pr(plan2).hasProperty("foo")); + assertTrue(pr(plan2).hasProperty("bar")); + } + + //------ Suggestion/spellcheck plan tests @Test public void nonSuggestIndex() throws Exception {