Package com.marklogic.client.expression

Interface PlanBuilder.Plan

All Superinterfaces:

PlanBuilderBase.PlanBase

All Known Subinterfaces:

PlanBuilder.AccessPlan, PlanBuilder.ExportablePlan, PlanBuilder.ModifyPlan, PlanBuilder.PreparePlan, RawPlan, RawPlanDefinition, RawQueryDSLPlan, RawSPARQLSelectPlan, RawSQLPlan

Enclosing class:

PlanBuilder

public static interface PlanBuilder.Plan
extends PlanBuilderBase.PlanBase

Provides functions and operations in the final phase of the plan for executing a row pipeline on the server.

Method Summary

Modifier and Type	Method	Description
PlanBuilder.Plan	bindParam(PlanParamExpr param, PlanParamBindingVal literal)	Specifies a value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

Methods inherited from interface com.marklogic.client.expression.PlanBuilderBase.PlanBase

bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam

Method Detail

bindParam

PlanBuilder.Plan bindParam(PlanParamExpr param,
                           PlanParamBindingVal literal)

Specifies a value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - the name of a placeholder parameter

literal - a value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding