Package | Description |
---|---|
com.marklogic.client.expression |
The package provides classes for building Optic
plan pipelines and expressions for execution on the REST
server.
|
com.marklogic.client.type |
The package provides interfaces specifying the
type of an expression or value as passed to a
PlanBuilder
method or returned from a RowRecord
method. |
Modifier and Type | Method | Description |
---|---|---|
PlanColumn |
PlanBuilder.AccessPlan.col(XsStringVal column) |
Identifies a column where the column name is
unique and a qualifier on the column name isn't necessary (and
might not exist).
|
PlanColumn |
PlanBuilder.AccessPlan.col(java.lang.String column) |
Identifies a column where the column name is
unique and a qualifier on the column name isn't necessary (and
might not exist).
|
abstract PlanColumn |
PlanBuilder.col(XsStringVal column) |
Identifies a column where the column name is
unique and a qualifier on the column name isn't necessary (and
might not exist).
|
abstract PlanColumn |
PlanBuilder.col(java.lang.String column) |
Identifies a column where the column name is
unique and a qualifier on the column name isn't necessary (and
might not exist).
|
abstract PlanColumn |
PlanBuilder.schemaCol(XsStringVal schema,
XsStringVal view,
XsStringVal column) |
Unambiguously identifies a column with the
schema name, view name, and column name.
|
abstract PlanColumn |
PlanBuilder.schemaCol(java.lang.String schema,
java.lang.String view,
java.lang.String column) |
Unambiguously identifies a column with the
schema name, view name, and column name.
|
abstract PlanColumn |
PlanBuilder.viewCol(XsStringVal view,
XsStringVal column) |
Identifies a column where the combination of
view and column name is unique.
|
abstract PlanColumn |
PlanBuilder.viewCol(java.lang.String view,
java.lang.String column) |
Identifies a column where the combination of
view and column name is unique.
|
Modifier and Type | Method | Description |
---|---|---|
abstract PlanAggregateCol |
PlanBuilder.arrayAggregate(PlanColumn name,
PlanExprCol column) |
This function constructs an array whose items
are the result of evaluating the column for each row in the group
or row set.
|
abstract PlanAggregateCol |
PlanBuilder.arrayAggregate(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This function constructs an array whose items
are the result of evaluating the column for each row in the group
or row set.
|
abstract PlanExprCol |
PlanBuilder.as(PlanColumn column,
ServerExpression expression) |
This function defines a column by assigning the
value of an expression over the rows in the row set.
|
abstract PlanAggregateCol |
PlanBuilder.avg(PlanColumn name,
PlanExprCol column) |
This function averages the non-null values of
the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.avg(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This function averages the non-null values of
the column for the rows in the group or row set.
|
PlanBuilder.ModifyPlan |
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.
|
abstract PlanAggregateCol |
PlanBuilder.count(PlanColumn name) |
This function counts the rows where the
specified input column has a value.
|
abstract PlanAggregateCol |
PlanBuilder.count(PlanColumn name,
PlanExprCol column) |
This function counts the rows where the
specified input column has a value.
|
abstract PlanAggregateCol |
PlanBuilder.count(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This function counts the rows where the
specified input column has a value.
|
PlanAggregateCol |
PlanBuilderBase.groupConcat(PlanColumn name,
PlanExprCol column) |
This function concatenates the non-null values
of the column for the rows in the group or row set.
|
PlanAggregateCol |
PlanBuilderBase.groupConcat(PlanColumn name,
PlanExprCol column,
PlanGroupConcatOptionSeq options) |
This function concatenates the non-null values
of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.groupKey(PlanColumn name,
PlanExprCol column) |
|
abstract PlanAggregateCol |
PlanBuilder.hasGroupKey(PlanColumn name,
PlanExprCol column) |
This aggregate function adds a flag to a grouped
row specifying whether a column acted as a grouping key for the
row.
|
PlanBuilder.ModifyPlan |
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 |
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 |
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 |
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 |
PlanBuilderBase.ModifyPlanBase.lockForUpdate(PlanColumn uriColumn) |
Acquires exclusive locks on the URI in the given
column of each row in the pipeline.
|
PlanExprCol |
RdtExpr.maskDeterministic(PlanColumn column) |
Redacts a column with string values by replacing
each value with deterministic masking text.
|
PlanExprCol |
RdtExpr.maskDeterministic(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with string values by replacing
each value with deterministic masking text.
|
PlanExprCol |
RdtExpr.maskRandom(PlanColumn column) |
Redacts a column with string values by replacing
each value with random masking text.
|
PlanExprCol |
RdtExpr.maskRandom(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with string values by replacing
each value with random masking text.
|
abstract PlanAggregateCol |
PlanBuilder.max(PlanColumn name,
PlanExprCol column) |
This function gets the largest non-null value of
the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.max(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This function gets the largest non-null value of
the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.min(PlanColumn name,
PlanExprCol column) |
This function gets the smallest non-null value
of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.min(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This function gets the smallest non-null value
of the column for the rows in the group or row set.
|
PlanExprCol |
RdtExpr.redactDatetime(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with date or datetime values
either by masking part of the existing value or by generating a
random value.
|
PlanExprCol |
RdtExpr.redactEmail(PlanColumn column) |
Redacts a column with email address string that
conforms to the pattern
name@domain . |
PlanExprCol |
RdtExpr.redactEmail(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with email address string that
conforms to the pattern
name@domain . |
PlanExprCol |
RdtExpr.redactIpv4(PlanColumn column) |
Redacts a column with IPv4 address string that
conforms to a pattern with four blocks of 1-3 decimal digits
separated by period (.) where the value of each block of digits is
less than or equal to 255 as in
123.201.098.112 and
123.45.678.0 . |
PlanExprCol |
RdtExpr.redactIpv4(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with IPv4 address string that
conforms to a pattern with four blocks of 1-3 decimal digits
separated by period (.) where the value of each block of digits is
less than or equal to 255 as in
123.201.098.112 and
123.45.678.0 . |
PlanExprCol |
RdtExpr.redactNumber(PlanColumn column) |
Redacts a column by generating a random number
within a configurable range either as a numeric data type or as a
formatted string.
|
PlanExprCol |
RdtExpr.redactNumber(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column by generating a random number
within a configurable range either as a numeric data type or as a
formatted string.
|
PlanExprCol |
RdtExpr.redactRegex(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a string column by applying a regular
expression.
|
PlanExprCol |
RdtExpr.redactUsPhone(PlanColumn column) |
Redacts a column with a 10-digit US phone number
string by generating random numbers or replacing numbers with a
masking character.
|
PlanExprCol |
RdtExpr.redactUsPhone(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with a 10-digit US phone number
string by generating random numbers or replacing numbers with a
masking character.
|
PlanExprCol |
RdtExpr.redactUsSsn(PlanColumn column) |
Redacts a column with a 9-digit US SSN (Social
Security Number) string by generating random numbers or replacing
numbers with a masking character.
|
PlanExprCol |
RdtExpr.redactUsSsn(PlanColumn column,
java.util.Map<java.lang.String,?> options) |
Redacts a column with a 9-digit US SSN (Social
Security Number) string by generating random numbers or replacing
numbers with a masking character.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.remove(PlanColumn uriColumn) |
Removes (deletes) any document with a URI
matching the value of the given column in at least one row in the
pipeline.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.remove(PlanColumn temporalCollection,
PlanColumn uriColumn) |
Removes (deletes) any temporal document with a
URI matching the value of the given column in at least one row in
the pipeline.
|
abstract PlanAggregateCol |
PlanBuilder.sample(PlanColumn name,
PlanExprCol column) |
This function randomly selects one non-null
value of the column from the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.sequenceAggregate(PlanColumn name,
PlanExprCol column) |
This call constructs a sequence whose items are
the values of a column for each row in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.sequenceAggregate(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This call constructs a sequence whose items are
the values of a column for each row in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.sum(PlanColumn name,
PlanExprCol column) |
This function adds the non-null values of the
column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.sum(PlanColumn name,
PlanExprCol column,
PlanValueOption option) |
This function adds the non-null values of the
column for the rows in the group or row set.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.transformDoc(PlanColumn docColumn,
TransformDef transformDef) |
Applies the given transformation to the content
in the given column in each row.
|
abstract PlanAggregateCol |
PlanBuilder.uda(PlanColumn name,
PlanExprCol column,
XsStringVal module,
XsStringVal function) |
This function processes the values of column for
each row in the group or row set with the specified user-defined
aggregate as implemented by an aggregate user-defined function
(UDF) plugin.
|
abstract PlanAggregateCol |
PlanBuilder.uda(PlanColumn name,
PlanExprCol column,
XsStringVal module,
XsStringVal function,
XsAnyAtomicTypeVal arg) |
This function processes the values of column for
each row in the group or row set with the specified user-defined
aggregate as implemented by an aggregate user-defined function
(UDF) plugin.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.validateDoc(PlanColumn validateDocCol,
PlanSchemaDef schemaDef) |
Validate the document based on a supplied
schema.
|
abstract ServerExpression |
PlanBuilder.xpath(PlanColumn column,
ServerExpression path) |
This function extracts a sequence of child nodes
from a column with node values -- especially, the document nodes
from a document join.
|
abstract ServerExpression |
PlanBuilder.xpath(PlanColumn column,
ServerExpression path,
PlanNamespaceBindingsSeq namespaceBindings) |
This function extracts a sequence of child nodes
from a column with node values -- especially, the document nodes
from a document join.
|
Modifier and Type | Method | Description |
---|---|---|
PlanDocColsIdentifier |
PlanBuilderBase.docCols(java.util.Map<java.lang.String,PlanColumn> descriptorColumnMapping) |
Construct a mapping of document descriptor
column names to columns in the plan.
|
Modifier and Type | Interface | Description |
---|---|---|
interface |
PlanSystemColumn |
An instance of a fragment id, graph id, or other
system column for a row pipeline.
|
Copyright © 2022 MarkLogic Corporation