#1329 expose op.columnInfo

Author: lling

marklogic-client-api/src/main/java/com/marklogic/client/impl/RowManagerImpl.java

@@ -285,6 +285,30 @@ public <T> T generateViewAs(Plan plan, String schema, String view, Class<T> as)
     return handle.get();
   }
 
+  @Override
+  public <T extends JSONReadHandle> T columnInfo(Plan plan, T resultsHandle) {
+    if (resultsHandle == null) {
+      throw new IllegalArgumentException("Must specify a handle to generate a view for the plan");
+    }
+
+    PlanBuilderBaseImpl.RequestPlan requestPlan = checkPlan(plan);
+    AbstractWriteHandle astHandle = requestPlan.getHandle();
+
+    RequestParameters params = new RequestParameters();
+    params.add("output",     "columnInfo");
+
+    return services.postResource(requestLogger, "rows", null, params, astHandle, resultsHandle);
+  }
+  @Override
+  public <T> T columnInfoAs(Plan plan, Class<T> as) {
+    ContentHandle<T> handle = handleFor(as);
+    if (columnInfo(plan, (JSONReadHandle) handle) == null) {
+      return null;
+    }
+
+    return handle.get();
+  }
+
   private void addDatatypeStyleParam(RequestParameters params, RowSetPart datatypeStyle) {
     if (datatypeStyle != null) {
       switch (datatypeStyle) {

marklogic-client-api/src/main/java/com/marklogic/client/row/RowManager.java

@@ -22,6 +22,7 @@
 import com.marklogic.client.io.marker.StructureReadHandle;
 import com.marklogic.client.io.marker.TextWriteHandle;
 import com.marklogic.client.io.marker.XMLReadHandle;
+import com.marklogic.client.io.marker.JSONReadHandle;
 
 /**
  * A Row Manager provides database operations on rows projected from documents.
@@ -294,4 +295,32 @@ public enum RowStructure{ARRAY, OBJECT}
      * @return	an object of the IO class with the content of the generated view for the plan
      */
     <T> T generateViewAs(Plan plan, String schema, String view, Class<T> as);
+
+    /**
+     * This function can be used to inspect the state of a plan before execution. It returns the information about each
+     * column in the plan, including schema name, view name, column name, data type and nullability. It also returns the
+     * information about system columns.
+     *
+     * @param plan	the definition of a plan for database rows
+     * @param handle	the Json handle on the column information for the plan
+     * @param <T> the type of the handle for the column information
+     * @return	the handle with the content of the column information for the plan
+     */
+    <T extends JSONReadHandle> T columnInfo(Plan plan, T handle);
+    /**This function can be used to inspect the state of a plan before execution. It returns the information about each
+     * column in the plan, including schema name, view name, column name, data type and nullability. It also returns the
+     * information about system columns.Generates generates a view that encapsulates a plan.
+     *
+     * The IO class must have been registered before creating the database client.
+     * By default, the provided handles that implement
+     * {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
+     *
+     * <a href="../../../../overview-summary.html#ShortcutMethods">Learn more about shortcut methods</a>
+     *
+     * @param plan	the definition of a plan for database rows
+     * @param as	the IO class for reading the column information for the plan
+     * @param <T> the type of the IO object for reading the column information
+     * @return	an object of the IO class with the content of the column information for the plan
+     */
+    <T> T columnInfoAs(Plan plan, Class<T> as);
 }

marklogic-client-api/src/test/java/com/marklogic/client/test/RowManagerTest.java

@@ -39,6 +39,7 @@
 import javax.xml.transform.stream.StreamResult;
 import javax.xml.xpath.XPathExpressionException;
 
+import com.marklogic.client.io.marker.JSONReadHandle;
 import com.marklogic.client.row.*;
 import com.marklogic.client.type.*;
 import org.junit.AfterClass;
@@ -1205,6 +1206,27 @@ public void testMapper() throws IOException, XPathExpressionException {
     }
   }
   @Test
+  public void testColumnInfo() throws IOException {
+    RowManager rowMgr = Common.client.newRowManager();
+
+    PlanBuilder p = rowMgr.newPlanBuilder();
+
+    PlanBuilder.ExportablePlan builtPlan =
+            p.fromView("opticUnitTest", "musician")
+                    .where(
+                            p.cts.andQuery(
+                                    p.cts.jsonPropertyWordQuery("instrument", "trumpet"),
+                                    p.cts.jsonPropertyWordQuery(p.xs.string("lastName"), p.xs.stringSeq("Armstrong", "Davis"))
+                            )
+                    )
+                    .orderBy(p.col("lastName"));
+
+    String result = rowMgr.columnInfo(builtPlan, new StringHandle()).get();
+    assertNotNull(result);
+    result = rowMgr.columnInfoAs(builtPlan, String.class);
+    assertNotNull(result);
+  }
+  @Test
   public void testGenerateView() throws IOException {
     RowManager rowMgr = Common.client.newRowManager();