| Package | Description |
|---|---|
| com.marklogic.client.expression |
The package provides classes for building Optic plan pipelines and expressions
for execution on the REST server.
|
| com.marklogic.client.type |
The package provides interfaces specifying the type of an expression or
value as passed to a
PlanBuilder method
or returned from a RowRecord method. |
| Modifier and Type | Method | Description |
|---|---|---|
XsStringVal |
XsValue.string(java.lang.String value) |
Takes a String literal and constructs an xs:string value
|
| Modifier and Type | Method | Description |
|---|---|---|
abstract PlanNamedGroup |
PlanBuilder.bucketGroup(XsStringVal name,
PlanExprCol key,
XsAnyAtomicTypeSeqVal boundaries) |
This function can be used as a named group in functions op:group-to-arrays or op:facet-by.
|
abstract PlanNamedGroup |
PlanBuilder.bucketGroup(XsStringVal name,
PlanExprCol key,
XsAnyAtomicTypeSeqVal boundaries,
XsStringVal collation) |
This function can be used as a named group in functions op:group-to-arrays or op:facet-by.
|
PlanColumn |
PlanBuilder.AccessPlan.col(XsStringVal column) |
This method identifies a column, where the column name is unique.
|
abstract PlanColumn |
PlanBuilder.col(XsStringVal column) |
This method identifies a column, where the column name is unique.
|
abstract PlanSystemColumn |
PlanBuilder.fragmentIdCol(XsStringVal column) |
Specifies a name for adding a fragment id column to the row set identifying the source documents for the rows from a view, lexicons or triples.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromLexicons(java.util.Map<java.lang.String,CtsReferenceExpr> indexes,
XsStringVal qualifierName) |
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromLexicons(java.util.Map<java.lang.String,CtsReferenceExpr> indexes,
XsStringVal qualifierName,
PlanSystemColumn sysCols) |
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
PlanBuilder.AccessPlan |
PlanBuilderBase.fromLiterals(java.util.Map<java.lang.String,java.lang.Object>[] rows,
XsStringVal qualifierName) |
Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements.
|
PlanBuilder.AccessPlan |
PlanBuilderBase.fromSearch(CtsQueryExpr query,
PlanExprColSeq columns,
XsStringVal qualifierName,
PlanSearchOptions options) |
Supports document matching and relevance by constructing rows with the document fragment id and
columns for relevance factors.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSparql(XsStringVal select) |
This function dynamically constructs a row set based on a SPARQL SELECT query from triples.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSparql(XsStringVal select,
XsStringVal qualifierName) |
This function dynamically constructs a row set based on a SPARQL SELECT query from triples.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSparql(XsStringVal select,
XsStringVal qualifierName,
PlanSparqlOptions option) |
This function dynamically constructs a row set based on a SPARQL SELECT query from triples.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSql(XsStringVal select) |
This function dynamically constructs a row set based on a SQL SELECT query from views.
|
abstract PlanBuilder.ModifyPlan |
PlanBuilder.fromSql(XsStringVal select,
XsStringVal qualifierName) |
This function dynamically constructs a row set based on a SQL SELECT query from views.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromTriples(PlanTriplePatternSeq patterns,
XsStringVal qualifierName) |
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromTriples(PlanTriplePatternSeq patterns,
XsStringVal qualifierName,
XsStringSeqVal graphIris) |
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromTriples(PlanTriplePatternSeq patterns,
XsStringVal qualifierName,
XsStringSeqVal graphIris,
PlanTripleOption option) |
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromView(XsStringVal schema,
XsStringVal view) |
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromView(XsStringVal schema,
XsStringVal view,
XsStringVal qualifierName) |
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
|
abstract PlanBuilder.AccessPlan |
PlanBuilder.fromView(XsStringVal schema,
XsStringVal view,
XsStringVal qualifierName,
PlanSystemColumn sysCols) |
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
|
abstract PlanSystemColumn |
PlanBuilder.graphCol(XsStringVal column) |
Identifies the graph for a triple providing one or more columns for a row.
|
abstract PlanNamedGroup |
PlanBuilder.namedGroup(XsStringVal name) |
This function specifies the grouping keys for a group as a named list of zero or more columns.
|
abstract PlanNamedGroup |
PlanBuilder.namedGroup(XsStringVal name,
PlanExprColSeq keys) |
This function specifies the grouping keys for a group as a named list of zero or more columns.
|
abstract PlanParamExpr |
PlanBuilder.param(XsStringVal name) |
This function creates a placeholder for a literal value in an expression or as the offset or max for a limit.
|
abstract PlanPrefixer |
PlanBuilder.prefixer(XsStringVal base) |
This function factory returns a new function that takes a name parameter and returns a sem:iri, prepending the specified base URI onto the name.
|
abstract PlanFunction |
PlanBuilder.resolveFunction(XsQNameVal functionName,
XsStringVal modulePath) |
Specifies a JavaScript or XQuery function installed on the server for use in post-processing in a map() or reduce() operation.
|
abstract PlanColumn |
PlanBuilder.schemaCol(XsStringVal schema,
XsStringVal view,
XsStringVal column) |
Unambiguously identifies a column with the schema name, view name, and column name.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.select(PlanExprColSeq columns,
XsStringVal qualifierName) |
This call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set.
|
abstract PlanCondition |
PlanBuilder.sqlCondition(XsStringVal expression) |
This function returns a filter definition as input for a WHERE operation.
|
XsStringSeqVal |
XsValue.stringSeq(XsStringVal... values) |
Takes any number of xs:string values and constructs an xs:string sequence
|
abstract PlanAggregateCol |
PlanBuilder.uda(PlanColumn name,
PlanExprCol column,
XsStringVal module,
XsStringVal function) |
This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin.
|
abstract PlanAggregateCol |
PlanBuilder.uda(PlanColumn name,
PlanExprCol column,
XsStringVal module,
XsStringVal function,
XsAnyAtomicTypeVal arg) |
This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin.
|
abstract PlanColumn |
PlanBuilder.viewCol(XsStringVal view,
XsStringVal column) |
Identifies a column where the combination of view and column name is unique.
|
| Modifier and Type | Interface | Description |
|---|---|---|
interface |
RdfLangStringVal |
A sequence of RDF language string values.
|
| Modifier and Type | Method | Description |
|---|---|---|
XsStringVal |
PlanSparqlOptions.getBase() |
|
XsStringVal[] |
XsStringSeqVal.getStringItems() |
| Modifier and Type | Method | Description |
|---|---|---|
SemIriVal |
PlanPrefixer.iri(XsStringVal name) |
|
PlanSparqlOptions |
PlanSparqlOptions.withBase(XsStringVal base) |
Copyright © 2013-2021 MarkLogic Corporation.