com.marklogic.client.expression

Interface PlanBuilder.AccessPlan

All Superinterfaces:

PlanBuilder.ExportablePlan, PlanBuilder.ModifyPlan, PlanBuilder.Plan, PlanBuilder.PreparePlan, PlanBuilderBase.AccessPlanBase, PlanBuilderBase.ExportablePlanBase, PlanBuilderBase.ModifyPlanBase, PlanBuilderBase.PlanBase, PlanBuilderBase.PreparePlanBase

Enclosing class:

PlanBuilder

public static interface PlanBuilder.AccessPlan
extends PlanBuilder.ModifyPlan, PlanBuilderBase.AccessPlanBase

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

Method Summary

Modifier and Type	Method and Description
PlanColumn	col(String column) This method identifies a column, where the column name is unique.
PlanColumn	col(XsStringVal column) This method identifies a column, where the column name is unique.

Methods inherited from interface com.marklogic.client.expression.PlanBuilder.ModifyPlan

except, groupBy, groupBy, intersect, joinCrossProduct, joinCrossProduct, joinCrossProduct, joinDoc, joinDoc, joinDocUri, joinDocUri, joinInner, joinInner, joinInner, joinInner, joinLeftOuter, joinLeftOuter, joinLeftOuter, joinLeftOuter, orderBy, prepare, prepare, select, select, select, select, union, whereDistinct

Methods inherited from interface com.marklogic.client.expression.PlanBuilder.PreparePlan

map, reduce, reduce, reduce

Methods inherited from interface com.marklogic.client.expression.PlanBuilder.Plan

bindParam

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

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

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

export, exportAs

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

limit, limit, limit, offset, offset, offset, offsetLimit, offsetLimit, where, where, where

Method Detail

col

PlanColumn col(String column)

This method identifies a column, where the column name is unique. A qualifier on the column name isn’t necessary (and might not exist). In positions where only a column name can appear, the unqualified column name can also be provided as a string. Qualified column names cannot be provided as a string.

Parameters:

column - The Optic AccessorPlan created by op:from-view, op:from-triples, or op:from-lexicons.

Returns:

a PlanColumn object

col

PlanColumn col(XsStringVal column)

This method identifies a column, where the column name is unique. A qualifier on the column name isn’t necessary (and might not exist). In positions where only a column name can appear, the unqualified column name can also be provided as a string. Qualified column names cannot be provided as a string.

Parameters:

column - The Optic AccessorPlan created by op:from-view, op:from-triples, or op:from-lexicons.

Returns:

a PlanColumn object