TermsEnum api - allow null search strings (#73144)

Allow null search strings (matches all) Closes #73141
elastic · May 17, 2021 · dbc37f9 · dbc37f9
1 parent 7b64cae
commit dbc37f9
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 4 deletions.
diff --git a/docs/reference/search/terms-enum.asciidoc b/docs/reference/search/terms-enum.asciidoc
@@ -72,8 +72,9 @@ Which field to match
 
 [[terms-enum-string-param]]
 `string`::
-(Mandatory, string)
-The string to match at the start of indexed terms
+(Optional, string)
+The string to match at the start of indexed terms. If not provided, all terms in the field
+are considered.
 
 [[terms-enum-size-param]]
 `size`::

diff --git a/...in/core/src/main/java/org/elasticsearch/xpack/core/termsenum/action/TermsEnumRequest.java b/...in/core/src/main/java/org/elasticsearch/xpack/core/termsenum/action/TermsEnumRequest.java
@@ -182,7 +182,9 @@ public String toString() {
     public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
         builder.startObject();
         builder.field("field", field);
-        builder.field("string", string);
+        if (string != null) {
+            builder.field("string", string);
+        }
         if (searchAfter != null) {
             builder.field("search_after", searchAfter);            
         }

diff --git a/...src/main/java/org/elasticsearch/xpack/core/termsenum/action/TransportTermsEnumAction.java b/...src/main/java/org/elasticsearch/xpack/core/termsenum/action/TransportTermsEnumAction.java
@@ -300,7 +300,7 @@ protected NodeTermsEnumResponse dataNodeOperation(NodeTermsEnumRequest request,
                 if (mappedFieldType != null) {
                     TermsEnum terms = mappedFieldType.getTerms(
                         request.caseInsensitive(),
-                        request.string(),
+                        request.string() == null ? "" : request.string(),
                         queryShardContext,
                         request.searchAfter()                        
                     );

diff --git a/x-pack/plugin/src/yamlRestTest/resources/rest-api-spec/test/terms_enum/10_basic.yml b/x-pack/plugin/src/yamlRestTest/resources/rest-api-spec/test/terms_enum/10_basic.yml
@@ -279,6 +279,17 @@ teardown:
   - length: {terms: 0}
 
 ---
+"Test null search string allowed":
+  - skip:
+      version: " - 7.99.99"
+      reason:  TODO remove this skip after PR 73144 is backported to 7.x
+
+  - do:
+      terms_enum:
+        index:  test_k
+        body:  {"field": "foo"}
+  - length: {terms: 1}
+---
 "Test search after keyword field":
   - do:
       terms_enum: