You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/plan-builder-generated.js
+17-5Lines changed: 17 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -7152,10 +7152,22 @@ class PlanColumnBuilder extends types.ServerType {
7152
7152
super(ns, fn, args);
7153
7153
}
7154
7154
/**
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}
7156
7168
* @method planBuilder.ColumnBuilder#addColumn
7157
7169
* @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.
7159
7171
* @returns { planBuilder.ColumnBuilder }
7160
7172
*/
7161
7173
addColumn(...args) {
@@ -7263,7 +7275,7 @@ units(...args) {
7263
7275
* 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}
7264
7276
* @method planBuilder.ColumnBuilder#xpath
7265
7277
* @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.
7267
7279
* @returns { planBuilder.ColumnBuilder }
7268
7280
*/
7269
7281
xpath(...args) {
@@ -8287,7 +8299,7 @@ annTopK(...args) {
8287
8299
* @since 4.1.0
8288
8300
* @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.
8289
8301
* @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.
8291
8303
* @returns { planBuilder.ModifyPlan }
8292
8304
*/
8293
8305
transitiveClosure(...args) {
@@ -9070,7 +9082,7 @@ fromDocUris(...args) {
9070
9082
* @since 4.1.0
9071
9083
* @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.
9072
9084
* @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
9074
9086
* @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.
9075
9087
* @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.
9076
9088
* @param { PlanNamespaceBindings } [namespaces] - Namespaces prefix (key) and uri (value).
0 commit comments