Package | Description |
---|---|
com.marklogic.client.datamovement |
The MarkLogic Data Movement SDK supports
long-running write, read, delete, or transform jobs.
|
com.marklogic.client.expression |
The package provides classes for building Optic
plan pipelines and expressions for execution on the REST
server.
|
Modifier and Type | Method | Description |
---|---|---|
RowBatcher<T> |
RowBatcher.withBatchView(PlanBuilder.ModifyPlan viewPlan) |
Specifies the plan for getting rows from a
view.
|
Modifier and Type | Interface | Description |
---|---|---|
static interface |
PlanBuilder.AccessPlan |
Provides functions and operations in the access
phase of the plan for executing a row pipeline on the server.
|
Modifier and Type | Method | Description |
---|---|---|
PlanBuilder.ModifyPlan |
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.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSparql(XsStringVal select) |
This function dynamically constructs a row set
based on a SPARQL SELECT query from triples.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSparql(XsStringVal select,
XsStringVal qualifierName) |
This function dynamically constructs a row set
based on a SPARQL SELECT query from triples.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSparql(java.lang.String select) |
This function dynamically constructs a row set
based on a SPARQL SELECT query from triples.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSparql(java.lang.String select,
java.lang.String qualifierName) |
This function dynamically constructs a row set
based on a SPARQL SELECT query from triples.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSql(XsStringVal select) |
This function dynamically constructs a row set
based on a SQL SELECT query from views.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSql(XsStringVal select,
XsStringVal qualifierName) |
This function dynamically constructs a row set
based on a SQL SELECT query from views.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSql(java.lang.String select) |
This function dynamically constructs a row set
based on a SQL SELECT query from views.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSql(java.lang.String select,
java.lang.String qualifierName) |
This function dynamically constructs a row set
based on a SQL SELECT query from views.
|
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.
|
PlanBuilder.ModifyPlan |
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 |
PlanBuilder.ModifyPlan.joinCrossProduct(PlanBuilder.ModifyPlan right) |
This method yields one output row set that
concatenates every left row with every right row.
|
PlanBuilder.ModifyPlan |
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 |
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 |
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.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 |
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 |
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 |
PlanBuilder.ModifyPlan.joinInner(PlanBuilder.ModifyPlan right) |
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.joinInner(PlanBuilder.ModifyPlan right,
PlanJoinKey... keys) |
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.joinInner(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys) |
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
PlanBuilderBase.ModifyPlanBase.limit(long length) |
This method returns a subset of the rows in the
result set by returning the specified number of rows.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.limit(PlanParamExpr length) |
This method returns a subset of the rows in the
result set by returning the specified number of rows.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.limit(XsLongVal length) |
This method returns a subset of the rows in the
result set by returning the specified number of rows.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.offset(long start) |
This method returns a subset of the rows in the
result set by skipping the number of rows specified by start and
returning the remaining rows up to the number specified by the
prototype.limit method.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.offset(PlanParamExpr start) |
This method returns a subset of the rows in the
result set by skipping the number of rows specified by start and
returning the remaining rows up to the number specified by the
prototype.limit method.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.offset(XsLongVal start) |
This method returns a subset of the rows in the
result set by skipping the number of rows specified by start and
returning the remaining rows up to the number specified by the
prototype.limit method.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.offsetLimit(long start,
long length) |
This method returns a subset of the rows in the
result set by skipping the number of rows specified by start and
returning the remaining rows up to the length limit.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.offsetLimit(XsLongVal start,
XsLongVal length) |
This method returns a subset of the rows in the
result set by skipping the number of rows specified by start and
returning the remaining rows up to the length limit.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.orderBy(PlanSortKeySeq keys) |
This method sorts the row set by the specified
order definition.
|
PlanBuilder.ModifyPlan |
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 |
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.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.union(PlanBuilder.ModifyPlan right) |
This method yields all of the rows from the
input row sets.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.where(CtsQueryExpr condition) |
This method restricts the row set to rows from
the documents matched by the cts.query expression.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.where(PlanCondition condition) |
This method restricts the row set to rows
matched by an SQL boolean expression.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.where(SemStoreExpr condition) |
This method adjusts the row set based on the
triples for the sem.store definition, restricting the triples to
the documents matched by a cts.query expression and expanding the
triples based on inferencing rules.
|
PlanBuilder.ModifyPlan |
PlanBuilderBase.ModifyPlanBase.where(ServerExpression condition) |
This method restricts the row set to rows
matched by the boolean expression.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.whereDistinct() |
This method removes duplicate rows from the row
set.
|
Modifier and Type | Method | Description |
---|---|---|
PlanBuilder.ModifyPlan |
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 |
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 |
PlanBuilder.ModifyPlan.joinCrossProduct(PlanBuilder.ModifyPlan right) |
This method yields one output row set that
concatenates every left row with every right row.
|
PlanBuilder.ModifyPlan |
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 |
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 |
PlanBuilder.ModifyPlan.joinInner(PlanBuilder.ModifyPlan right) |
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.joinInner(PlanBuilder.ModifyPlan right,
PlanJoinKey... keys) |
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.joinInner(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys) |
This method returns all rows from multiple
tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
PlanBuilder.ModifyPlan.union(PlanBuilder.ModifyPlan right) |
This method yields all of the rows from the
input row sets.
|
Copyright © 2013-2019 MarkLogic Corporation.