public static interface PlanBuilder.ModifyPlan extends PlanBuilder.PreparePlan, PlanBuilderBase.ModifyPlanBase
| Modifier and Type | Method and Description |
|---|---|
PlanBuilder.ModifyPlan |
bind(PlanExprColSeq columns)
This function adds new columns or modifies
existing columns based on expressions while preserving existing
unmodified columns in the row set.
|
PlanBuilder.ModifyPlan |
bindAs(PlanColumn column,
ServerExpression expression)
This function is deprecated in favor of the
bind() function and will not be supported in MarkLogic 11.
|
PlanBuilder.ModifyPlan |
bindAs(java.lang.String column,
ServerExpression expression)
This function is deprecated in favor of the
bind() function and will not be supported in MarkLogic 11.
|
PlanBuilder.ModifyPlan |
except(PlanBuilder.ModifyPlan right)
This method restricts the left row set to rows
where a row with the same columns and values doesn't exist in the
right row set.
|
PlanBuilder.ModifyPlan |
existsJoin(PlanBuilder.ModifyPlan right)
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
|
PlanBuilder.ModifyPlan |
existsJoin(PlanBuilder.ModifyPlan right,
PlanJoinKey... keys)
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
|
PlanBuilder.ModifyPlan |
existsJoin(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys)
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
|
PlanBuilder.ModifyPlan |
existsJoin(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
boolean condition)
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
|
PlanBuilder.ModifyPlan |
existsJoin(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
ServerExpression condition)
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
|
PlanBuilder.ModifyPlan |
groupBy(PlanExprColSeq keys)
This method collapses a group of rows into a
single row.
|
PlanBuilder.ModifyPlan |
groupBy(PlanExprColSeq keys,
PlanAggregateColSeq aggregates)
This method collapses a group of rows into a
single row.
|
PlanBuilder.ModifyPlan |
intersect(PlanBuilder.ModifyPlan right)
This method restricts the left row set to rows
where a row with the same columns and values exists in the right
row set.
|
PlanBuilder.ModifyPlan |
joinCrossProduct(PlanBuilder.ModifyPlan right)
This method yields one output row set that
concatenates every left row with every right row.
|
PlanBuilder.ModifyPlan |
joinCrossProduct(PlanBuilder.ModifyPlan right,
boolean condition)
This method yields one output row set that
concatenates every left row with every right row.
|
PlanBuilder.ModifyPlan |
joinCrossProduct(PlanBuilder.ModifyPlan right,
ServerExpression condition)
This method yields one output row set that
concatenates every left row with every right row.
|
PlanBuilder.ModifyPlan |
joinDoc(PlanColumn docCol,
PlanColumn sourceCol)
This function specifies a document column to add
to the rows by reading the documents for an existing source column
having a value of a document uri (which can be used to read other
documents) or a fragment id (which can be used to read the source
documents for rows).
|
PlanBuilder.ModifyPlan |
joinDoc(java.lang.String docCol,
java.lang.String sourceCol)
This function specifies a document column to add
to the rows by reading the documents for an existing source column
having a value of a document uri (which can be used to read other
documents) or a fragment id (which can be used to read the source
documents for rows).
|
PlanBuilder.ModifyPlan |
joinDocAndUri(PlanColumn docCol,
PlanColumn uriCol,
PlanColumn sourceCol)
This method adds an uri column and a document
column to rows based on an existing source column having a value of
a document uri (which can be used to read other documents) or a
fragment id (which can be used to read the source documents for
rows).
|
PlanBuilder.ModifyPlan |
joinDocAndUri(java.lang.String docCol,
java.lang.String uriCol,
java.lang.String sourceCol)
This method adds an uri column and a document
column to rows based on an existing source column having a value of
a document uri (which can be used to read other documents) or a
fragment id (which can be used to read the source documents for
rows).
|
PlanBuilder.ModifyPlan |
joinDocCols(PlanDocColsIdentifier cols,
PlanColumn docIdCol)
This function populates the view with the uri,
doc, collections, metadata, permissions, and / or quality document
descriptor columns for database document values.
|
PlanBuilder.ModifyPlan |
joinDocCols(PlanDocColsIdentifier cols,
java.lang.String docIdCol)
This function populates the view with the uri,
doc, collections, metadata, permissions, and / or quality document
descriptor columns for database document values.
|
PlanBuilder.ModifyPlan |
joinDocUri(PlanColumn uriCol,
PlanColumn fragmentIdCol)
This method adds a uri column to rows based on
an existing fragment id column to identify the source document for
each row.
|
PlanBuilder.ModifyPlan |
joinDocUri(java.lang.String uriCol,
java.lang.String fragmentIdCol)
This method adds a uri column to rows based on
an existing fragment id column to identify the source document for
each row.
|
PlanBuilder.ModifyPlan |
joinFullOuter(PlanBuilder.ModifyPlan right)
This method yields one output row set with the
rows from an inner join as well as the other rows from both the
left and right row sets.
|
PlanBuilder.ModifyPlan |
joinFullOuter(PlanBuilder.ModifyPlan right,
PlanJoinKey... keys)
This method yields one output row set with the
rows from an inner join as well as the other rows from both the
left and right row sets.
|
PlanBuilder.ModifyPlan |
joinFullOuter(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys)
This method yields one output row set with the
rows from an inner join as well as the other rows from both the
left and right row sets.
|
PlanBuilder.ModifyPlan |
joinFullOuter(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
boolean condition)
This method yields one output row set with the
rows from an inner join as well as the other rows from both the
left and right row sets.
|
PlanBuilder.ModifyPlan |
joinFullOuter(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
ServerExpression condition)
This method yields one output row set with the
rows from an inner join as well as the other rows from both the
left and right row sets.
|
PlanBuilder.ModifyPlan |
joinInner(PlanBuilder.ModifyPlan right)
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
joinInner(PlanBuilder.ModifyPlan right,
PlanJoinKey... keys)
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
joinInner(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys)
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
joinInner(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
boolean condition)
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
joinInner(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
ServerExpression condition)
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
joinLeftOuter(PlanBuilder.ModifyPlan right)
This method yields one output row set with the
rows from an inner join as well as the other rows from the left row
set.
|
PlanBuilder.ModifyPlan |
joinLeftOuter(PlanBuilder.ModifyPlan right,
PlanJoinKey... keys)
This method yields one output row set with the
rows from an inner join as well as the other rows from the left row
set.
|
PlanBuilder.ModifyPlan |
joinLeftOuter(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys)
This method yields one output row set with the
rows from an inner join as well as the other rows from the left row
set.
|
PlanBuilder.ModifyPlan |
joinLeftOuter(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
boolean condition)
This method yields one output row set with the
rows from an inner join as well as the other rows from the left row
set.
|
PlanBuilder.ModifyPlan |
joinLeftOuter(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
ServerExpression condition)
This method yields one output row set with the
rows from an inner join as well as the other rows from the left row
set.
|
PlanBuilder.ModifyPlan |
notExistsJoin(PlanBuilder.ModifyPlan right)
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
|
PlanBuilder.ModifyPlan |
notExistsJoin(PlanBuilder.ModifyPlan right,
PlanJoinKey... keys)
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
|
PlanBuilder.ModifyPlan |
notExistsJoin(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys)
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
|
PlanBuilder.ModifyPlan |
notExistsJoin(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
boolean condition)
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
|
PlanBuilder.ModifyPlan |
notExistsJoin(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
ServerExpression condition)
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
|
PlanBuilder.ModifyPlan |
onError(java.lang.String action)
Add an error-handler to the Optic Pipeline to
catch Optic Update runtime errors.
|
PlanBuilder.ModifyPlan |
onError(java.lang.String action,
java.lang.String errorColumn)
Add an error-handler to the Optic Pipeline to
catch Optic Update runtime errors.
|
PlanBuilder.ModifyPlan |
onError(XsStringVal action)
Add an error-handler to the Optic Pipeline to
catch Optic Update runtime errors.
|
PlanBuilder.ModifyPlan |
onError(XsStringVal action,
PlanExprCol errorColumn)
Add an error-handler to the Optic Pipeline to
catch Optic Update runtime errors.
|
PlanBuilder.ModifyPlan |
orderBy(PlanSortKeySeq keys)
This method sorts the row set by the specified
order definition.
|
PlanBuilder.ModifyPlan |
patch(PlanExprCol docColumn,
PatchBuilder patchDef)
Builds a patch operation including a sequence of
inserts, replaces, replace-inserts and deletes.
|
PlanBuilder.ModifyPlan |
patch(java.lang.String docColumn,
PatchBuilder patchDef)
Builds a patch operation including a sequence of
inserts, replaces, replace-inserts and deletes.
|
PlanBuilder.PreparePlan |
prepare(int optimize)
This method prepares the specified plan for
execution as an optional final step before execution.
|
PlanBuilder.PreparePlan |
prepare(XsIntVal optimize)
This method prepares the specified plan for
execution as an optional final step before execution.
|
PlanBuilder.ModifyPlan |
select(PlanExprCol... columns)
This call projects the specified columns from
the current row set and / or applies a qualifier to the columns in
the row set.
|
PlanBuilder.ModifyPlan |
select(PlanExprColSeq columns)
This call projects the specified columns from
the current row set and / or applies a qualifier to the columns in
the row set.
|
PlanBuilder.ModifyPlan |
select(PlanExprColSeq columns,
java.lang.String qualifierName)
This call projects the specified columns from
the current row set and / or applies a qualifier to the columns in
the row set.
|
PlanBuilder.ModifyPlan |
select(PlanExprColSeq columns,
XsStringVal qualifierName)
This call projects the specified columns from
the current row set and / or applies a qualifier to the columns in
the row set.
|
PlanBuilder.ModifyPlan |
union(PlanBuilder.ModifyPlan right)
This method yields all of the rows from the
input row sets.
|
PlanBuilder.ModifyPlan |
unnestInner(PlanExprCol inputColumn,
PlanExprCol valueColumn)
This function flattens an array value into
multiple rows.Then performs a op:join-inner on the rest of the
rows.
|
PlanBuilder.ModifyPlan |
unnestInner(PlanExprCol inputColumn,
PlanExprCol valueColumn,
PlanExprCol ordinalColumn)
This function flattens an array value into
multiple rows.Then performs a op:join-inner on the rest of the
rows.
|
PlanBuilder.ModifyPlan |
unnestInner(java.lang.String inputColumn,
java.lang.String valueColumn)
This function flattens an array value into
multiple rows.Then performs a op:join-inner on the rest of the
rows.
|
PlanBuilder.ModifyPlan |
unnestInner(java.lang.String inputColumn,
java.lang.String valueColumn,
java.lang.String ordinalColumn)
This function flattens an array value into
multiple rows.Then performs a op:join-inner on the rest of the
rows.
|
PlanBuilder.ModifyPlan |
unnestLeftOuter(PlanExprCol inputColumn,
PlanExprCol valueColumn)
This function flattens an array value into
multiple rows.Then performs a op:join-left-outer on the rest of the
rows.
|
PlanBuilder.ModifyPlan |
unnestLeftOuter(PlanExprCol inputColumn,
PlanExprCol valueColumn,
PlanExprCol ordinalColumn)
This function flattens an array value into
multiple rows.Then performs a op:join-left-outer on the rest of the
rows.
|
PlanBuilder.ModifyPlan |
unnestLeftOuter(java.lang.String inputColumn,
java.lang.String valueColumn)
This function flattens an array value into
multiple rows.Then performs a op:join-left-outer on the rest of the
rows.
|
PlanBuilder.ModifyPlan |
unnestLeftOuter(java.lang.String inputColumn,
java.lang.String valueColumn,
java.lang.String ordinalColumn)
This function flattens an array value into
multiple rows.Then performs a op:join-left-outer on the rest of the
rows.
|
PlanBuilder.ModifyPlan |
validateDoc(PlanColumn validateDocCol,
PlanSchemaDef schemaDef)
Validate the document based on a supplied
schema.
|
PlanBuilder.ModifyPlan |
validateDoc(java.lang.String validateDocCol,
PlanSchemaDef schemaDef)
Validate the document based on a supplied
schema.
|
PlanBuilder.ModifyPlan |
whereDistinct()
This method removes duplicate rows from the row
set.
|
PlanBuilder.ModifyPlan |
write()
Inserts or overwrites the documents identified
by the uri column with the data supplied by the other document
descriptor columns.
|
PlanBuilder.ModifyPlan |
write(PlanDocColsIdentifier docCols)
Inserts or overwrites the documents identified
by the uri column with the data supplied by the other document
descriptor columns.
|
map,
reduce,
reduce,
reducebindParambindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParam,
bindParamexport,
exportAsfacetBy,
facetBy,
facetBy,
groupByUnion,
groupByUnion,
groupToArrays,
groupToArrays,
limit,
limit,
limit,
lockForUpdate,
lockForUpdate,
offset,
offset,
offset,
offsetLimit,
offsetLimit,
remove,
remove,
remove,
transformDoc,
where,
where,
where,
wherePlanBuilder.ModifyPlan bind(PlanExprColSeq columns)
columns - The op:as calls that specify the column
name and the expression that constructs the column values. See
PlanBuilder.colSeq(PlanExprCol...)PlanBuilder.ModifyPlan bindAs(java.lang.String column, ServerExpression expression)
column - The name of the column to be defined. See
PlanBuilder.col(XsStringVal)expression - The expression that specifies the
value the column in the row. (of item)PlanBuilder.ModifyPlan bindAs(PlanColumn column, ServerExpression expression)
column - The name of the column to be defined. See
PlanBuilder.col(XsStringVal)expression - The expression that specifies the
value the column in the row. (of item)PlanBuilder.ModifyPlan except(PlanBuilder.ModifyPlan right)
right - The row set from the right view.PlanBuilder.ModifyPlan existsJoin(PlanBuilder.ModifyPlan right)
right - The row set from the right view.PlanBuilder.ModifyPlan existsJoin(PlanBuilder.ModifyPlan right, PlanJoinKey... keys)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)PlanBuilder.ModifyPlan existsJoin(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)PlanBuilder.ModifyPlan existsJoin(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, boolean condition)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)condition - A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan existsJoin(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, ServerExpression condition)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)condition - A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan groupBy(PlanExprColSeq keys)
keys - This parameter specifies the columns used
to determine the groups. Rows with the same values in these columns
are consolidated into a single group. The columns can be existing
columns or new columns created by an expression specified with
op:as. The rows produced by the group by operation include the key
columns. Specify an empty sequence to create a single group for all
of the rows in the row set. See
PlanBuilder.colSeq(PlanExprCol...)PlanBuilder.ModifyPlan groupBy(PlanExprColSeq keys, PlanAggregateColSeq aggregates)
keys - This parameter specifies the columns used
to determine the groups. Rows with the same values in these columns
are consolidated into a single group. The columns can be existing
columns or new columns created by an expression specified with
op:as. The rows produced by the group by operation include the key
columns. Specify an empty sequence to create a single group for all
of the rows in the row set. See
PlanBuilder.colSeq(PlanExprCol...)aggregates - This parameter specifies either new
columns for aggregate functions over the rows in the group or
columndefs that are constant for the group. The aggregate library
functions are listed below. See
PlanBuilder.aggregateSeq(PlanAggregateCol...)PlanBuilder.ModifyPlan intersect(PlanBuilder.ModifyPlan right)
right - The row set from the right view.PlanBuilder.ModifyPlan joinCrossProduct(PlanBuilder.ModifyPlan right)
right - The row set from the right view.PlanBuilder.ModifyPlan joinCrossProduct(PlanBuilder.ModifyPlan right, boolean condition)
right - The row set from the right view.condition - A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan joinCrossProduct(PlanBuilder.ModifyPlan right, ServerExpression condition)
right - The row set from the right view.condition - A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan joinDoc(java.lang.String docCol, java.lang.String sourceCol)
docCol - The document column to add to the rows.
This can be a string or column specifying the name of the new
column that should have the document as its value. See
PlanBuilder.col(XsStringVal)sourceCol - The document uri or fragment id value.
This is either the output from op:fragment-id-col specifying a
fragment id column or a document uri column. Joining on a fragment
id is more efficient than joining on a uri column. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan joinDoc(PlanColumn docCol, PlanColumn sourceCol)
docCol - The document column to add to the rows.
This can be a string or column specifying the name of the new
column that should have the document as its value. See
PlanBuilder.col(XsStringVal)sourceCol - The document uri or fragment id value.
This is either the output from op:fragment-id-col specifying a
fragment id column or a document uri column. Joining on a fragment
id is more efficient than joining on a uri column. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan joinDocAndUri(java.lang.String docCol, java.lang.String uriCol, java.lang.String sourceCol)
docCol - The document column to add to the rows.
This can be a string or a column, op:col, op:view-col or
op:schema-col, specifying the name of the new column that should
have the document as its value. See
PlanBuilder.col(XsStringVal)uriCol - The uri column to add to the rows. This
can be a string or a column, op:col, op:view-col or op:schema-col,
specifying the name of the new column that should have the document
uri as its value. See
PlanBuilder.col(XsStringVal)sourceCol - The document uri or fragment id value.
This is either an op:fragment-id-col specifying a fragment id
column or a document uri column as xs:string or as a column using
op:col, op:view-col or op:schema-col. Joining on a fragment id is
more efficient than joining on a uri column. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan joinDocAndUri(PlanColumn docCol, PlanColumn uriCol, PlanColumn sourceCol)
docCol - The document column to add to the rows.
This can be a string or a column, op:col, op:view-col or
op:schema-col, specifying the name of the new column that should
have the document as its value. See
PlanBuilder.col(XsStringVal)uriCol - The uri column to add to the rows. This
can be a string or a column, op:col, op:view-col or op:schema-col,
specifying the name of the new column that should have the document
uri as its value. See
PlanBuilder.col(XsStringVal)sourceCol - The document uri or fragment id value.
This is either an op:fragment-id-col specifying a fragment id
column or a document uri column as xs:string or as a column using
op:col, op:view-col or op:schema-col. Joining on a fragment id is
more efficient than joining on a uri column. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan joinDocUri(java.lang.String uriCol, java.lang.String fragmentIdCol)
uriCol - The document uri. This is the output from
op:col('uri') that specifies a document uri column. See
PlanBuilder.col(XsStringVal)fragmentIdCol - The document fragment id value.
This is the output from op:fragment-id-col specifying a fragment id
column. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan joinDocUri(PlanColumn uriCol, PlanColumn fragmentIdCol)
uriCol - The document uri. This is the output from
op:col('uri') that specifies a document uri column. See
PlanBuilder.col(XsStringVal)fragmentIdCol - The document fragment id value.
This is the output from op:fragment-id-col specifying a fragment id
column. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan joinInner(PlanBuilder.ModifyPlan right)
right - The row set from the right view.PlanBuilder.ModifyPlan joinInner(PlanBuilder.ModifyPlan right, PlanJoinKey... keys)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)PlanBuilder.ModifyPlan joinInner(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)PlanBuilder.ModifyPlan joinInner(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, boolean condition)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)condition - A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan joinInner(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, ServerExpression condition)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)condition - A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan joinLeftOuter(PlanBuilder.ModifyPlan right)
right - The row set from the right view.PlanBuilder.ModifyPlan joinLeftOuter(PlanBuilder.ModifyPlan right, PlanJoinKey... keys)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)PlanBuilder.ModifyPlan joinLeftOuter(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)PlanBuilder.ModifyPlan joinLeftOuter(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, boolean condition)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)condition - A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan joinLeftOuter(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, ServerExpression condition)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)condition - A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan joinFullOuter(PlanBuilder.ModifyPlan right)
right - The row set from the right view.PlanBuilder.ModifyPlan joinFullOuter(PlanBuilder.ModifyPlan right, PlanJoinKey... keys)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)PlanBuilder.ModifyPlan joinFullOuter(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)PlanBuilder.ModifyPlan joinFullOuter(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, boolean condition)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)condition - A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan joinFullOuter(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, ServerExpression condition)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)condition - A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan notExistsJoin(PlanBuilder.ModifyPlan right)
right - The row set from the right view.PlanBuilder.ModifyPlan notExistsJoin(PlanBuilder.ModifyPlan right, PlanJoinKey... keys)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)PlanBuilder.ModifyPlan notExistsJoin(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)PlanBuilder.ModifyPlan notExistsJoin(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, boolean condition)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)condition - A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan notExistsJoin(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, ServerExpression condition)
right - The row set from the right view.keys - The equijoin from one or more calls to the
op:on function. See
PlanBuilder.joinKeySeq(PlanJoinKey...)condition - A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan orderBy(PlanSortKeySeq keys)
keys - The specified column or sortdef output from
the op:asc or op:desc function. See
PlanBuilder.sortKeySeq(PlanSortKey...)PlanBuilder.ModifyPlan onError(java.lang.String action)
action - Valid options are: "fail" - stop
processing and "continue" - add an error to the error column and
continue processing.PlanBuilder.ModifyPlan onError(XsStringVal action)
action - Valid options are: "fail" - stop
processing and "continue" - add an error to the error column and
continue processing.PlanBuilder.ModifyPlan onError(java.lang.String action, java.lang.String errorColumn)
action - Valid options are: "fail" - stop
processing and "continue" - add an error to the error column and
continue processing.errorColumn - An optional error column which is
not used in the plan. If this parameter is not passed in
'sys.errors' is used. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan onError(XsStringVal action, PlanExprCol errorColumn)
action - Valid options are: "fail" - stop
processing and "continue" - add an error to the error column and
continue processing.errorColumn - An optional error column which is
not used in the plan. If this parameter is not passed in
'sys.errors' is used. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan patch(java.lang.String docColumn, PatchBuilder patchDef)
docColumn - The document column which need to be
patched. See
PlanBuilder.col(XsStringVal)patchDef - The patch definition as
op:patch-builderPlanBuilder.ModifyPlan patch(PlanExprCol docColumn, PatchBuilder patchDef)
docColumn - The document column which need to be
patched. See
PlanBuilder.col(XsStringVal)patchDef - The patch definition as
op:patch-builderPlanBuilder.PreparePlan prepare(int optimize)
optimize - The optimization level, which can be 0,
1, or 2 (1 is mostly used).PlanBuilder.PreparePlan prepare(XsIntVal optimize)
optimize - The optimization level, which can be 0,
1, or 2 (1 is mostly used).PlanBuilder.ModifyPlan select(PlanExprCol... columns)
columns - The columns to project from the input
rows. The columns can be named with a string or a column parameter
function such as op:col or constructed from an expression with
op:as. See
PlanBuilder.colSeq(PlanExprCol...)PlanBuilder.ModifyPlan select(PlanExprColSeq columns)
columns - The columns to project from the input
rows. The columns can be named with a string or a column parameter
function such as op:col or constructed from an expression with
op:as. See
PlanBuilder.colSeq(PlanExprCol...)PlanBuilder.ModifyPlan select(PlanExprColSeq columns, java.lang.String qualifierName)
columns - The columns to project from the input
rows. The columns can be named with a string or a column parameter
function such as op:col or constructed from an expression with
op:as. See
PlanBuilder.colSeq(PlanExprCol...)qualifierName - 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.PlanBuilder.ModifyPlan select(PlanExprColSeq columns, XsStringVal qualifierName)
columns - The columns to project from the input
rows. The columns can be named with a string or a column parameter
function such as op:col or constructed from an expression with
op:as. See
PlanBuilder.colSeq(PlanExprCol...)qualifierName - 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.PlanBuilder.ModifyPlan union(PlanBuilder.ModifyPlan right)
right - The row set from the right view.PlanBuilder.ModifyPlan whereDistinct()
PlanBuilder.ModifyPlan write()
PlanBuilder.ModifyPlan write(PlanDocColsIdentifier docCols)
docCols - the docCols value.PlanBuilder.ModifyPlan joinDocCols(PlanDocColsIdentifier cols, java.lang.String docIdCol)
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.docIdCol - the docIdCol value. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan joinDocCols(PlanDocColsIdentifier cols, PlanColumn docIdCol)
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.docIdCol - the docIdCol value. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan validateDoc(java.lang.String validateDocCol, PlanSchemaDef schemaDef)
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). See
PlanBuilder.col(XsStringVal)schemaDef - the schemaDef value.PlanBuilder.ModifyPlan validateDoc(PlanColumn validateDocCol, PlanSchemaDef schemaDef)
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). See
PlanBuilder.col(XsStringVal)schemaDef - the schemaDef value.PlanBuilder.ModifyPlan unnestInner(java.lang.String inputColumn, java.lang.String valueColumn)
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.
See
PlanBuilder.col(XsStringVal)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. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan unnestInner(PlanExprCol inputColumn, PlanExprCol valueColumn)
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.
See
PlanBuilder.col(XsStringVal)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. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan unnestInner(java.lang.String inputColumn, java.lang.String valueColumn, java.lang.String ordinalColumn)
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.
See
PlanBuilder.col(XsStringVal)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. See
PlanBuilder.col(XsStringVal)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. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan unnestInner(PlanExprCol inputColumn, PlanExprCol valueColumn, PlanExprCol ordinalColumn)
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.
See
PlanBuilder.col(XsStringVal)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. See
PlanBuilder.col(XsStringVal)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. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan unnestLeftOuter(java.lang.String inputColumn, java.lang.String valueColumn)
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.
See
PlanBuilder.col(XsStringVal)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. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan unnestLeftOuter(PlanExprCol inputColumn, PlanExprCol valueColumn)
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.
See
PlanBuilder.col(XsStringVal)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. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan unnestLeftOuter(java.lang.String inputColumn, java.lang.String valueColumn, java.lang.String ordinalColumn)
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.
See
PlanBuilder.col(XsStringVal)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. See
PlanBuilder.col(XsStringVal)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. See
PlanBuilder.col(XsStringVal)PlanBuilder.ModifyPlan unnestLeftOuter(PlanExprCol inputColumn, PlanExprCol valueColumn, PlanExprCol ordinalColumn)
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.
See
PlanBuilder.col(XsStringVal)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. See
PlanBuilder.col(XsStringVal)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. See
PlanBuilder.col(XsStringVal)Copyright © 2024 MarkLogic Corporation. All Rights Reserved.