summaryrefslogtreecommitdiff
path: root/src/mongo/db/query/index_bounds_builder.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/mongo/db/query/index_bounds_builder.h')
-rw-r--r--src/mongo/db/query/index_bounds_builder.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/mongo/db/query/index_bounds_builder.h b/src/mongo/db/query/index_bounds_builder.h
index b397f81b295..311b3ee61f6 100644
--- a/src/mongo/db/query/index_bounds_builder.h
+++ b/src/mongo/db/query/index_bounds_builder.h
@@ -70,6 +70,17 @@ public:
static void allValuesForField(const BSONElement& elt, OrderedIntervalList* out);
/**
+ * Returns true if 'expr' can correctly be assigned as an INEXACT_COVERED predicate to an index
+ * scan over 'index'.
+ *
+ * The result of this function is not meaningful when the predicate applies to special fields
+ * such as "hashed", "2d", or "2dsphere". That is, the caller is responsible for ensuring that
+ * 'expr' is a candidate for covered matching over a regular ascending/descending field of the
+ * index.
+ */
+ static bool canUseCoveredMatching(const MatchExpression* expr, const IndexEntry& index);
+
+ /**
* Turn the MatchExpression in 'expr' into a set of index bounds. The field that 'expr' is
* concerned with is indexed according to the keypattern element 'elt' from index 'index'.
*