Uses of Interface
com.marklogic.client.expression.PlanBuilder.Plan

• Uses of PlanBuilder.Plan in com.marklogic.client.expression

  Subinterfaces of PlanBuilder.Plan in com.marklogic.client.expression
  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.

  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.
  Methods in com.marklogic.client.expression that return PlanBuilder.Plan
  Modifier and Type

  Method

  Description

  PlanBuilder.Plan

  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.

  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

  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, DocumentWriteSet writeSet)

  Specifies a set of documents 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, AbstractWriteHandle content, Map<String,Map<String,AbstractWriteHandle>> columnAttachments)

  Specifies a content handle 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, 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.

  PlanBuilder.Plan

  PlanBuilderBase.PlanBase.bindParam(String paramName, 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(String paramName, 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(String paramName, 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(String paramName, 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(String paramName, 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(String paramName, 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

  PlanBuilderBase.PlanBase.bindParam(String paramName, 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(String param, DocumentWriteSet writeSet)

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

  PlanBuilder.Plan

  PlanBuilderBase.PlanBase.bindParam(String param, AbstractWriteHandle content)

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

  PlanBuilder.Plan

  PlanBuilderBase.PlanBase.bindParam(String param, AbstractWriteHandle content, Map<String,Map<String,AbstractWriteHandle>> columnAttachments)

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

  PlanBuilder.Plan

  PlanBuilderBase.PlanBase.bindParam(String paramName, 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.

• Uses of PlanBuilder.Plan in com.marklogic.client.row

  Subinterfaces of PlanBuilder.Plan in com.marklogic.client.row
  Modifier and Type

  Interface

  Description

  interface 

  RawPlan

  An abstraction for a serialization of a plan such as an AST in JSON format, a Query DSL in JavaScript syntax, or a SQL or SPARQL SELECT query.

  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.

  interface 

  RawQueryDSLPlan

  A Raw Query DSL Plan provides access to a plan expressed in JavaScript syntax.

  interface 

  RawSPARQLSelectPlan

  A Raw SPARQL Select Plan provides access to a plan expressed as a SPARQL SELECT statement.

  interface 

  RawSQLPlan

  A Raw SQL Plan provides access to a plan expressed as an SQL SELECT statement.
  Methods in com.marklogic.client.row with parameters of type PlanBuilder.Plan
  Modifier and Type

  Method

  Description

  <T extends JSONReadHandle>
T

  RowManager.columnInfo(PlanBuilder.Plan plan, T handle)

  This function can be used to inspect the state of a plan before execution.

  <T> T

  RowManager.columnInfoAs(PlanBuilder.Plan plan, Class<T> as)

  This function can be used to inspect the state of a plan before execution.

  void

  RowManager.execute(PlanBuilder.Plan plan)

  Execute the given plan without returning any result.

  void

  RowManager.execute(PlanBuilder.Plan plan, Transaction transaction)

  Execute the given plan without returning any result.

  <T extends StructureReadHandle>
T

  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, 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>
T

  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>
T

  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, 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, 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.

  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>
RowSet<T>

  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.

  <T extends StructureReadHandle>
RowSet<T>

  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, 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, 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.
  Method parameters in com.marklogic.client.row with type arguments of type PlanBuilder.Plan
  Modifier and Type

  Method

  Description

  <T> T

  RowTemplate.query(Function<PlanBuilder,PlanBuilder.Plan> planFunction, Function<RowSet<RowRecord>,T> rowSetConsumer)

  Execute a query defined by the given function for building an Optic plan.

  void

  RowTemplate.update(Function<PlanBuilder,PlanBuilder.Plan> planFunction)

  Execute an update defined by the given function for building an Optic plan.

  <T> T

  RowTemplate.update(Function<PlanBuilder,PlanBuilder.Plan> planFunction, Function<RowSet<RowRecord>,T> rowSetConsumer)

  Execute an update defined by the given function for building an Optic plan.

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.