Skip to content

Commit 562abe4

Browse files
committed
MLE-12345
Fix copyright end year and fix some JSDoc typos and incorrect statements caught by Copilot
1 parent 4e4afee commit 562abe4

5 files changed

Lines changed: 21 additions & 9 deletions

File tree

lib/plan-builder-generated.js

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7152,10 +7152,22 @@ class PlanColumnBuilder extends types.ServerType {
71527152
super(ns, fn, args);
71537153
}
71547154
/**
7155-
* Create a new column definition for use with op:from-docs. This method initializes the column with default properties unless overridden by additional chained methods. Default Behavior: If no other properties are set (such as xpath(), type(), or nullable()), the column defaults to: XPath: ./name (where name is the name passed to add-column()).Type: stringNullable: true Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.addColumn|op.addColumn}
7155+
* Create a new column definition for use with op:from-docs.
7156+
* This method initializes the column with default properties unless overridden by additional chained methods.
7157+
* Default behavior (when no other properties are set, such as xpath(), type(), or nullable()):
7158+
* - XPath: ./name (where name is the name passed to add-column()).
7159+
* - Type: string
7160+
* - Nullable: true
7161+
* Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.addColumn|op.addColumn}
7162+
* This method initializes the column with default properties unless overridden by additional chained methods.
7163+
* Default behavior (when no other properties are set, such as xpath(), type(), or nullable()):
7164+
* - XPath: ./name (where name is the name passed to add-column()).
7165+
* - Type: string
7166+
* - Nullable: true
7167+
* Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.addColumn|op.addColumn}
71567168
* @method planBuilder.ColumnBuilder#addColumn
71577169
* @since 4.1.0
7158-
* @param { PlanColumnName } [column] - The Column Builder Plan. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.
7170+
* @param { PlanColumnName } [column] - The name of the column to add, specified either as a string or as a PlanColumn. You can either use the XQuery => chaining operator or specify the variable that captures the return value from the previous operation.
71597171
* @returns { planBuilder.ColumnBuilder }
71607172
*/
71617173
addColumn(...args) {
@@ -7263,7 +7275,7 @@ units(...args) {
72637275
* This function extracts a sequence of child nodes from a column with node values -- especially, the document nodes from a document join. The path is an XPath (specified as a string) to apply to each node to generate a sequence of nodes as an expression value. Sets the XPath expression in the document from which to extract content for the column created by op:add-column. It cannot be used together with op:expr, as both of them define the content of the column. Provides a client interface to a server function. See {@link http://docs.marklogic.com/op.xpath|op.xpath}
72647276
* @method planBuilder.ColumnBuilder#xpath
72657277
* @since 4.1.0
7266-
* @param { XsString } [path] - The name of the column from which to extract the child nodes. The column can be named with a string or a column function such as op:col, op:view-col, or op:schema-col, or constructed from an expression with the op:as function.It can also be op:context to refer to the node of the current processing row.
7278+
* @param { XsString } [path] - The XPath expression, specified as a string, to apply to each node in the source column in order to extract child nodes or content for the column created by op:add-column.
72677279
* @returns { planBuilder.ColumnBuilder }
72687280
*/
72697281
xpath(...args) {
@@ -8287,7 +8299,7 @@ annTopK(...args) {
82878299
* @since 4.1.0
82888300
* @param { PlanExprColName } [start] - The column is the starting node of the traversal. The column can be named with a string or a column function such as op:col, op:view-col, or op:schema-col, or constructed from an expression with the op:as function.
82898301
* @param { PlanExprColName } [end] - The column is the end node of the traversal. The column can be named with a string or a column function such as op:col, op:view-col, or op:schema-col, or constructed from an expression with the op:as function.
8290-
* @param { PlanTransitiveClosureOptions } [options] - This is either a sequence of strings or an object containing keys and values for the options to this operator. Options include: min-length This option is the minimum number of steps (edges) required in the path. It should be a non-negative integer, and the default is 1. max-length This option Maximum number of steps (edges) allowed in the path. It should be a non-negative integer, and the default is unlimited.
8302+
* @param { PlanTransitiveClosureOptions } [options] - This is either a sequence of strings or an object containing keys and values for the options to this operator. Options include: min-length This option is the minimum number of steps (edges) required in the path. It should be a non-negative integer, and the default is 1. max-length This option is the maximum number of steps (edges) allowed in the path. It should be a non-negative integer, and the default is unlimited.
82918303
* @returns { planBuilder.ModifyPlan }
82928304
*/
82938305
transitiveClosure(...args) {
@@ -9070,7 +9082,7 @@ fromDocUris(...args) {
90709082
* @since 4.1.0
90719083
* @param { PlanQueryDef } [ctsQuery] - Query to select documents for row generation . The query can be a cts:query or a string as a shortcut for a cts:word-query.
90729084
* @param { XsString } [contextPath] - XPath applied to each matched document; each result becomes a row.
9073-
* @param { PlanColumnBuilder } [columnSpec] - The column definitionss create by using op:column-builder
9085+
* @param { PlanColumnBuilder } [columnSpec] - The column definitions create by using op:column-builder
90749086
* @param { XsString } [qualifier] - Specifies a name for qualifying the column names in place of the combination of the schema and view names. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.
90759087
* @param { PlanSystemColumn } [systemCol] - An optional named fragment id column returned by op:fragment-id-col. One use case for fragment ids is in joins with lexicons or document content.
90769088
* @param { PlanNamespaceBindings } [namespaces] - Namespaces prefix (key) and uri (value).

test-basic/plan-builder-generated.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1728,7 +1728,7 @@ describe('plan builder', function() {
17281728
this.skip();
17291729
}
17301730
// AAAAAAMAAAAAAIA/AAAAQAAAQEA= is the ML base64 encoding string of the vector [1,2,3]
1731-
// Run vec.base64Encode(vec.vector([1,2,3])) in query console to generate
1731+
// Run vec.base64Encode(vec.vector([1,2,3])) in query console to generate this encoded value.
17321732
testPlan([p.xs.string("AAAAAAMAAAAAAIA/AAAAQAAAQEA=")],p.vec.base64Decode(p.col("1")))
17331733
.then(function(response) {
17341734
should(String(getResult(response).value)).equal('1,2,3');

test-basic/service-caller.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
2+
* Copyright (c) 2015-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
33
*/
44

55
var marklogic = require('../');

test-basic/ssl-min-allow-tls-test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
2+
* Copyright (c) 2015-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
33
*/
44

55
let testconfig = require('../etc/test-config.js');

test-basic/transitive-closure.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
2+
* Copyright (c) 2015-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
33
*/
44
'use strict';
55

0 commit comments

Comments
 (0)