Package | Description |
---|---|
com.marklogic.client.example.cookbook.datamovement | |
com.marklogic.client.expression |
The package provides classes for building Optic plan pipelines and expressions
for execution on the REST server.
|
com.marklogic.client.row |
The package provides classes for sending plan requests to and
processing row responses from the REST server.
|
Modifier and Type | Field and Description |
---|---|
protected java.util.function.Function<QueryBatch,PlanBuilder.Plan> |
OpticExportListener.exportFunction |
Constructor and Description |
---|
OpticExportListener(java.util.function.Function<QueryBatch,PlanBuilder.Plan> function,
RowManager rowManager) |
OpticExportToWriterListener(java.util.function.Function<QueryBatch,PlanBuilder.Plan> function,
RowManager rowManager,
java.io.Writer writer) |
Modifier and Type | Interface and Description |
---|---|
static interface |
PlanBuilder.AccessPlan
Provides functions and operations in the access phase
of the plan for executing a row pipeline on the server.
|
static interface |
PlanBuilder.ExportablePlan
Provides functions and operations in the exportable phase
of the plan for executing a row pipeline on the server.
|
static interface |
PlanBuilder.ModifyPlan
Provides functions and operations in the modify phase
of the plan for executing a row pipeline on the server.
|
static interface |
PlanBuilder.PreparePlan
Provides functions and operations in the prepare phase
of the plan for executing a row pipeline on the server.
|
Modifier and Type | Method and Description |
---|---|
PlanBuilder.Plan |
PlanBuilderBase.PlanBase.bindParam(PlanParamExpr param,
boolean literal)
Specifies a boolean primitive value to replace a placeholder parameter during this
execution of the plan in all expressions in which the parameter appears.
|
PlanBuilder.Plan |
PlanBuilderBase.PlanBase.bindParam(PlanParamExpr param,
byte literal)
Specifies a byte primitive value to replace a placeholder parameter during this
execution of the plan in all expressions in which the parameter appears.
|
PlanBuilder.Plan |
PlanBuilderBase.PlanBase.bindParam(PlanParamExpr param,
double literal)
Specifies a double primitive value to replace a placeholder parameter during this
execution of the plan in all expressions in which the parameter appears.
|
PlanBuilder.Plan |
PlanBuilderBase.PlanBase.bindParam(PlanParamExpr param,
float literal)
Specifies a float primitive value to replace a placeholder parameter during this
execution of the plan in all expressions in which the parameter appears.
|
PlanBuilder.Plan |
PlanBuilderBase.PlanBase.bindParam(PlanParamExpr param,
int literal)
Specifies an int primitive value to replace a placeholder parameter during this
execution of the plan in all expressions in which the parameter appears.
|
PlanBuilder.Plan |
PlanBuilderBase.PlanBase.bindParam(PlanParamExpr param,
long literal)
Specifies a long primitive value to replace a placeholder parameter during this
execution of the plan in all expressions in which the parameter appears.
|
PlanBuilder.Plan |
PlanBuilder.Plan.bindParam(PlanParamExpr param,
PlanParamBindingVal literal) |
PlanBuilder.Plan |
PlanBuilderBase.PlanBase.bindParam(PlanParamExpr param,
short literal)
Specifies a short primitive value to replace a placeholder parameter during this
execution of the plan in all expressions in which the parameter appears.
|
PlanBuilder.Plan |
PlanBuilderBase.PlanBase.bindParam(PlanParamExpr param,
java.lang.String literal)
Specifies a string literal value to replace a placeholder parameter during this
execution of the plan in all expressions in which the parameter appears.
|
Modifier and Type | Interface and Description |
---|---|
interface |
RawPlanDefinition
A Raw Plan Definition provides access to a plan
in a JSON serialization of the exported
AST (Abstract Syntax Tree) for the plan.
|
Modifier and Type | Method and Description |
---|---|
<T extends StructureReadHandle> |
RowManager.explain(PlanBuilder.Plan plan,
T handle)
Constructs a plan for retrieving a set of database rows and returns a handle
for the explanation of the plan as a JSON or XML structure.
|
<T> T |
RowManager.explainAs(PlanBuilder.Plan plan,
java.lang.Class<T> as)
Constructs a plan for retrieving a set of database rows and returns an explanation
of the plan in the representation specified by the IO class.
|
<T extends StructureReadHandle> |
RowManager.resultDoc(PlanBuilder.Plan plan,
T handle)
Constructs and retrieves a set of database rows based on a plan using
a handle to get the set of rows as a single JSON or XML structure.
|
<T extends StructureReadHandle> |
RowManager.resultDoc(PlanBuilder.Plan plan,
T handle,
Transaction transaction)
Constructs and retrieves a set of database rows based on a plan using
a handle to get the set of rows as a single JSON or XML structure
and reflecting documents written or deleted by an uncommitted transaction.
|
<T> T |
RowManager.resultDocAs(PlanBuilder.Plan plan,
java.lang.Class<T> as)
Constructs and retrieves a set of database rows based on a plan
in the representation specified by the IO class.
|
<T> T |
RowManager.resultDocAs(PlanBuilder.Plan plan,
java.lang.Class<T> as,
Transaction transaction)
Constructs and retrieves a set of database rows based on a plan
in the representation specified by the IO class and reflecting
documents written or deleted by an uncommitted transaction.
|
RowSet<RowRecord> |
RowManager.resultRows(PlanBuilder.Plan plan)
Constructs and retrieves a set of database rows based on a plan using
a map interface for the column values in each row.
|
<T extends StructureReadHandle> |
RowManager.resultRows(PlanBuilder.Plan plan,
T rowHandle)
Constructs and retrieves a set of database rows based on a plan using
a JSON or XML handle for each row.
|
RowSet<RowRecord> |
RowManager.resultRows(PlanBuilder.Plan plan,
Transaction transaction)
Constructs and retrieves a set of database rows based on a plan using
a map interface and reflecting documents written or deleted by an
uncommitted transaction.
|
<T extends StructureReadHandle> |
RowManager.resultRows(PlanBuilder.Plan plan,
T rowHandle,
Transaction transaction)
Constructs and retrieves a set of database rows based on a plan using
a JSON or XML handle for each row and reflecting documents written or
deleted by an uncommitted transaction.
|
<T> RowSet<T> |
RowManager.resultRowsAs(PlanBuilder.Plan plan,
java.lang.Class<T> as)
Constructs and retrieves a set of database rows based on a plan using
a JSON or XML handle for each row and reflecting documents written or
deleted by an uncommitted transaction.
|
<T> RowSet<T> |
RowManager.resultRowsAs(PlanBuilder.Plan plan,
java.lang.Class<T> as,
Transaction transaction)
Constructs and retrieves a set of database rows based on a plan using
a JSON or XML handle for each row and reflecting documents written or
deleted by an uncommitted transaction.
|
Copyright © 2013-2018 MarkLogic Corporation.