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 and Description |
---|---|
abstract PlanColumn |
PlanBuilder.col(java.lang.String column)
This method identifies a column, where the column name is unique.
|
PlanColumn |
PlanBuilder.AccessPlan.col(java.lang.String column)
This method identifies a column, where the column name is unique.
|
abstract PlanColumn |
PlanBuilder.col(XsStringVal column)
This method identifies a column, where the column name is unique.
|
PlanColumn |
PlanBuilder.AccessPlan.col(XsStringVal column)
This method identifies a column, where the column name is unique.
|
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.schemaCol(XsStringVal schema,
XsStringVal view,
XsStringVal column)
Unambiguously identifies a column with the schema name, view name, and column name.
|
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.
|
abstract PlanColumn |
PlanBuilder.viewCol(XsStringVal view,
XsStringVal column)
Identifies a column where the combination of view and column name is unique.
|
Modifier and Type | Method and 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.
|
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.
|
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.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.
|
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.
|
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.
|
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 NodeSeqExpr |
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.
|
Modifier and Type | Interface and Description |
---|---|
interface |
PlanSystemColumn
An instance of a fragment id, graph id, or other system column
for a row pipeline.
|
Copyright © 2013-2018 MarkLogic Corporation.