You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by GitBox <gi...@apache.org> on 2022/03/26 02:44:04 UTC
[GitHub] [lucene] zacharymorn opened a new pull request #767: LUCENE-10436: Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
zacharymorn opened a new pull request #767:
URL: https://github.com/apache/lucene/pull/767
# Description / Solution
Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
# Tests
Passed existing tests (especially `TestNormsFieldExistsQuery`, `TestKnnVectorFieldExistsQuery` and `TestDocValuesFieldExistsQuery` via `./gradlew check -Pvalidation.git.failOnModified=false` with `nocommit` ignored
# Checklist
Please review the following and check all that apply:
- [x] I have reviewed the guidelines for [How to Contribute](https://wiki.apache.org/lucene/HowToContribute) and my code conforms to the standards described there to the best of my ability.
- [x] I have created a Jira issue and added the issue ID to my pull request title.
- [x] I have given Lucene maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
- [x] I have developed this patch against the `main` branch.
- [x] I have run `./gradlew check`.
- [ ] I have added tests for my changes.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mikemccand commented on pull request #767: LUCENE-10436: Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
Posted by GitBox <gi...@apache.org>.
mikemccand commented on pull request #767:
URL: https://github.com/apache/lucene/pull/767#issuecomment-1082139269
> Quick question: shall I also merge existing test cases from `TestNormsFieldExistsQuery`, `TestKnnVectorFieldExistsQuery` and `TestDocValuesFieldExistsQuery` as well ?
+1 -- that would avoid Deprecation warnings compiling our own test cases? But I do not think it is a blocker to first pushing this -- progress not perfection!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] zacharymorn commented on a change in pull request #767: LUCENE-10436: Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
Posted by GitBox <gi...@apache.org>.
zacharymorn commented on a change in pull request #767:
URL: https://github.com/apache/lucene/pull/767#discussion_r839159814
##########
File path: lucene/core/src/java/org/apache/lucene/search/FieldExistsQuery.java
##########
@@ -0,0 +1,165 @@
+/*
+ * 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.lucene.search;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.index.DocValues;
+import org.apache.lucene.index.DocValuesType;
+import org.apache.lucene.index.FieldInfo;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.IndexOptions;
+import org.apache.lucene.index.LeafReader;
+import org.apache.lucene.index.LeafReaderContext;
+
+/**
+ * A {@link Query} that matches documents that contain either a {@link
+ * org.apache.lucene.document.KnnVectorField}, or a field that indexes norms or doc values.
+ */
+public class FieldExistsQuery extends Query {
+ private String field;
+
+ /** Create a query that will match that have a value for the given {@code field}. */
+ public FieldExistsQuery(String field) {
+ this.field = Objects.requireNonNull(field);
+ }
+
+ public String getField() {
+ return field;
+ }
+
+ @Override
+ public String toString(String field) {
+ return "FieldExistsQuery [field=" + this.field + "]";
+ }
+
+ @Override
+ public void visit(QueryVisitor visitor) {
+ if (visitor.acceptField(field)) {
+ visitor.visitLeaf(this);
+ }
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return sameClassAs(other) && field.equals(((FieldExistsQuery) other).field);
+ }
+
+ @Override
+ public int hashCode() {
+ final int prime = 31;
+ int hash = classHash();
+ hash = prime * hash + field.hashCode();
+ return hash;
+ }
+
+ @Override
+ public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) {
+ return new ConstantScoreWeight(this, boost) {
+ @Override
+ public Scorer scorer(LeafReaderContext context) throws IOException {
+ FieldInfos fieldInfos = context.reader().getFieldInfos();
+ FieldInfo fieldInfo = fieldInfos.fieldInfo(field);
+ DocIdSetIterator iterator = null;
+
+ if (fieldInfo == null) {
+ return null;
+ }
+
+ if (fieldInfo.hasNorms()) { // the field indexes norms
+ iterator = context.reader().getNormValues(field);
+ } else if (fieldInfo.getVectorDimension() != 0) { // the field indexes vectors
+ iterator = context.reader().getVectorValues(field);
+ } else if (fieldInfo.getDocValuesType()
+ != DocValuesType.NONE) { // the field indexes doc values
+ switch (fieldInfo.getDocValuesType()) {
+ case NUMERIC:
+ iterator = context.reader().getNumericDocValues(field);
+ break;
+ case BINARY:
+ iterator = context.reader().getBinaryDocValues(field);
+ break;
+ case SORTED:
+ iterator = context.reader().getSortedDocValues(field);
+ break;
+ case SORTED_NUMERIC:
+ iterator = context.reader().getSortedNumericDocValues(field);
+ break;
+ case SORTED_SET:
+ iterator = context.reader().getSortedSetDocValues(field);
+ break;
+ case NONE:
+ default:
+ throw new AssertionError();
+ }
+ }
Review comment:
Makes sense! I've implemented it in https://github.com/apache/lucene/pull/767/commits/97344ef1726051bbc70869861ecd5d33b9c6ca82.
##########
File path: lucene/core/src/java/org/apache/lucene/search/FieldExistsQuery.java
##########
@@ -0,0 +1,165 @@
+/*
+ * 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.lucene.search;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.index.DocValues;
+import org.apache.lucene.index.DocValuesType;
+import org.apache.lucene.index.FieldInfo;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.IndexOptions;
+import org.apache.lucene.index.LeafReader;
+import org.apache.lucene.index.LeafReaderContext;
+
+/**
+ * A {@link Query} that matches documents that contain either a {@link
+ * org.apache.lucene.document.KnnVectorField}, or a field that indexes norms or doc values.
+ */
+public class FieldExistsQuery extends Query {
+ private String field;
+
+ /** Create a query that will match that have a value for the given {@code field}. */
+ public FieldExistsQuery(String field) {
+ this.field = Objects.requireNonNull(field);
+ }
+
+ public String getField() {
+ return field;
+ }
+
+ @Override
+ public String toString(String field) {
+ return "FieldExistsQuery [field=" + this.field + "]";
+ }
+
+ @Override
+ public void visit(QueryVisitor visitor) {
+ if (visitor.acceptField(field)) {
+ visitor.visitLeaf(this);
+ }
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return sameClassAs(other) && field.equals(((FieldExistsQuery) other).field);
+ }
+
+ @Override
+ public int hashCode() {
+ final int prime = 31;
+ int hash = classHash();
+ hash = prime * hash + field.hashCode();
+ return hash;
+ }
+
+ @Override
+ public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) {
+ return new ConstantScoreWeight(this, boost) {
+ @Override
+ public Scorer scorer(LeafReaderContext context) throws IOException {
+ FieldInfos fieldInfos = context.reader().getFieldInfos();
+ FieldInfo fieldInfo = fieldInfos.fieldInfo(field);
+ DocIdSetIterator iterator = null;
+
+ if (fieldInfo == null) {
+ return null;
+ }
+
+ if (fieldInfo.hasNorms()) { // the field indexes norms
+ iterator = context.reader().getNormValues(field);
+ } else if (fieldInfo.getVectorDimension() != 0) { // the field indexes vectors
+ iterator = context.reader().getVectorValues(field);
+ } else if (fieldInfo.getDocValuesType()
+ != DocValuesType.NONE) { // the field indexes doc values
+ switch (fieldInfo.getDocValuesType()) {
+ case NUMERIC:
+ iterator = context.reader().getNumericDocValues(field);
+ break;
+ case BINARY:
+ iterator = context.reader().getBinaryDocValues(field);
+ break;
+ case SORTED:
+ iterator = context.reader().getSortedDocValues(field);
+ break;
+ case SORTED_NUMERIC:
+ iterator = context.reader().getSortedNumericDocValues(field);
+ break;
+ case SORTED_SET:
+ iterator = context.reader().getSortedSetDocValues(field);
+ break;
+ case NONE:
+ default:
+ throw new AssertionError();
+ }
+ }
+
+ if (iterator == null) {
+ return null;
+ }
+ return new ConstantScoreScorer(this, score(), scoreMode, iterator);
+ }
+
+ @Override
+ public int count(LeafReaderContext context) throws IOException {
+ LeafReader reader = context.reader();
+ FieldInfos fieldInfos = reader.getFieldInfos();
+ FieldInfo fieldInfo = fieldInfos.fieldInfo(field);
+
+ if (fieldInfo == null) {
+ return 0;
+ }
+
+ if (fieldInfo.hasNorms()) { // the field indexes norms
+ // If every field has a value then we can shortcut
+ if (reader.getDocCount(field) == reader.maxDoc()) {
+ return reader.numDocs();
+ }
+
+ return super.count(context);
+ } else if (fieldInfo.getVectorDimension() != 0) { // the field indexes vectors
+ return super.count(context);
+ } else if (fieldInfo.getDocValuesType()
+ != DocValuesType.NONE) { // the field indexes doc values
+ if (reader.hasDeletions() == false) {
+ if (fieldInfo.getPointDimensionCount() > 0) {
+ return reader.getPointValues(field).getDocCount();
+ } else if (fieldInfo.getIndexOptions() != IndexOptions.NONE) {
+ return reader.terms(field).getDocCount();
+ }
+ }
+
+ return super.count(context);
+ }
+
+ return 0;
Review comment:
Done.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] zacharymorn commented on a change in pull request #767: LUCENE-10436: Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
Posted by GitBox <gi...@apache.org>.
zacharymorn commented on a change in pull request #767:
URL: https://github.com/apache/lucene/pull/767#discussion_r840250256
##########
File path: lucene/core/src/java/org/apache/lucene/search/DocValuesFieldExistsQuery.java
##########
@@ -31,42 +28,21 @@
/**
* A {@link Query} that matches documents that have a value for a given field as reported by doc
* values iterators.
+ *
+ * @deprecated Use {@link org.apache.lucene.search.FieldExistsQuery} instead.
*/
-public final class DocValuesFieldExistsQuery extends Query {
-
- private final String field;
+@Deprecated
+public final class DocValuesFieldExistsQuery extends FieldExistsQuery {
+ private String field;
/** Create a query that will match documents which have a value for the given {@code field}. */
public DocValuesFieldExistsQuery(String field) {
+ super(field);
this.field = Objects.requireNonNull(field);
}
- public String getField() {
- return field;
- }
-
- @Override
- public boolean equals(Object other) {
- return sameClassAs(other) && field.equals(((DocValuesFieldExistsQuery) other).field);
- }
-
- @Override
- public int hashCode() {
- return 31 * classHash() + field.hashCode();
- }
-
- @Override
- public String toString(String field) {
- return "DocValuesFieldExistsQuery [field=" + this.field + "]";
- }
-
- @Override
- public void visit(QueryVisitor visitor) {
- if (visitor.acceptField(field)) {
- visitor.visitLeaf(this);
- }
- }
-
+ // nocommit this seems to be generalizable to norms and knn as well given LUCENE-9334, and thus
+ // could be moved to the new FieldExistsQuery?
Review comment:
But anyway, I have given this a try in https://github.com/apache/lucene/pull/767/commits/e323b49dfeb204bf89609605abe98df7fc990fb9, please let me know if this looks correct to you.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] jpountz commented on a change in pull request #767: LUCENE-10436: Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
Posted by GitBox <gi...@apache.org>.
jpountz commented on a change in pull request #767:
URL: https://github.com/apache/lucene/pull/767#discussion_r840308477
##########
File path: lucene/core/src/java/org/apache/lucene/search/FieldExistsQuery.java
##########
@@ -0,0 +1,223 @@
+/*
+ * 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.lucene.search;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.index.DocValues;
+import org.apache.lucene.index.DocValuesType;
+import org.apache.lucene.index.FieldInfo;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.IndexOptions;
+import org.apache.lucene.index.IndexReader;
+import org.apache.lucene.index.LeafReader;
+import org.apache.lucene.index.LeafReaderContext;
+import org.apache.lucene.index.PointValues;
+import org.apache.lucene.index.Terms;
+
+/**
+ * A {@link Query} that matches documents that contain either a {@link
+ * org.apache.lucene.document.KnnVectorField}, or a field that indexes norms or doc values.
+ */
+public class FieldExistsQuery extends Query {
+ private String field;
+
+ /** Create a query that will match that have a value for the given {@code field}. */
+ public FieldExistsQuery(String field) {
+ this.field = Objects.requireNonNull(field);
+ }
+
+ public String getField() {
+ return field;
+ }
+
+ @Override
+ public String toString(String field) {
+ return "FieldExistsQuery [field=" + this.field + "]";
+ }
+
+ @Override
+ public void visit(QueryVisitor visitor) {
+ if (visitor.acceptField(field)) {
+ visitor.visitLeaf(this);
+ }
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return sameClassAs(other) && field.equals(((FieldExistsQuery) other).field);
+ }
+
+ @Override
+ public int hashCode() {
+ final int prime = 31;
+ int hash = classHash();
+ hash = prime * hash + field.hashCode();
+ return hash;
+ }
+
+ @Override
+ public Query rewrite(IndexReader reader) throws IOException {
+ boolean allReadersRewritable = true;
+
+ for (LeafReaderContext context : reader.leaves()) {
+ LeafReader leaf = context.reader();
+ FieldInfos fieldInfos = leaf.getFieldInfos();
+ FieldInfo fieldInfo = fieldInfos.fieldInfo(field);
+
+ if (fieldInfo == null) {
+ allReadersRewritable = false;
+ break;
+ }
+
+ if (fieldInfo.hasNorms()) { // the field indexes norms
+ if (reader.getDocCount(field) != reader.maxDoc()) {
+ allReadersRewritable = false;
+ break;
+ }
+ } else if (fieldInfo.getVectorDimension() != 0) { // the field indexes vectors
+ if (leaf.getVectorValues(field).size() != reader.maxDoc()) {
+ allReadersRewritable = false;
+ break;
+ }
+ } else if (fieldInfo.getDocValuesType() != DocValuesType.NONE
+ || leaf.terms(field) != null
+ || leaf.getPointValues(field) != null) { // the field indexes doc values or points
Review comment:
Oh, I think you added these checks because the old implementation did not verify that the field info had doc values enabled, but this was leniency. I would only check that the field info has doc values here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] zacharymorn commented on a change in pull request #767: LUCENE-10436: Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
Posted by GitBox <gi...@apache.org>.
zacharymorn commented on a change in pull request #767:
URL: https://github.com/apache/lucene/pull/767#discussion_r839158832
##########
File path: lucene/core/src/java/org/apache/lucene/search/DocValuesFieldExistsQuery.java
##########
@@ -31,42 +28,21 @@
/**
* A {@link Query} that matches documents that have a value for a given field as reported by doc
* values iterators.
+ *
+ * @deprecated Use {@link org.apache.lucene.search.FieldExistsQuery} instead.
*/
-public final class DocValuesFieldExistsQuery extends Query {
-
- private final String field;
+@Deprecated
+public final class DocValuesFieldExistsQuery extends FieldExistsQuery {
+ private String field;
/** Create a query that will match documents which have a value for the given {@code field}. */
public DocValuesFieldExistsQuery(String field) {
+ super(field);
this.field = Objects.requireNonNull(field);
}
- public String getField() {
- return field;
- }
-
- @Override
- public boolean equals(Object other) {
- return sameClassAs(other) && field.equals(((DocValuesFieldExistsQuery) other).field);
- }
-
- @Override
- public int hashCode() {
- return 31 * classHash() + field.hashCode();
- }
-
- @Override
- public String toString(String field) {
- return "DocValuesFieldExistsQuery [field=" + this.field + "]";
- }
-
- @Override
- public void visit(QueryVisitor visitor) {
- if (visitor.acceptField(field)) {
- visitor.visitLeaf(this);
- }
- }
-
+ // nocommit this seems to be generalizable to norms and knn as well given LUCENE-9334, and thus
+ // could be moved to the new FieldExistsQuery?
Review comment:
Thanks for the confirmation! I do have one follow-up question though. When I looked into this further, I noticed `PointValues` was used in the current implementation (pasted below for ease of reference) for determining if `DocValuesFieldExistsQuery` could be re-written to `MatchAllDocsQuery`:
```
@Override
public Query rewrite(IndexReader reader) throws IOException {
boolean allReadersRewritable = true;
for (LeafReaderContext context : reader.leaves()) {
LeafReader leaf = context.reader();
Terms terms = leaf.terms(field);
PointValues pointValues = leaf.getPointValues(field);
if ((terms == null || terms.getDocCount() != leaf.maxDoc())
&& (pointValues == null || pointValues.getDocCount() != leaf.maxDoc())) {
allReadersRewritable = false;
break;
}
}
if (allReadersRewritable) {
return new MatchAllDocsQuery();
}
return super.rewrite(reader);
}
```
I thought `PointValues` and `DocValues` are separate indexed values and hence we would use one of the `leaf.getXXXDocValues` method here instead? On the other hand, the returned values of those methods such as `NumericDocValues` and `BinaryDocValues` don't seems to have a method to retrieve the associated doc count. I felt I might be missing something here but will look further into it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] jpountz commented on a change in pull request #767: LUCENE-10436: Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
Posted by GitBox <gi...@apache.org>.
jpountz commented on a change in pull request #767:
URL: https://github.com/apache/lucene/pull/767#discussion_r840305767
##########
File path: lucene/core/src/java/org/apache/lucene/search/DocValuesFieldExistsQuery.java
##########
@@ -31,42 +28,21 @@
/**
* A {@link Query} that matches documents that have a value for a given field as reported by doc
* values iterators.
+ *
+ * @deprecated Use {@link org.apache.lucene.search.FieldExistsQuery} instead.
*/
-public final class DocValuesFieldExistsQuery extends Query {
-
- private final String field;
+@Deprecated
+public final class DocValuesFieldExistsQuery extends FieldExistsQuery {
+ private String field;
/** Create a query that will match documents which have a value for the given {@code field}. */
public DocValuesFieldExistsQuery(String field) {
+ super(field);
this.field = Objects.requireNonNull(field);
}
- public String getField() {
- return field;
- }
-
- @Override
- public boolean equals(Object other) {
- return sameClassAs(other) && field.equals(((DocValuesFieldExistsQuery) other).field);
- }
-
- @Override
- public int hashCode() {
- return 31 * classHash() + field.hashCode();
- }
-
- @Override
- public String toString(String field) {
- return "DocValuesFieldExistsQuery [field=" + this.field + "]";
- }
-
- @Override
- public void visit(QueryVisitor visitor) {
- if (visitor.acceptField(field)) {
- visitor.visitLeaf(this);
- }
- }
-
+ // nocommit this seems to be generalizable to norms and knn as well given LUCENE-9334, and thus
+ // could be moved to the new FieldExistsQuery?
Review comment:
It would be nice if we could detect when all documents have a doc value but unfortunately we do not have an inedx statistic we can use to check.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] jpountz commented on a change in pull request #767: LUCENE-10436: Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
Posted by GitBox <gi...@apache.org>.
jpountz commented on a change in pull request #767:
URL: https://github.com/apache/lucene/pull/767#discussion_r837740611
##########
File path: lucene/core/src/java/org/apache/lucene/search/DocValuesFieldExistsQuery.java
##########
@@ -31,42 +28,21 @@
/**
* A {@link Query} that matches documents that have a value for a given field as reported by doc
* values iterators.
+ *
+ * @deprecated Use {@link org.apache.lucene.search.FieldExistsQuery} instead.
*/
-public final class DocValuesFieldExistsQuery extends Query {
-
- private final String field;
+@Deprecated
+public final class DocValuesFieldExistsQuery extends FieldExistsQuery {
+ private String field;
/** Create a query that will match documents which have a value for the given {@code field}. */
public DocValuesFieldExistsQuery(String field) {
+ super(field);
this.field = Objects.requireNonNull(field);
}
- public String getField() {
- return field;
- }
-
- @Override
- public boolean equals(Object other) {
- return sameClassAs(other) && field.equals(((DocValuesFieldExistsQuery) other).field);
- }
-
- @Override
- public int hashCode() {
- return 31 * classHash() + field.hashCode();
- }
-
- @Override
- public String toString(String field) {
- return "DocValuesFieldExistsQuery [field=" + this.field + "]";
- }
-
- @Override
- public void visit(QueryVisitor visitor) {
- if (visitor.acceptField(field)) {
- visitor.visitLeaf(this);
- }
- }
-
+ // nocommit this seems to be generalizable to norms and knn as well given LUCENE-9334, and thus
+ // could be moved to the new FieldExistsQuery?
Review comment:
+1
##########
File path: lucene/core/src/java/org/apache/lucene/search/FieldExistsQuery.java
##########
@@ -0,0 +1,165 @@
+/*
+ * 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.lucene.search;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.index.DocValues;
+import org.apache.lucene.index.DocValuesType;
+import org.apache.lucene.index.FieldInfo;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.IndexOptions;
+import org.apache.lucene.index.LeafReader;
+import org.apache.lucene.index.LeafReaderContext;
+
+/**
+ * A {@link Query} that matches documents that contain either a {@link
+ * org.apache.lucene.document.KnnVectorField}, or a field that indexes norms or doc values.
+ */
+public class FieldExistsQuery extends Query {
+ private String field;
+
+ /** Create a query that will match that have a value for the given {@code field}. */
+ public FieldExistsQuery(String field) {
+ this.field = Objects.requireNonNull(field);
+ }
+
+ public String getField() {
+ return field;
+ }
+
+ @Override
+ public String toString(String field) {
+ return "FieldExistsQuery [field=" + this.field + "]";
+ }
+
+ @Override
+ public void visit(QueryVisitor visitor) {
+ if (visitor.acceptField(field)) {
+ visitor.visitLeaf(this);
+ }
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return sameClassAs(other) && field.equals(((FieldExistsQuery) other).field);
+ }
+
+ @Override
+ public int hashCode() {
+ final int prime = 31;
+ int hash = classHash();
+ hash = prime * hash + field.hashCode();
+ return hash;
+ }
+
+ @Override
+ public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) {
+ return new ConstantScoreWeight(this, boost) {
+ @Override
+ public Scorer scorer(LeafReaderContext context) throws IOException {
+ FieldInfos fieldInfos = context.reader().getFieldInfos();
+ FieldInfo fieldInfo = fieldInfos.fieldInfo(field);
+ DocIdSetIterator iterator = null;
+
+ if (fieldInfo == null) {
+ return null;
+ }
+
+ if (fieldInfo.hasNorms()) { // the field indexes norms
+ iterator = context.reader().getNormValues(field);
+ } else if (fieldInfo.getVectorDimension() != 0) { // the field indexes vectors
+ iterator = context.reader().getVectorValues(field);
+ } else if (fieldInfo.getDocValuesType()
+ != DocValuesType.NONE) { // the field indexes doc values
+ switch (fieldInfo.getDocValuesType()) {
+ case NUMERIC:
+ iterator = context.reader().getNumericDocValues(field);
+ break;
+ case BINARY:
+ iterator = context.reader().getBinaryDocValues(field);
+ break;
+ case SORTED:
+ iterator = context.reader().getSortedDocValues(field);
+ break;
+ case SORTED_NUMERIC:
+ iterator = context.reader().getSortedNumericDocValues(field);
+ break;
+ case SORTED_SET:
+ iterator = context.reader().getSortedSetDocValues(field);
+ break;
+ case NONE:
+ default:
+ throw new AssertionError();
+ }
+ }
+
+ if (iterator == null) {
+ return null;
+ }
+ return new ConstantScoreScorer(this, score(), scoreMode, iterator);
+ }
+
+ @Override
+ public int count(LeafReaderContext context) throws IOException {
+ LeafReader reader = context.reader();
+ FieldInfos fieldInfos = reader.getFieldInfos();
+ FieldInfo fieldInfo = fieldInfos.fieldInfo(field);
+
+ if (fieldInfo == null) {
+ return 0;
+ }
+
+ if (fieldInfo.hasNorms()) { // the field indexes norms
+ // If every field has a value then we can shortcut
+ if (reader.getDocCount(field) == reader.maxDoc()) {
+ return reader.numDocs();
+ }
+
+ return super.count(context);
+ } else if (fieldInfo.getVectorDimension() != 0) { // the field indexes vectors
+ return super.count(context);
+ } else if (fieldInfo.getDocValuesType()
+ != DocValuesType.NONE) { // the field indexes doc values
+ if (reader.hasDeletions() == false) {
+ if (fieldInfo.getPointDimensionCount() > 0) {
+ return reader.getPointValues(field).getDocCount();
+ } else if (fieldInfo.getIndexOptions() != IndexOptions.NONE) {
+ return reader.terms(field).getDocCount();
+ }
+ }
+
+ return super.count(context);
+ }
+
+ return 0;
Review comment:
Let's throw an exception here too?
##########
File path: lucene/core/src/java/org/apache/lucene/search/FieldExistsQuery.java
##########
@@ -0,0 +1,165 @@
+/*
+ * 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.lucene.search;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.index.DocValues;
+import org.apache.lucene.index.DocValuesType;
+import org.apache.lucene.index.FieldInfo;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.IndexOptions;
+import org.apache.lucene.index.LeafReader;
+import org.apache.lucene.index.LeafReaderContext;
+
+/**
+ * A {@link Query} that matches documents that contain either a {@link
+ * org.apache.lucene.document.KnnVectorField}, or a field that indexes norms or doc values.
+ */
+public class FieldExistsQuery extends Query {
+ private String field;
+
+ /** Create a query that will match that have a value for the given {@code field}. */
+ public FieldExistsQuery(String field) {
+ this.field = Objects.requireNonNull(field);
+ }
+
+ public String getField() {
+ return field;
+ }
+
+ @Override
+ public String toString(String field) {
+ return "FieldExistsQuery [field=" + this.field + "]";
+ }
+
+ @Override
+ public void visit(QueryVisitor visitor) {
+ if (visitor.acceptField(field)) {
+ visitor.visitLeaf(this);
+ }
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return sameClassAs(other) && field.equals(((FieldExistsQuery) other).field);
+ }
+
+ @Override
+ public int hashCode() {
+ final int prime = 31;
+ int hash = classHash();
+ hash = prime * hash + field.hashCode();
+ return hash;
+ }
+
+ @Override
+ public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) {
+ return new ConstantScoreWeight(this, boost) {
+ @Override
+ public Scorer scorer(LeafReaderContext context) throws IOException {
+ FieldInfos fieldInfos = context.reader().getFieldInfos();
+ FieldInfo fieldInfo = fieldInfos.fieldInfo(field);
+ DocIdSetIterator iterator = null;
+
+ if (fieldInfo == null) {
+ return null;
+ }
+
+ if (fieldInfo.hasNorms()) { // the field indexes norms
+ iterator = context.reader().getNormValues(field);
+ } else if (fieldInfo.getVectorDimension() != 0) { // the field indexes vectors
+ iterator = context.reader().getVectorValues(field);
+ } else if (fieldInfo.getDocValuesType()
+ != DocValuesType.NONE) { // the field indexes doc values
+ switch (fieldInfo.getDocValuesType()) {
+ case NUMERIC:
+ iterator = context.reader().getNumericDocValues(field);
+ break;
+ case BINARY:
+ iterator = context.reader().getBinaryDocValues(field);
+ break;
+ case SORTED:
+ iterator = context.reader().getSortedDocValues(field);
+ break;
+ case SORTED_NUMERIC:
+ iterator = context.reader().getSortedNumericDocValues(field);
+ break;
+ case SORTED_SET:
+ iterator = context.reader().getSortedSetDocValues(field);
+ break;
+ case NONE:
+ default:
+ throw new AssertionError();
+ }
+ }
Review comment:
Maybe add an `else` condition that throws an exception. This query is about finding documents that have a value for a field. If the field exists but doesn't index any of the data structures that can help figure out whether it actually exists, then it means users haven't indexed data correctly, or they are using this query while they shouldn't?
```suggestion
} else {
throw new IllegalStateException("FieldExistsQuery requires that the field indexes doc values, norms or vectors, but field '" + fieldInfo.name + "' exists and indexes neither of these data structures");
}
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] jpountz commented on a change in pull request #767: LUCENE-10436: Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
Posted by GitBox <gi...@apache.org>.
jpountz commented on a change in pull request #767:
URL: https://github.com/apache/lucene/pull/767#discussion_r839380353
##########
File path: lucene/core/src/java/org/apache/lucene/search/DocValuesFieldExistsQuery.java
##########
@@ -31,42 +28,21 @@
/**
* A {@link Query} that matches documents that have a value for a given field as reported by doc
* values iterators.
+ *
+ * @deprecated Use {@link org.apache.lucene.search.FieldExistsQuery} instead.
*/
-public final class DocValuesFieldExistsQuery extends Query {
-
- private final String field;
+@Deprecated
+public final class DocValuesFieldExistsQuery extends FieldExistsQuery {
+ private String field;
/** Create a query that will match documents which have a value for the given {@code field}. */
public DocValuesFieldExistsQuery(String field) {
+ super(field);
this.field = Objects.requireNonNull(field);
}
- public String getField() {
- return field;
- }
-
- @Override
- public boolean equals(Object other) {
- return sameClassAs(other) && field.equals(((DocValuesFieldExistsQuery) other).field);
- }
-
- @Override
- public int hashCode() {
- return 31 * classHash() + field.hashCode();
- }
-
- @Override
- public String toString(String field) {
- return "DocValuesFieldExistsQuery [field=" + this.field + "]";
- }
-
- @Override
- public void visit(QueryVisitor visitor) {
- if (visitor.acceptField(field)) {
- visitor.visitLeaf(this);
- }
- }
-
+ // nocommit this seems to be generalizable to norms and knn as well given LUCENE-9334, and thus
+ // could be moved to the new FieldExistsQuery?
Review comment:
Lucene 9 introduced a new index-time requirement that a field always uses the same data structures. Ie. if a document has both points and doc values for a field, then all other documents need to either have neither points and doc values for the field, or both points and doc values. It makes it legal to do this sort of optimization. https://issues.apache.org/jira/browse/LUCENE-9334
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] zacharymorn commented on a change in pull request #767: LUCENE-10436: Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
Posted by GitBox <gi...@apache.org>.
zacharymorn commented on a change in pull request #767:
URL: https://github.com/apache/lucene/pull/767#discussion_r840249824
##########
File path: lucene/core/src/java/org/apache/lucene/search/DocValuesFieldExistsQuery.java
##########
@@ -31,42 +28,21 @@
/**
* A {@link Query} that matches documents that have a value for a given field as reported by doc
* values iterators.
+ *
+ * @deprecated Use {@link org.apache.lucene.search.FieldExistsQuery} instead.
*/
-public final class DocValuesFieldExistsQuery extends Query {
-
- private final String field;
+@Deprecated
+public final class DocValuesFieldExistsQuery extends FieldExistsQuery {
+ private String field;
/** Create a query that will match documents which have a value for the given {@code field}. */
public DocValuesFieldExistsQuery(String field) {
+ super(field);
this.field = Objects.requireNonNull(field);
}
- public String getField() {
- return field;
- }
-
- @Override
- public boolean equals(Object other) {
- return sameClassAs(other) && field.equals(((DocValuesFieldExistsQuery) other).field);
- }
-
- @Override
- public int hashCode() {
- return 31 * classHash() + field.hashCode();
- }
-
- @Override
- public String toString(String field) {
- return "DocValuesFieldExistsQuery [field=" + this.field + "]";
- }
-
- @Override
- public void visit(QueryVisitor visitor) {
- if (visitor.acceptField(field)) {
- visitor.visitLeaf(this);
- }
- }
-
+ // nocommit this seems to be generalizable to norms and knn as well given LUCENE-9334, and thus
+ // could be moved to the new FieldExistsQuery?
Review comment:
Thanks @jpountz for the clarification! I guess to put my question differently, this current implementation doesn't seems to cover the case where the docs only have `DocValues`, but not `PointValues` fields, as asserted in this existing test case:
https://github.com/apache/lucene/blob/69b040fc6292ac47d7f7fc8bc3b7fd601794e54b/lucene/core/src/test/org/apache/lucene/search/TestDocValuesFieldExistsQuery.java#L103-L126
I would imagine in this scenario `DocValuesFieldExistsQuery` should be overwritten to `MatchAllDocsQuery`, since all docs that doc values field and value?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] LuXugang commented on pull request #767: LUCENE-10436: Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
Posted by GitBox <gi...@apache.org>.
LuXugang commented on pull request #767:
URL: https://github.com/apache/lucene/pull/767#issuecomment-1086537083
Since at search phase, vector's all docs of all fields have been loaded into memory, when `FieldExistsQuery` as a lead iterator, should we always try to supply a `Scorer` by vector if vector fields were indexed. so should we implement `Weight#scorerSupplier` ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] zacharymorn commented on pull request #767: LUCENE-10436: Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
Posted by GitBox <gi...@apache.org>.
zacharymorn commented on pull request #767:
URL: https://github.com/apache/lucene/pull/767#issuecomment-1079574848
Quick question: shall I also merge existing test cases from `TestNormsFieldExistsQuery`, `TestKnnVectorFieldExistsQuery` and `TestDocValuesFieldExistsQuery` as well ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] zacharymorn commented on pull request #767: LUCENE-10436: Deprecate DocValuesFieldExistsQuery, NormsFieldExistsQuery and KnnVectorFieldExistsQuery with FieldExistsQuery
Posted by GitBox <gi...@apache.org>.
zacharymorn commented on pull request #767:
URL: https://github.com/apache/lucene/pull/767#issuecomment-1084053516
Thanks @mikemccand @jpountz for the reviews and suggestions! I've gone ahead and merge the test cases, and will remove the deprecated queries as well in follow-up PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org