| 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 PlanExprColSeq |
PlanBuilder.colSeq(PlanExprCol... col) |
Constructs a sequence from multiple col values to pass as a parameter to an operation.
|
abstract PlanExprColSeq |
PlanBuilder.colSeq(java.lang.String... col) |
Constructs a sequence from multiple col values to pass as a parameter to an operation.
|
| Modifier and Type | Method | Description |
|---|---|---|
PlanBuilder.ModifyPlan |
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.
|
abstract PlanGroupSeq |
PlanBuilder.cube(PlanExprColSeq keys) |
This function specifies a list of grouping keys for a group and returns that group and every possible larger group (including all rows) formed from any subset of keys.
|
PlanBuilder.AccessPlan |
PlanBuilderBase.fromSearch(CtsQueryExpr query,
PlanExprColSeq columns,
XsStringVal qualifierName,
PlanSearchOptions options) |
Supports document matching and relevance by constructing rows with the document fragment id and
columns for relevance factors.
|
PlanBuilder.AccessPlan |
PlanBuilderBase.fromSearch(CtsQueryExpr query,
PlanExprColSeq columns,
java.lang.String qualifierName) |
Supports document matching and relevance by constructing rows with the document fragment id and
columns for relevance factors.
|
abstract PlanGroup |
PlanBuilder.group(PlanExprColSeq keys) |
This function specifies the grouping keys for a group as a list of zero or more columns.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.groupBy(PlanExprColSeq keys) |
This method collapses a group of rows into a single row.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.groupBy(PlanExprColSeq keys,
PlanAggregateColSeq aggregates) |
This method collapses a group of rows into a single row.
|
abstract PlanNamedGroup |
PlanBuilder.namedGroup(XsStringVal name,
PlanExprColSeq keys) |
This function specifies the grouping keys for a group as a named list of zero or more columns.
|
PlanNamedGroup |
PlanBuilderBase.namedGroup(java.lang.String name,
PlanExprColSeq keys) |
Specifies the name and keys for a named group when grouping a row set in multiple ways
with
PlanBuilderBase.ModifyPlanBase.groupToArrays(PlanNamedGroupSeq, PlanAggregateColSeq). |
abstract PlanGroupSeq |
PlanBuilder.rollup(PlanExprColSeq keys) |
This function specifies a list of grouping keys for a group and returns that group and larger groups (including all rows) formed by dropping columns from right to left.
|
PlanBuilder.ModifyPlan |
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 |
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 |
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.
|
| Modifier and Type | Interface | Description |
|---|---|---|
interface |
PlanColumn |
An instance of a column expression returned by a col() call
in a row pipeline.
|
interface |
PlanColumnSeq |
A sequence of column expressions returned by col() calls
for 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.
|
interface |
PlanSystemColumnSeq |
A sequence of fragment id, graph id, or other system columns
for a row pipeline.
|
Copyright © 2013-2021 MarkLogic Corporation.