op functions (ModifyPlan Object)
The following prototype methods convert a row set into a different row set (typically with fewer rows or columns). These prototype methods can be used in conjunction with the Modifier Functions
32 functions
| Function name | Description |
|---|---|
| op:bind | This function adds new columns or modifies existing columns based on expressions while preserving existing unmodified columns in the row set. |
| op:bind-as | This function is deprecated in favor of the bind() function and will not be supported in MarkLogic 11. |
| op:except | 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. |
| op:exists-join | This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. |
| op:facet-by | This method counts values for multiple grouping key columns. |
| op:group-by | This method collapses a group of rows into a single row. |
| op:group-by-union | This method performs the union of multiple group-by operations on a row set. |
| op:group-to-arrays | This method performs multiple group-by operations on a row set and produces a single row with a column for each group having an array value whose items are the rows for the group. |
| op:intersect | This method restricts the left row set to rows where a row with the same columns and values exists in the right row set. |
| op:join-cross-product | This method yields one output row set that concatenates every left row with every right row. |
| op:join-doc | 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). |
| op:join-doc-and-uri | 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). |
| op:join-doc-cols | This function populates the view with the uri, doc, collections, metadata, permissions, and / or quality document descriptor columns for database document values. |
| op:join-doc-uri | This method adds a uri column to rows based on an existing fragment id column to identify the source document for each row. |
| op:join-full-outer | 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. |
| op:join-inner | This method returns all rows from multiple tables where the join condition is met. |
| op:join-left-outer | 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. |
| op:limit | This method specifies the maximum number of rows to be returned by this Plan. |
| op:not-exists-join | This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. |
| op:offset | This method returns a subset of the rows in the result set. |
| op:offset-limit | This method returns a subset of the rows in the result set by skipping the number of rows specified by start and returning the remaining rows up to the length limit. |
| op:on-error | Add an error-handler to the Optic Pipeline to catch Optic Update runtime errors. |
| op:order-by | This method sorts the row set by the specified order definition. |
| op:prepare | This method prepares the specified plan for execution as an optional final step before execution. |
| op:select | This call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set. |
| op:transform-doc | This function applies a transformation to a column that contains documents. |
| op:union | This method yields all of the rows from the input row sets. |
| op:unnest-inner | This function flattens an array value into multiple rows.Then performs a op:join-inner on the rest of the rows. |
| op:unnest-left-outer | This function flattens an array value into multiple rows.Then performs a op:join-left-outer on the rest of the rows. |
| op:validate-doc | Validate the document based on a supplied schema. |
| op:where | This method restricts the row set to rows matched by the boolean expression. |
| op:where-distinct | This method removes duplicate rows from the row set. |