Add code to generate docs for match operator

Author: carlosdelest

x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/AbstractFunctionTestCase.java

@@ -44,6 +44,7 @@
 import org.elasticsearch.xpack.esql.core.util.NumericUtils;
 import org.elasticsearch.xpack.esql.core.util.StringUtils;
 import org.elasticsearch.xpack.esql.evaluator.EvalMapper;
+import org.elasticsearch.xpack.esql.expression.function.fulltext.Match;
 import org.elasticsearch.xpack.esql.expression.function.scalar.conditional.Greatest;
 import org.elasticsearch.xpack.esql.expression.function.scalar.nulls.Coalesce;
 import org.elasticsearch.xpack.esql.expression.function.scalar.string.RLike;
@@ -130,7 +131,9 @@ public abstract class AbstractFunctionTestCase extends ESTestCase {
         entry("mod", Mod.class),
         entry("neg", Neg.class),
         entry("is_null", IsNull.class),
-        entry("is_not_null", IsNotNull.class)
+        entry("is_not_null", IsNotNull.class),
+        // Match operator is both a function and an operator
+        entry("match_operator", Match.class)
     );
 
     private static EsqlFunctionRegistry functionRegistry = new EsqlFunctionRegistry().snapshotRegistry();
@@ -1250,6 +1253,7 @@ private static String binaryOperator(String name) {
             case "greater_than_or_equal" -> ">=";
             case "less_than" -> "<";
             case "less_than_or_equal" -> "<=";
+            case "match_operator" -> ":";
             case "mod" -> "%";
             case "mul" -> "*";
             case "not_equals" -> "!=";

x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchOperatorTests.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+package org.elasticsearch.xpack.esql.expression.function.fulltext;
+
+import com.carrotsearch.randomizedtesting.annotations.Name;
+import com.carrotsearch.randomizedtesting.annotations.ParametersFactory;
+
+import org.elasticsearch.xpack.esql.core.type.DataType;
+import org.elasticsearch.xpack.esql.expression.function.FunctionName;
+import org.elasticsearch.xpack.esql.expression.function.TestCaseSupplier;
+
+import java.util.LinkedList;
+import java.util.List;
+import java.util.function.Supplier;
+
+/**
+ * This class is only used to generates docs for the match operator - all testing is done in {@link MatchTests}
+ */
+@FunctionName("match_operator")
+public class MatchOperatorTests extends MatchTests {
+
+    public MatchOperatorTests(@Name("TestCase") Supplier<TestCaseSupplier.TestCase> testCaseSupplier) {
+        super(testCaseSupplier);
+    }
+
+    @ParametersFactory
+    public static Iterable<Object[]> parameters() {
+        // Have a minimal test so that we can generate the docs
+        List<TestCaseSupplier> suppliers = new LinkedList<>();
+        addPositiveTestCase(List.of(DataType.KEYWORD, DataType.KEYWORD), suppliers);
+        return parameterSuppliersFromTypedData(suppliers);
+    }
+}

x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchTests.java

@@ -36,19 +36,11 @@ public MatchTests(@Name("TestCase") Supplier<TestCaseSupplier.TestCase> testCase
 
     @ParametersFactory
     public static Iterable<Object[]> parameters() {
-        Set<DataType> supportedTextParams = Set.of(DataType.KEYWORD, DataType.TEXT);
-        Set<DataType> supportedNumericParams = Set.of(DataType.DOUBLE, DataType.INTEGER);
-        Set<DataType> supportedFuzzinessParams = Set.of(DataType.INTEGER, DataType.KEYWORD, DataType.TEXT);
-        List<Set<DataType>> supportedPerPosition = List.of(
-            supportedTextParams,
-            supportedTextParams,
-            supportedNumericParams,
-            supportedFuzzinessParams
-        );
+        List<Set<DataType>> supportedPerPosition = supportedParams();
         List<TestCaseSupplier> suppliers = new LinkedList<>();
         for (DataType fieldType : DataType.stringTypes()) {
             for (DataType queryType : DataType.stringTypes()) {
-                addPositiveTestCase(List.of(fieldType, queryType), supportedPerPosition, suppliers);
+                addPositiveTestCase(List.of(fieldType, queryType), suppliers);
                 addNonFieldTestCase(List.of(fieldType, queryType), supportedPerPosition, suppliers);
             }
         }
@@ -61,9 +53,21 @@ public static Iterable<Object[]> parameters() {
         );
     }
 
-    private static void addPositiveTestCase(
+    protected static List<Set<DataType>> supportedParams() {
+        Set<DataType> supportedTextParams = Set.of(DataType.KEYWORD, DataType.TEXT);
+        Set<DataType> supportedNumericParams = Set.of(DataType.DOUBLE, DataType.INTEGER);
+        Set<DataType> supportedFuzzinessParams = Set.of(DataType.INTEGER, DataType.KEYWORD, DataType.TEXT);
+        List<Set<DataType>> supportedPerPosition = List.of(
+            supportedTextParams,
+            supportedTextParams,
+            supportedNumericParams,
+            supportedFuzzinessParams
+        );
+        return supportedPerPosition;
+    }
+
+    protected static void addPositiveTestCase(
         List<DataType> paramDataTypes,
-        List<Set<DataType>> supportedPerPosition,
         List<TestCaseSupplier> suppliers
     ) {