DOCSP-22127: Atlas searchMeta builder (#259)

* DOCSP-22127: Atlas searchMeta builder

Author: Chris Cho

source/fundamentals/builders/aggregates.txt

@@ -588,3 +588,30 @@ field for text that contains the word "Future":
 
 Learn more about the builders from the
 `search package API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/search/package-summary.html>`__.
+
+Atlas Search Metadata
+---------------------
+
+Use the ``searchMeta()`` method to create a
+:manual:`$searchMeta </reference/operator/aggregation/searchMeta/>`
+pipeline stage which returns only the metadata part of the results from
+Atlas full-text search queries.
+
+.. tip:: Only Available on Atlas for MongoDB v4.4.11 and later
+
+   This aggregation pipeline operator is only available
+   on :atlas:`MongoDB Atlas </>` clusters running v4.4.11 and later. For a
+   detailed list of version availability, see the MongoDB Atlas documentation 
+   on :atlas:`$searchMeta </atlas-search/query-syntax/#-searchmeta>`.
+
+The following example shows the ``count`` metadata for an Atlas search
+aggregation stage:
+
+.. literalinclude:: /includes/fundamentals/code-snippets/builders/AggregateSearchBuilderExample.java
+   :start-after: // begin atlasSearchMeta
+   :end-before: // end atlasSearchMeta
+   :language: java
+   :dedent:
+
+Learn more about this helper from the
+`searchMeta() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#searchMeta(com.mongodb.client.model.search.SearchCollector)>`__.

source/includes/fundamentals/code-snippets/builders/AggregateSearchBuilderExample.java

@@ -43,24 +43,41 @@ private static void runAtlasTextSearch(MongoCollection<Document> collection) {
                         SearchPath.fieldPath("title"), "Future"));
         // end atlasTextSearch
 
-        Bson projection = Aggregates.project(Projections.fields(Projections.include("title", "released")));
+        // To condense result data, add this projection into the pipeline
+        // Bson projection = Aggregates.project(Projections.fields(Projections.include("title", "released")));
 
-        List<Bson> aggregateStages = Arrays.asList(textSearch, projection);
+        List<Bson> aggregateStages = Arrays.asList(textSearch);
         System.out.println("aggregateStages: " + aggregateStages);
 
         System.out.println("explain:\n" + collection.aggregate(aggregateStages).explain());
         collection.aggregate(aggregateStages).forEach(result -> System.out.println(result));
     }
 
+    private static void runAtlasTextSearchMeta(MongoCollection<Document> collection) {
+        Bson textSearchMeta =
+        // begin atlasSearchMeta
+        Aggregates.searchMeta(
+                SearchOperator.near(2010, 1, SearchPath.fieldPath("year")));
+        // end atlasSearchMeta
+
+        List<Bson> aggregateStages = Arrays.asList(textSearchMeta);
+        System.out.println("aggregateStages: " + aggregateStages);
+
+        collection.aggregate(aggregateStages).forEach(result -> System.out.println(result));
+    }
+
     public static void main(String[] args) {
         String uri = CONNECTION_URI; 
 
         try (MongoClient mongoClient = MongoClients.create(uri)) {
             MongoDatabase database = mongoClient.getDatabase("sample_mflix");
             MongoCollection<Document> collection = database.getCollection("movies");
 
+
+            // Uncomment the methods that correspond to what you're testing
             // runMatch(collection);
-            runAtlasTextSearch(collection);
+            // runAtlasTextSearch(collection);
+            runAtlasTextSearchMeta(collection);
         }
     }
 }