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 |
---|---|---|
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 PlanAggregateCol |
PlanBuilder.arrayAggregate(java.lang.String name,
java.lang.String 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(java.lang.String name,
java.lang.String 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 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.
|
abstract PlanAggregateCol |
PlanBuilder.avg(java.lang.String name,
java.lang.String column) |
This function averages the non-null values of
the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.avg(java.lang.String name,
java.lang.String column, PlanValueOption option) |
This function averages the non-null values of
the column for the rows in the group or row set.
|
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.
|
abstract PlanAggregateCol |
PlanBuilder.count(java.lang.String name) |
This function counts the rows where the
specified input column has a value.
|
abstract PlanAggregateCol |
PlanBuilder.count(java.lang.String name,
java.lang.String column) |
This function counts the rows where the
specified input column has a value.
|
abstract PlanAggregateCol |
PlanBuilder.count(java.lang.String name,
java.lang.String 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.
|
PlanAggregateCol |
PlanBuilderBase.groupConcat(java.lang.String name,
java.lang.String column) |
This function concatenates the non-null values
of the column for the rows in the group or row set.
|
PlanAggregateCol |
PlanBuilderBase.groupConcat(java.lang.String name,
java.lang.String 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.groupKey(java.lang.String name,
java.lang.String 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.
|
abstract PlanAggregateCol |
PlanBuilder.hasGroupKey(java.lang.String name,
java.lang.String column) |
This aggregate function adds a flag to a grouped
row specifying whether a column acted as a grouping key for the
row.
|
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.max(java.lang.String name,
java.lang.String 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(java.lang.String name,
java.lang.String 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.
|
abstract PlanAggregateCol |
PlanBuilder.min(java.lang.String name,
java.lang.String 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(java.lang.String name,
java.lang.String column, PlanValueOption option) |
This function gets the smallest non-null value
of the column for the rows in the group or row set.
|
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.sample(java.lang.String name,
java.lang.String 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.sequenceAggregate(java.lang.String name,
java.lang.String 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(java.lang.String name,
java.lang.String 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.
|
abstract PlanAggregateCol |
PlanBuilder.sum(java.lang.String name,
java.lang.String column) |
This function adds the non-null values of the
column for the rows in the group or row set.
|
abstract PlanAggregateCol |
PlanBuilder.sum(java.lang.String name,
java.lang.String column, PlanValueOption option) |
This function adds the non-null values of the
column for the rows in the group or row set.
|
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.
|
abstract PlanAggregateCol |
PlanBuilder.uda(java.lang.String name,
java.lang.String column, java.lang.String module,
java.lang.String 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(java.lang.String name,
java.lang.String column, java.lang.String module,
java.lang.String function,
java.lang.String 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.
|
Modifier and Type | Method | Description |
---|---|---|
abstract PlanAggregateColSeq |
PlanBuilder.aggregateSeq(PlanAggregateCol... aggregate) |
Constructs a sequence from multiple aggregate
values to pass as a parameter to an operation.
|
Modifier and Type | Interface | Description |
---|---|---|
interface |
PlanColumn |
An instance of a column expression returned by a
col() call in a row pipeline.
|
interface |
PlanExprCol |
An instance of a column expression returned by
an as() or col() call in a row pipeline.
|
interface |
PlanSystemColumn |
An instance of a fragment id, graph id, or other
system column for a row pipeline.
|
Copyright © 2022 MarkLogic Corporation