Namespace: AccessPlan

planBuilder. AccessPlan

AccessPlan objects have methods and inherit planBuilder.ModifyPlan methods.
Since:
  • 2.1.1

Methods


col(column) → {planBuilder.PlanColumn}

Identifies a column where the column name is unique and a qualifier on the column name isn't necessary (and might not exist). Provides a client interface to a server function. See op.col
Parameters:
Name Type Argument Description
column XsString <optional>
The Optic AccessorPlan created by op:from-view, op:from-triples, or op:from-lexicons.
Since:
  • 2.1.1
Returns:
Type
planBuilder.PlanColumn

sampleBy(option) → {planBuilder.ModifyPlan}

This function samples rows from a view or from a pattern match on the triple index. Provides a client interface to a server function. See AccessPlan.prototype.sampleBy
Parameters:
Name Type Argument Description
option PlanSampleByOption <optional>
-
Since:
  • 2.1.1
Returns:
Type
planBuilder.ModifyPlan
Copyright (c) 2020 MarkLogic Corporation Documentation generated by JSDoc 4.0.0 on 2024-01-04T18:17:58-08:00 using the DocStrap template.