PlanBuilderBasestatic
interface static
interface static
interface static
interface static
interface PlanBuilderBase.AccessPlanBase,
PlanBuilderBase.ExportablePlanBase,
PlanBuilderBase.ModifyPlanBase,
PlanBuilderBase.PlanBase,
PlanBuilderBase.PreparePlanBasefinal CtsExprfinal FnExprfinal GeoExprfinal JsonExprfinal MapExprfinal MathExprfinal RdfExprfinal RdtExprfinal SemExprfinal SpellExprfinal SqlExprfinal VecExprfinal XdmpExprfinal XsExprabstract ServerExpressionadd (ServerExpression... left)abstract PlanAggregateColSeqaggregateSeq (PlanAggregateCol... aggregate)abstract ServerExpressionand (ServerExpression... left)abstract PlanAggregateColarrayAggregate (PlanColumn name,
PlanExprCol column)abstract PlanAggregateColarrayAggregate (PlanColumn name,
PlanExprCol column,
PlanValueOption option)abstract PlanAggregateColarrayAggregate (String name, String column)abstract PlanAggregateColarrayAggregate (String name, String column, PlanValueOption option)abstract PlanExprColas (PlanColumn column,
ServerExpression expression)abstract PlanExprColas (String column, ServerExpression expression)abstract PlanSortKeyasc (PlanExprCol column)abstract PlanSortKeyabstract PlanAggregateColavg (PlanColumn name,
PlanExprCol column)abstract PlanAggregateColavg (PlanColumn name,
PlanExprCol column,
PlanValueOption option)abstract PlanAggregateColabstract PlanAggregateColavg (String name, String column, PlanValueOption option)abstract PlanNamedGroupbucketGroup (XsStringVal name,
PlanExprCol key,
XsAnyAtomicTypeSeqVal boundaries)abstract PlanNamedGroupbucketGroup (XsStringVal name,
PlanExprCol key,
XsAnyAtomicTypeSeqVal boundaries,
XsStringVal collation)abstract PlanNamedGroupbucketGroup (String name, String key, String boundaries)abstract PlanNamedGroupbucketGroup (String name, String key, String boundaries, String collation)abstract PlanColumncol (XsStringVal column)abstract PlanColumnabstract PlanExprColSeqcolSeq (PlanExprCol... col)abstract PlanExprColSeqabstract PlanColumnBuilderabstract PlanContextExprCallcontext()abstract PlanAggregateColcount (PlanColumn name)abstract PlanAggregateColcount (PlanColumn name,
PlanExprCol column)abstract PlanAggregateColcount (PlanColumn name,
PlanExprCol column,
PlanValueOption option)abstract PlanAggregateColabstract PlanAggregateColabstract PlanAggregateColcount (String name, String column, PlanValueOption option)abstract PlanGroupSeqcube (PlanExprColSeq keys)abstract PlanSortKeydesc (PlanExprCol column)abstract PlanSortKeyabstract ServerExpressiondivide (ServerExpression left,
ServerExpression right)abstract PlanDocColsIdentifierdocCols()abstract PlanDocColsIdentifierdocCols (XsStringVal qualifier)abstract PlanDocColsIdentifierdocCols (XsStringVal qualifier,
XsStringSeqVal names)abstract PlanDocColsIdentifierabstract PlanDocColsIdentifierabstract PlanRowColTypesSeqabstract ServerExpressioneq (ServerExpression... operand)abstract PlanSystemColumnfragmentIdCol (XsStringVal column)abstract PlanSystemColumnfragmentIdCol (String column)abstract PlanBuilder.AccessPlanfromDocDescriptors (PlanDocDescriptor... docDescriptor)abstract PlanBuilder.AccessPlanfromDocDescriptors (PlanDocDescriptorSeq docDescriptor)abstract PlanBuilder.AccessPlanfromDocDescriptors (PlanDocDescriptorSeq docDescriptor,
XsStringVal qualifier)abstract PlanBuilder.AccessPlanfromDocDescriptors (PlanDocDescriptorSeq docDescriptor,
String qualifier)abstract PlanBuilder.AccessPlanfromDocs (CtsQueryExpr query,
String contextPath, PlanColumnBuilder columnSpec,
String qualifier)abstract PlanBuilder.AccessPlanfromDocs (String query, String contextPath, PlanColumnBuilder columnSpec)abstract PlanBuilder.AccessPlanfromDocs (String query, String contextPath, PlanColumnBuilder columnSpec,
String qualifier)abstract PlanBuilder.AccessPlanfromDocs (String query, String contextPath, PlanColumnBuilder columnSpec,
String qualifier, PlanSystemColumn systemCol)abstract PlanBuilder.AccessPlanfromDocs (String query, String contextPath, PlanColumnBuilder columnSpec,
String qualifier, PlanSystemColumn systemCol,
PlanNamespaceBindingsSeq namespaces)abstract PlanBuilder.AccessPlanfromLexicons (Map<String, CtsReferenceExpr> indexes)abstract PlanBuilder.AccessPlanfromLexicons (Map<String, CtsReferenceExpr> indexes,
XsStringVal qualifierName)abstract PlanBuilder.AccessPlanfromLexicons (Map<String, CtsReferenceExpr> indexes,
XsStringVal qualifierName,
PlanSystemColumn sysCols)abstract PlanBuilder.AccessPlanfromLexicons (Map<String, CtsReferenceExpr> indexes,
String qualifierName)abstract PlanBuilder.AccessPlanfromLexicons (Map<String, CtsReferenceExpr> indexes,
String qualifierName, PlanSystemColumn sysCols)abstract PlanBuilder.AccessPlanfromParam (XsStringVal paramName,
XsStringVal qualifier,
PlanRowColTypesSeq rowColTypes)abstract PlanBuilder.AccessPlanfromParam (String paramName, String qualifier, PlanRowColTypesSeq rowColTypes)abstract PlanBuilder.ModifyPlanfromSparql (XsStringVal select)abstract PlanBuilder.ModifyPlanfromSparql (XsStringVal select,
XsStringVal qualifierName)abstract PlanBuilder.ModifyPlanfromSparql (XsStringVal select,
XsStringVal qualifierName,
PlanSparqlOptions option)abstract PlanBuilder.ModifyPlanfromSparql (String select)abstract PlanBuilder.ModifyPlanfromSparql (String select, String qualifierName)abstract PlanBuilder.ModifyPlanfromSparql (String select, String qualifierName, PlanSparqlOptions option)abstract PlanBuilder.ModifyPlanfromSql (XsStringVal select)abstract PlanBuilder.ModifyPlanfromSql (XsStringVal select,
XsStringVal qualifierName)abstract PlanBuilder.ModifyPlanabstract PlanBuilder.ModifyPlanabstract PlanBuilder.AccessPlanfromTriples (PlanTriplePattern... patterns)abstract PlanBuilder.AccessPlanfromTriples (PlanTriplePatternSeq patterns)abstract PlanBuilder.AccessPlanfromTriples (PlanTriplePatternSeq patterns,
XsStringVal qualifierName)abstract PlanBuilder.AccessPlanfromTriples (PlanTriplePatternSeq patterns,
XsStringVal qualifierName,
XsStringSeqVal graphIris)abstract PlanBuilder.AccessPlanfromTriples (PlanTriplePatternSeq patterns,
XsStringVal qualifierName,
XsStringSeqVal graphIris,
PlanTripleOption option)abstract PlanBuilder.AccessPlanfromTriples (PlanTriplePatternSeq patterns,
String qualifierName)abstract PlanBuilder.AccessPlanfromTriples (PlanTriplePatternSeq patterns,
String qualifierName, String graphIris)abstract PlanBuilder.AccessPlanfromTriples (PlanTriplePatternSeq patterns,
String qualifierName, String graphIris, PlanTripleOption option)abstract PlanBuilder.AccessPlanfromView (XsStringVal schema,
XsStringVal view)abstract PlanBuilder.AccessPlanfromView (XsStringVal schema,
XsStringVal view,
XsStringVal qualifierName)abstract PlanBuilder.AccessPlanfromView (XsStringVal schema,
XsStringVal view,
XsStringVal qualifierName,
PlanSystemColumn sysCols)abstract PlanBuilder.AccessPlanabstract PlanBuilder.AccessPlanabstract PlanBuilder.AccessPlanfromView (String schema, String view, String qualifierName, PlanSystemColumn sysCols)abstract ServerExpressionge (ServerExpression left,
ServerExpression right)abstract PlanSystemColumngraphCol (XsStringVal column)abstract PlanSystemColumnabstract PlanGroupgroup (PlanExprColSeq keys)abstract PlanAggregateColgroupKey (PlanColumn name,
PlanExprCol column)abstract PlanAggregateColabstract ServerExpressiongt (ServerExpression left,
ServerExpression right)abstract PlanAggregateColhasGroupKey (PlanColumn name,
PlanExprCol column)abstract PlanAggregateColhasGroupKey (String name, String column)abstract ServerExpressionin (ServerExpression value,
ServerExpression anyOf)abstract ServerExpressionisDefined (ServerExpression operand)abstract PlanJoinKeySeqjoinKeySeq (PlanJoinKey... key)abstract ServerExpressionjsonBoolean (boolean value)abstract ServerExpressionjsonBoolean (ServerExpression value)abstract ServerExpressionjsonDocument (ServerExpression root)abstract ServerExpressionjsonNull()abstract ServerExpressionjsonNumber (double value)abstract ServerExpressionjsonNumber (ServerExpression value)abstract ServerExpressionjsonString (ServerExpression value)abstract ServerExpressionjsonString (String value)abstract ServerExpressionle (ServerExpression left,
ServerExpression right)abstract ServerExpressionlt (ServerExpression left,
ServerExpression right)abstract PlanAggregateColmax (PlanColumn name,
PlanExprCol column)abstract PlanAggregateColmax (PlanColumn name,
PlanExprCol column,
PlanValueOption option)abstract PlanAggregateColabstract PlanAggregateColmax (String name, String column, PlanValueOption option)abstract PlanAggregateColmin (PlanColumn name,
PlanExprCol column)abstract PlanAggregateColmin (PlanColumn name,
PlanExprCol column,
PlanValueOption option)abstract PlanAggregateColabstract PlanAggregateColmin (String name, String column, PlanValueOption option)abstract ServerExpressionmodulo (double left,
double right)abstract ServerExpressionmodulo (ServerExpression left,
ServerExpression right)abstract ServerExpressionmultiply (ServerExpression... left)abstract PlanNamedGroupnamedGroup (XsStringVal name)abstract PlanNamedGroupnamedGroup (XsStringVal name,
PlanExprColSeq keys)abstract PlanNamedGroupnamedGroup (String name)abstract PlanNamedGroupnamedGroup (String name, String keys)abstract ServerExpressionne (ServerExpression left,
ServerExpression right)abstract ServerExpressionnot (ServerExpression operand)abstract PlanTriplePositionSeqobjectSeq (PlanTriplePosition... object)abstract PlanJoinKeyon (PlanExprCol left,
PlanExprCol right)abstract PlanJoinKeyabstract ServerExpressionor (ServerExpression... left)abstract PlanParamExprparam (XsStringVal name)abstract PlanParamExprabstract PatchBuilderpatchBuilder (XsStringVal contextPath)abstract PatchBuilderpatchBuilder (XsStringVal contextPath,
Map<String, String> namespaces)abstract PatchBuilderpatchBuilder (String contextPath)abstract PatchBuilderpatchBuilder (String contextPath, Map<String, String> namespaces)abstract PlanTriplePatternpattern (PlanTriplePositionSeq subjects,
PlanTriplePositionSeq predicates,
PlanTriplePositionSeq objects)abstract PlanTriplePatternpattern (PlanTriplePositionSeq subjects,
PlanTriplePositionSeq predicates,
PlanTriplePositionSeq objects,
PlanSystemColumnSeq sysCols)abstract PlanTriplePatternSeqpatternSeq (PlanTriplePattern... pattern)abstract PlanTriplePositionSeqpredicateSeq (PlanTriplePosition... predicate)abstract PlanPrefixerprefixer (XsStringVal base)abstract PlanPrefixerabstract PlanJsonPropertyprop (ServerExpression key,
ServerExpression value)abstract PlanJsonPropertyprop (String key, ServerExpression value)abstract PlanFunctionresolveFunction (XsQNameVal functionName,
XsStringVal modulePath)abstract PlanFunctionresolveFunction (String functionName, String modulePath)abstract PlanGroupSeqrollup (PlanExprColSeq keys)abstract PlanAggregateColsample (PlanColumn name,
PlanExprCol column)abstract PlanAggregateColabstract PlanColumnschemaCol (XsStringVal schema,
XsStringVal view,
XsStringVal column)abstract PlanColumnabstract PlanAggregateColsequenceAggregate (PlanColumn name,
PlanExprCol column)abstract PlanAggregateColsequenceAggregate (PlanColumn name,
PlanExprCol column,
PlanValueOption option)abstract PlanAggregateColsequenceAggregate (String name, String column)abstract PlanAggregateColsequenceAggregate (String name, String column, PlanValueOption option)abstract PlanSortKeySeqsortKeySeq (PlanSortKey... key)abstract PlanConditionsqlCondition (XsStringVal expression)abstract PlanConditionsqlCondition (String expression)abstract PlanTriplePositionSeqsubjectSeq (PlanTriplePosition... subject)abstract ServerExpressionsubtract (ServerExpression left,
ServerExpression right)abstract PlanAggregateColsum (PlanColumn name,
PlanExprCol column)abstract PlanAggregateColsum (PlanColumn name,
PlanExprCol column,
PlanValueOption option)abstract PlanAggregateColabstract PlanAggregateColsum (String name, String column, PlanValueOption option)abstract PlanAggregateColuda (PlanColumn name,
PlanExprCol column,
XsStringVal module,
XsStringVal function)abstract PlanAggregateColuda (PlanColumn name,
PlanExprCol column,
XsStringVal module,
XsStringVal function,
XsAnyAtomicTypeVal arg)abstract PlanAggregateColabstract PlanAggregateColabstract PlanColumnviewCol (XsStringVal view,
XsStringVal column)abstract PlanColumnabstract PlanCasewhen (boolean condition,
ServerExpression... value)abstract PlanCasewhen (ServerExpression condition,
ServerExpression... value)abstract ServerExpressionxmlAttribute (ServerExpression name,
ServerExpression value)abstract ServerExpressionxmlAttribute (String name, String value)abstract ServerExpressionxmlComment (ServerExpression content)abstract ServerExpressionxmlComment (String content)abstract ServerExpressionxmlDocument (ServerExpression root)abstract ServerExpressionxmlElement (ServerExpression name)abstract ServerExpressionxmlElement (ServerExpression name,
ServerExpression attributes)abstract ServerExpressionxmlElement (ServerExpression name,
ServerExpression attributes,
ServerExpression... content)abstract ServerExpressionxmlElement (String name)abstract ServerExpressionxmlElement (String name, ServerExpression attributes)abstract ServerExpressionxmlElement (String name, ServerExpression attributes,
ServerExpression... content)abstract ServerExpressionxmlPi (ServerExpression name,
ServerExpression value)abstract ServerExpressionabstract ServerExpressionxmlText (ServerExpression value)abstract ServerExpressionabstract ServerExpressionxpath (PlanColumn column,
ServerExpression path)abstract ServerExpressionxpath (PlanColumn column,
ServerExpression path,
PlanNamespaceBindingsSeq namespaceBindings)abstract ServerExpressionxpath (ServerExpression expression,
ServerExpression path)abstract ServerExpressionxpath (ServerExpression expression,
String path)abstract ServerExpressionabstract ServerExpressionxpath (String column, String path, PlanNamespaceBindingsSeq namespaceBindings)clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcaseExpr,
colType,
colType,
colType,
colTypes, cube, docCols,
docDescriptor,
docDescriptors,
elseExpr,
fromDocUris,
fromDocUris, fromDocUris,
fromLiterals,
fromLiterals,
fromLiterals,
fromSearch,
fromSearch,
fromSearch,
fromSearch,
fromSearchDocs,
fromSearchDocs,
fromSearchDocs, group,
groupConcat,
groupConcat,
groupConcat,
groupConcat,
groupConcatOptions, groupConcatOptions,
groupConcatOptions,
groupSeq,
jsonArray,
jsonObject,
namedGroup,
namedGroupSeq,
permission,
resolveFunction, rollup,
sampleByOptions,
schemaDefinition,
searchOptions,
seq, sparqlOptions, transformDef,
transitiveClosureOptionsProvides a client interface to the op:add server function.
left - The left value expression. (of xs:anyAtomicType)Provides a client interface to the op:and server function.
left - The left value expression. (of xs:anyAtomicType)Provides a client interface to the op:divide server function.
left - The left numeric expression. (of xs:anyAtomicType)right - The right numeric expression. (of xs:anyAtomicType)Provides a client interface to the op:eq server function.
operand - Two or more expressions. (of xs:anyAtomicType)Provides a client interface to the op:ge server function.
left - The left value expression. (of xs:anyAtomicType)right - The right value expression. (of xs:anyAtomicType)Provides a client interface to the op:gt server function.
left - The left value expression. (of xs:anyAtomicType)right - The right value expression. (of xs:anyAtomicType)Provides a client interface to the op:in server function.
value - The expression providing the value to
test. (of xs:anyAtomicType)anyOf - One or more expressions providing the
candidate values. (of xs:anyAtomicType)Provides a client interface to the op:is-defined server function.
operand - A boolean expression, such as op:eq or
op:not, that might be null. (of item)Provides a client interface to the op:le server function.
left - The left value expression. (of xs:anyAtomicType)right - The right value expression. (of xs:anyAtomicType)Provides a client interface to the op:lt server function.
left - The left value expression. (of xs:anyAtomicType)right - The right value expression. (of xs:anyAtomicType)Provides a client interface to the op:multiply server function.
left - The left numeric expression. (of xs:anyAtomicType)Provides a client interface to the op:ne server function.
left - The left value expression. (of xs:anyAtomicType)right - The right value expression. (of xs:anyAtomicType)Provides a client interface to the op:not server function.
operand - Exactly one boolean expression, such as
op:and or op:or, or op:is-defined. (of xs:anyAtomicType)Provides a client interface to the op:or server function.
left - The left value expression. See Boolean
Expression Functions for the list of functions used to build
boolean expressions. (of xs:anyAtomicType)Provides a client interface to the op:subtract server function.
left - The left numeric expression. (of xs:anyAtomicType)right - The right numeric expression. (of xs:anyAtomicType)contextPath - The context path to patch.contextPath - The context path to patch.contextPath - The context path to patch.namespaces - Namespaces prefix (key) and uri
(value).contextPath - The context path to patch.namespaces - Namespaces prefix (key) and uri
(value).Provides a client interface to the op:param server function.
name - The name of the parameter.Provides a client interface to the op:param server function.
name - The name of the parameter.column - The name of the column.column - The name of the column.schema - The name of the schema.view - The name of the view.column - The name of the column.schema - The name of the schema.view - The name of the view.column - The name of the column.view - The name of the view.column - The name of the column.view - The name of the view.column - The name of the column.column - The name of the fragment ID column.column - The name of the fragment ID column.column - The name to use for the graph
column.column - The name to use for the graph
column.column - The name of the column to be defined.
This can be either a string or the return value from op:col,
op:view-col, or op:schema-col. See col(XsStringVal)expression - The expression used to define the
value the column. (of item)column - The name of the column to be defined.
This can be either a string or the return value from op:col,
op:view-col, or op:schema-col. See col(XsStringVal)expression - The expression used to define the
value the column. (of item)col - the col values for the sequence See col(XsStringVal)col - the col values for the sequence See col(XsStringVal)schema - The name identifying the schema
containing the view. If the schema name is null, the engine
searches for a view with the specified name.view - The name identifying a configured template
or range view for rows projected from documents.schema - The name identifying the schema
containing the view. If the schema name is null, the engine
searches for a view with the specified name.view - The name identifying a configured template
or range view for rows projected from documents.schema - The name identifying the schema
containing the view. If the schema name is null, the engine
searches for a view with the specified name.view - The name identifying a configured template
or range view for rows projected from documents.qualifierName - Specifies a name for qualifying
the column names in place of the combination of the schema and view
names. Use cases for the qualifier include self joins. Using an
empty string removes all qualification from the column names.schema - The name identifying the schema
containing the view. If the schema name is null, the engine
searches for a view with the specified name.view - The name identifying a configured template
or range view for rows projected from documents.qualifierName - Specifies a name for qualifying
the column names in place of the combination of the schema and view
names. Use cases for the qualifier include self joins. Using an
empty string removes all qualification from the column names.schema - The name identifying the schema
containing the view. If the schema name is null, the engine
searches for a view with the specified name.view - The name identifying a configured template
or range view for rows projected from documents.qualifierName - Specifies a name for qualifying
the column names in place of the combination of the schema and view
names. Use cases for the qualifier include self joins. Using an
empty string removes all qualification from the column names.sysCols - An optional named fragment id column
returned by op:fragment-id-col. One use case for fragment ids is in
joins with lexicons or document content.schema - The name identifying the schema
containing the view. If the schema name is null, the engine
searches for a view with the specified name.view - The name identifying a configured template
or range view for rows projected from documents.qualifierName - Specifies a name for qualifying
the column names in place of the combination of the schema and view
names. Use cases for the qualifier include self joins. Using an
empty string removes all qualification from the column names.sysCols - An optional named fragment id column
returned by op:fragment-id-col. One use case for fragment ids is in
joins with lexicons or document content.query - Query to select documents for row
generation. The query can be a cts:query or a string as a shortcut
for a cts:word-query.contextPath - XPath applied to each matched
document; each result becomes a row.columnSpec - The column definitions created by
using op:column-builder.query - Query to select documents for row
generation. The query can be a cts:query or a string as a shortcut
for a cts:word-query.contextPath - XPath applied to each matched
document; each result becomes a row.columnSpec - The column definitions created by
using op:column-builder.qualifier - Specifies a name for qualifying the
column names in place of the combination of the schema and view
names. Use cases for the qualifier include self joins. Using an
empty string removes all qualification from the column names.query - Query to select documents for row
generation. The query can be a cts:query or a string as a shortcut
for a cts:word-query.contextPath - XPath applied to each matched
document; each result becomes a row.columnSpec - The column definitions created by
using op:column-builder.qualifier - Specifies a name for qualifying the
column names in place of the combination of the schema and view
names. Use cases for the qualifier include self joins. Using an
empty string removes all qualification from the column names.query - Query to select documents for row
generation. The query can be a cts:query or a string as a shortcut
for a cts:word-query.contextPath - XPath applied to each matched
document; each result becomes a row.columnSpec - The column definitions created by
using op:column-builder.qualifier - Specifies a name for qualifying the
column names in place of the combination of the schema and view
names. Use cases for the qualifier include self joins. Using an
empty string removes all qualification from the column names.systemCol - An optional named fragment id column
returned by op:fragment-id-col. One use case for fragment ids is in
joins with lexicons or document content.query - Query to select documents for row
generation. The query can be a cts:query or a string as a shortcut
for a cts:word-query.contextPath - XPath applied to each matched
document; each result becomes a row.columnSpec - The column definitions created by
using op:column-builder.qualifier - Specifies a name for qualifying the
column names in place of the combination of the schema and view
names. Use cases for the qualifier include self joins. Using an
empty string removes all qualification from the column names.systemCol - An optional named fragment id column
returned by op:fragment-id-col. One use case for fragment ids is in
joins with lexicons or document content.namespaces - Namespaces prefix (key) and uri
(value).base - The base URI to be prepended to the
name.base - The base URI to be prepended to the
name.patterns - One or more pattern definitions
returned by the op:pattern function. See
patternSeq(PlanTriplePattern...)patterns - One or more pattern definitions
returned by the op:pattern function. See
patternSeq(PlanTriplePattern...)patterns - One or more pattern definitions
returned by the op:pattern function. See
patternSeq(PlanTriplePattern...)qualifierName - Specifies a name for qualifying
the column names. By default, triple rows have no qualification.
Use cases for the qualifier include self joins. Using an empty
string removes all qualification from the column names.patterns - One or more pattern definitions
returned by the op:pattern function. See
patternSeq(PlanTriplePattern...)qualifierName - Specifies a name for qualifying
the column names. By default, triple rows have no qualification.
Use cases for the qualifier include self joins. Using an empty
string removes all qualification from the column names.patterns - One or more pattern definitions
returned by the op:pattern function. See
patternSeq(PlanTriplePattern...)qualifierName - Specifies a name for qualifying
the column names. By default, triple rows have no qualification.
Use cases for the qualifier include self joins. Using an empty
string removes all qualification from the column names.graphIris - A list of graph IRIs to restrict the
results to triples in the specified graphs. The
sem:default-graph-iri function returns the iri that identifies the
default graph.patterns - One or more pattern definitions
returned by the op:pattern function. See
patternSeq(PlanTriplePattern...)qualifierName - Specifies a name for qualifying
the column names. By default, triple rows have no qualification.
Use cases for the qualifier include self joins. Using an empty
string removes all qualification from the column names.graphIris - A list of graph IRIs to restrict the
results to triples in the specified graphs. The
sem:default-graph-iri function returns the iri that identifies the
default graph.patterns - One or more pattern definitions
returned by the op:pattern function. See
patternSeq(PlanTriplePattern...)qualifierName - Specifies a name for qualifying
the column names. By default, triple rows have no qualification.
Use cases for the qualifier include self joins. Using an empty
string removes all qualification from the column names.graphIris - A list of graph IRIs to restrict the
results to triples in the specified graphs. The
sem:default-graph-iri function returns the iri that identifies the
default graph.option - Options consisting of key-value pairs
that set options. At present, the options consist of dedup which
can take an on|off value to enable or disable deduplication.
Deduplication is off by default.patterns - One or more pattern definitions
returned by the op:pattern function. See
patternSeq(PlanTriplePattern...)qualifierName - Specifies a name for qualifying
the column names. By default, triple rows have no qualification.
Use cases for the qualifier include self joins. Using an empty
string removes all qualification from the column names.graphIris - A list of graph IRIs to restrict the
results to triples in the specified graphs. The
sem:default-graph-iri function returns the iri that identifies the
default graph.option - Options consisting of key-value pairs
that set options. At present, the options consist of dedup which
can take an on|off value to enable or disable deduplication.
Deduplication is off by default.subjects - One column or one or more literal
values, such as the literal returned by a sem:iri call. See
subjectSeq(PlanTriplePosition...)predicates - One column or one or more literal
values, such as the literal returned by a sem.iri call. See
predicateSeq(PlanTriplePosition...)objects - One column or one or more literal
values, such as the literal returned by a sem:iri call. See
objectSeq(PlanTriplePosition...)subjects - One column or one or more literal
values, such as the literal returned by a sem:iri call. See
subjectSeq(PlanTriplePosition...)predicates - One column or one or more literal
values, such as the literal returned by a sem.iri call. See
predicateSeq(PlanTriplePosition...)objects - One column or one or more literal
values, such as the literal returned by a sem:iri call. See
objectSeq(PlanTriplePosition...)sysCols - Specifies the result of an
op:fragment-id-col or op:graph-col function to add columns for the
fragment id or graph iri.pattern - the pattern values for the sequence See
pattern(PlanTriplePositionSeq, PlanTriplePositionSeq,
PlanTriplePositionSeq, PlanSystemColumnSeq)subject - the subject values for the sequencepredicate - the predicate values for the
sequenceobject - the object values for the sequenceindexes - An object in which each key is a column
name and each value specifies a cts:reference for a range index or
other lexicon (especially the cts:uri-reference lexicon) with the
column values.indexes - An object in which each key is a column
name and each value specifies a cts:reference for a range index or
other lexicon (especially the cts:uri-reference lexicon) with the
column values.qualifierName - Specifies a name for qualifying
the column names. By default, lexicon rows have no qualification.
Use cases for the qualifier include self joins. Using an empty
string removes all qualification from the column names.indexes - An object in which each key is a column
name and each value specifies a cts:reference for a range index or
other lexicon (especially the cts:uri-reference lexicon) with the
column values.qualifierName - Specifies a name for qualifying
the column names. By default, lexicon rows have no qualification.
Use cases for the qualifier include self joins. Using an empty
string removes all qualification from the column names.indexes - An object in which each key is a column
name and each value specifies a cts:reference for a range index or
other lexicon (especially the cts:uri-reference lexicon) with the
column values.qualifierName - Specifies a name for qualifying
the column names. By default, lexicon rows have no qualification.
Use cases for the qualifier include self joins. Using an empty
string removes all qualification from the column names.sysCols - An optional named fragment id column
returned by the op:fragment-id-col function. The fragment id column
can be used for joins.indexes - An object in which each key is a column
name and each value specifies a cts:reference for a range index or
other lexicon (especially the cts:uri-reference lexicon) with the
column values.qualifierName - Specifies a name for qualifying
the column names. By default, lexicon rows have no qualification.
Use cases for the qualifier include self joins. Using an empty
string removes all qualification from the column names.sysCols - An optional named fragment id column
returned by the op:fragment-id-col function. The fragment id column
can be used for joins.select - A SPARQL SELECT query expressed as a
string.select - A SPARQL SELECT query expressed as a
string.select - A SPARQL SELECT query expressed as a
string.qualifierName - Specifies a name for qualifying
the column names. An "@" in front of the name specifies a parameter
placeholder. A parameter placeholder in the SPARQL string must be
bound to a parameter value in the result() call.select - A SPARQL SELECT query expressed as a
string.qualifierName - Specifies a name for qualifying
the column names. An "@" in front of the name specifies a parameter
placeholder. A parameter placeholder in the SPARQL string must be
bound to a parameter value in the result() call.select - A SPARQL SELECT query expressed as a
string.qualifierName - Specifies a name for qualifying
the column names. An "@" in front of the name specifies a parameter
placeholder. A parameter placeholder in the SPARQL string must be
bound to a parameter value in the result() call.option - Options consisting of key-value pairs
that set options. At present, the options consist of dedup and
base. Option dedup can take an on|off value to enable or disable
deduplication. Deduplication is off by default. Option base takes a
string as the initial base IRI for the query.select - A SPARQL SELECT query expressed as a
string.qualifierName - Specifies a name for qualifying
the column names. An "@" in front of the name specifies a parameter
placeholder. A parameter placeholder in the SPARQL string must be
bound to a parameter value in the result() call.option - Options consisting of key-value pairs
that set options. At present, the options consist of dedup and
base. Option dedup can take an on|off value to enable or disable
deduplication. Deduplication is off by default. Option base takes a
string as the initial base IRI for the query.select - A SQL SELECT query expressed as a
string.select - A SQL SELECT query expressed as a
string.select - A SQL SELECT query expressed as a
string.qualifierName - Specifies a name for qualifying
the column names. Placeholder parameters in the SQL string may be
bound in the result() callselect - A SQL SELECT query expressed as a
string.qualifierName - Specifies a name for qualifying
the column names. Placeholder parameters in the SQL string may be
bound in the result() callparamName - The paramName parameter specifies the
placeholder parameter supplying the rows.qualifier - Specifies a name for qualifying the
column names.rowColTypes - Describes the columns with a
sequence of maps. It's a combinations of column, type and nullable.
The 'column' is the column name, which is required. The 'type' is
the optional type of the column, which can be an atomic type or the
default of none. The 'nullable' is an optional boolean defaulting
to false. If your rows contains only uri, doc, collections,
metadata, permissions, quality and temporalCollection columns, you
could simply use op:doc-col-types instead.paramName - The paramName parameter specifies the
placeholder parameter supplying the rows.qualifier - Specifies a name for qualifying the
column names.rowColTypes - Describes the columns with a
sequence of maps. It's a combinations of column, type and nullable.
The 'column' is the column name, which is required. The 'type' is
the optional type of the column, which can be an atomic type or the
default of none. The 'nullable' is an optional boolean defaulting
to false. If your rows contains only uri, doc, collections,
metadata, permissions, quality and temporalCollection columns, you
could simply use op:doc-col-types instead.docDescriptor - A map of document descriptors.
Each document descriptor describes a document. A document
descriptor contains a combination of uri, doc, collections,
metadata, permissions, quality and temporalCollection. This is a
simpler form of op:from-param.docDescriptor - A map of document descriptors.
Each document descriptor describes a document. A document
descriptor contains a combination of uri, doc, collections,
metadata, permissions, quality and temporalCollection. This is a
simpler form of op:from-param.docDescriptor - A map of document descriptors.
Each document descriptor describes a document. A document
descriptor contains a combination of uri, doc, collections,
metadata, permissions, quality and temporalCollection. This is a
simpler form of op:from-param.qualifier - Specifies a name for qualifying the
column names.docDescriptor - A map of document descriptors.
Each document descriptor describes a document. A document
descriptor contains a combination of uri, doc, collections,
metadata, permissions, quality and temporalCollection. This is a
simpler form of op:from-param.qualifier - Specifies a name for qualifying the
column names.expression - A boolean expression, such as op:eq
or op:not, that might be null.expression - A boolean expression, such as op:eq
or op:not, that might be null.left - The rows from the left view. See col(XsStringVal)right - The row set from the right view. See
col(XsStringVal)left - The rows from the left view. See col(XsStringVal)right - The row set from the right view. See
col(XsStringVal)key - the key values for the sequence See
on(PlanExprCol, PlanExprCol)keys - The columns (if any) to use as grouping
keys. The columns can be named with a string or a column parameter
function such as op:col or constructed from an expression with
op:as. See colSeq(PlanExprCol...)keys - The columns to use as grouping keys. The
columns can be named with a string or a column parameter function
such as op:col or constructed from an expression with op:as. See
colSeq(PlanExprCol...)keys - The columns to use as grouping keys. The
columns can be named with a string or a column parameter function
such as op:col or constructed from an expression with op:as. See
colSeq(PlanExprCol...)namedGroup in
interface PlanBuilderBasename - The name for the list of grouping
keys.name - The name for the list of grouping
keys.name - The name for the list of grouping
keys.keys - The columns (if any) to use as grouping
keys. The columns can be named with a string or a column parameter
function such as op:col or constructed from an expression with
op:as. See colSeq(PlanExprCol...)name - The name for the list of grouping
keys.keys - The columns (if any) to use as grouping
keys. The columns can be named with a string or a column parameter
function such as op:col or constructed from an expression with
op:as. See colSeq(PlanExprCol...)name - The name of both the group and the new
grouping key column with numbered buckets.key - The identifier for the existing column with
the values (typically numeric or datetime) to put into buckets. The
columns can be named with a string or a column parameter function
such as op:col or constructed from an expression with op:as. See
col(XsStringVal)boundaries - An ordered XQuery sequence of values
that specify the boundaries between buckets. The values must have
the same type as the existing column.name - The name of both the group and the new
grouping key column with numbered buckets.key - The identifier for the existing column with
the values (typically numeric or datetime) to put into buckets. The
columns can be named with a string or a column parameter function
such as op:col or constructed from an expression with op:as. See
col(XsStringVal)boundaries - An ordered XQuery sequence of values
that specify the boundaries between buckets. The values must have
the same type as the existing column.name - The name of both the group and the new
grouping key column with numbered buckets.key - The identifier for the existing column with
the values (typically numeric or datetime) to put into buckets. The
columns can be named with a string or a column parameter function
such as op:col or constructed from an expression with op:as. See
col(XsStringVal)boundaries - An ordered XQuery sequence of values
that specify the boundaries between buckets. The values must have
the same type as the existing column.collation - The collation to use when comparing
strings as described in 'Collation URI Syntax' in the Application
Developer's Guidename - The name of both the group and the new
grouping key column with numbered buckets.key - The identifier for the existing column with
the values (typically numeric or datetime) to put into buckets. The
columns can be named with a string or a column parameter function
such as op:col or constructed from an expression with op:as. See
col(XsStringVal)boundaries - An ordered XQuery sequence of values
that specify the boundaries between buckets. The values must have
the same type as the existing column.collation - The collation to use when comparing
strings as described in 'Collation URI Syntax' in the Application
Developer's Guidename - The name to be used for the aggregated
column. See col(XsStringVal)column - The column to be aggregated. See col(XsStringVal)name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column to be aggregated. See col(XsStringVal)name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column to be aggregated. See col(XsStringVal)option - The options can take a values key with a
'distinct' value to average the distinct values of the column.name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column to be aggregated. See col(XsStringVal)option - The options can take a values key with a
'distinct' value to average the distinct values of the column.name - The name to be used for the aggregated
column. See col(XsStringVal)column - The columns to be aggregated. See
col(XsStringVal)name - The name to be used for the aggregated
column. See col(XsStringVal)column - The columns to be aggregated. See
col(XsStringVal)name - The name to be used for the aggregated
column. See col(XsStringVal)column - The columns to be aggregated. See
col(XsStringVal)option - The options can take a values key with a
'distinct' value to aggregate the distinct values of the
column.name - The name to be used for the aggregated
column. See col(XsStringVal)column - The columns to be aggregated. See
col(XsStringVal)option - The options can take a values key with a
'distinct' value to aggregate the distinct values of the
column.name - The name to be used for the column values.
See col(XsStringVal)name - The name to be used for the column values.
See col(XsStringVal)name - The name to be used for the column values.
See col(XsStringVal)column - The columns to be counted. See col(XsStringVal)name - The name to be used for the column values.
See col(XsStringVal)column - The columns to be counted. See col(XsStringVal)name - The name to be used for the column values.
See col(XsStringVal)column - The columns to be counted. See col(XsStringVal)option - The options can take a values key with a
'distinct' value to count the distinct values of the column.name - The name to be used for the column values.
See col(XsStringVal)column - The columns to be counted. See col(XsStringVal)option - The options can take a values key with a
'distinct' value to count the distinct values of the column.name - The name to be used for the aggregated flag
column. See col(XsStringVal)column - The column to flag as a grouping key. The
column can be named with a string or a column parameter function
such as op:col or constructed from an expression with op:as. See
col(XsStringVal)name - The name to be used for the aggregated flag
column. See col(XsStringVal)column - The column to flag as a grouping key. The
column can be named with a string or a column parameter function
such as op:col or constructed from an expression with op:as. See
col(XsStringVal)name - The name to be used for the largest value.
See col(XsStringVal)column - The group or row set. See col(XsStringVal)name - The name to be used for the largest value.
See col(XsStringVal)column - The group or row set. See col(XsStringVal)name - The name to be used for the largest value.
See col(XsStringVal)column - The group or row set. See col(XsStringVal)option - the option value.name - The name to be used for the largest value.
See col(XsStringVal)column - The group or row set. See col(XsStringVal)option - the option value.name - The name to be used for the smallest value.
See col(XsStringVal)column - The group or row set. See col(XsStringVal)name - The name to be used for the smallest value.
See col(XsStringVal)column - The group or row set. See col(XsStringVal)name - The name to be used for the smallest value.
See col(XsStringVal)column - The group or row set. See col(XsStringVal)option - the option value.name - The name to be used for the smallest value.
See col(XsStringVal)column - The group or row set. See col(XsStringVal)option - the option value.name - The name to be used for the value. See
col(XsStringVal)column - The group or row set. See col(XsStringVal)name - The name to be used for the value. See
col(XsStringVal)column - The group or row set. See col(XsStringVal)name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column with the values to aggregate.
See col(XsStringVal)name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column with the values to aggregate.
See col(XsStringVal)name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column with the values to aggregate.
See col(XsStringVal)option - The options can take a values key with a
'distinct' value to aggregate the distinct values of the
column.name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column with the values to aggregate.
See col(XsStringVal)option - The options can take a values key with a
'distinct' value to aggregate the distinct values of the
column.name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column with the values to add. See
col(XsStringVal)name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column with the values to add. See
col(XsStringVal)name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column with the values to add. See
col(XsStringVal)option - The options can take a values key with a
'distinct' value to sum the distinct values of the column.name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column with the values to add. See
col(XsStringVal)option - The options can take a values key with a
'distinct' value to sum the distinct values of the column.name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column with the values to aggregate.
See col(XsStringVal)module - The path to the installed plugin
module.function - The name of the UDF function.name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column with the values to aggregate.
See col(XsStringVal)module - The path to the installed plugin
module.function - The name of the UDF function.name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column with the values to aggregate.
See col(XsStringVal)module - The path to the installed plugin
module.function - The name of the UDF function.arg - The options can take a values key with a
'distinct' value to aggregate the distinct values of the column and
an arg key specifying an argument for the user-defined aggregate.
The value can be a string or placeholder parameter.name - The name to be used for the aggregated
column. See col(XsStringVal)column - The column with the values to aggregate.
See col(XsStringVal)module - The path to the installed plugin
module.function - The name of the UDF function.arg - The options can take a values key with a
'distinct' value to aggregate the distinct values of the column and
an arg key specifying an argument for the user-defined aggregate.
The value can be a string or placeholder parameter.aggregate - the aggregate values for the
sequencecolumn - The column by which order the output. See
col(XsStringVal)column - The column by which order the output. See
col(XsStringVal)column - The column by which order the output. See
col(XsStringVal)column - The column by which order the output. See
col(XsStringVal)key - the key values for the sequence See desc(PlanExprCol)Provides a client interface to the op:modulo server function.
left - The dividend numeric expression. (of
xs:numeric)right - The divisor numeric expression. (of
xs:numeric)Provides a client interface to the op:modulo server function.
left - The dividend numeric expression. (of
xs:numeric)right - The divisor numeric expression. (of
xs:numeric)condition - A boolean expression. (of xs:boolean)value - The value expression to return if the
boolean expression is true. (of item)condition - A boolean expression. (of xs:boolean)value - The value expression to return if the
boolean expression is true. (of item)Provides a client interface to the op:xpath server function.
column - The name of the column from which to
extract the child nodes. See col(XsStringVal)path - An XPath (specified as a string) to apply
to each node. (of xs:string)Provides a client interface to the op:xpath server function.
column - The name of the column from which to
extract the child nodes. See col(XsStringVal)path - An XPath (specified as a string) to apply
to each node. (of xs:string)Provides a client interface to the op:xpath server function.
column - The name of the column from which to
extract the child nodes. See col(XsStringVal)path - An XPath (specified as a string) to apply
to each node. (of xs:string)namespaceBindings - A map of namespace bindings.
The keys should be namespace prefixes and the values should be
namespace URIs. These namespace bindings will be added to the
in-scope namespace bindings in the evaluation of the path.Provides a client interface to the op:xpath server function.
column - The name of the column from which to
extract the child nodes. See col(XsStringVal)path - An XPath (specified as a string) to apply
to each node. (of xs:string)namespaceBindings - A map of namespace bindings.
The keys should be namespace prefixes and the values should be
namespace URIs. These namespace bindings will be added to the
in-scope namespace bindings in the evaluation of the path.Provides a client interface to the op:xpath server function.
Provides a client interface to the op:xpath server function.
Provides a client interface to the op:json-document server function.
root - The JSON object or array node used to
construct the JSON document. (of json-root-node)key - The key expression. This must evaluate to a
string. (of xs:string)value - The value content. This must be exactly
one JSON node expression. (of json-content-node)key - The key expression. This must evaluate to a
string. (of xs:string)value - The value content. This must be exactly
one JSON node expression. (of json-content-node)Provides a client interface to the op:json-string server function.
value - The value of the JSON text node. (of
xs:anyAtomicType)Provides a client interface to the op:json-string server function.
value - The value of the JSON text node. (of
xs:anyAtomicType)Provides a client interface to the op:json-number server function.
value - The value of the JSON number node. (of
xs:numeric)Provides a client interface to the op:json-number server function.
value - The value of the JSON number node. (of
xs:numeric)Provides a client interface to the op:json-boolean server function.
value - The value of the JSON boolean node. (of
xs:boolean)Provides a client interface to the op:json-boolean server function.
value - The value of the JSON boolean node. (of
xs:boolean)Provides a client interface to the op:json-null server function.
Provides a client interface to the op:xml-document server function.
root - The XML node used to construct the XML
document. (of xml-root-node)Provides a client interface to the op:xml-element server function.
name - The string or QName for the constructed
element. (of xs:QName)Provides a client interface to the op:xml-element server function.
name - The string or QName for the constructed
element. (of xs:QName)Provides a client interface to the op:xml-element server function.
name - The string or QName for the constructed
element. (of xs:QName)attributes - Any element attributes returned from
op:xml-attribute, or null if no attributes. (of attribute-node)Provides a client interface to the op:xml-element server function.
name - The string or QName for the constructed
element. (of xs:QName)attributes - Any element attributes returned from
op:xml-attribute, or null if no attributes. (of attribute-node)Provides a client interface to the op:xml-element server function.
name - The string or QName for the constructed
element. (of xs:QName)attributes - Any element attributes returned from
op:xml-attribute, or null if no attributes. (of attribute-node)content - A sequence or array of atomic values or
an element, a comment from op:xml-comment, or processing
instruction nodes from op:xml-pi. (of xml-content-node)Provides a client interface to the op:xml-element server function.
name - The string or QName for the constructed
element. (of xs:QName)attributes - Any element attributes returned from
op:xml-attribute, or null if no attributes. (of attribute-node)content - A sequence or array of atomic values or
an element, a comment from op:xml-comment, or processing
instruction nodes from op:xml-pi. (of xml-content-node)Provides a client interface to the op:xml-attribute server function.
name - The attribute name. (of xs:QName)value - The attribute value. (of xs:anyAtomicType)Provides a client interface to the op:xml-attribute server function.
name - The attribute name. (of xs:QName)value - The attribute value. (of xs:anyAtomicType)Provides a client interface to the op:xml-text server function.
value - The value of the XML text node. (of
xs:anyAtomicType)Provides a client interface to the op:xml-text server function.
value - The value of the XML text node. (of
xs:anyAtomicType)Provides a client interface to the op:xml-comment server function.
content - The comment text. (of xs:anyAtomicType)Provides a client interface to the op:xml-comment server function.
content - The comment text. (of xs:anyAtomicType)Provides a client interface to the op:xml-pi server function.
name - The name of the processing instruction. (of
xs:string)value - The value of the processing instruction.
(of xs:anyAtomicType)Provides a client interface to the op:xml-pi server function.
name - The name of the processing instruction. (of
xs:string)value - The value of the processing instruction.
(of xs:anyAtomicType)functionName - the name of the function installed
on the servermodulePath - the path on the server for the
library module providing the functionfunctionName - the name of the function installed
on the servermodulePath - the path on the server for the
library module providing the functionqualifier - Specifies a name for qualifying the
column names.qualifier - Specifies a name for qualifying the
column names.qualifier - Specifies a name for qualifying the
column names.names - A sequence of columns names, a combination
of uri, doc, collections, metadata, permissions, quality and
temporalCollection.qualifier - Specifies a name for qualifying the
column names.names - A sequence of columns names, a combination
of uri, doc, collections, metadata, permissions, quality and
temporalCollection.Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.