DEVEXP-279 : Add documentation for the optic functions using auto-generation

Author: anu3990

lib/plan-builder-generated.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -7428,10 +7428,10 @@ whereDistinct(...args) {
     return new PlanModifyPlan(this, 'op', 'where-distinct', args);
     }
 /**
-    * 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}
+     *  Provides a client interface to a server function.
     * @method planBuilder.ModifyPlan#write
-    * @since 2.1.1
-    * @param { PlanDocColsIdentifier } [docCols] -
+     * @since 3.1.0
+     * @param { PlanDocColsIdentifier } [docCols] - the docCols  value.
     * @returns { planBuilder.ModifyPlan }
     */
 write(...args) {
@@ -7440,10 +7440,10 @@ write(...args) {
     return new PlanModifyPlan(this, 'op', 'write', checkedArgs);
     }
 /**
-    * 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}
+     *  Provides a client interface to a server function.
     * @method planBuilder.ModifyPlan#remove
-    * @since 2.1.1
-    * @param { PlanDocIdentifier } [removeCol] -
+     * @since 3.1.0
+     * @param { PlanDocIdentifier } [removeCol] - the column containing URIs to be removed
     * @returns { planBuilder.ModifyPlan }
     */
 remove(...args) {
@@ -7452,10 +7452,10 @@ remove(...args) {
     return new PlanModifyPlan(this, 'op', 'remove', checkedArgs);
     }
 /**
-    * 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}
+     *  Provides a client interface to a server function.
     * @method planBuilder.ModifyPlan#lockForUpdate
-    * @since 2.1.1
-    * @param { PlanDocIdentifier } [lockUriCol] -
+     * @since 3.1.0
+     * @param { PlanDocIdentifier } [lockUriCol] - the column containing URIs to be locked
     * @returns { planBuilder.ModifyPlan }
     */
 lockForUpdate(...args) {
@@ -7466,9 +7466,9 @@ lockForUpdate(...args) {
 /**
     *  Provides a client interface to a server function.
     * @method planBuilder.ModifyPlan#transformDoc
-    * @since 2.1.1
-    * @param { PlanDocIdentifier } [transformDocCol] -
-    * @param { PlanTransformDef } [transformDef] -
+     * @since 3.1.0
+     * @param { PlanDocIdentifier } [transformDocCol] - the column containing content to be transformed.
+     * @param { PlanTransformDef } [transformDef] - defines a transform to be used.
     * @returns { planBuilder.ModifyPlan }
     */
 transformDoc(...args) {
@@ -7483,9 +7483,9 @@ transformDoc(...args) {
 /**
     *  Provides a client interface to a server function.
     * @method planBuilder.ModifyPlan#joinDocCols
-    * @since 2.1.1
-    * @param { PlanDocColsIdentifier } [cols] -
-    * @param { PlanColumnName } [docIdCol] -
+     * @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.
     * @returns { planBuilder.ModifyPlan }
     */
 joinDocCols(...args) {
@@ -7500,9 +7500,10 @@ joinDocCols(...args) {
 /**
     *  Provides a client interface to a server function.
     * @method planBuilder.ModifyPlan#validateDoc
-    * @since 2.1.1
-    * @param { PlanColumnName } [validateDocCol] -
-    * @param { PlanSchemaDef } [schemaDef] -
+     * @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).
     * @returns { planBuilder.ModifyPlan }
     */
 validateDoc(...args) {
@@ -7517,7 +7518,7 @@ validateDoc(...args) {
 /**
     * This function flattens an array value into multiple rows.Then performs a op:join-inner on the rest of the rows. Provides a client interface to a server function. See {@link http://docs.marklogic.com/ModifyPlan.prototype.unnestInner|ModifyPlan.prototype.unnestInner}
     * @method planBuilder.ModifyPlan#unnestInner
-    * @since 2.1.1
+     * @since 3.0.0
     * @param { PlanExprColName } [inputColumn] - The input column, which contains an array, to flatten into rows. This can be a string of the column name or an op:col. Use op:view-col or op:schema-col if you need to identify columns in the two views that have the same column name.
     * @param { PlanExprColName } [valueColumn] - The output column which contains the flattened array values. This can be a string of the column name or an op:col. Use op:view-col or op:schema-col as needed.
     * @param { PlanExprColName } [ordinalColumn] - The ordinalColumn is optional. If specified, an additional column will be added to the rows of flattened array values, starting from 1. This can be a string of the column name or an op:col. Use op:view-col or op:schema-col as needed.
@@ -7535,7 +7536,7 @@ unnestInner(...args) {
 /**
     * This function flattens an array value into multiple rows.Then performs a op:join-left-outer on the rest of the rows. Provides a client interface to a server function. See {@link http://docs.marklogic.com/ModifyPlan.prototype.unnestLeftOuter|ModifyPlan.prototype.unnestLeftOuter}
     * @method planBuilder.ModifyPlan#unnestLeftOuter
-    * @since 2.1.1
+     * @since 3.0.0
     * @param { PlanExprColName } [inputColumn] - The input column, which contains an array, to flatten into rows. This can be a string of the column name or an op:col. Use op:view-col or op:schema-col if you need to identify columns in the two views that have the same column name.
     * @param { PlanExprColName } [valueColumn] - The output column which contains the flattened array values. This can be a string of the column name or an op:col. Use op:view-col or op:schema-col as needed.
     * @param { PlanExprColName } [ordinalColumn] - The ordinalColumn is optional. If specified, an additional column will be added to the rows of flattened array values, starting from 1. This can be a string of the column name or an op:col. Use op:view-col or op:schema-col as needed.
@@ -7562,10 +7563,10 @@ class PlanAccessPlan extends PlanModifyPlan {
     super(prior, ns, fn, args);
   }
 /**
-    * 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}
+     * 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}
     * @method planBuilder.AccessPlan#col
     * @since 2.1.1
-    * @param { XsString } [column] - 
+     * @param { XsString } [column] - The Optic AccessorPlan created by op:from-view, op:from-triples, or op:from-lexicons.
     * @returns { planBuilder.PlanColumn }
     */
 col(...args) {
@@ -7964,10 +7965,10 @@ param(...args) {
     return new PlanParam('op', 'param', checkedArgs);
     }
 /**
-    * 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}
+     * 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}
     * @method planBuilder#col
     * @since 2.1.1
-    * @param { XsString } [column] - 
+     * @param { XsString } [column] - The Optic AccessorPlan created by op:from-view, op:from-triples, or op:from-lexicons.
     * @returns { planBuilder.PlanColumn }
     */
 col(...args) {
@@ -8229,7 +8230,7 @@ fromSearch(...args) {
 /**
     * This function constructs document rows with rows provided by a parameter. Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.fromParam|op.fromParam}
     * @method planBuilder#fromParam
-    * @since 2.1.1
+     * @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.
@@ -8247,7 +8248,7 @@ 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 2.1.1
+     * @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.
     * @param { XsString } [qualifier] - Specifies a name for qualifying the column names.
     * @returns { planBuilder.AccessPlan }
@@ -8264,7 +8265,7 @@ 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 2.1.1
+     * @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.
     * @param { XsString } [qualifier] - Specifies a name for qualifying the column names.
     * @returns { planBuilder.AccessPlan }

lib/server-types-generated.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

test-basic/plan-builder-generated.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.