Interface PlanBuilderBase.PlanBase

All Known Subinterfaces:

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

Enclosing interface:

PlanBuilderBase

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  PlanBuilder.Plan

  bindParam(CtsParamExpr param, CtsQueryExpr query)

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

  PlanBuilder.Plan

  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

  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

  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

  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

  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

  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

  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

  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

  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

  bindParam(PlanParamExpr param, CtsQueryExpr query)

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

  PlanBuilder.Plan

  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

  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

  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

  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

  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

  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

  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

  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

  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

  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

  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

  bindParam(String paramName, CtsQueryExpr query)

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

  PlanBuilder.Plan

  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.

• Method Details

  • bindParam

    PlanBuilder.Plan 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.

    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:

    paramName - the name of a placeholder parameter

    literal - a boolean primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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 - a placeholder parameter as constructed by the param() method

    literal - a boolean primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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:

    paramName - the name of a placeholder parameter

    literal - a byte primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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 - a placeholder parameter as constructed by the param() method

    literal - a byte primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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:

    paramName - the name of a placeholder parameter

    literal - a double primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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 - a placeholder parameter as constructed by the param() method

    literal - a double primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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:

    paramName - the name of a placeholder parameter

    literal - a float primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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 - a placeholder parameter as constructed by the param() method

    literal - a float primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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:

    paramName - the name of a placeholder parameter

    literal - an int primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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 - a placeholder parameter as constructed by the param() method

    literal - an int primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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:

    paramName - the name of a placeholder parameter

    literal - a long primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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 - a placeholder parameter as constructed by the param() method

    literal - a long primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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:

    paramName - the name of a placeholder parameter

    literal - a short primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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 - a placeholder parameter as constructed by the param() method

    literal - a short primitive value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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:

    paramName - the name of a placeholder parameter

    literal - a string literal value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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 - a placeholder parameter as constructed by the param() method

    literal - a string literal value to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan bindParam(String paramName, CtsQueryExpr query)
    Specifies a CTS query expression 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:

    paramName - the name of a placeholder parameter as defined by cts.param() or param() (i.e. op:param)

    query - the CTS query expression to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

    Since:

    8.2.0; requires MarkLogic 12.1 or higher

  • bindParam

    PlanBuilder.Plan bindParam(CtsParamExpr param, CtsQueryExpr query)
    Specifies a CTS query expression 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 - a placeholder parameter as constructed by cts:param()

    query - the CTS query expression to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

    Since:

    8.2.0; requires MarkLogic 12.1 or higher

  • bindParam

    PlanBuilder.Plan bindParam(PlanParamExpr param, CtsQueryExpr query)
    Specifies a CTS query expression to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

    Pass the same PlanParamExpr returned by param() to both a plan step (such as where()) and this method. The client substitutes the query expression into the serialised plan AST before it is sent to the server.

    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 - a placeholder parameter as constructed by param()

    query - the CTS query expression to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

    Since:

    8.2.0; requires MarkLogic 12.1 or higher

  • bindParam

    PlanBuilder.Plan 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.

    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

    writeSet - the set of documents to bind; the URI, content, and metadata in each document will be honored except for the properties fragment config in the metadata

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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 - a placeholder parameter as constructed by the param() method

    writeSet - the set of documents to bind; the URI, content, and metadata in each document will be honored except for the properties fragment config in the metadata

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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

    content - the content to replace the parameter

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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

    content - the content to replace the parameter

    columnAttachments - optional (can be null) map that associates column names with maps of attachments, which map filenames to content handles. For each column name in the map, the expectation is that the associated column in the content object will contain values matching the filenames in the map of filenames to content handles. When the plan is executed, those filenames will then be replaced with the associated attachment content objects.

    Returns:

    a new instance of the Plan object with the parameter binding

  • bindParam

    PlanBuilder.Plan 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.

    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 - a placeholder parameter as constructed by the param() method

    content - the content to replace the parameter

    columnAttachments - optional (can be null) map that associates column names with maps of attachments, which map filenames to content handles. For each column name in the map, the expectation is that the associated column in the content object will contain values matching the filenames in the map of filenames to content handles. When the plan is executed, those filenames will then be replaced with the associated attachment content objects.

    Returns:

    a new instance of the Plan object with the parameter binding

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