DEVEXP-592 : Submit Optic plan containing new operations in MarkLogic 11.1

Author: anu3990

lib/plan-builder-base.js

@@ -417,7 +417,8 @@ function castArg(arg, funcName, paramName, argPos, paramTypes) {
     }
     break;
   case 'string':
-    if (isProtoChained(paramTypes, [types.XsAnyAtomicType, types.TextNode, types.JsonContentNode, types.XmlContentNode])) {
+    if (isProtoChained(paramTypes, [types.XsAnyAtomicType, types.TextNode, types.JsonContentNode, types.XmlContentNode,
+    types.XsString])) {
       return arg;
     }
     break;

lib/plan-builder-generated.js

@@ -1113,9 +1113,10 @@ periodRangeQuery(...args) {
 point(...args) {
     const namer = bldrbase.getNamer(args, 'latitude');
     const paramdefs = [['latitude', [types.XsDouble, PlanColumn, PlanParam], true, false], ['longitude', [types.XsDouble, PlanColumn, PlanParam], true, false]];
+    // Changing minArity to 1 manually since cts.point now accepts string input (MarkLogic 11.1.0 or higher needed).
     const checkedArgs = (namer !== null) ?
         bldrbase.makeNamedArgs(namer, 'cts.point', 2, new Set(['latitude', 'longitude']), paramdefs, args) :
-        bldrbase.makePositionalArgs('cts.point', 2, false, paramdefs, args);
+        bldrbase.makePositionalArgs('cts.point', 1, false, paramdefs, args);
     return new types.CtsPoint('cts', 'point', checkedArgs);
 
     }
@@ -1151,7 +1152,8 @@ pointLongitude(...args) {
     * @returns { CtsPolygon }
     */
 polygon(...args) {
-    const paramdef = ['vertices', [types.CtsPoint, PlanColumn, PlanParam], false, true];
+    // Adding types.XsString manually since cts.polygon now accepts string input (MarkLogic 11.1.0 or higher needed).
+    const paramdef = ['vertices', [types.CtsPoint, PlanColumn, PlanParam, types.XsString], false, true];
     const checkedArgs = bldrbase.makeSingleArgs('cts.polygon', 1, paramdef, args);
     return new types.CtsPolygon('cts', 'polygon', checkedArgs);
     }
@@ -3188,8 +3190,8 @@ geohashSubhashes(...args) {
     const namer = bldrbase.getNamer(args, 'hash');
     const paramdefs = [['hash', [types.XsString, PlanColumn, PlanParam], true, false], ['which', [types.XsString, PlanColumn, PlanParam], true, false]];
     const checkedArgs = (namer !== null) ?
-        bldrbase.makeNamedArgs(namer, 'geo.geohashSubhashes', 2, new Set(['hash', 'which']), paramdefs, args) :
-        bldrbase.makePositionalArgs('geo.geohashSubhashes', 2, false, paramdefs, args);
+        bldrbase.makeNamedArgs(namer, 'geo.geohashSubhashes', 1, new Set(['hash', 'which']), paramdefs, args) :
+        bldrbase.makePositionalArgs('geo.geohashSubhashes', 1, false, paramdefs, args);
     return new types.XsString('geo', 'geohash-subhashes', checkedArgs);
 
     }
@@ -5393,8 +5395,8 @@ decodeFromNCName(...args) {
     * @method planBuilder.xdmp#describe
     * @since 2.1.1
     * @param { Item } [item] - The item sequence whose description is returned.
-    * @param { XsUnsignedInt } [maxSequenceLength] - Represents the maximum number of items per sequence to print. The default is 3. () means no maximum.
-    * @param { XsUnsignedInt } [maxItemLength] - Represents the maximum number of characters per item to print. The default is 64. The minimum is 8. () means no limit.
+    * @param { XsUnsignedInt } [maxSequenceLength] - Represents the maximum number of items per sequence to print. The default is 3.
+    * @param { XsUnsignedInt } [maxItemLength] - Represents the maximum number of characters per item to print. The default is 64. The minimum is 8.
     * @returns { XsString }
     */
 describe(...args) {
@@ -7367,7 +7369,7 @@ orderBy(...args) {
     * This method prepares the specified plan for execution as an optional final step before execution. Provides a client interface to a server function. See {@link http://docs.marklogic.com/ModifyPlan.prototype.prepare|ModifyPlan.prototype.prepare}
     * @method planBuilder.ModifyPlan#prepare
     * @since 2.1.1
-    * @param { XsInt } [optimize] - The optimization level, which can be 0, 1, or 2 (with 1 as the default).
+    * @param { XsInt } [optimize] - The optimization level, which can be 0, 1, or 2 (1 is mostly used).
     * @returns { planBuilder.PreparePlan }
     */
 prepare(...args) {
@@ -7428,7 +7430,7 @@ whereDistinct(...args) {
     return new PlanModifyPlan(this, 'op', 'where-distinct', args);
     }
 /**
-     *  Provides a client interface to a server function.
+    * Inserts or overwrites the documents identified by the uri column with the data supplied by the other document descriptor columns. Provides a client interface to a server function. See {@link http://docs.marklogic.com/ModifyPlan.prototype.write|ModifyPlan.prototype.write}
     * @method planBuilder.ModifyPlan#write
      * @since 3.1.0
      * @param { PlanDocColsIdentifier } [docCols] - the docCols  value.
@@ -7440,7 +7442,7 @@ write(...args) {
     return new PlanModifyPlan(this, 'op', 'write', checkedArgs);
     }
 /**
-     *  Provides a client interface to a server function.
+    * This method deletes a document from the database. If the document does not exist, this method does not throw an error. Provides a client interface to a server function. See {@link http://docs.marklogic.com/ModifyPlan.prototype.remove|ModifyPlan.prototype.remove}
     * @method planBuilder.ModifyPlan#remove
      * @since 3.1.0
      * @param { PlanDocIdentifier } [removeCol] - the column containing URIs to be removed
@@ -7452,7 +7454,7 @@ remove(...args) {
     return new PlanModifyPlan(this, 'op', 'remove', checkedArgs);
     }
 /**
-     *  Provides a client interface to a server function.
+    * Gets an early lock on documents that will be updated later in the pipeline with an operation like remove() or write(). Documents are always locked, but for complex pipelines, it can be beneficial to lock the document early, so to minimize the potential for lock contention. Provides a client interface to a server function. See {@link http://docs.marklogic.com/ModifyPlan.prototype.lockForUpdate|ModifyPlan.prototype.lockForUpdate}
     * @method planBuilder.ModifyPlan#lockForUpdate
      * @since 3.1.0
      * @param { PlanDocIdentifier } [lockUriCol] - the column containing URIs to be locked
@@ -7464,11 +7466,11 @@ lockForUpdate(...args) {
     return new PlanModifyPlan(this, 'op', 'lock-for-update', checkedArgs);
     }
 /**
-    *  Provides a client interface to a server function.
+    * This function applies a transformation to a column that contains documents. This transform module needs to be stored in the modules database. Provides a client interface to a server function. See {@link http://docs.marklogic.com/ModifyPlan.prototype.transformDoc|ModifyPlan.prototype.transformDoc}
     * @method planBuilder.ModifyPlan#transformDoc
-     * @since 3.1.0
-     * @param { PlanDocIdentifier } [transformDocCol] - the column containing content to be transformed.
-     * @param { PlanTransformDef } [transformDef] - defines a transform to be used.
+    * @since 3.1.0
+    * @param { PlanDocIdentifier } [transformDocCol] - The 'kind' key of the schema map must be 'mjs'(the default), or 'xslt'. The 'path' key specifies the main module in the modules database. The 'params' key specifies parameter values passed to the main module. (refer to xdmp:invoke and xdmp:xslt-invoke).
+    * @param { PlanTransformDef } [transformDef] - defines a transform to be used.
     * @returns { planBuilder.ModifyPlan }
     */
 transformDoc(...args) {
@@ -7481,11 +7483,11 @@ transformDoc(...args) {
 
     }
 /**
-    *  Provides a client interface to a server function.
+    * This function populates the view with the uri, doc, collections, metadata, permissions, and / or quality document descriptor columns for database document values. Provides a client interface to a server function. See {@link http://docs.marklogic.com/ModifyPlan.prototype.joinDocCols|ModifyPlan.prototype.joinDocCols}
     * @method planBuilder.ModifyPlan#joinDocCols
-     * @since 3.1.0
-     * @param { PlanDocColsIdentifier } [cols] - Supplies a document column identifier object to specify which document columns to join and their names. The names cannot conflict with existing column names.
-     * @param { PlanColumnName } [docIdCol] - The document uri or fragment id value. This is either an op.fragmentIdCol object specifying a fragment id column or a document uri column.
+    * @since 3.1.0
+    * @param { PlanDocColsIdentifier } [cols] - The source column to join. This is either an op:fragment-id-col specifying a fragment id column or a op:col, op:view-col or op:schema-col that contains document uris. Joining on a fragment id is more efficient than joining on an uri column.
+    * @param { PlanColumnName } [docIdCol] - The document uri or fragment id value. This is either an op.fragmentIdCol object specifying a fragment id column or a document uri column.
     * @returns { planBuilder.ModifyPlan }
     */
 joinDocCols(...args) {
@@ -7498,12 +7500,12 @@ joinDocCols(...args) {
 
     }
 /**
-    *  Provides a client interface to a server function.
+    * Validate the document based on a supplied schema. This schema needs to be stored in the schema database. Check appserver error log for validate errors. Provides a client interface to a server function. See {@link http://docs.marklogic.com/ModifyPlan.prototype.validateDoc|ModifyPlan.prototype.validateDoc}
     * @method planBuilder.ModifyPlan#validateDoc
-     * @since 3.1.0
-     * @param { PlanColumnName } [validateDocCol] - Contains the document to validate.
-     * @param { PlanSchemaDef } [schemaDef] - This is an object. The required 'kind' property of the schema object must be 'jsonSchema', 'schematron', or 'xmlSchema'. When 'kind' is 'jsonSchema' or 'schemtron' then a property 'schemaUri' is required.
-     *                      Property 'mode' takes 'strict', 'lax' or 'type' (refer to xdmp.validate).
+    * @since 3.1.0
+    * @param { PlanColumnName } [validateDocCol] - The required 'kind' key of the schemaDef map must be 'jsonSchema', 'schematron', or 'xmlSchema'. When 'kind' is 'jsonSchema' or 'schemtron' then a key 'schemaUri' is required. Key 'mode' takes 'strict', 'lax' or 'type' (refer to xdmp:validate).
+    * @param { PlanSchemaDef } [schemaDef] - This is an object. The required 'kind' property of the schema object must be 'jsonSchema', 'schematron', or 'xmlSchema'. When 'kind' is 'jsonSchema' or 'schemtron' then a property 'schemaUri' is required.
+ *                      Property 'mode' takes 'strict', 'lax' or 'type' (refer to xdmp.validate).
     * @returns { planBuilder.ModifyPlan }
     */
 validateDoc(...args) {
@@ -7563,7 +7565,7 @@ class PlanAccessPlan extends PlanModifyPlan {
     super(prior, ns, fn, args);
   }
 /**
-     * This method identifies a column, where the column name is unique. A qualifier on the column name isn't necessary (and might not exist). In positions where only a column name can appear, the unqualified column name can also be provided as a string. Qualified column names cannot be provided as a string. Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.col|op.col}
+    * Identifies a column where the column name is unique and a qualifier on the column name isn't necessary (and might not exist).  Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.col|op.col}
     * @method planBuilder.AccessPlan#col
     * @since 2.1.1
      * @param { XsString } [column] - The Optic AccessorPlan created by op:from-view, op:from-triples, or op:from-lexicons.
@@ -7965,7 +7967,7 @@ param(...args) {
     return new PlanParam('op', 'param', checkedArgs);
     }
 /**
-     * This method identifies a column, where the column name is unique. A qualifier on the column name isn't necessary (and might not exist). In positions where only a column name can appear, the unqualified column name can also be provided as a string. Qualified column names cannot be provided as a string. Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.col|op.col}
+    * Identifies a column where the column name is unique and a qualifier on the column name isn't necessary (and might not exist).  Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.col|op.col}
     * @method planBuilder#col
     * @since 2.1.1
      * @param { XsString } [column] - The Optic AccessorPlan created by op:from-view, op:from-triples, or op:from-lexicons.
@@ -8233,7 +8235,7 @@ fromSearch(...args) {
      * @since 3.1.0
     * @param { XsString } [paramName] - The paramName parameter specifies the placeholder parameter supplying the rows.
     * @param { XsString } [qualifier] - Specifies a name for qualifying the column names.
-    * @param { PlanRowColTypes } [rowColTypes] - Describes the columns with an array of JavaScript objects. It's a combinations of column, type and nullable. The 'column' is the column name, which is required. The 'type' is the optional type of the column, which can be an atomic type or the default of none. The 'nullable' is an optional boolean defaulting to false. If your rows contains only uri, doc, collections, metadata, permissions, quality and temporalCollection columns, you could simply use op.docColTypes instead.
+    * @param { PlanRowColTypes } [rowColTypes] - Describes the columns with a sequence of maps. It's a combinations of column, type and nullable. The 'column' is the column name, which is required. The 'type' is the optional type of the column, which can be an atomic type or the default of none. The 'nullable' is an optional boolean defaulting to false. If your rows contains only uri, doc, collections, metadata, permissions, quality and temporalCollection columns, you could simply use op:doc-col-types instead.
     * @returns { planBuilder.AccessPlan }
     */
 fromParam(...args) {
@@ -8248,8 +8250,8 @@ fromParam(...args) {
 /**
     * This function constructs document rows from the docsDescriptors. Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.fromDocDescriptors|op.fromDocDescriptors}
     * @method planBuilder#fromDocDescriptors
-     * @since 3.1.0
-    * @param { PlanDocDescriptor } [docDescriptor] - An array of document descriptors. Each document descriptor describes a document. A document descriptor contains a combination of uri, doc, collections, metadata, permissions, quality and temporalCollection. This is a simpler form of op.fromParam.
+    * @since 3.1.0
+    * @param { PlanDocDescriptor } [docDescriptor] - A map of document descriptors. Each document descriptor describes a document. A document descriptor contains a combination of uri, doc, collections, metadata, permissions, quality and temporalCollection. This is a simpler form of op:from-param.
     * @param { XsString } [qualifier] - Specifies a name for qualifying the column names.
     * @returns { planBuilder.AccessPlan }
     */
@@ -8265,8 +8267,8 @@ fromDocDescriptors(...args) {
 /**
     * This function matches and returns the uri, content, and score for documents. Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.fromDocUris|op.fromDocUris}
     * @method planBuilder#fromDocUris
-     * @since 3.1.0
-    * @param { PlanQueryDef } [querydef] - Qualifies a set of documents. The query can be a cts.query or as an array of document URI string literals.
+    * @since 3.1.0
+    * @param { PlanQueryDef } [querydef] - Qualifies a set of documents. The query can be a cts:query or as a sequence of document URI string literals.
     * @param { XsString } [qualifier] - Specifies a name for qualifying the column names.
     * @returns { planBuilder.AccessPlan }
     */
@@ -8894,11 +8896,11 @@ resolveFunction(...args) {
 
     }
 /**
-    * Constructs a document column identifier object for columns of uri, doc, collections, metadata, permissions, quality and temporalCollection. The document column identifier object can be passed to the prototype.joinDocCols or prototype.write. Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.docCols|op.docCols}
+    * Constructs a document column identifier object for columns of uri, doc, collections, metadata, permissions, quality and temporalCollection. The document column identifier object can be passed to the op:join-doc-cols or op:write. Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.docCols|op.docCols}
     * @method planBuilder#docCols
     * @since 2.1.1
     * @param { XsString } [qualifier] - Specifies a name for qualifying the column names.
-    * @param { XsString } [names] - An array of columns names, a combination of uri, doc, collections, metadata, permissions, quality and temporalCollection.
+    * @param { XsString } [names] - A sequence of columns names, a combination of uri, doc, collections, metadata, permissions, quality and temporalCollection.
     * @returns { planBuilder.PlanDocColsIdentifier }
     */
 docCols(...args) {
@@ -8911,7 +8913,7 @@ docCols(...args) {
 
     }
 /**
-    * Provides the 3rd parameter for op.fromParam for row column types. Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.docColTypes|op.docColTypes}
+    * Provides the 3rd parameter for op:from-param for row column types. Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.docColTypes|op.docColTypes}
     * @method planBuilder#docColTypes
     * @since 2.1.1