PlanBuilder.ExportablePlan
,
PlanBuilder.Plan
,
PlanBuilder.PreparePlan
,
PlanBuilderBase.ExportablePlanBase
,
PlanBuilderBase.ModifyPlanBase
,
PlanBuilderBase.PlanBase
,
PlanBuilderBase.PreparePlanBase
PlanBuilder.AccessPlan
public static interface PlanBuilder.ModifyPlan extends PlanBuilder.PreparePlan, PlanBuilderBase.ModifyPlanBase
Modifier and Type | Method | Description |
---|---|---|
PlanBuilder.ModifyPlan |
except(PlanBuilder.ModifyPlan right) |
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.
|
PlanBuilder.ModifyPlan |
groupBy(PlanExprColSeq keys) |
This method collapses a group of rows into a
single row.
|
PlanBuilder.ModifyPlan |
groupBy(PlanExprColSeq keys,
PlanAggregateColSeq aggregates) |
This method collapses a group of rows into a
single row.
|
PlanBuilder.ModifyPlan |
intersect(PlanBuilder.ModifyPlan right) |
This method restricts the left row set to rows
where a row with the same columns and values exists in the right
row set.
|
PlanBuilder.ModifyPlan |
joinCrossProduct(PlanBuilder.ModifyPlan right) |
This method yields one output row set that
concatenates every left row with every right row.
|
PlanBuilder.ModifyPlan |
joinCrossProduct(PlanBuilder.ModifyPlan right,
boolean condition) |
This method yields one output row set that
concatenates every left row with every right row.
|
PlanBuilder.ModifyPlan |
joinCrossProduct(PlanBuilder.ModifyPlan right,
ServerExpression condition) |
This method yields one output row set that
concatenates every left row with every right row.
|
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 |
joinDoc(java.lang.String docCol,
java.lang.String 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 |
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 |
joinDocUri(java.lang.String uriCol,
java.lang.String 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 |
joinInner(PlanBuilder.ModifyPlan right) |
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
joinInner(PlanBuilder.ModifyPlan right,
PlanJoinKey... keys) |
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
joinInner(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys) |
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
joinInner(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
boolean condition) |
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
joinInner(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
ServerExpression condition) |
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
joinLeftOuter(PlanBuilder.ModifyPlan right) |
This method yields one output row set with the
rows from an inner join as well as rows from the left row
set.
|
PlanBuilder.ModifyPlan |
joinLeftOuter(PlanBuilder.ModifyPlan right,
PlanJoinKey... keys) |
This method yields one output row set with the
rows from an inner join as well as rows from the left row
set.
|
PlanBuilder.ModifyPlan |
joinLeftOuter(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys) |
This method yields one output row set with the
rows from an inner join as well as rows from the left row
set.
|
PlanBuilder.ModifyPlan |
joinLeftOuter(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
boolean condition) |
This method yields one output row set with the
rows from an inner join as well as rows from the left row
set.
|
PlanBuilder.ModifyPlan |
joinLeftOuter(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
ServerExpression condition) |
This method yields one output row set with the
rows from an inner join as well as rows from the left row
set.
|
PlanBuilder.ModifyPlan |
orderBy(PlanSortKeySeq keys) |
This method sorts the row set by the specified
order definition.
|
PlanBuilder.PreparePlan |
prepare(int optimize) |
This method prepares the specified plan for
execution as an optional final step before execution.
|
PlanBuilder.PreparePlan |
prepare(XsIntVal optimize) |
This method prepares the specified plan for
execution as an optional final step before execution.
|
PlanBuilder.ModifyPlan |
select(PlanExprCol... 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 |
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 |
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 |
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.
|
PlanBuilder.ModifyPlan |
union(PlanBuilder.ModifyPlan right) |
This method yields all of the rows from the
input row sets.
|
PlanBuilder.ModifyPlan |
whereDistinct() |
This method removes duplicate rows from the row
set.
|
bindParam
map,
reduce,
reduce,
reduce
export,
exportAs
limit,
limit,
limit,
offset,
offset,
offset,
offsetLimit,
offsetLimit,
where,
where,
where,
where
PlanBuilder.ModifyPlan except(PlanBuilder.ModifyPlan right)
right
- The row set from the right view.PlanBuilder.ModifyPlan groupBy(PlanExprColSeq keys)
keys
- This parameter specifies the columns used
to determine the groups. Rows with the same values in these columns
are consolidated into a single group. The columns can be existing
columns or new columns created by an expression specified with
op:as. The rows produced by the group by operation include the key
columns. Specify an empty sequence to create a single group for all
of the rows in the row set.PlanBuilder.ModifyPlan groupBy(PlanExprColSeq keys, PlanAggregateColSeq aggregates)
keys
- This parameter specifies the columns used
to determine the groups. Rows with the same values in these columns
are consolidated into a single group. The columns can be existing
columns or new columns created by an expression specified with
op:as. The rows produced by the group by operation include the key
columns. Specify an empty sequence to create a single group for all
of the rows in the row set.aggregates
- This parameter specifies either new
columns for aggregate functions over the rows in the group or
columndefs that are constant for the group. The aggregate library
functions are listed below.PlanBuilder.ModifyPlan intersect(PlanBuilder.ModifyPlan right)
right
- The row set from the right view.PlanBuilder.ModifyPlan joinCrossProduct(PlanBuilder.ModifyPlan right)
right
- The row set from the right view.PlanBuilder.ModifyPlan joinCrossProduct(PlanBuilder.ModifyPlan right, boolean condition)
right
- The row set from the right view.condition
- A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan joinCrossProduct(PlanBuilder.ModifyPlan right, ServerExpression condition)
right
- The row set from the right view.condition
- A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan joinDoc(java.lang.String docCol, java.lang.String sourceCol)
docCol
- The document column to add to the rows.
This can be a string or column specifying the name of the new
column that should have the document as its value.sourceCol
- The document uri or fragment id value.
This is either the output from op:fragment-id-col specifying a
fragment id column or a document uri column. Joining on a fragment
id is more efficient than joining on a uri column.PlanBuilder.ModifyPlan joinDoc(PlanColumn docCol, PlanColumn sourceCol)
docCol
- The document column to add to the rows.
This can be a string or column specifying the name of the new
column that should have the document as its value.sourceCol
- The document uri or fragment id value.
This is either the output from op:fragment-id-col specifying a
fragment id column or a document uri column. Joining on a fragment
id is more efficient than joining on a uri column.PlanBuilder.ModifyPlan joinDocUri(java.lang.String uriCol, java.lang.String fragmentIdCol)
uriCol
- The document uri. This is the output from
op:col('uri') that specifies a document uri column.fragmentIdCol
- The document fragment id value.
This is the output from op:fragment-id-col specifying a fragment id
column.PlanBuilder.ModifyPlan joinDocUri(PlanColumn uriCol, PlanColumn fragmentIdCol)
uriCol
- The document uri. This is the output from
op:col('uri') that specifies a document uri column.fragmentIdCol
- The document fragment id value.
This is the output from op:fragment-id-col specifying a fragment id
column.PlanBuilder.ModifyPlan joinInner(PlanBuilder.ModifyPlan right)
right
- The row set from the right view.PlanBuilder.ModifyPlan joinInner(PlanBuilder.ModifyPlan right, PlanJoinKey... keys)
right
- The row set from the right view.keys
- The equijoin from one or more calls to the
op:on function.PlanBuilder.ModifyPlan joinInner(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys)
right
- The row set from the right view.keys
- The equijoin from one or more calls to the
op:on function.PlanBuilder.ModifyPlan joinInner(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, boolean condition)
right
- The row set from the right view.keys
- The equijoin from one or more calls to the
op:on function.condition
- A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan joinInner(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, ServerExpression condition)
right
- The row set from the right view.keys
- The equijoin from one or more calls to the
op:on function.condition
- A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan joinLeftOuter(PlanBuilder.ModifyPlan right)
right
- The row set from the right view.PlanBuilder.ModifyPlan joinLeftOuter(PlanBuilder.ModifyPlan right, PlanJoinKey... keys)
right
- The row set from the right view.keys
- The equijoin from one or more calls to the
op:on function.PlanBuilder.ModifyPlan joinLeftOuter(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys)
right
- The row set from the right view.keys
- The equijoin from one or more calls to the
op:on function.PlanBuilder.ModifyPlan joinLeftOuter(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, boolean condition)
right
- The row set from the right view.keys
- The equijoin from one or more calls to the
op:on function.condition
- A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan joinLeftOuter(PlanBuilder.ModifyPlan right, PlanJoinKeySeq keys, ServerExpression condition)
right
- The row set from the right view.keys
- The equijoin from one or more calls to the
op:on function.condition
- A boolean expression that filters the
join output rows. (of xs:boolean)PlanBuilder.ModifyPlan orderBy(PlanSortKeySeq keys)
keys
- The specified column or sortdef output from
the op:asc or op:desc function.PlanBuilder.PreparePlan prepare(int optimize)
optimize
- The optimization level, which can be 0,
1, or 2 (with 1 as the default).PlanBuilder.PreparePlan prepare(XsIntVal optimize)
optimize
- The optimization level, which can be 0,
1, or 2 (with 1 as the default).PlanBuilder.ModifyPlan select(PlanExprCol... columns)
columns
- The columns to select.PlanBuilder.ModifyPlan select(PlanExprColSeq columns)
columns
- The columns to select.PlanBuilder.ModifyPlan select(PlanExprColSeq columns, java.lang.String qualifierName)
columns
- The columns to select.qualifierName
- Specifies a name for qualifying
the column names in place of the combination of the schema and view
names. Use cases for the qualifier include self joins. Using an
empty string removes all qualification from the column names.PlanBuilder.ModifyPlan select(PlanExprColSeq columns, XsStringVal qualifierName)
columns
- The columns to select.qualifierName
- Specifies a name for qualifying
the column names in place of the combination of the schema and view
names. Use cases for the qualifier include self joins. Using an
empty string removes all qualification from the column names.PlanBuilder.ModifyPlan union(PlanBuilder.ModifyPlan right)
right
- The row set from the right view.PlanBuilder.ModifyPlan whereDistinct()
Copyright © 2013-2019 MarkLogic Corporation.