DOCSP-45419-Run-Java-Queries (#10)

* DOCSP-45419-Run-Java-Queries

* internal review

* ir

* xr

Author: jmd-mongo

source/images/run-queries/intellij-pg-icon-converted-query.png

@@ -37,12 +37,11 @@ The {+intellij-short+} currently supports the following features:
 
 - :ref:`Autocomplete <intellij-autocomplete>` for database, collection, and 
   document field names. 
-
 - :ref:`Database reference validation <intellij-db-reference-validation>`.
-
 - :ref:`Type validation <intellij-type-validation>` of document fields.
-
 - :ref:`Missing index warnings <intellij-index-warning>` for Java queries.
+- :ref:`Run Java Queries <intellij-run-java-queries>` directly in the
+  Database Explorer Playgrounds.
 
 Get Started 
 -----------
@@ -70,5 +69,6 @@ To learn more about submitting feedback, see :ref:`intellij-submit-feedback`.
    Database Reference Validation </db-reference-validation>
    Type Validation </type-validation>
    Missing Index Warning </index-warning>
+   Run Java Queries </run-java-queries>
    Release Notes <https://github.com/mongodb-js/intellij/blob/main/CHANGELOG.md>
    Submit Feedback </submit-feedback>

source/images/run-queries/intellij-run-icon.png

@@ -0,0 +1,80 @@
+.. _intellij-run-java-queries:
+
+================
+Run Java Queries
+================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Definition
+----------
+
+The {+intellij-full+} enables you to run queries written in Java directly 
+in the Database Explorer Playgrounds. 
+
+The Run button appears next to your MongoDB queries.
+
+.. image:: /images/run-queries/intellij-run-icon.png
+   :alt: Click the Run button to convert your Java query to mongosh syntax.
+
+Behavior
+--------
+
+When you click the Run button, the plugin automatically converts your 
+Java query to ``mongosh`` syntax and opens a Playground file with the 
+populated query.
+
+For field values that are variables determined at runtime, the plugin 
+creates a placeholder variable. You can populate this placeholder with 
+a test value and run the query in the Playground. 
+
+Example
+-------
+
+In this example, the Java query on the ``production.trips`` collection
+resemles the following:
+
+.. code:: java
+   :copyable: false
+
+   public List<Document> findCompletedTripsByDriver(String driverId) {
+      return trips.find(Filters.and(
+              Filters.eq(fieldName: "trip_status", value: "completed"),
+              Filters.eq(fieldName: "driver_id", driverId)
+      )).into(new ArrayList<>());
+   }
+
+The code example below shows the converted query from the Java code 
+above.
+
+.. code:: javascript
+   :copyable: true
+
+   var driver_id = "<driver ID>"
+
+   db.getSiblingsDB("production")
+     .getCollection("trips")
+     .find( { 
+        "$and" : [ 
+           { "trip_status" : "completed" },
+           { "driver_id" : driver_id }
+        ]
+      )
+
+In this example, ``driver_id`` is a variable that holds a value 
+determined at runtime. In order to test that your query outputs the 
+results you expect, you must specify a test value by replacing 
+``<driver ID>`` with the driver ID. For example, 
+``driver_id = "1a2b3c4d5e"``.
+
+Once you are satisfied with the query, you can run it in the Playground 
+and view the query results.
+
+.. image:: /images/run-queries/intellij-pg-icon-converted-query.png
+   :alt: Click the Run button to run your query and view the results.

source/index.txt

@@ -64,3 +64,4 @@ Learn More
 - :ref:`intellij-connect`
 - :ref:`intellij-autocomplete`
 - :ref:`intellij-index-warning`
+- :ref:`intellij-run-java-queries`