Merge pull request #1555 from marklogic/feature/394-columnInfo

DEVEXP-394 columnInfo now supports DSL and serialized queries

Author: rjrudin

marklogic-client-api/build.gradle

@@ -53,6 +53,7 @@ dependencies {
 	testImplementation 'org.apache.httpcomponents:httpclient:4.5.14'
 	testImplementation 'com.opencsv:opencsv:4.6'
 	testImplementation 'org.geonames:geonames:1.0'
+	testImplementation 'org.skyscreamer:jsonassert:1.5.0'
 }
 
 // Ensure that mlHost and mlPassword can override the defaults of localhost/admin if they've been modified

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

@@ -331,7 +331,7 @@ public <T> T generateViewAs(PlanBuilder.PreparePlan plan, String schema, String
   }
 
   @Override
-  public <T extends JSONReadHandle> T columnInfo(PlanBuilder.PreparePlan plan, T resultsHandle) {
+  public <T extends JSONReadHandle> T columnInfo(PlanBuilder.Plan plan, T resultsHandle) {
     if (resultsHandle == null) {
       throw new IllegalArgumentException("Must specify a handle to generate a view for the plan");
     }
@@ -345,7 +345,7 @@ public <T extends JSONReadHandle> T columnInfo(PlanBuilder.PreparePlan plan, T r
     return services.postResource(requestLogger, "rows", null, params, astHandle, resultsHandle);
   }
   @Override
-  public <T> T columnInfoAs(PlanBuilder.PreparePlan plan, Class<T> as) {
+  public <T> T columnInfoAs(PlanBuilder.Plan plan, Class<T> as) {
     ContentHandle<T> handle = handleFor(as);
     if (!(handle instanceof JSONReadHandle))
       throw new IllegalArgumentException("The handle is not an instance of JSONReadHandle.");

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

@@ -344,10 +344,12 @@ public enum RowStructure{ARRAY, OBJECT}
      * @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(PlanBuilder.PreparePlan plan, T handle);
-    /**This function can be used to inspect the state of a plan before execution. It returns the information about each
+    <T extends JSONReadHandle> T columnInfo(PlanBuilder.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.
+     * information about system columns.
      *
      * The IO class must have been registered before creating the database client.
      * By default, the provided handles that implement
@@ -360,7 +362,7 @@ public enum RowStructure{ARRAY, OBJECT}
      * @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(PlanBuilder.PreparePlan plan, Class<T> as);
+    <T> T columnInfoAs(PlanBuilder.Plan plan, Class<T> as);
 
 	/**
 	 * Executes a GraphQL query against the database and returns the results as a JSON object.

marklogic-client-api/src/test/java/com/marklogic/client/test/rows/ColumnInfoTest.java

@@ -0,0 +1,83 @@
+package com.marklogic.client.test.rows;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.marklogic.client.expression.PlanBuilder;
+import com.marklogic.client.io.StringHandle;
+import com.marklogic.client.row.RawPlanDefinition;
+import com.marklogic.client.row.RawQueryDSLPlan;
+import com.marklogic.client.row.RowManager;
+import com.marklogic.client.test.Common;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.skyscreamer.jsonassert.JSONAssert;
+import org.springframework.core.io.ClassPathResource;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+public class ColumnInfoTest {
+
+	private RowManager rowManager;
+
+	@BeforeEach
+	void beforeEach() {
+		rowManager = Common.newClient().newRowManager();
+	}
+
+	@Test
+	void allTypesWithDSLPlan() {
+		String query = "op.fromView('javaClient', 'allTypes')";
+		RawQueryDSLPlan plan = rowManager.newRawQueryDSLPlan(new StringHandle(query));
+		verifyColumnInfo(plan);
+	}
+
+	@Test
+	void allTypesWithSerializedPlan() {
+		String serializedQuery = "{\n" +
+			"  \"$optic\": {\n" +
+			"    \"ns\": \"op\",\n" +
+			"    \"fn\": \"operators\",\n" +
+			"    \"args\": [\n" +
+			"      {\n" +
+			"        \"ns\": \"op\",\n" +
+			"        \"fn\": \"from-view\",\n" +
+			"        \"args\": [\n" +
+			"          \"javaClient\",\n" +
+			"          \"allTypes\"\n" +
+			"        ]\n" +
+			"      }\n" +
+			"    ]\n" +
+			"  }\n" +
+			"}";
+
+		RawPlanDefinition plan = rowManager.newRawPlanDefinition(new StringHandle(serializedQuery));
+		verifyColumnInfo(plan);
+	}
+
+	/**
+	 * The expected JSON for all the column infos is based on the results from the 20230417 build. See the internal
+	 * DBQ-296 ticket for an explanation on why some of the columns have an expected type of "none".
+	 *
+	 * @param plan
+	 */
+	private void verifyColumnInfo(PlanBuilder.Plan plan) {
+		StringHandle output = Common.client.newRowManager().columnInfo(plan, new StringHandle());
+
+		assertTrue(output.getServerTimestamp() > 0, "The server timestamp should be present so that a client, such as " +
+			"the Spark connector, can both get column info and identify a timestamp for future point-in-time queries.");
+
+		String[] columnInfos = output.get().split("\n");
+		assertEquals(36, columnInfos.length, "There are 35 column definitions in the allTypes TDE, and then a 36th " +
+			"column info is added for the rowid column.");
+
+		ObjectMapper mapper = new ObjectMapper();
+		try {
+			JsonNode actualColumnInfo = mapper.readTree("[" + String.join(",", columnInfos) + "]");
+			JsonNode expectedColumnInfo = mapper.readTree(new ClassPathResource("allTypes-columnInfo.json").getInputStream());
+			JSONAssert.assertEquals(expectedColumnInfo.toString(), actualColumnInfo.toString(), true);
+		} catch (Exception ex) {
+			throw new RuntimeException(ex);
+		}
+	}
+}