Loading TOC...

JavaScript Functions By Category (1766)

The following table lists all Server-Side JavaScript functions in the MarkLogic API reference, including all built-in functions available to JavaScript.
1761 functions
Function nameDescription
AccessPlan.prototype.colThis method identifies a column, where the column name is unique.
AccessPlan.prototype.exceptThis method restricts the left row set to rows where a row with the same columns and values doesn't exist in the right row set.
AccessPlan.prototype.explainThis method returns a representation of the builtin execution plan.
AccessPlan.prototype.exportThis method generates a serialized representation of the Optic query to JSON so that it can be persisted as a file or used as a REST payload.
AccessPlan.prototype.groupByThis method collapses a group of rows into a single row.
AccessPlan.prototype.intersectThis method restricts the left row set to rows where a row with the same columns and values exists in the right row set.
AccessPlan.prototype.joinCrossProductThis method yields one output row set that concatenates every left row with every right row.
AccessPlan.prototype.joinDocThis function specifies a document column to add to the rows by reading the documents for an existing source column having a value of a document uri (which can be used to read other documents) or a fragment id (which can be used to read the source documents for rows).
AccessPlan.prototype.joinDocUriThis method adds a uri column to rows based on an existing fragment id column to identify the source document for each row.
AccessPlan.prototype.joinInnerThis method returns all rows from multiple tables where the join condition is met.
AccessPlan.prototype.joinLeftOuterThis method yields one output row set with the rows from an inner join as well as rows from the left row set.
AccessPlan.prototype.limitThis method returns the specified number of rows in the result set.
AccessPlan.prototype.mapThis method applies the specified function to each row returned by the plan to produce a different result row.
AccessPlan.prototype.offsetThis method returns a subset of the rows in the result set by skipping the number of rows specified by start and returning the remaining rows up to the number specified by the prototype.limit method.
AccessPlan.prototype.offsetLimitThis method returns a subset of the rows in the result set by skipping the number of rows specified by start and returning the remaining rows up to the length limit.
AccessPlan.prototype.orderByThis method sorts the row set by the specified order definition.
AccessPlan.prototype.prepareThis method prepares the specified plan for execution as an optional final step before execution.
AccessPlan.prototype.reduceThis method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array.
AccessPlan.prototype.resultThis method executes the plan (mapping or reducing, if specified) to generate the result, which is a plan, document plan, prepared plan, or map or reduce result plan.
AccessPlan.prototype.selectThis call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set.
AccessPlan.prototype.unionThis method yields all of the rows from the input row sets.
AccessPlan.prototype.whereThis method restricts the row set to rows matched by the boolean expression.
AccessPlan.prototype.whereDistinctThis method removes duplicate rows from the row set.
alert.actionGetDescriptionThis function returns the description of a given action.
alert.actionGetModuleThis function returns the module of a given action.
alert.actionGetModuleDbThis function returns the module database of a given action.
alert.actionGetModuleRootThis function returns the module root of a given action.
alert.actionGetNameThis function returns the name of a given action.
alert.actionGetOptionsThis function returns the options of a given action.
alert.actionInsertThis function inserts the specified action into the collection.
alert.actionRemoveThis function removes the named action from the database or throws an exception if the action does not exist.
alert.actionSetDescriptionThis function returns the action with the description of the action updated.
alert.actionSetModuleThis function returns the action with the module of the action updated.
alert.actionSetModuleDbThis function sets the module database of a given action.
alert.actionSetModuleRootThis function sets the module root of a given action.
alert.actionSetNameThis function returns the action with the name of the action updated.
alert.actionSetOptionsThis function returns the action with the options of the action updated.
alert.configDeleteRemove an alerting configuration identified by the specified URI.
alert.configGetGets the config associated with the specified URI.
alert.configGetCpfDomainNamesThis function returns the CPF domain names set in the specified alerting configuration.
alert.configGetDescriptionThis function provides returns the description set in the specified alerting configuration.
alert.configGetIdThis function returns the ID of the specified alerting configuration.
alert.configGetNameThis function returns the name set in the specified an alerting configuration.
alert.configGetOptionsThis function returns the options set in specified alerting configuration.
alert.configGetTriggerIdsThis function returns the trigger IDs set in the specified alerting configuration.
alert.configGetUriThis function returns the URI set in the specified alerting configuration.
alert.configInsertInserts a config into the database.
alert.configSetCpfDomainNamesThis function sets the CPF domain names in the specified alerting configuration.
alert.configSetDescriptionThis function sets the description within the specified alerting configuration.
alert.configSetNameThis function sets the name in the specified alerting configuration.
alert.configSetOptionsThis function sets the options in the specified alerting configuration.
alert.configSetTriggerIdsThis function sets the trigger IDs in the specified alerting configuration.
alert.createTriggersCreate triggers that invoke the standard alerting trigger module.
alert.findMatchingRulesReturns a list of all rules associated with the specified config that match the specified document.
alert.getActionsThis function retrieves all the named actions in the specified config URI.
alert.getAllRulesThis function returns all rules visible to the current user.
alert.getMyRulesThis function returns all rules associated with the current user.
alert.invokeMatchingActionsFinds the rules that match the specified document and invokes their associated actions.
alert.makeActionThis function creates the specified action.
alert.makeConfigCreate an alerting configuration associated with a particular URI.
alert.makeLogActionCreate a standard logging action named "log".
alert.makeRuleThis function creates the specified rule.
alert.removeTriggersRemove triggers whose IDs are listed in the config.
alert.ruleActionQueryThis function creates a query to find rules with any of the specified actions.
alert.ruleGetActionThis function returns the action of a given rule.
alert.ruleGetDescriptionThis function returns the description of a given rule.
alert.ruleGetIdThis function returns the ID of a given rule.
alert.ruleGetNameThis function returns the name of a given rule.
alert.ruleGetOptionsThis function returns the options of a given rule.
alert.ruleGetQueryGet the cts.query corresponding to the rule's query expression.
alert.ruleGetUserIdThis function returns the user ID of a given rule.
alert.ruleIdQueryThis function creates a query to find rules with any of the specified IDs.
alert.ruleInsertThis function inserts rule into the database associated with the specified alerting configuration.
alert.ruleNameQueryThis function creates a query to find rules with any of the specified names.
alert.ruleRemoveThis function removes the specified rule from the collection.
alert.ruleSetActionThis function returns the rule with the action updated.
alert.ruleSetDescriptionThis function returns the rule with the description of the rule updated.
alert.ruleSetNameThis function returns the rule with the name of the rule updated.
alert.ruleSetOptionsThis function returns the rule with the options of the rule updated.
alert.ruleSetQuerySet the cts:query corresponding to the rule's query expression.
alert.ruleSetUserIdThis function returns the rule with the user ID updated.
alert.ruleUserIdQueryThis function creates a query to find rules with any of the specified user IDs.
alert.spawnMatchingActionsFinds the rules that match the specified document and spawns their associated actions.
ArrayNode.baseURIThis is inherited from the Node object. Returns a string representing the base URI of the node.
ArrayNode.lengthLength property on ArrayNode
ArrayNode.nodeKindThis is inherited from the Node object. Return a string indicating the type of the node.
ArrayNode.nodeTypeThis is inherited from the Node object. Return the DOM code indicating the type of the node.
ArrayNode.xpathThis is inherited from the Node object. Evaluate an XPath using the node as context.
Attr.attributesThis is inherited from the XMLNode object. The attributes of this node.
Attr.childNodesThis is inherited from the XMLNode object. The children of this node.
Attr.firstChildThis is inherited from the XMLNode object. The first child of this node, if any.
Attr.hasAttributesThis is inherited from the XMLNode object. Whether this node has attributes.
Attr.hasChildNodesThis is inherited from the XMLNode object. Whether this node has any children.
Attr.isEqualNodeThis is inherited from the XMLNode object. Whether this node is equal to another node.
Attr.isIdWhether this is an ID attribute.
Attr.isSameNodeThis is inherited from the XMLNode object. Whether this node is the same exact node as another node.
Attr.isSpecifiedWhether this attribute is specified explicitly or was defaulted from a schema.
Attr.lastChildThis is inherited from the XMLNode object. The last child of this node, if any.
Attr.localNameThis is inherited from the XMLNode object. Return the local name of this node.
Attr.namespaceURIThis is inherited from the XMLNode object. Return the namespace URI of this node.
Attr.nextSiblingThis is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any.
Attr.nodeNameThis is inherited from the XMLNode object. The DOM name of the node.
Attr.nodeValueThis is inherited from the XMLNode object. The DOM value of the node.
Attr.ownerDocumentThis is inherited from the XMLNode object. The document node containing this node, if any.
Attr.ownerElementThe element that contains this attribute.
Attr.parentNodeThis is inherited from the XMLNode object. The node that is this node's parent.
Attr.prefixThis is inherited from the XMLNode object. Return the namespace prefix of this node.
Attr.previousSiblingThis is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any.
Attr.textContentThis is inherited from the XMLNode object. The DOM text value of the node.
BinaryNode.baseURIThis is inherited from the Node object. Returns a string representing the base URI of the node.
BinaryNode.nodeKindThis is inherited from the Node object. Return a string indicating the type of the node.
BinaryNode.nodeTypeThis is inherited from the Node object. Return the DOM code indicating the type of the node.
BinaryNode.xpathThis is inherited from the Node object. Evaluate an XPath using the node as context.
BooleanNode.baseURIThis is inherited from the Node object. Returns a string representing the base URI of the node.
BooleanNode.nodeKindThis is inherited from the Node object. Return a string indicating the type of the node.
BooleanNode.nodeTypeThis is inherited from the Node object. Return the DOM code indicating the type of the node.
BooleanNode.xpathThis is inherited from the Node object. Evaluate an XPath using the node as context.
cdict.dictionaryDeleteDelete a custom dictionary.
cdict.dictionaryReadRetrieve the custom dictionary for a language.
cdict.dictionaryWriteInsert or update a custom dictionary for language.
cdict.getLanguagesReturn the ISO language codes for all licensed languages.
CharacterData.attributesThis is inherited from the XMLNode object. The attributes of this node.
CharacterData.childNodesThis is inherited from the XMLNode object. The children of this node.
CharacterData.dataThe character data.
CharacterData.firstChildThis is inherited from the XMLNode object. The first child of this node, if any.
CharacterData.hasAttributesThis is inherited from the XMLNode object. Whether this node has attributes.
CharacterData.hasChildNodesThis is inherited from the XMLNode object. Whether this node has any children.
CharacterData.isElementContentWhitespaceWhether this text node is ignorable whitespace.
CharacterData.isEqualNodeThis is inherited from the XMLNode object. Whether this node is equal to another node.
CharacterData.isSameNodeThis is inherited from the XMLNode object. Whether this node is the same exact node as another node.
CharacterData.lastChildThis is inherited from the XMLNode object. The last child of this node, if any.
CharacterData.lengthThe length of the character data (codepoints).
CharacterData.localNameThis is inherited from the XMLNode object. Return the local name of this node.
CharacterData.namespaceURIThis is inherited from the XMLNode object. Return the namespace URI of this node.
CharacterData.nextSiblingThis is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any.
CharacterData.nodeNameThis is inherited from the XMLNode object. The DOM name of the node.
CharacterData.nodeValueThis is inherited from the XMLNode object. The DOM value of the node.
CharacterData.ownerDocumentThis is inherited from the XMLNode object. The document node containing this node, if any.
CharacterData.parentNodeThis is inherited from the XMLNode object. The node that is this node's parent.
CharacterData.prefixThis is inherited from the XMLNode object. Return the namespace prefix of this node.
CharacterData.previousSiblingThis is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any.
CharacterData.substringA substring of the character data, starting at a given offset and continuing for a given length.
CharacterData.textContentThis is inherited from the XMLNode object. The DOM text value of the node.
CharacterData.wholeTextThe text of the text node concatenated with its logically adjacent text nodes.
clang.deleteUserLanguageThis function returns user languages configuration with any existing configuration item for a given language removed.
clang.languageConfigDeleteThis function removes all custom language configuration from the cluster configuration files.
clang.languageConfigReadThis function reads the custom language configuration specification from the cluster configuration files.
clang.languageConfigWriteThis function saves a custom language configuration specification to the cluster configuration files.
clang.lexerThis function constructs a custom lexer configuration item, suitable for use with clang.userLanguagePlugin.
clang.stemmerThis function constructs a custom stemmer configuration item, suitable for use with clang.userLanguagePlugin.
clang.updateUserLanguageAdd or replace a configuration item for a language in the given language configuration item, and return the new configuration.
clang.userLanguageThis function constructs a user language configuration item, suitable for use with clang.languageConfigUpdate.
clang.userLanguagePluginThis function constructs a user language plugin configuration item, suitable for use with clang.userLanguage.
Comment.dataThis is inherited from the CharacterData object. The character data.
Comment.isElementContentWhitespaceThis is inherited from the CharacterData object. Whether this text node is ignorable whitespace.
Comment.lengthThis is inherited from the CharacterData object. The length of the character data (codepoints).
Comment.substringThis is inherited from the CharacterData object. A substring of the character data, starting at a given offset and continuing for a given length.
Comment.wholeTextThis is inherited from the CharacterData object. The text of the text node concatenated with its logically adjacent text nodes.
console.assertIf value is true, do nothing.
console.debugLogs a debug-level message to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server.
console.dirLogs an object to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server.
console.errorLogs an error-level message to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server.
console.logLogs an info-level message to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server.
console.traceLogs a message and the JavaScript stack trace to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server.
console.warnLogs a warning-level message to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server.
cts.aggregateExecutes a user-defined extension aggregate function against a value lexicon or n-way co-occurence of multiple value lexicons.
cts.andNotQueryReturns a query specifying the set difference of the matches specified by two sub-queries.
cts.andNotQueryNegativeQueryReturns the negative (second parameter) query used to construct the specified query.
cts.andNotQueryPositiveQueryReturns the positive (first parameter) query used to construct the specified query.
cts.andQueryReturns a query specifying the intersection of the matches specified by the sub-queries.
cts.andQueryOptionsReturns the options for the specified query.
cts.andQueryQueriesReturns a sequence of the queries that were used to construct the specified query.
cts.approxCenter[DEPRECATED: use geo:approx-center instead] Return a point approximating the center of the given region.
cts.arcIntersection[DEPRECATED: use geo:arc-intersection instead] Returns the point at the intersection of two arcs.
cts.avgAggregateReturns the average of the values given a value lexicon.
cts.bearing[DEPRECATED: use geo:bearing instead] Returns the true bearing in radians of the path from the first point to the second.
cts.boostQueryReturns a query specifying that matches to $matching-query should have their search relevance scores boosted if they also match $boosting-query.
cts.boostQueryBoostingQueryReturns the boosting (second parameter) query used to construct the specified boost query.
cts.boostQueryMatchingQueryReturns the matching (first parameter) query used to construct the specified boost query.
cts.boundingBoxes[DEPRECATED: use geo:bounding-boxes instead] Returns a sequence of boxes that bound the given region.
cts.boxReturns a geospatial box value.
cts.boxEastReturns a box's eastern boundary.
cts.boxIntersects[DEPRECATED: use geo:box-intersects instead] Returns true if the box intersects with a region.
cts.boxNorthReturns a box's northern boundary.
cts.boxSouthReturns a box's southern boundary.
cts.boxWestReturns a box's western boundary.
cts.circleReturns a geospatial circle value.
cts.circleCenterReturns a circle's center point.
cts.circleIntersects[DEPRECATED: use geo:circle-intersects instead] Returns true if the circle intersects with a region.
cts.circleRadiusReturns a circle's radius.
cts.classifyClassifies an array of nodes based on training data.
cts.clusterProduces a set of clusters from an array of nodes.
cts.collectionMatchReturns values from the collection lexicon that match the specified wildcard pattern.
cts.collectionQueryReturns a query matching documents in the collections with the given URIs.
cts.collectionQueryUrisReturns the URIs used to construct the specified query.
cts.collectionReferenceCreates a reference to the collection lexicon, for use as a parameter to cts:value-tuples.
cts.collectionsReturns values from the collection lexicon.
cts.complexPolygonReturns a geospatial complex polygon value.
cts.complexPolygonContains[DEPRECATED: use geo:complex-polygon-contains instead] Returns true if the complex-polygon contains a region.
cts.complexPolygonInnerReturns a complex polygon's inner polygons.
cts.complexPolygonIntersects[DEPRECATED: use geo:complex-polygon-intersects instead] Returns true if the complex-polygon intersects with a region.
cts.complexPolygonOuterReturns a complex polygon's outer polygon.
cts.confidenceReturns the confidence of a node, or of the context node if no node is provided.
cts.confidenceOrderCreates a confidence-based ordering clause, for use as an option to cts:search.
cts.containsReturns true if any of a sequence of values matches a query.
cts.correlationReturns the frequency-weighted correlation given a 2-way co-occurrence.
cts.countAggregateReturns the count of a value lexicon.
cts.covarianceReturns the frequency-weighted sample covariance given a 2-way co-occurrence.
cts.covariancePReturns the frequency-weighted covariance of the population given a 2-way co-occurrence.
cts.deregisterDeregister a registered query, explicitly releasing the associated resources.
cts.destination[DEPRECATED: use geo:destination instead] Returns the point at the given distance (in miles) along the given bearing (in radians) from the starting point.
cts.directoryQueryReturns a query matching documents in the directories with the given URIs.
cts.directoryQueryDepthReturns the depth used to construct the specified query.
cts.directoryQueryUrisReturns the URIs used to construct the specified query.
cts.distance[DEPRECATED: use geo:distance instead] Returns the distance (in miles) between two points.
cts.distinctiveTermsReturn the most "relevant" terms in the model nodes (that is, the terms with the highest scores).
cts.docReturns the document stored in the database at the specified URI.
cts.documentFragmentQueryReturns a query that matches all documents where $query matches any document fragment.
cts.documentFragmentQueryQueryReturns the query used to construct the specified query.
cts.documentOrderCreates a document-based ordering clause, for use as an option to cts:search.
cts.documentQueryReturns a query matching documents with the given URIs.
cts.documentQueryUrisReturns the URIs used to construct the specified query.
cts.elementAttributePairGeospatialBoxesReturns boxes derived from the specified element point lexicon(s).
cts.elementAttributePairGeospatialQueryReturns a cts:query matching elements by name which has specific attributes representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.elementAttributePairGeospatialQueryElementNameReturns the QNames used to construct the specified query.
cts.elementAttributePairGeospatialQueryLatitudeNameReturns the QNames used to construct the specified query.
cts.elementAttributePairGeospatialQueryLongitudeNameReturns the QNames used to construct the specified query.
cts.elementAttributePairGeospatialQueryOptionsReturns the options for the specified query.
cts.elementAttributePairGeospatialQueryRegionReturns the geographical regions with which the specified query was constructed.
cts.elementAttributePairGeospatialQueryWeightReturns the weight with which the specified query was constructed.
cts.elementAttributePairGeospatialValueMatchReturns values from the specified element attribute pair geospatial value lexicon(s) that match the specified wildcard pattern.
cts.elementAttributePairGeospatialValuesReturns values from the specified element-attribute-pair geospatial value lexicon(s).
cts.elementAttributeRangeQueryReturns a cts:query matching element-attributes by name with a range-index entry equal to a given value.
cts.elementAttributeRangeQueryAttributeNameReturns the QNames used to construct the specified query.
cts.elementAttributeRangeQueryElementNameReturns the QNames used to construct the specified query.
cts.elementAttributeRangeQueryOperatorReturns the operator used to construct the specified query.
cts.elementAttributeRangeQueryOptionsReturns the options for the specified query.
cts.elementAttributeRangeQueryValueReturns the value used to construct the specified query.
cts.elementAttributeRangeQueryWeightReturns the weight with which the specified query was constructed.
cts.elementAttributeReferenceCreates a reference to an element attribute value lexicon, for use as a parameter to cts:value-tuples.
cts.elementAttributeValueCoOccurrencesReturns value co-occurrences from the specified element or element-attribute value lexicon(s).
cts.elementAttributeValueGeospatialCoOccurrencesReturns value co-occurrences from the specified element-attribute value lexicon with the specified geospatial lexicon.
cts.elementAttributeValueMatchReturns values from the specified element-attribute value lexicon(s) that match the specified pattern.
cts.elementAttributeValueQueryReturns a query matching elements by name with attributes by name with text content equal a given phrase.
cts.elementAttributeValueQueryAttributeNameReturns the attribute QNames used to construct the specified query.
cts.elementAttributeValueQueryElementNameReturns the element QNames used to construct the specified query.
cts.elementAttributeValueQueryOptionsReturns the options for the specified query.
cts.elementAttributeValueQueryTextReturns the text used to construct the specified query.
cts.elementAttributeValueQueryWeightReturns the weight with which the specified query was constructed.
cts.elementAttributeValueRangesReturns value ranges from the specified element-attribute value lexicon(s).
cts.elementAttributeValuesReturns values from the specified element-attribute value lexicon(s).
cts.elementAttributeWordMatchReturns words from the specified element-attribute word lexicon(s) that match a wildcard pattern.
cts.elementAttributeWordQueryReturns a query matching elements by name with attributes by name with text content containing a given phrase.
cts.elementAttributeWordQueryAttributeNameReturns the attribute QNames used to construct the specified query.
cts.elementAttributeWordQueryElementNameReturns the element QNames used to construct the specified query.
cts.elementAttributeWordQueryOptionsReturns the options for the specified query.
cts.elementAttributeWordQueryTextReturns the text used to construct the specified query.
cts.elementAttributeWordQueryWeightReturns the weight with which the specified query was constructed.
cts.elementAttributeWordsReturns words from the specified element-attribute word lexicon(s).
cts.elementChildGeospatialBoxesReturns boxes derived from the specified element point lexicon(s).
cts.elementChildGeospatialQueryReturns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.elementChildGeospatialQueryChildNameReturns the QNames used to construct the specified query.
cts.elementChildGeospatialQueryElementNameReturns the QNames used to construct the specified query.
cts.elementChildGeospatialQueryOptionsReturns the options for the specified query.
cts.elementChildGeospatialQueryRegionReturns the geographical regions with which the specified query was constructed.
cts.elementChildGeospatialQueryWeightReturns the weight with which the specified query was constructed.
cts.elementChildGeospatialValueMatchReturns values from the specified element child geospatial value lexicon(s) that match the specified wildcard pattern.
cts.elementChildGeospatialValuesReturns values from the specified element-child geospatial value lexicon(s).
cts.elementGeospatialBoxesReturns boxes derived from the specified element point lexicon(s).
cts.elementGeospatialQueryReturns a cts:query matching elements by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.elementGeospatialQueryElementNameReturns the QNames used to construct the specified query.
cts.elementGeospatialQueryOptionsReturns the options for the specified query.
cts.elementGeospatialQueryRegionReturns the geographical regions with which the specified query was constructed.
cts.elementGeospatialQueryWeightReturns the weight with which the specified query was constructed.
cts.elementGeospatialValueMatchReturns values from the specified element geospatial value lexicon(s) that match the specified wildcard pattern.
cts.elementGeospatialValuesReturns values from the specified element geospatial value lexicon(s).
cts.elementPairGeospatialBoxesReturns boxes derived from the specified element point lexicon(s).
cts.elementPairGeospatialQueryReturns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.elementPairGeospatialQueryElementNameReturns the QNames used to construct the specified query.
cts.elementPairGeospatialQueryLatitudeNameReturns the QNames used to construct the specified query.
cts.elementPairGeospatialQueryLongitudeNameReturns the QNames used to construct the specified query.
cts.elementPairGeospatialQueryOptionsReturns the options for the specified query.
cts.elementPairGeospatialQueryRegionReturns the geographical regions with which the specified query was constructed.
cts.elementPairGeospatialQueryWeightReturns the weight with which the specified query was constructed.
cts.elementPairGeospatialValueMatchReturns values from the specified element pair geospatial value lexicon(s) that match the specified wildcard pattern.
cts.elementPairGeospatialValuesReturns values from the specified element-pair geospatial value lexicon(s).
cts.elementQueryReturns a cts:query matching elements by name with the content constrained by the given cts:query in the second parameter.
cts.elementQueryElementNameReturns the QNames used to construct the specified query.
cts.elementQueryQueryReturns the query used to construct the element query.
cts.elementRangeQueryReturns a cts:query matching elements by name with a range-index entry equal to a given value.
cts.elementRangeQueryElementNameReturns the QNames used to construct the specified query.
cts.elementRangeQueryOperatorReturns the operator used to construct the specified query.
cts.elementRangeQueryOptionsReturns the options for the specified query.
cts.elementRangeQueryValueReturns the value used to construct the specified query.
cts.elementRangeQueryWeightReturns the weight with which the specified query was constructed.
cts.elementReferenceCreates a reference to an element value lexicon, for use as a parameter to cts.valueTuples, temporal.axisCreate, or any other function that takes an index reference.
cts.elementValueCoOccurrencesReturns value co-occurrences (that is, pairs of values, both of which appear in the same fragment) from the specified element value lexicon(s).
cts.elementValueGeospatialCoOccurrencesReturns value co-occurrences from the specified element value lexicon with the specified geospatial lexicon.
cts.elementValueMatchReturns values from the specified element value lexicon(s) that match the specified wildcard pattern.
cts.elementValueQueryReturns a query matching elements by name with text content equal a given phrase.
cts.elementValueQueryElementNameReturns the QNames used to construct the specified query.
cts.elementValueQueryOptionsReturns the options for the specified query.
cts.elementValueQueryTextReturns the text used to construct the specified query.
cts.elementValueQueryWeightReturns the weight with which the specified query was constructed.
cts.elementValueRangesReturns value ranges from the specified element value lexicon(s).
cts.elementValuesReturns values from the specified element value lexicon(s).
cts.elementWalkReturns a copy of the node, replacing any elements found with the specified expression.
cts.elementWordMatchReturns words from the specified element word lexicon(s) that match a wildcard pattern.
cts.elementWordQueryReturns a query matching elements by name with text content containing a given phrase.
cts.elementWordQueryElementNameReturns the QNames used to construct the specified query.
cts.elementWordQueryOptionsReturns the options for the specified query.
cts.elementWordQueryTextReturns the text used to construct the specified query.
cts.elementWordQueryWeightReturns the weight with which the specified query was constructed.
cts.elementWordsReturns words from the specified element word lexicon.
cts.estimateReturns the number of fragments selected by a search.
cts.existsReturns true if any fragment is selected by the search, false if no fragments are selected.
cts.falseQueryReturns a query that matches no fragments.
cts.fieldRangeQueryReturns a cts:query matching fields by name with a range-index entry equal to a given value.
cts.fieldRangeQueryFieldNameReturns the fieldname used to construct the specified query.
cts.fieldRangeQueryOperatorReturns the operator used to construct the specified query.
cts.fieldRangeQueryOptionsReturns the options for the specified query.
cts.fieldRangeQueryValueReturns the value used to construct the specified query.
cts.fieldRangeQueryWeightReturns the weight with which the specified query was constructed.
cts.fieldReferenceCreates a reference to a field value lexicon, for use as a parameter to cts:value-tuples.
cts.fieldValueCoOccurrencesReturns value co-occurrences (that is, pairs of values, both of which appear in the same fragment) from the specified field value lexicon(s).
cts.fieldValueMatchReturns values from the specified field value lexicon(s) that match the specified wildcard pattern.
cts.fieldValueQueryReturns a query matching text content containing a given value in the specified field.
cts.fieldValueQueryFieldNameReturns the names used to construct the specified cts:field-value-query.
cts.fieldValueQueryOptionsReturns the options for the specified cts:field-value-query.
cts.fieldValueQueryTextReturns the values used to construct the specified cts:field-value-query.
cts.fieldValueQueryWeightReturns the weight with which the specified query was constructed.
cts.fieldValueRangesReturns value ranges from the specified field value lexicon(s).
cts.fieldValuesReturns values from the specified field value lexicon(s).
cts.fieldWordMatchReturns words from the specified field word lexicon(s) that match a wildcard pattern.
cts.fieldWordQueryReturns a query matching fields whose content contains the given phrase.
cts.fieldWordQueryFieldNameReturns the names used to construct the specified cts:field-word-query.
cts.fieldWordQueryOptionsReturns the options for the specified cts:field-word-query.
cts.fieldWordQueryTextReturns the text used to construct the specified cts:field-word-query.
cts.fieldWordQueryWeightReturns the weight with which the specified query was constructed.
cts.fieldWordsReturns words from the specified field word lexicon.
cts.fitnessReturns the fitness of a node, or of the context node if no node is provided.
cts.fitnessOrderCreates a fitness-based ordering clause, for use as an option to cts:search.
cts.frequencyReturns an integer representing the number of times in which a particular value occurs in a value lexicon lookup (for example, cts:element-values).
cts.geospatialAttributePairReferenceCreates a reference to a geospatial attribute pair range index, for use as a parameter to cts:value-tuples.
cts.geospatialBoxesReturns boxes derived from the specified point lexicon(s).
cts.geospatialCoOccurrencesFind value co-occurrences from two geospatial lexicons.
cts.geospatialElementChildReferenceCreates a reference to a geospatial element child range index, for use as a parameter to cts:value-tuples.
cts.geospatialElementPairReferenceCreates a reference to a geospatial element pair range index, for use as a parameter to cts:value-tuples.
cts.geospatialElementReferenceCreates a reference to a geospatial element range index, for use as a parameter to cts:value-tuples.
cts.geospatialJsonPropertyChildReferenceCreates a reference to a geospatial json property child range index, for use as a parameter to cts:value-tuples.
cts.geospatialJsonPropertyPairReferenceCreates a reference to a geospatial JSON property pair range index, for use as a parameter to cts:value-tuples.
cts.geospatialJsonPropertyReferenceCreates a reference to a geospatial json property range index, for use as a parameter to cts:value-tuples.
cts.geospatialPathReferenceCreates a reference to a geospatial path range index, for use as a parameter to cts:value-tuples.
cts.geospatialRegionPathReferenceCreate a reference to a geospatial region path index, for use as a parameter to cts.geospatialRegionQuery and other query operations on geospatial region indexes.
cts.geospatialRegionQueryConstruct a cts:query to match regions in documents that satisfy a specified relationship relative to other regions.
cts.geospatialRegionQueryOperationReturns the comparison operation specified when constructing the input query.
cts.geospatialRegionQueryOptionsReturns the options specified when constructing the input query.
cts.geospatialRegionQueryReferenceReturns the geospatial region path index reference(s) specified when constructing the input query.
cts.geospatialRegionQueryRegionReturns the cts:region(s) criteria specified when constructing the input query.
cts.geospatialRegionQueryWeightReturns the weight specified when constructing the input query.
cts.highlightReturns a copy of the node, replacing any text matching the query with the specified expression.
cts.indexOrderCreates a index-based ordering clause, for use as an option to cts:search.
cts.jsonPropertyChildGeospatialQueryReturns a cts:query matching json properties by name which has specific children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.jsonPropertyChildGeospatialQueryChildNameReturns the names used to construct the specified query.
cts.jsonPropertyChildGeospatialQueryOptionsReturns the options for the specified query.
cts.jsonPropertyChildGeospatialQueryPropertyNameReturns the names used to construct the specified query.
cts.jsonPropertyChildGeospatialQueryRegionReturns the geographical regions with which the specified query was constructed.
cts.jsonPropertyChildGeospatialQueryWeightReturns the weight with which the specified query was constructed.
cts.jsonPropertyGeospatialQueryReturns a cts:query matching json properties by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.jsonPropertyGeospatialQueryOptionsReturns the options for the specified query.
cts.jsonPropertyGeospatialQueryPropertyNameReturns the json property names used to construct the specified query.
cts.jsonPropertyGeospatialQueryRegionReturns the geographical regions with which the specified query was constructed.
cts.jsonPropertyGeospatialQueryWeightReturns the weight with which the specified query was constructed.
cts.jsonPropertyPairGeospatialQueryReturns a cts:query matching json properties by name which has specific property children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.jsonPropertyPairGeospatialQueryLatitudeNameReturns the property names used to construct the specified query.
cts.jsonPropertyPairGeospatialQueryLongitudeNameReturns the property names used to construct the specified query.
cts.jsonPropertyPairGeospatialQueryOptionsReturns the options for the specified query.
cts.jsonPropertyPairGeospatialQueryPropertyNameReturns the property names used to construct the specified query.
cts.jsonPropertyPairGeospatialQueryRegionReturns the geographical regions with which the specified query was constructed.
cts.jsonPropertyPairGeospatialQueryWeightReturns the weight with which the specified query was constructed.
cts.jsonPropertyRangeQueryReturns a cts:query matching JSON properties by name with a range-index entry equal to a given value.
cts.jsonPropertyRangeQueryOperatorReturns the operator used to construct the specified query.
cts.jsonPropertyRangeQueryOptionsReturns the options for the specified query.
cts.jsonPropertyRangeQueryPropertyNameReturns the JSON property name used to construct the specified query.
cts.jsonPropertyRangeQueryValueReturns the value used to construct the specified query.
cts.jsonPropertyRangeQueryWeightReturns the weight with which the specified query was constructed.
cts.jsonPropertyReferenceCreates a reference to a JSON property value lexicon, for use as a parameter to cts:value-tuples.
cts.jsonPropertyScopeQueryReturns a cts:query matching JSON properties by name with the content constrained by the given cts:query in the second parameter.
cts.jsonPropertyScopeQueryPropertyNameReturns the JSON property name used to construct the specified query.
cts.jsonPropertyScopeQueryQueryReturns the query used to construct the property scope query.
cts.jsonPropertyValueQueryReturns a query matching JSON properties by name with value equal the given value.
cts.jsonPropertyValueQueryOptionsReturns the options for the specified query.
cts.jsonPropertyValueQueryPropertyNameReturns the JSON property name used to construct the specified query.
cts.jsonPropertyValueQueryTextReturns the text used to construct the specified query.
cts.jsonPropertyValueQueryValueReturns the value used to construct the specified query.
cts.jsonPropertyValueQueryWeightReturns the weight with which the specified query was constructed.
cts.jsonPropertyWordMatchReturns words from the specified JSON property word lexicon(s) that match a wildcard pattern.
cts.jsonPropertyWordQueryReturns a query matching JSON properties by name with text content containing a given phrase.
cts.jsonPropertyWordQueryOptionsReturns the options for the specified query.
cts.jsonPropertyWordQueryPropertyNameReturns the name used to construct the specified query.
cts.jsonPropertyWordQueryTextReturns the text used to construct the specified query.
cts.jsonPropertyWordQueryWeightReturns the weight with which the specified query was constructed.
cts.jsonPropertyWordsReturns words from the specified JSON property word lexicon.
cts.linearModelReturns a linear model that fits the frequency-weighted data set.
cts.linestringReturns a geospatial linestring value.
cts.linestringVerticesReturns a linestring's vertices.
cts.locksFragmentQueryReturns a query that matches all documents where $query matches document-locks.
cts.locksFragmentQueryQueryReturns the query used to construct the specified query.
cts.lsqtQueryReturns only documents before LSQT or a timestamp before LSQT for stable query results.
cts.lsqtQueryOptionsReturns the options for the specified query.
cts.lsqtQueryTemporalCollectionReturns the name of the temporal collection used to construct specified query.
cts.lsqtQueryTimestampReturns timestamp used to construct the specified query.
cts.lsqtQueryWeightReturns the weight with which the specified query was constructed.
cts.matchRegionsFind regions in documents that have a spatial relationship to one or more caller-supplied regions.
cts.maxReturns the maximal value given a value lexicon.
cts.medianReturns a frequency-weighted median of a sequence.
cts.minReturns the minimal value given a value lexicon.
cts.nearQueryReturns a query matching all of the specified queries, where the matches occur within the specified distance from each other.
cts.nearQueryDistanceReturns the distance used to construct the near query.
cts.nearQueryOptionsReturns the options for the specified query.
cts.nearQueryQueriesReturns the query sequence used to construct the near query.
cts.nearQueryWeightReturns the weight with which the specified query was constructed.
cts.notInQueryReturns a query matching the first subquery, where those matches do not occur within 0 distance of the other query.
cts.notInQueryNegativeQueryReturns the negative (second parameter) query used to construct the specified query.
cts.notInQueryPositiveQueryReturns the positive (first parameter) query used to construct the specified query.
cts.notQueryReturns a query specifying the matches not specified by its sub-query.
cts.notQueryQueryReturns the query used to construct the specified query.
cts.notQueryWeightReturns the weight with which the specified query was constructed.
cts.orQueryReturns a query specifying the union of the matches specified by the sub-queries.
cts.orQueryOptionsReturns the options for the specified query.
cts.orQueryQueriesReturns a sequence of the queries that were used to construct the specified query.
cts.parseParses a query string
cts.parseWkt[DEPRECATED: use geo:parse-wkt instead] Returns a sequence of geospatial regions parsed from Well-Known Text format.
cts.partOfSpeechReturns the part of speech for a cts:token, if any.
cts.pathGeospatialQueryReturns a cts:query matching path expressions whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
cts.pathGeospatialQueryOptionsReturns the options for the specified query.
cts.pathGeospatialQueryPathExpressionReturns the path expressions used to construct the specified query.
cts.pathGeospatialQueryRegionReturns the geographical regions with which the specified query was constructed.
cts.pathGeospatialQueryWeightReturns the weight with which the specified query was constructed.
cts.pathRangeQueryReturns a cts:query matching documents where the content addressed by an XPath expression satisfies the specified relationship (=, <, >, etc.) with respect to the input criteria values.
cts.pathRangeQueryOperatorReturns the operator used to construct the specified query.
cts.pathRangeQueryOptionsReturns the options for the specified query.
cts.pathRangeQueryPathNameReturns the path expression used to construct the specified query.
cts.pathRangeQueryValueReturns the value used to construct the specified query.
cts.pathRangeQueryWeightReturns the weight with which the specified query was constructed.
cts.pathReferenceCreates a reference to a path value lexicon, for use as a parameter to cts:value-tuples.
cts.percentileReturns a sequence of percentile(s) given a sequence of percentage(s).
cts.percentRankReturns the rank of a value in a data set as a percentage of the data set.
cts.periodCreates a period value, for use as a parameter to cts:period-range-query or cts:period-compare-query.
cts.periodCompareCompares two periods using the specified comparision operator.
cts.periodCompareQueryReturns a cts:query matching documents that have relevant pair of period values.
cts.periodCompareQueryAxis1Returns the name of the first axis used to construct the specified query.
cts.periodCompareQueryAxis2Returns the name of the second axis used to construct the specified query.
cts.periodCompareQueryOperatorReturns the operator used to construct the specified query.
cts.periodCompareQueryOptionsReturns the options for the specified query.
cts.periodRangeQueryReturns a cts:query matching axis by name with a period value with an operator.
cts.periodRangeQueryAxisReturns the axis name used to construct the specified query.
cts.periodRangeQueryOperatorReturns the operator used to construct the specified query.
cts.periodRangeQueryOptionsReturns the options for the specified query.
cts.periodRangeQueryPeriodReturns the period used to construct the specified query.
cts.planReturns an array of JavaScript objects recording information about how the given search will be processed by the index.
cts.pointReturns a point value.
cts.pointLatitudeReturns a point's latitude value.
cts.pointLongitudeReturns a point's longitude value.
cts.polygonReturns a geospatial polygon value.
cts.polygonContains[DEPRECATED: use geo:polygon-contains instead] Returns true if the polygon contains a region.
cts.polygonIntersects[DEPRECATED: use geo:polygon-intersects instead] Returns true if the polygon intersects with a region.
cts.polygonVerticesReturns a polygon's vertices.
cts.propertiesFragmentQueryReturns a query that matches all documents where $query matches document-properties.
cts.propertiesFragmentQueryQueryReturns the query used to construct the specified query.
cts.qualityReturns the quality of a node, or of the context node if no node is provided.
cts.qualityOrderCreates a quality-based ordering clause, for use as an option to cts:search.
cts.queryCreates a query.
cts.rangeQueryReturns a cts:query matching specified nodes with a range-index entry compared to a given value.
cts.rangeQueryIndexReturns the range index used to construct the specified query.
cts.rangeQueryOperatorReturns the operator used to construct the specified query.
cts.rangeQueryOptionsReturns the options for the specified query.
cts.rangeQueryValueReturns the value used to construct the specified query.
cts.rangeQueryWeightReturns the weight with which the specified query was constructed.
cts.rankReturns the rank of a value in a data set.
cts.referenceCollationAccessor for the collation of a reference to a string value lexicon.
cts.referenceCoordinateSystemAccessor for the coordinate-system of a reference to a geospatial lexicon.
cts.referenceNullableReturns true() if the reference is nullable, false() otherwise.
cts.referenceParseCreates a reference to a value lexicon by parsing its XML or JSON representation, for use as a parameter to cts:value-tuples.
cts.referenceScalarTypeAccessor for the scalar type of a reference to a value lexicon.
cts.regionContains[DEPRECATED: use geo:region-contains instead] Returns true if the region contains the other region.
cts.regionIntersects[DEPRECATED: use geo:region-intersects instead] Returns true if the region intersects with a region.
cts.registerRegister a query for later use.
cts.registeredQueryReturns a query matching fragments specified by previously registered queries (see cts:register).
cts.registeredQueryIdsReturns the registered query identifiers used to construct the specified query.
cts.registeredQueryOptionsReturns the options for the specified query.
cts.registeredQueryWeightReturns the weight with which the specified query was constructed.
cts.relevanceInfoReturn the relevance score computation report for a node.
cts.remainderReturns an estimated search result size for a node, or of the context node if no node is provided.
cts.reverseQueryConstruct a query that matches serialized cts queries, based on a set of model input nodes.
cts.reverseQueryNodesReturns the nodes used to construct the specified query.
cts.reverseQueryWeightReturns the weight with which the specified query was constructed.
cts.scoreReturns the score of a node, or of the context node if no node is provided.
cts.scoreOrderCreates a score-based ordering clause, for use as an option to cts:search.
cts.searchReturns a relevance-ordered sequence of nodes specified by a given query.
cts.shortestDistance[DEPRECATED: use geo:shortest-distance instead] Returns the great circle distance (in miles) between a point and an region.
cts.similarQueryReturns a query matching nodes similar to the model nodes.
cts.similarQueryNodesReturns the nodes used to construct the specified query.
cts.similarQueryWeightReturns the weight with which the specified query was constructed.
cts.stddevReturns a frequency-weighted sample standard deviation given a value lexicon.
cts.stddevPReturns a frequency-weighted standard deviation of the population given a value lexicon.
cts.stemReturns the stem(s) for a word.
cts.sumAggregateReturns the sum of the values given a value lexicon.
cts.thresholdsCompute precision, recall, the F measure, and thresholds for the classes computed by the classifier, by comparing with the labels for the same set.
cts.tokenizeTokenizes text into words, punctuation, and spaces.
cts.toWkt[DEPRECATED: use geo:to-wkt instead] Returns a sequence of strings in Well-Known Text format.
cts.trainProduces a set of classifiers from a list of labeled training documents.
cts.tripleRangeQueryReturns a cts:query matching triples with a triple index entry equal to the given values.
cts.tripleRangeQueryObjectReturns the object value used to construct the specified query.
cts.tripleRangeQueryOperatorReturns the operators used to construct the specified query.
cts.tripleRangeQueryOptionsReturns the options for the specified query.
cts.tripleRangeQueryPredicateReturns the predicate value used to construct the specified query.
cts.tripleRangeQuerySubjectReturns the subject value used to construct the specified query.
cts.tripleRangeQueryWeightReturns the weight with which the specified query was constructed.
cts.triplesReturns values from the triple index.
cts.tripleValueStatisticsReturns statistics from the triple index for the values given.
cts.trueQueryReturns a query that matches all fragments.
cts.unorderedSpecifies that results should be unordered, for use with cts:search.
cts.uriMatchReturns values from the URI lexicon that match the specified wildcard pattern.
cts.uriReferenceCreates a reference to the URI lexicon, for use as a parameter to cts:value-tuples.
cts.urisReturns values from the URI lexicon.
cts.validIndexPathParses path expressions and resolves namespaces based on the server run-time environment.
cts.valueCoOccurrencesReturns value co-occurrences (that is, pairs of values, both of which appear in the same fragment) from the specified value lexicon(s).
cts.valueMatchReturns values from the specified value lexicon(s) that match the specified wildcard pattern.
cts.valueRangesReturns value ranges from the specified value lexicon(s).
cts.valuesReturns values from the specified value lexicon(s).
cts.valueTuplesReturns value co-occurrence tuples (that is, tuples of values, each of which appear in the same fragment) from the specified value lexicons.
cts.varianceReturns a frequency-weighted sample variance given a value lexicon.
cts.variancePReturns a frequency-weighted variance of the population given a value lexicon.
cts.walkWalks a node, evaluating a callback function for any text matching a query.
cts.wordMatchReturns words from the word lexicon that match the wildcard pattern.
cts.wordQueryReturns a query matching text content containing a given phrase.
cts.wordQueryOptionsReturns the options for the specified query.
cts.wordQueryTextReturns the text used to construct the specified query.
cts.wordQueryWeightReturns the weight with which the specified query was constructed.
cts.wordsReturns words from the word lexicon.
Document.baseURIThis is inherited from the Node object. Returns a string representing the base URI of the node.
Document.documentFormatThe format of the document node, "JSON", "XML", "TEXT", or "BINARY"
Document.nodeKindThis is inherited from the Node object. Return a string indicating the type of the node.
Document.nodeTypeThis is inherited from the Node object. Return the DOM code indicating the type of the node.
Document.rootThe root node of the document.
Document.xpathThis is inherited from the Node object. Evaluate an XPath using the node as context.
DocumentsSearch.filterSpecifies filtering the documents by inspecting the contents of matched and ordered documents to populate the slice.
DocumentsSearch.mapSpecifies a function similar to Array.prototype.map() to apply to each document within the slice or the configuration for the built-in mapper.
DocumentsSearch.orderBySpecifies the sort order for matched documents.
DocumentsSearch.reduceSpecifies a function similar to Array.prototype.reduce() to apply to each document within the slice.
DocumentsSearch.resultExecutes the document search definition and returns a result object with an estimate property for the total number of matched documents, a results property with an array holding the subsequence of documents in the slice, and other properties if specified by withOptions().
DocumentsSearch.sliceSpecifies a subsequence of matched, sorted, and filtered documents to retrieve.
DocumentsSearch.whereSpecifies which documents to match based on the indexes over the documents.
DocumentsSearch.withOptionsConfigure advanced document search options.
Element.attributesThis is inherited from the XMLNode object. The attributes of this node.
Element.childNodesThis is inherited from the XMLNode object. The children of this node.
Element.firstChildThis is inherited from the XMLNode object. The first child of this node, if any.
Element.getAttributeGet the value of the attribute of this element with the given name, if any.
Element.getAttributeNodeGet the attribute of this element with the given name, if any.
Element.getAttributeNodeNSGet the attribute of this element with the given localname and namespace URI, if any.
Element.getAttributeNSGet the value of the attribute of this element with the given localname and namespace URI, if any.
Element.getElementsByTagNameReturn all the elements that are descendants of the current element that have the given name.
Element.getElementsByTagNameNSReturn all the elements that are descendants of the current element that have the given localname and namespace URI.
Element.hasAttributeWhether this element has an attribute with the given name.
Element.hasAttributeNSWhether this element has an attribute the given localname and namespace URI.
Element.hasAttributesThis is inherited from the XMLNode object. Whether this node has attributes.
Element.hasChildNodesThis is inherited from the XMLNode object. Whether this node has any children.
Element.isEqualNodeThis is inherited from the XMLNode object. Whether this node is equal to another node.
Element.isSameNodeThis is inherited from the XMLNode object. Whether this node is the same exact node as another node.
Element.lastChildThis is inherited from the XMLNode object. The last child of this node, if any.
Element.localNameThis is inherited from the XMLNode object. Return the local name of this node.
Element.namespaceURIThis is inherited from the XMLNode object. Return the namespace URI of this node.
Element.nextSiblingThis is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any.
Element.nodeNameThis is inherited from the XMLNode object. The DOM name of the node.
Element.nodeValueThis is inherited from the XMLNode object. The DOM value of the node.
Element.ownerDocumentThis is inherited from the XMLNode object. The document node containing this node, if any.
Element.parentNodeThis is inherited from the XMLNode object. The node that is this node's parent.
Element.prefixThis is inherited from the XMLNode object. Return the namespace prefix of this node.
Element.previousSiblingThis is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any.
Element.schemaTypeInfoThe schema type information associated with this element.
Element.textContentThis is inherited from the XMLNode object. The DOM text value of the node.
Error.codeFor DOM errors, this is the DOM error code.
Error.dataThe data passed to the error.
Error.messageThe formatted error message.
Error.nameThe error name.
Error.retryableWhether the error can be retried.
Error.stackA string representation of the call stack.
Error.stackFramesAn array of stack frames.
Error.toStringA string representation of the error.
es.databasePropertiesGenerateGenerate a database configuration artifact from a basic model.
es.extractionTemplateGenerateGenerate a Template Driven Extraction (TDE) template you can use to render entity instance data into rows for querying with the Optic API or SQL.
es.instanceConverterGenerateGenerate an XQuery library module containing stub code for converting source data to entity instances.
es.instanceFromDocumentExtract an in-memory entity instance from its envelope document as a JavaScript object.
es.instanceGetAttachmentsExtract attachments from an entity service document.
es.instanceJsonFromDocumentExtract an entity instance from its envelope document, as JSON.
es.instanceXmlFromDocumentExtract a canonical entity instance from its envelope document, as XML.
es.modelFromXmlCreate a basic model from an XML model descriptor, without validating the input descriptor for correctness.
es.modelGetTestInstancesGenerate entity instances of each entity type in a basic model.
es.modelToXmlSerialize a basic model as an XML element.
es.modelValidateValidates an entity services model descriptor.
es.schemaGenerateGenerate an XSD schema that can be used to validate instance data.
es.searchOptionsGenerateGenerate a set of query options that can be used to query your entity instances using several MarkLogic server-side and client APIs.
es.versionTranslatorGenerateGenerate a module that can be used to translate instances conforming to one version of a model into instances conforming to another version
FacetDefinition.groupIntoGroups facet values into buckets between bound values as in a ValuesSearch definition.
FacetDefinition.mapSpecifies a function similar to Array.prototype.map() to apply to each value within the slice or the configuration for the built-in mapper, as in a ValuesSearch definition.
FacetDefinition.orderBySpecifies the sort order for facet values, as in a ValuesSearch definition.
FacetDefinition.othersWhereSpecify a query to apply to facets other than this one.
FacetDefinition.reduceSpecifies a function similar to Array.prototype.reduce() to apply to each value within the slice or a configuration object for the built-in reducer, as in a ValuesSearch definition.
FacetDefinition.sliceSpecifies a subsequence of values to retrieve as in a ValuesSearch definition.
FacetDefinition.thisWhereSpecify a query to apply only to this facet.
FacetDefinition.withOptionsConfigure advanced options for facet generation.
FacetsSearch.resultExecutes the facets search definition and returns the results.
FacetsSearch.whereSpecify one or an array of cts.query's used to qualify the facet values and the document result set (if requested).
FacetsSearch.withOptionsConfigure advanced options for facet generation.
fn.absReturns the absolute value of $arg.
fn.adjustDateTimeToTimezoneAdjusts an xs:dateTime value to a specific timezone, or to no timezone at all.
fn.adjustDateToTimezoneAdjusts an xs:date value to a specific timezone, or to no timezone at all.
fn.adjustTimeToTimezoneAdjusts an xs:time value to a specific timezone, or to no timezone at all.
fn.analyzeStringThe result of the function is a new element node whose string value is the original string, but which contains markup to show which parts of the input match the regular expression.
fn.avgReturns the average of the values in the input sequence $arg, that is, the sum of the values divided by the number of values.
fn.baseUriReturns the value of the base-uri property for the specified node.
fn.booleanComputes the effective boolean value of the sequence $arg.
fn.ceilingReturns the smallest (closest to negative infinity) number with no fractional part that is not less than the value of $arg.
fn.codepointEqualReturns true if the specified parameters are the same Unicode code point, otherwise returns false.
fn.codepointsToStringCreates an xs:string from a sequence of Unicode code points.
fn.collectionReturns all of the documents that belong to the specified collection(s).
fn.compareReturns -1, 0, or 1, depending on whether the value of the $comparand1 is respectively less than, equal to, or greater than the value of $comparand2, according to the rules of the collation that is used.
fn.concatReturns the xs:string that is the concatenation of the values of the specified parameters.
fn.containsReturns true if the first parameter contains the string from the second parameter, otherwise returns false.
fn.countReturns the number of items in the value of $arg.
fn.currentDateReturns xs:date(fn:current-dateTime()).
fn.currentDateTimeReturns the current dateTime value (with timezone) from the dynamic context.
fn.currentTimeReturns xs:time(fn:current-dateTime()).
fn.dataTakes a sequence of items and returns a sequence of atomic values.
fn.dayFromDateReturns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg.
fn.dayFromDateTimeReturns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg.
fn.daysFromDurationReturns an xs:integer representing the days component in the canonical lexical representation of the value of $arg.
fn.deepEqualThis function assesses whether two sequences are deep-equal to each other.
fn.defaultCollationReturns the value of the default collation property from the static context.
fn.distinctValuesReturns the sequence that results from removing from $arg all but one of a set of values that are eq to one other.
fn.docReturns the document(s) stored in the database at the specified URI(s).
fn.docAvailableIf fn:doc($uri) returns a document node, this function returns true.
fn.documentReturns the document(s) stored in the database at the specified URI(s).
fn.documentUriReturns the value of the document-uri property for the specified node.
fn.emptyIf the value of $arg is the empty sequence, the function returns true; otherwise, the function returns false.
fn.encodeForUriInvertible function that escapes characters required to be escaped inside path segments of URIs.
fn.endsWithReturns true if the first parameter ends with the string from the second parameter, otherwise returns false.
fn.error[1.0 and 1.0-ml only, 0.9-ml has a different signature] Throw the given error.
fn.escapeHtmlUri%-escapes everything except printable ASCII characters.
fn.exactlyOneReturns $arg if it contains exactly one item.
fn.existsIf the value of $arg is not the empty sequence, the function returns true; otherwise, the function returns false.
fn.falseReturns the xs:boolean value false.
fn.floorReturns the largest (closest to positive infinity) number with no fractional part that is not greater than the value of $arg.
fn.formatDateReturns a formatted date value based on the picture argument.
fn.formatDateTimeReturns a formatted dateTime value based on the picture argument.
fn.formatNumberReturns a formatted string representation of value argument based on the supplied picture.
fn.formatTimeReturns a formatted time value based on the picture argument.
fn.functionAvailableReturns true if and only if there is an XQuery or XSLT function whose name and optionally arity matches the value of the $function-name and the optional $arity arguments.
fn.functionLookupReturns a function with the given name and arity, or the empty sequence if none exists.
fn.generateIdReturns a string that uniquely identifies a given node.
fn.headReturns the first item in a sequence.
fn.hoursFromDateTimeReturns an xs:integer between 0 and 23, both inclusive, representing the hours component in the localized value of $arg.
fn.hoursFromDurationReturns an xs:integer representing the hours component in the canonical lexical representation of the value of $arg.
fn.hoursFromTimeReturns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of $arg.
fn.idReturns the sequence of element nodes that have an ID value matching the value of one or more of the IDREF values supplied in $arg.
fn.idrefReturns the sequence of element or attribute nodes that have an IDREF value matching the value of one or more of the ID values supplied in $arg.
fn.implicitTimezoneReturns the value of the implicit timezone property from the dynamic context.
fn.indexOfReturns a sequence of positive integers giving the positions within the sequence $seqParam of items that are equal to $srchParam.
fn.inScopePrefixesReturns the prefixes of the in-scope namespaces for $element.
fn.insertBeforeReturns a new sequence constructed from the value of $target with the value of $inserts inserted at the position specified by the value of $position.
fn.iriToUriIdempotent function that escapes non-URI characters.
fn.langThis function tests whether the language of $node, or the context node if the second argument is omitted, as specified by xml:lang attributes is the same as, or is a sublanguage of, the language specified by $testlang.
fn.localNameReturns the local part of the name of $arg as an xs:string that will either be the zero-length string or will have the lexical form of an xs:NCName.
fn.localNameFromQNameReturns an xs:NCName representing the local part of $arg.
fn.lowerCaseReturns the specified string converting all of the characters to lower-case characters.
fn.matchesReturns true if the specified $input matches the specified $pattern, otherwise returns false.
fn.maxSelects an item from the input sequence $arg whose value is greater than or equal to the value of every other item in the input sequence.
fn.minSelects an item from the input sequence $arg whose value is less than or equal to the value of every other item in the input sequence.
fn.minutesFromDateTimeReturns an xs:integer value between 0 and 59, both inclusive, representing the minute component in the localized value of $arg.
fn.minutesFromDurationReturns an xs:integer representing the minutes component in the canonical lexical representation of the value of $arg.
fn.minutesFromTimeReturns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of $arg.
fn.monthFromDateReturns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg.
fn.monthFromDateTimeReturns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg.
fn.monthsFromDurationReturns an xs:integer representing the months component in the canonical lexical representation of the value of $arg.
fn.nameReturns the name of a node, as an xs:string that is either the zero-length string, or has the lexical form of an xs:QName.
fn.namespaceUriReturns the namespace URI of the xs:QName of the node specified by $arg.
fn.namespaceUriForPrefixReturns the namespace URI of one of the in-scope namespaces for $element, identified by its namespace prefix.
fn.namespaceUriFromQNameReturns the namespace URI for $arg as an xs:string.
fn.nilledSummary: Returns an xs:boolean indicating whether the argument node is "nilled".
fn.nodeNameReturns an expanded-QName for node kinds that can have names.
fn.normalizeSpaceReturns the specified string with normalized whitespace, which strips off any leading or trailing whitespace and replaces any other sequences of more than one whitespace characters with a single space character (#x20).
fn.normalizeUnicodeReturn the argument normalized according to the normalization criteria for a normalization form identified by the value of $normalizationForm.
fn.notReturns true if the effective boolean value is false, and false if the effective boolean value is true.
fn.numberReturns the value indicated by $arg or, if $arg is not specified, the context item after atomization, converted to an xs:double.
fn.oneOrMoreReturns $arg if it contains one or more items.
fn.prefixFromQNameReturns an xs:NCName representing the prefix of $arg.
fn.QNameReturns an xs:QName with the namespace URI given in $paramURI.
fn.removeReturns a new sequence constructed from the value of $target with the item at the position specified by the value of $position removed.
fn.replaceReturns a string constructed by replacing the specified $pattern on the $input string with the specified $replacement string.
fn.resolveQNameReturns an xs:QName value (that is, an expanded QName) by taking an xs:string that has the lexical form of an xs:QName (a string in the form "prefix:local-name" or "local-name") and resolving it using the in-scope namespaces for a given element.
fn.resolveUriResolves a relative URI against an absolute URI.
fn.reverseReverses the order of items in a sequence.
fn.rootReturns the root of the tree to which $arg belongs.
fn.roundReturns the number with no fractional part that is closest to the argument.
fn.roundHalfToEvenThe value returned is the nearest (that is, numerically closest) numeric to $arg that is a multiple of ten to the power of minus $precision.
fn.secondsFromDateTimeReturns an xs:decimal value between 0 and 60.999..., both inclusive representing the seconds and fractional seconds in the localized value of $arg.
fn.secondsFromDurationReturns an xs:decimal representing the seconds component in the canonical lexical representation of the value of $arg.
fn.secondsFromTimeReturns an xs:decimal value between 0 and 60.999..., both inclusive, representing the seconds and fractional seconds in the localized value of $arg.
fn.startsWithReturns true if the first parameter starts with the string from the second parameter, otherwise returns false.
fn.staticBaseUriReturns the value of the base-uri property from the static context.
fn.stringReturns the value of $arg represented as an xs:string.
fn.stringJoinReturns an xs:string created by concatenating the members of the $parameter1 sequence using $parameter2 as a separator.
fn.stringLengthReturns an integer representing the length of the specified string.
fn.stringToCodepointsReturns the sequence of Unicode code points that constitute an xs:string.
fn.subsequenceReturns the contiguous sequence of items in the value of $sourceSeq beginning at the position indicated by the value of $startingLoc and continuing for the number of items indicated by the value of $length.
fn.substringReturns a substring starting from the $startingLoc and continuing for $length characters.
fn.substringAfterReturns the substring created by taking all of the input characters that occur after the specified $after characters.
fn.substringBeforeReturns the substring created by taking all of the input characters that occur before the specified $before characters.
fn.sumReturns a value obtained by adding together the values in $arg.
fn.tailReturns all but the first item in a sequence.
fn.timezoneFromDateReturns the timezone component of $arg if any.
fn.timezoneFromDateTimeReturns the timezone component of $arg if any.
fn.timezoneFromTimeReturns the timezone component of $arg if any.
fn.tokenizeReturns a sequence of strings contructed by breaking the specified input into substrings separated by the specified $pattern.
fn.traceReturn the input $value unchanged and, if $label is the name of an enabled server event, log event to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server.
fn.translateReturns a string where every character in $src that occurs in some position in the $mapString is translated into the $transString character in the corresponding location of the $mapString character.
fn.trueReturns the xs:boolean value true.
fn.typeAvailableReturns true if and only if there is a type whose name matches the value of the $type-name argument is present in the static context.
fn.unorderedReturns the items of $sourceSeq in an implementation dependent order.
fn.unparsedTextReads a file stored in the database as either text or binary file and returns its contents as a string.
fn.unparsedTextAvailableReturns true if a call to unparsed-text would succeed with identical arguments.
fn.upperCaseReturns the specified string converting all of the characters to upper-case characters.
fn.yearFromDateReturns an xs:integer representing the year component in the localized value of $arg.
fn.yearFromDateTimeReturns an xs:integer representing the year component in the localized value of $arg.
fn.yearsFromDurationReturns an xs:integer representing the years component in the canonical lexical representation of the value of $arg.
fn.zeroOrOneReturns $arg if it contains zero or one items.
geo.approxCenterReturn a point approximating the center of the given region.
geo.arcIntersectionReturns the point at the intersection of two arcs.
geo.bearingReturns the true bearing in radians of the path from the first point to the second.
geo.boundingBoxesReturns a sequence of boxes that bound the given region.
geo.boxCreate a cts.box value from a node representing a box in one of the supported markup vocabularies, such as KML, GML, or GeoJSON.
geo.boxIntersectsReturns true if the box intersects with a region.
geo.circleCreate a cts.box value from a radius and a node representing a point in one of the supported markup vocabularies, such as KML, GML, or GeoJSON.
geo.circleIntersectsReturns true if the circle intersects with a region.
geo.circlePolygonConstruct a polygon approximating a circle.
geo.complexPolygonCreate a cts.complexPolygon value from a node representing a complex polygon in one of the supported markup vocabularies, such as KML, GML, or GeoJSON.
geo.complexPolygonContainsReturns true if the complex-polygon contains a region.
geo.complexPolygonIntersectsReturns true if the complex-polygon intersects with a region.
geo.coordinateSystemCanonicalGet the canonical name for the coordinate system.
geo.countDistinctVerticesReturn a count of the distinct number of vertices in a region, taking tolerance into account.
geo.countVerticesThis function returns a count of the number of vertices in a region.
geo.defaultCoordinateSystemGet the canonical name for the coordinate system currently in effect.
geo.destinationReturns the point at the given distance (in units) along the given bearing (in radians) from the starting point.
geo.distanceReturns the distance (in units) between two points.
geo.distanceConvertThis function converts a distance from one unit of measure to another.
geo.ellipsePolygonConstruct a polygon approximating an ellipse.
geo.geohashDecodeGiven a geohash string, return the bounding box for that hash.
geo.geohashDecodePointGiven a geohash string, return the point for that hash.
geo.geohashEncodeCompute a set of covering geohashes for the given region, to the given level of precision.
geo.geohashNeighborsGiven a geohash string, return hashes for the neighbors.
geo.geohashPrecisionDimensionsGiven a geohash string, return the height and width for the given precision.
geo.geohashSubhashesGiven a geohash string, return the 32 subhashes.
geo.geospatialQueryReturns a query matching points within given regions.
geo.geospatialQueryFromElementsReturns a query matching points within given regions.
geo.geospatialQueryFromNodesReturns a query matching points within given regions.
geo.interiorPointThis function returns a point that is guaranteed to be inside the bounds of the given region.
geo.interiorPolygonCreate a sequence of cts.polygon values from a polygon node in one of the supported markup vocabularies, such as KML or GML.
geo.linestringCreate a cts.linestring value from a node representing a linestring in one of the supported markup vocabularies, such as GML or KML.
geo.linestringConcatConstruct a linestring by concatenating the vertices of the input linestrings, in order.
geo.linestringReverseConstruct a linestring with the vertices in reverse order.
geo.parseConvert nodes in one or more of the supported geospatial representations into cts.region values.
geo.parseWkbReturns a sequence of geospatial regions parsed from Well-Known Binary format.
geo.parseWktReturns a sequence of geospatial regions parsed from Well-Known Text format.
geo.pointCreate a cts.point value from a node representing a point in one of the supported markup vocabularies, such as KML or GML.
geo.polygonCreate a cts.polygon value from a sequence of point nodes in one of the supported markup vocabularies, such as KML or GML.
geo.polygonContainsReturns true if the polygon contains a region.
geo.polygonIntersectsReturns true if the polygon intersects with a region.
geo.polygonToLinestringConstruct a linestring from the vertices of a polygon, or construct a sequence of linestrings from the outer and inner polygons of a complex polygon.
geo.regionAffineTransformPerform an affine transformation on a geospatial region.
geo.regionApproximateThis function returns a simplified approximation of the region, using the Douglas-Peucker algorithm.
geo.regionCleanThis function fixes various problems with the region or raises an error if it is not repairable.
geo.regionContainsReturns true if one region contains the other region.
geo.regionDe9imCalculates the Dimensionally Extended nine-Intersection Matrix (DE-9IM) of two geospatial regions.
geo.regionIntersectsReturns true if the target region intersects with a region.
geo.regionRelateCompares geospatial regions based on a specified relationship.
geo.removeDuplicateVerticesRemove duplicate (adjacent) vertices.
geo.shortestDistanceReturns the great circle distance (in units) between a point and a region.
geo.toWkbReturns a binary node in Well-Known Binary format.
geo.toWktReturns a sequence of strings in Well-Known Text format.
geo.validateWkbReturns true if the binary data can be parsed as WKB into a supported region type.
geo.validateWktReturns true if the string is valid Well-Known Text for a supported region type.
geogml.boxCreate a cts:box value from a GML Envelope element.
geogml.circleCreate a cts:circle value from a radius and GML Point element.
geogml.complexPolygonCreate a cts:complex-polygon value from a GML Polygon element.
geogml.geospatialQueryReturns a cts:query matching points within given regions.
geogml.geospatialQueryFromElementsReturns a cts:query matching points within given regions.
geogml.interiorPolygonCreate a sequence of cts:polygon values from a GML Polygon element.
geogml.linestringCreate a cts:linestring value from a GML LineString element.
geogml.parseGmlConstruct regions from GML elements.
geogml.pointCreate a cts:point value from a GML Point element.
geogml.polygonCreate a cts:polygon value from a sequence of GML Point elements or a GML Polygon element.
geogml.toGmlConstruct GML elements from cts:region values.
geojson.boxCreate a cts:box value from GeoJSON bbox property.
geojson.circleCreate a cts:circle value from a radius and a GeoJSON "Point" type geometry object.
geojson.complexPolygonCreate a cts:complex-polygon value from a GeoJSON "Polygon" type geometry object.
geojson.geospatialQueryReturns a cts:query matching points within given regions.
geojson.geospatialQueryFromNodesReturns a cts:query matching points within given regions.
geojson.interiorPolygonCreate a sequence of cts:polygon values from a GeoJSON "Polygon" type geometry object.
geojson.linestringCreate a cts:linestring value from a GeoJSON "LineString" type geometry object.
geojson.multiLinestringCreate a set of cts:linestring values from a GeoJSON "MultiLineString" type geometry object.
geojson.multiPointCreate a set of cts:point values from a GeoJSON "MultiPoint" type geometry object.
geojson.parseGeojsonConvert GeoJSON object nodes into cts:region values.
geojson.pointCreate a cts:point value from a GeoJSON "Point" type geometry object.
geojson.polygonCreate a cts:polygon value from a GeoJSON "Polygon" type geometry object or a sequence of GeoJSON "Point" type geometry objects.
geojson.toGeojsonConvert cts:region values into GeoJSON object nodes.
geokml.boxCreate a cts:box value from a KML LatLongBox element.
geokml.circleCreate a cts:circle value from a radius and KML Point or Location element.
geokml.complexPolygonCreate a cts:complex-polygon value from a KML Polygon element.
geokml.geospatialQueryReturns a cts:query matching points within given regions.
geokml.geospatialQueryFromElementsReturns a cts:query matching points within given regions.
geokml.interiorPolygonCreate a sequence of cts:polygon values from a KML Polygon element.
geokml.linestringCreate a cts:linestring value from a KML LineString element.
geokml.parseKmlConstruct regions from KML elements.
geokml.pointCreate a cts:point value from a KML Point or Location element.
geokml.polygonCreate a cts:polygon value from a KML polygon or a sequence of KML Point or Location elements.
geokml.toKmlConstruct KML elements from cts:region values.
georss.circleCreate a cts:circle value from a radius and GeoRSS point element.
georss.complexPolygonCreate a cts:complex-polygon value from a GeoRSS "Polygon" element.
georss.geospatialQueryReturns a cts:query matching points within given regions.
georss.linestringCreate a cts:linestring value from a GeoRSS line element.
georss.parseGeorssConstruct zero or more cts:region values from GeoRSS XML elements.
georss.pointCreate a cts:point value from a GeoRSS point element.
georss.polygonCreate a cts:polygon value from a sequence of GeoRSS point elements or a GeoRSS polygon element.
georss.toGeorssConvert cts:region values to GeoRSS XML elements.
Global-Object.declareUpdateDeclares the statement to be an update.
Global-Object.requireImports a module at the specified location, and returns a JavaScript object.
IteratePlan.prototype.explainThis method returns a representation of the builtin execution plan.
IteratePlan.prototype.exportThis method generates a serialized representation of the Optic query to JSON so that it can be persisted as a file or used as a REST payload.
IteratePlan.prototype.resultThis method executes the plan (mapping or reducing, if specified) to generate the result, which is a plan, document plan, prepared plan, or map or reduce result plan.
jsearch.bucketNameNames a bucket below the smallest bound, between two bounds, or above the largest bound as input for the ValuesSearch.groupInto or FacetDefinition.groupInto method.
jsearch.byExampleConstructs a cts.query working by example.
jsearch.collectionsCreates a jsearch object for searching within the scope of the union of one or more collections.
jsearch.databaseLexiconIdentifies the lexicon for all words in the database as input for the jsearch.words method.
jsearch.documentsCreates a DocumentsSearch object to define and execute a search for documents.
jsearch.documentSelectApplies document selection logic to the documents returned by cts.search, fn.collection, fn.doc, or another document iterator or to an array of documents or one document.
jsearch.elementAttributeLexiconIdentifies the word lexicon for an attribute of an element as input for the jsearch.words method.
jsearch.elementLexiconIdentifies the word lexicon for an element as input for the jsearch.words method.
jsearch.facetCreates a FacetDefinition object to define the value enumeration as part of a facet search.
jsearch.facetsCreates a FacetsSearch object to define and execute a report listing value facets and, optionally, a page of documents.
jsearch.fieldLexiconIdentifies the word lexicon for a field as input for the jsearch.words method.
jsearch.jsonPropertyLexiconIdentifies the word lexicon for a JSON property as input for the jsearch.words method.
jsearch.makeBucketsReturns a list of bounds for grouping by subdividing an interval either with a fixed step size or a fixed number of division buckets within the min and max boundary values as input for the ValuesSearch.groupInto or FacetDefinition.groupInto method.
jsearch.makeHeatmapReturns a list of bounds for grouping geospatial points as a heatmap by subdividing a geospatial box with latitude and longitude divisions as input for the ValuesSearch.groupInto or FacetDefinition.groupInto method.
jsearch.tuplesCreates a TuplesSearch object to define and execute a search for a list of rows where the values in each row co-occur in indexes for a document.
jsearch.udfIdentifies a UDF (User Defined Function) to the ValuesSearch.aggregate function for aggregating values from a single index or to the TuplesSearch.aggregate function for aggregating co-occuring values from multiple indexes.
jsearch.valuesCreates a ValuesSearch object to define and execute a search for a list of indexed values.
jsearch.wordsCreates a WordsSearch object to define and execute a search for a list of indexed words.
math.acosReturns the arc cosine of x, in radians, in the range from 0 to pi (inclusive).
math.asinReturns the arc sine of x, in radians, in the range from -pi/2 to +pi/2 (inclusive).
math.atanReturns the arc tangent of x, in radians.
math.atan2Returns the arc tangent of y/x, in radians, in the range from -pi/2 to +pi/2 (inclusive), using the signs of y and x to determine the apropriate quadrant.
math.ceilReturns the smallest integer greater than or equal to x.
math.correlationReturns the Pearson correlation coefficient of a data set.
math.cosReturns the cosine of x, in the range from -1 to +1 (inclusive).
math.coshReturns the hyperbolic cosine of x.
math.cotReturns the cotangent of x.
math.covarianceReturns the sample covariance of a data set.
math.covariancePReturns the population covariance of a data set.
math.degreesReturns numeric expression converted from radians to degrees.
math.expReturns e (approximately 2.71828182845905) to the xth power.
math.fabsReturns the absolute value of x.
math.floorReturns the largest integer less than or equal to x.
math.fmodReturns the remainder of x/y.
math.frexpReturns x broken up into mantissa and exponent, where x = mantissa*2^exponent.
math.ldexpReturns x*2^i.
math.linearModelReturns a linear model that fits the given data set.
math.linearModelCoeffReturns the coefficients of the linear model.
math.linearModelInterceptReturns the intercept of the linear model.
math.linearModelRsquaredReturns the R^2 value of the linear model.
math.logReturns the base-e logarithm of x.
math.log10Returns the base-10 logarithm of x.
math.medianReturns the median of a sequence of values.
math.modeReturns the mode of a sequence.
math.modfReturns x broken up into fraction and integer.
math.percentileReturns a sequence of percentile(s) given a sequence of percentage(s).
math.percentRankReturns the rank of a value in a data set as a percentage of the data set.
math.piReturns the value of pi.
math.powReturns x^y.
math.radiansReturns numeric expression converted from degrees to radians.
math.rankReturns the rank of a value in a data set.
math.sinReturns the sine of x, in the range from -1 to +1 (inclusive).
math.sinhReturns the hyperbolic sine of x.
math.sqrtReturns the square root of x.
math.stddevReturns the sample standard deviation of a sequence of values.
math.stddevPReturns the standard deviation of a population.
math.tanReturns the tangent of x.
math.tanhReturns the hyperbolic tangent of x, in the range from -1 to +1 (inclusive).
math.truncReturns the number truncated to a certain number of decimal places.
math.varianceReturns the sample variance of a sequence of values.
math.variancePReturns the population variance of a sequence of values.
ModifyPlan.prototype.exceptThis method restricts the left row set to rows where a row with the same columns and values doesn't exist in the right row set.
ModifyPlan.prototype.explainThis method returns a representation of the builtin execution plan.
ModifyPlan.prototype.exportThis method generates a serialized representation of the Optic query to JSON so that it can be persisted as a file or used as a REST payload.
ModifyPlan.prototype.groupByThis method collapses a group of rows into a single row.
ModifyPlan.prototype.intersectThis method restricts the left row set to rows where a row with the same columns and values exists in the right row set.
ModifyPlan.prototype.joinCrossProductThis method yields one output row set that concatenates every left row with every right row.
ModifyPlan.prototype.joinDocThis function specifies a document column to add to the rows by reading the documents for an existing source column having a value of a document uri (which can be used to read other documents) or a fragment id (which can be used to read the source documents for rows).
ModifyPlan.prototype.joinDocUriThis method adds a uri column to rows based on an existing fragment id column to identify the source document for each row.
ModifyPlan.prototype.joinInnerThis method returns all rows from multiple tables where the join condition is met.
ModifyPlan.prototype.joinLeftOuterThis method yields one output row set with the rows from an inner join as well as rows from the left row set.
ModifyPlan.prototype.limitThis method returns the specified number of rows in the result set.
ModifyPlan.prototype.mapThis method applies the specified function to each row returned by the plan to produce a different result row.
ModifyPlan.prototype.offsetThis method returns a subset of the rows in the result set by skipping the number of rows specified by start and returning the remaining rows up to the number specified by the prototype.limit method.
ModifyPlan.prototype.offsetLimitThis method returns a subset of the rows in the result set by skipping the number of rows specified by start and returning the remaining rows up to the length limit.
ModifyPlan.prototype.orderByThis method sorts the row set by the specified order definition.
ModifyPlan.prototype.prepareThis method prepares the specified plan for execution as an optional final step before execution.
ModifyPlan.prototype.reduceThis method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array.
ModifyPlan.prototype.resultThis method executes the plan (mapping or reducing, if specified) to generate the result, which is a plan, document plan, prepared plan, or map or reduce result plan.
ModifyPlan.prototype.selectThis call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set.
ModifyPlan.prototype.unionThis method yields all of the rows from the input row sets.
ModifyPlan.prototype.whereThis method restricts the row set to rows matched by the boolean expression.
ModifyPlan.prototype.whereDistinctThis method removes duplicate rows from the row set.
NamedNodeMap.getNamedItemReturn the named node, if it exists in the map.
NamedNodeMap.getNamedItemNSReturn the node with the given localname and namespace URI, if it exists in the map.
Node.baseURIReturns a string representing the base URI of the node.
Node.nodeKindReturn a string indicating the type of the node.
Node.nodeTypeReturn the DOM code indicating the type of the node.
Node.toObjectThis is inherited from the Value object. Return a JavaScript object value.
Node.toStringThis is inherited from the Value object. The atomic value of the object (for example, of the Node).
Node.valueOfThis is inherited from the Value object. The atomic value of the object (for example, of the Node).
Node.xpathEvaluate an XPath using the node as context.
NodeBuilder.addAttributeAdd an attribute node to the node tree the builder is building.
NodeBuilder.addBinaryAdd a binary node to the node tree the builder is building.
NodeBuilder.addBooleanAdd a boolean node to the node tree the builder is building.
NodeBuilder.addCommentAdd an XML comment node to the node tree the builder is building.
NodeBuilder.addDocumentAdd a document node to the node tree the builder is building.
NodeBuilder.addElementAdd an XML element node to the node tree the builder is building.
NodeBuilder.addNodeAdd a node to the node tree the builder is building.
NodeBuilder.addNullAdd a null node to the node tree the builder is building.
NodeBuilder.addNumberAdd a number node to the node tree the builder is building.
NodeBuilder.addProcessingInstructionAdd an XML processing instruction node to the node tree the builder is building.
NodeBuilder.addTextAdd a text node to the node tree the builder is building.
NodeBuilder.endDocumentClose out the current document node.
NodeBuilder.endElementClose out the current XML element node.
NodeBuilder.startDocumentStart a new document node in the node tree the builder is building.
NodeBuilder.startElementStart a new XML element node in the node tree the builder is building.
NodeBuilder.toNodeReturn the node tree that has been built.
NodeList.itemReturn the nth node.
NodeList.lengthReturn the number of nodes in the node list.
NullNode.baseURIThis is inherited from the Node object. Returns a string representing the base URI of the node.
NullNode.nodeKindThis is inherited from the Node object. Return a string indicating the type of the node.
NullNode.nodeTypeThis is inherited from the Node object. Return the DOM code indicating the type of the node.
NullNode.xpathThis is inherited from the Node object. Evaluate an XPath using the node as context.
NumberNode.baseURIThis is inherited from the Node object. Returns a string representing the base URI of the node.
NumberNode.nodeKindThis is inherited from the Node object. Return a string indicating the type of the node.
NumberNode.nodeTypeThis is inherited from the Node object. Return the DOM code indicating the type of the node.
NumberNode.xpathThis is inherited from the Node object. Evaluate an XPath using the node as context.
ObjectNode.baseURIThis is inherited from the Node object. Returns a string representing the base URI of the node.
ObjectNode.nodeKindThis is inherited from the Node object. Return a string indicating the type of the node.
ObjectNode.nodeTypeThis is inherited from the Node object. Return the DOM code indicating the type of the node.
ObjectNode.xpathThis is inherited from the Node object. Evaluate an XPath using the node as context.
op.addThis function returns the sum of the specified numeric expressions.
op.andThis function returns true if the specified boolean expressions all return true.
op.arrayAggregateThis function constructs an array whose items are the result of evaluating the column for each row in the group or row set.
op.asThis function defines a column by assigning the value of an expression over the rows in the row set.
op.ascThis function sorts the specified columndef in ascending order.
op.avgThis function averages the non-null values of the column for the rows in the group or row set.
op.callThis function calls value processing built-in functions that aren't listed in the list Value Processing Functions, the API also provides a general-purpose constructor for deferred calls.
op.caseThis function returns the specified valueExpression if the specified valueExpression is true.
op.colIdentifies a column where the column name is unique and a qualifier on the column name isn't necessary (and might not exist).
op.countThis function counts the rows where the specified input column has a value.
op.descThis function sorts the specified columndef in descending order.
op.divideThis function divides the left numericExpression by the right numericExpression and returns the value.
op.eqThis function returns true if the left and right expressions return the same value.
op.fragmentIdColSpecifies 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.
op.fromLexiconsThis function dynamically constructs a view from range indexes or the uri or collection lexicons.
op.fromLiteralsConstructs a literal row set as in the SQL VALUES or SPARQL VALUES statements.
op.fromTriplesReads rows by matching patterns in the triple index.
op.fromViewThis function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
op.geThis function returns true if the value of the left expression is greater than or equal to the value of the right expression.
op.graphColIdentifies the graph for a triple providing one or more columns for a row.
op.groupConcatThis function concatenates the non-null values of the column for the rows in the group or row set.
op.gtThis function returns true if the value of the left expression is greater than the value of the right expression.
op.importThis function instantiates a plan from the JSON representation of a plan that was exported by the prototype.export function.
op.isDefinedThis function tests whether the value of an expression is null in the row where the expression might be as simple as a column identified by op.col .
op.jsonArrayThis function constructs a JSON array during row processing.
op.jsonBooleanThis function constructs a JSON boolean node with the specified value.
op.jsonDocumentThis function constructs a JSON document with the root content, which must be exactly one JSON object or array node.
op.jsonNullThis function constructs a JSON null node.
op.jsonNumberThis function constructs a JSON number node with the specified value.
op.jsonObjectThis function constructs a JSON object with the specified properties.
op.jsonStringThis function constructs a JSON text node with the specified value.
op.leThis function returns true if the value of the left expression is less than or equal to the value of the right expression.
op.ltThis function returns true if the value of the left expression is less than the value of the right expression.
op.maxThis function gets the largest non-null value of the column for the rows in the group or row set.
op.minThis function gets the smallest non-null value of the column for the rows in the group or row set.
op.moduloThis function returns the remainder afer the division of the dividend and divisor expressions.
op.multiplyThis function multipies the left numericExpression by the right numericExpression and returns the value.
op.neThis function returns true if the value of the left expression is not equal to the value of the right expression.
op.notThis function returns true if neither of the specified boolean expressions return true.
op.onSpecifies an equijoin using one columndef each from the left and right rows.
op.orThis function returns true if either of the specified boolean expressions return true.
op.paramThis function creates a placeholder for a literal value in an expression or as the offset or max for a limit.
op.patternThis function builds the parameters for the op.fromTriples function.
op.prefixerThis function factory returns a new function that takes a name parameter and prepends the specified base URI onto the name.
op.propThis function specifies the key expression and value content for a JSON property of a JSON object contructed by the op.jsonObject function.
op.sampleThis function randomly selects one non-null value of the column from the rows in the group or row set.
op.schemaColUnambiguously identifies a column with the schema name, view name, and column name.
op.sequenceAggregateThis call constructs a sequence whose items are the values of a column for each row in the group or row set.
op.subtractThis function subtracts the right numericExpression from the left numericExpression and returns the value.
op.sumThis function adds the non-null values of the column for the rows in the group or row set.
op.udaThis 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.
op.viewColIdentifies a column where the combination of view and column name is unique.
op.whenThis function executes the specified expression if the specified condition is true for the row.
op.xmlAttributeThis function constructs an XML attribute with the name (which can be a string or QName) and atomic value.
op.xmlCommentThis function constructs an XML comment with the atomic value.
op.xmlDocumentThis function constructs an XML document with the root content, which must be exactly one node.
op.xmlElementThis function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
op.xmlPIThis function constructs an XML processing instruction with the atomic value.
op.xmlTextThis function constructs an XML text node with the specified value.
op.xpathThis function extracts a sequence of child nodes from a column with node values -- especially, the document nodes from a document join.
PreparePlan.prototype.explainThis method returns a representation of the builtin execution plan.
PreparePlan.prototype.exportThis method generates a serialized representation of the Optic query to JSON so that it can be persisted as a file or used as a REST payload.
PreparePlan.prototype.mapThis method applies the specified function to each row returned by the plan to produce a different result row.
PreparePlan.prototype.reduceThis method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array.
PreparePlan.prototype.resultThis method executes the plan (mapping or reducing, if specified) to generate the result, which is a plan, document plan, prepared plan, or map or reduce result plan.
ProcessingInstruction.attributesThis is inherited from the XMLNode object. The attributes of this node.
ProcessingInstruction.childNodesThis is inherited from the XMLNode object. The children of this node.
ProcessingInstruction.firstChildThis is inherited from the XMLNode object. The first child of this node, if any.
ProcessingInstruction.hasAttributesThis is inherited from the XMLNode object. Whether this node has attributes.
ProcessingInstruction.hasChildNodesThis is inherited from the XMLNode object. Whether this node has any children.
ProcessingInstruction.isEqualNodeThis is inherited from the XMLNode object. Whether this node is equal to another node.
ProcessingInstruction.isSameNodeThis is inherited from the XMLNode object. Whether this node is the same exact node as another node.
ProcessingInstruction.lastChildThis is inherited from the XMLNode object. The last child of this node, if any.
ProcessingInstruction.localNameThis is inherited from the XMLNode object. Return the local name of this node.
ProcessingInstruction.namespaceURIThis is inherited from the XMLNode object. Return the namespace URI of this node.
ProcessingInstruction.nextSiblingThis is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any.
ProcessingInstruction.nodeNameThis is inherited from the XMLNode object. The DOM name of the node.
ProcessingInstruction.nodeValueThis is inherited from the XMLNode object. The DOM value of the node.
ProcessingInstruction.ownerDocumentThis is inherited from the XMLNode object. The document node containing this node, if any.
ProcessingInstruction.parentNodeThis is inherited from the XMLNode object. The node that is this node's parent.
ProcessingInstruction.prefixThis is inherited from the XMLNode object. Return the namespace prefix of this node.
ProcessingInstruction.previousSiblingThis is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any.
ProcessingInstruction.targetThe target of an XML processing instruction.
ProcessingInstruction.textContentThis is inherited from the XMLNode object. The DOM text value of the node.
prof.evalEvaluate a string as JavaScript for profiling.
rdf.langStringReturns an rdf:langString value with the given value and language tag.
rdf.langStringLanguageReturns the language of an rdf:langString value.
rdt.redactApply redaction rules to a set of XML and/or JSON documents, returning the resulting documents.
rdt.ruleValidateValidate the redaction rules in one or more redaction rule collections and return the URIs of the rule documents validated.
sc.annotationsReturns the schema annotations of the component, if any.
sc.attributeDeclReturns the attribute declaration of item, as a schema component, if any.
sc.attributesReturns the attribute declarations of the schema component, if any.
sc.canonicalPathReturns the canonical schema component path of the component.
sc.complexTypeReturns the complex type of item, as a schema component, if any.
sc.componentPropertyReturns the named property of the schema component.
sc.elementDeclReturns the element declaration of item, as a schema component, if any.
sc.facetsReturns the facets of the component, if any.
sc.functionParameterTypeReturns the declared parameter type of a specific parameter of the function item as a schema component.
sc.functionReturnTypeReturns the return type of a function item as a schema component.
sc.nameReturns the name of the schema component, if any.
sc.particlesReturns the particles of the schema component, if any.
sc.schemaReturns the root schema of the item.
sc.schemaFromPathGet a schema object as a value based on its namespace and schema location hint.
sc.simpleTypeReturns the simple type of item, as a schema component, if any.
sc.typeReturns the type of item, as a schema component, if any.
sc.typeApplyApply a type to an item to construct a typed instance of that type.
sc.typeNamedReturns the type with the given name, if any, as a schema component.
sem.bnodeThis function returns an identifier for a blank node, allowing the construction of a triple that refers to a blank node.
sem.coalesceReturns the value of the first argument that evaluates without error.
sem.curieExpandThis function expands a CURIE (Compact URI) into a sem:iri object.
sem.curieShortenThis function shortens an IRI into a CURIE (Compact URI) into a sem:iri object.
sem.databaseNodesThis function returns database nodes backing given triples.
sem.datatypeReturns the name of the simple type of the atomic value argument as a SPARQL style IRI.
sem.defaultGraphIriReturns the iri of the default graph.
sem.describeThis function implements the Concise Bounded Description (CBD) specification to describe one or more nodes in the graph.
sem.graphThis function returns all triples from a named graph in the database.
sem.graphAddPermissionsAdd permissions to the graph specified.
sem.graphDeleteThis function deletes a named graph, and its graph document containing metadata, from the database.
sem.graphGetPermissionsGet permissions to the graph specified.
sem.graphInsertThis function inserts triples into a named graph, creating the graph if necessary.
sem.graphRemovePermissionsRemove permissions from the graph specified.
sem.graphSetPermissionsSet permissions to the graph specified.
sem.ifThe IF function form evaluates the first argument, interprets it as a effective boolean value, then returns the value of expression2 if the EBV is true, otherwise it returns the value of expression3.
sem.inMemoryStoreReturns a sem:store constructor that queries from the sequence of sem:triple values passed in as an argument.
sem.invalidReturns a sem:invalid value with the given literal value and datatype IRI.
sem.invalidDatatypeReturns the datatype IRI of a sem:invalid value.
sem.isBlankReturns true if the argument is an RDF blank node - that is, derived from type sem:blank.
sem.isIRIReturns true if the argument is an RDF IRI - that is, derived from type sem:iri, but not derived from type sem:blank.
sem.isLiteralReturns true if the argument is an RDF literal - that is, derived from type xs:anyAtomicType, but not derived from type sem:iri.
sem.isNumericReturns true if the argument is a valid numeric RDF literal.
sem.langReturns the language of the value passed in, or the empty string if the value has no language.
sem.langMatchesReturns true if $lang-tag matches $lang-range according to the basic filtering scheme defined in RFC4647.
sem.prefixesThis function returns a set of prefix mappings for use with CURIE processing.
sem.queryResultsSerializeThis function implements the W3C SPARQL Query Results format.
sem.randomReturns a random double between 0 and 1.
sem.rdfBuilderThis function returns a function that builds triples from CURIE and blank node syntax.
sem.rdfGetThis function returns sem:triples from a specified location.
sem.rdfInsertThis function inserts triples into a specified database as one or more sem:triples documents.
sem.rdfLoadThis function inserts an RDF document from a specified location into the designated database.
sem.rdfParseThis function returns parsed sem:triple objects from a text format or XML.
sem.rdfSerializeThis function returns a string or json or XML serialization of the provided triples.
sem.resolveIriResolves a relative URI against an absolute URI.
sem.sameTermReturns true if the arguments are the same RDF term as defined by the RDF concepts specification.
sem.sparqlExecutes a SPARQL query against the database.
sem.sparqlUpdateExecutes a SPARQL Update operation against the database.
sem.sparqlValuesThis function executes a SPARQL SELECT query using passed-in bindings participating as a starting point for the query.
sem.storeThe sem:store function defines a set of criteria, that when evaluated, selects a set of triples to be passed in to sem:sparql(), sem:sparql-update(), or sem:sparql-values() as part of the options argument.
sem.timezoneStringReturns the timezone of an xs:dateTime value as a string.
sem.transitiveClosureFrom a starting set of seeds, follow a given set of predicates, to a given depth, and return all unique node IRIs.
sem.tripleCreates a triple object, which represents an RDF triple containing atomic values representing the subject, predicate, object, and optionally graph identifier (graph IRI).
sem.tripleGraphReturns the graph identifier (graph IRI) from a sem:triple value.
sem.tripleObjectReturns the object from a sem:triple value.
sem.triplePredicateReturns the predicate from a sem:triple value.
sem.tripleSubjectReturns the subject from a sem:triple value.
sem.typedLiteralReturns a value to represent the RDF typed literal with lexical value $value and datatype IRI $datatype.
sem.unknownReturns a sem:unknown value with the given literal value and datatype IRI.
sem.unknownDatatypeReturns the datatype IRI of a sem:unknown value.
sem.uuidReturn a UUID URN (RFC4122) as a sem:iri value.
sem.uuidStringReturn a string that is the scheme specific part of random UUID URN (RFC4122).
Sequence.fromCreate a Sequence object from an array-like or iterable object.
Sequence.prototype.@@iteratorReturn an iterator object.
Sequence.prototype.toArrayReturn an array containing the values in the Sequence.
Sequence.toObjectThis is inherited from the Value object. Return a JavaScript object value.
Sequence.toStringThis is inherited from the Value object. The atomic value of the object (for example, of the Node).
Sequence.valueOfThis is inherited from the Value object. The atomic value of the object (for example, of the Node).
spell.addWordAdd the word $word to the dictionary at $uri.
spell.doubleMetaphoneGiven a word returns the two metaphone keys.
spell.insertLoad the words in $dict into the dictionary at $uri.
spell.isCorrectReturns true() if the specified word is spelled correctly, otherwise returns false().
spell.levenshteinDistanceGiven two strings, returns the Levenshtein distance between those strings.
spell.loadAdd the words from the file specified in $path to the dictionary at $uri.
spell.makeDictionaryCreates a dictionary node from a sequence of words.
spell.removeWordRemove the word $word from the dictionary at $uri.
spell.romanizeReturns the romanization of the string, substituting basic Latin letters for the letters in the string, according to their sound.
spell.suggestSuggests a list of spellings for a word.
spell.suggestDetailedSuggests a list of spellings for a word.
sql.bitLengthReturns the length of the string "str" in bits.
sql.collatedStringReturns an rdf.collatedString value with the given value and collation tag.
sql.collatedStringCollationReturns the collation of an sql.collatedString value.
sql.columnIDReturns the column ID from a schema name, a view name and a column name.
sql.dayReturns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg.
sql.daynameReturns an xs:string representing the dayname value in the localized value of $arg.
sql.differenceReturns an integer value that indicates the difference between the SOUNDEX values of two character expressions.
sql.globReturns true if the specified $input glob the specified $pattern, otherwise returns false.
sql.hoursReturns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of $arg.
sql.ifnullIf the first expression is NULL, then the value of the second expression is returned.
sql.insertReturns a string that that is the first argument with length characters removed starting at start and the second string has been inserted beginning at start.
sql.instrFind the starting location of a pattern in a string.
sql.leftReturns a string that is the leftmost characters of the target string.
sql.likeReturns true if the specified $input like the specified $pattern, otherwise returns false.
sql.ltrimReturn a string that removes leading empty spaces in the input string.
sql.minutesReturns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of $arg.
sql.monthReturns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg.
sql.monthnameReturns month name, calculated from the localized value of $arg.
sql.nullifReturns a NULL value if the two specified values are equal.
sql.octetLengthReturns the length of the string "str" in bits.
sql.quarterReturns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of $arg.
sql.randReturn a random number.
sql.repeatReturns a string that concatenates the first argument as many times as specified by the second argument.
sql.rightReturns a string that is the rightmost characters of the target string.
sql.rtrimReturn a string that removes trailing empty spaces in the input string.
sql.secondsReturns an xs:decimal value between 0 and 60.999..., both inclusive, representing the seconds and fractional seconds in the localized value of $arg.
sql.signReturns the sign of number x.
sql.soundexReturns a four-character (SOUNDEX) code to evaluate the similarity of two strings.
sql.spaceReturns a string that is the given number of spaces.
sql.strposReturns an integer value representing the starting position of a string within the search string.
sql.timestampaddReturns a xs:string? timestamp created by adding a number to the given dateTimeType field of a given timestamp.
sql.timestampdiffReturns the difference in dateTimeType field of two given timestamps.
sql.trimReturn a string that removes leading empty spaces in the input string.
sql.weekReturns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of $arg.
sql.yearReturns an xs:integer representing the year component in the localized value of $arg.
sql.yeardayReturns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of $arg.
tde.getViewThis function returns a view's description using a schema and a view name.
tde.nodeDataExtractExtracts row or triple data from a list of specified documents by applying extraction templates that are either stored in the schema database or provided as a second argument.
tde.templateInsertThis function validates the template, inserts the template as a document into the tde collection of the schema database (if executed on the content database) with the default permissions, and reindexes the database.
tde.validateIn addition to xdmp.validate that can be used for validating against the extraction template schema.
temporal.advanceLsqtThis function enables Last Stable Query Time (LSQT) on the named collection and advances the LSQT for the collection to the maximum system start time.
temporal.axesThis function returns all the axis names defined in the schema databases.
temporal.axisCreateThis function constructs an axis definition based on the existing range indexes that can be added to a temporal collection in subsequent API calls.
temporal.axisGetEndThis function returns the range index used to define the end of the period by the named axis.
temporal.axisGetStartThis function returns the range index used to define the start of the period by the named axis.
temporal.axisRemoveThis function removes an axis definition from the schema database.
temporal.collectionCreateThis function constructs a named and protected temporal collection in the schema database with the specified system and optional valid axes.
temporal.collectionGetAxisThis function returns the name of either the system or valid axis in the named temporal collection.
temporal.collectionGetOptionsThis function returns the options set on the temporal collection.
temporal.collectionRemoveThis function removes the named temporal collection from the Security database.
temporal.collectionsThis function returns all of the temporal collection names in the schema database.
temporal.collectionSetOptionsThis function sets the options on the temporal collection.
temporal.documentDeleteThis function deletes the temporal document identified by the given URI.
temporal.documentInsertThis function inserts a document into the database and stores it as a temporal document.
temporal.documentLoadThis function inserts a document into the database and stores it as a temporal document.
temporal.documentPeriodThis function returns the period (as a dateTime pair) for the named axis in the document identified by its root node in the named collection.
temporal.documentProtectProtects a temporal document from certain temporal operations, such as update, delete or wipe for a specific period of time.
temporal.documentWipeDeletes all versions of a temporal document.
temporal.getLsqtThis function returns the Last Stable Query Time (LSQT) for the collection at current moment.
temporal.getLsqtAutomationThis function returns whether Last Stable Query Time (LSQT) management is automatically managed (true) or not automatically managed (false).
temporal.getLsqtAutomationLagWhen the LSQT is advanced automatically, this function returns how far behind (in milliseconds) the Last Stable Query Time (LSQT) is from latest system time.
temporal.getLsqtAutomationPeriodThis function returns how often Last Stable Query Time (LSQT) is automatically advanced, in milliseconds.
temporal.getUseLsqtThis function specifies whether the named temporal collection has LSQT (Last Stable Query Time) enabled (true) or disabled (false).
temporal.nodeDeleteDeletes a node from the database.
temporal.nodeInsertAfterAdds an immediately following sibling to a node in a temporal document.
temporal.nodeInsertBeforeAdds an immediately preceding sibling to a node in a temporal document.
temporal.nodeInsertChildAdds a new last child to a node in a temporal document.
temporal.nodeReplaceReplaces a node in a temporal document.
temporal.setLsqtAutomationThis function sets whether Last Stable Query Time (LSQT) management is automatic.
temporal.setUseLsqtThis function enables or disables the use of LSQT (Last Stable Query Time) on the named collection.
temporal.statementGetSystemTimeThis function gets the system start time on temporal documents that are inserted or deleted in the same statement as this function.
temporal.statementSetDocumentVersionUriThis function sets document URI for a temporal document to be used for the new version of temporal document to be generated in the current statement.
temporal.statementSetSystemTimeThis function sets the system start time on temporal documents that are inserted or deleted in the same statement as this function.
Text.dataThis is inherited from the CharacterData object. The character data.
Text.isElementContentWhitespaceThis is inherited from the CharacterData object. Whether this text node is ignorable whitespace.
Text.lengthThis is inherited from the CharacterData object. The length of the character data (codepoints).
Text.substringThis is inherited from the CharacterData object. A substring of the character data, starting at a given offset and continuing for a given length.
Text.wholeTextThis is inherited from the CharacterData object. The text of the text node concatenated with its logically adjacent text nodes.
thsr.addSynonymAdds a synonym to the specified thesaurus entry.
thsr.expandReturns a query that searches for all the query strings specified in $query and their synonyms as found in $entries.
thsr.insertLoad the entries in $thsr into the thesaurus at $uri.
thsr.loadLoad the file specified in $path to the thesaurus at $uri.
thsr.lookupReturns all entries for term $term in the thesaurus document(s) at $uri.
thsr.queryLookupReturns a Sequence of all entries that are found by looking up terms in the query and/or subqueries of $query in the thesaurus document(s) at $uri.
thsr.removeEntryRemoves all entries that exactly match $entry from the thesaurus documents(s) at $uri.
thsr.removeSynonymRemoves synonym $synonym from thesaurus entry $entry.
thsr.removeTermRemoves all entries with term $term from the thesaurus document(s) at $uri.
thsr.setEntryAdds the entry $entry to the thesaurus at $uri.
TuplesSearch.aggregateApplies one or more aggregates to the tuples.
TuplesSearch.mapSpecifies a function similar to Array.prototype.map() to apply to each tuple within the slice or the configuration for the built-in mapper.
TuplesSearch.orderBySpecifies the sort method for the tuples.
TuplesSearch.reduceSpecifies a function similar to Array.prototype.reduce() to apply to each tuple within the slice.
TuplesSearch.resultExecutes the tuples search definition and returns results.
TuplesSearch.sliceSpecifies a subset of tuples to retrieve.
TuplesSearch.whereSpecifies which documents have the co-occurring values.
TuplesSearch.withOptionsConfigure advanced options for a tuples query.
TypeInfo.isDerivedFromWhether this type is derived from a named type by the selected methods.
TypeInfo.toObjectThis is inherited from the Value object. Return a JavaScript object value.
TypeInfo.toStringThis is inherited from the Value object. The atomic value of the object (for example, of the Node).
TypeInfo.typeNameThe local name of the type.
TypeInfo.typeNamespaceThe namespace URI of the type.
TypeInfo.valueOfThis is inherited from the Value object. The atomic value of the object (for example, of the Node).
Value.toObjectReturn a JavaScript object value.
Value.toStringThe atomic value of the object (for example, of the Node).
Value.valueOfThe atomic value of the object (for example, of the Node).
ValueIterator.clone[DEPRECATED: Only available for type checking; use Sequence instead.] Clone the value iterator.
ValueIterator.count[DEPRECATED: Only available for type checking; use Sequence instead.] Return a count of how many values are in the iterator.
ValueIterator.next[DEPRECATED: Only available for type checking; use Sequence instead.] Advance the iterator to obtain the next value.
ValueIterator.toArray[DEPRECATED: Only available for type checking; use Sequence instead.] Return an array containing the values in the value iterator.
ValueIterator.toObjectThis is inherited from the Value object. Return a JavaScript object value.
ValueIterator.toStringThis is inherited from the Value object. The atomic value of the object (for example, of the Node).
ValueIterator.valueOfThis is inherited from the Value object. The atomic value of the object (for example, of the Node).
ValuesSearch.aggregateApplies one or more aggregates to the values in the index.
ValuesSearch.groupIntoGroups the values into buckets between bound values, which must appear in increasing order.
ValuesSearch.mapSpecify a function similar to Array.prototype.map() to apply to each value within the slice, or configure the built-in mapper.
ValuesSearch.matchLimits the values to those that match the pattern.
ValuesSearch.orderBySpecifies the sort order for values.
ValuesSearch.reduceSpecifies a function similar to Array.prototype.reduce() to apply to each value within the slice or a configuration object for the built-in reducer.
ValuesSearch.resultExecutes the values search definition and returns an array or object depending on whether the results are generated by default, with a mapper, or with a reducer.
ValuesSearch.sliceSpecifies a subsequence of values to retrieve.
ValuesSearch.whereSpecifies which documents have values in the index.
ValuesSearch.withOptionsConfigure advanced options for a values query.
WordsSearch.mapSpecifies a function similar to Array.prototype.map() to apply to each word within the slice.
WordsSearch.matchLimits the words returned by a word lexicon query to those that match a wildcard pattern.
WordsSearch.orderBySpecifies the sort order for the words.
WordsSearch.reduceSpecifies a function similar to Array.prototype.reduce() to apply to each word within the slice.
WordsSearch.resultExecutes the words search definition and returns an array or object depending on whether the results are generated by default, with a mapper, or with a reducer.
WordsSearch.sliceSpecify a positional subset of words to retrieve.
WordsSearch.whereLimit the words returned by a word lexicon query to those in documents selected by a query.
WordsSearch.withOptionsConfigure advanced options for a words query.
xdmp.accessReturns whether a given action on the specified document URI would succeed.
xdmp.add64Add two 64-bit integer values, discarding overflow.
xdmp.addResponseHeaderAdds an HTTP response header field.
xdmp.ampReturns the amp ID for the specified amp.
xdmp.ampRolesReturns the set of all roles assigned to an amp, including roles directly assigned to the amp and roles inherited by other roles.
xdmp.and64AND two 64-bit integer values.
xdmp.applyApplies an xdmp:function with the given parameters.
xdmp.architectureReturns the hardware architecture upon which MarkLogic Server is running.
xdmp.arrayValuesReturns the array values as a Sequence.
xdmp.atomizableReturns true if a value could be atomized without error.
xdmp.base64DecodeConverts base64-encoded string to plaintext.
xdmp.base64EncodeConverts plaintext into base64-encoded string.
xdmp.binaryDecodeConverts an encoded byte sequence, passed in as a binary node, from the specified encoding to a unicode string.
xdmp.binaryIsExternalTest whether or not a binary node represents an external binary.
xdmp.binaryIsLargeCheck whether a binary node is a large binary.
xdmp.binaryIsSmallCheck whether a binary node is a small binary.
xdmp.binarySizeReturns the size of the data, in bytes, represented by a binary node.
xdmp.binaryToIntegerParses a binary string, returning an integer.
xdmp.bootstrapHostsReturns a sequence of the IDs of all the bootstrap hosts in the cluster.
xdmp.cacheStatusReturns the status of the caches as a Sequence of ObjectNodes.
xdmp.callerDialectReturns the dialect (e.g., "javascript", "1.0-ml", etc) of the caller or the empty sequence if no dialect information is available.
xdmp.canGrantRolesTests whether a user can grant or revoke a set of roles.
xdmp.castableAsReturns true if a value is castable.
xdmp.clusterReturns the ID of the cluster named in the parameter.
xdmp.clusterEffectiveVersionReturns the current MarkLogic Server effective version.
xdmp.clusterNameReturns the name of the cluster with the specified ID.
xdmp.clusterVersionAtLeastReturns true current MarkLogic Server effective version is equal or greater that the version
xdmp.collationCanonicalUriReturns the canonical URI for the given URI, if it represents a valid collation.
xdmp.collectionDeleteDeletes from the database every document in a collection.
xdmp.collectionLocksReturns locks of documents in a collection.
xdmp.collectionPropertiesReturns a sequence of properties documents, one for each document in the specified collection(s) that has a corresponding properties document.
xdmp.commitCommit the current transaction to the database.
xdmp.configurationTimestampReturns timestamp of last configuration changed
xdmp.credentialReturns the credential
xdmp.credentialIdReturns the id of a named credential.
xdmp.credentialsReturns the credentials that the current user is allowed to use.
xdmp.cryptCalculates the password hash for the given password and salt.
xdmp.crypt2Calculates the password hash for the given plain-text password.
xdmp.databaseReturns the ID of the database named in the parameter.
xdmp.databaseAssignmentPolicyThis function returns the assignment policy for the specified database.
xdmp.databaseBackupStarts an asynchronous backup of the specified list of forests to the backup data directory.
xdmp.databaseBackupCancelCancels an outstanding backup job with the specified job ID, returning true if the cancel operation is successful, false if the cancel operation is not successful.
xdmp.databaseBackupPurgePurge old backups from a directory.
xdmp.databaseBackupStatusChecks the status of the outstanding backup job with the specified job ID.
xdmp.databaseBackupValidateValidates that the specified list of forests can be backed up to the backup data directory.
xdmp.databaseDirectoryCreationThis function returns the directory creation setting for the specified database.
xdmp.databaseEncryptionAtRestReturns the encryption at rest setting for the database identified by database-id
xdmp.databaseEncryptionKeyIdReturns the encryption key ID for the database identified by database-id
xdmp.databaseForestsReturns a sequence of forest IDs in the specified database.
xdmp.databaseGlobalNonblockingTimestampReturns the most recent commit timestamp for which a query on the database including its foreign database will not block waiting for transactions to commit or journal frames to arrive from a foreign master.
xdmp.databaseIncrementalBackupStarts an asynchronous incremental backup of the specified list of forests to the backup data directory.
xdmp.databaseIncrementalBackupValidateValidates that the specified list of forests can be backed up to the backup data directory.
xdmp.databaseIsForestRetiredThis function returns true if the specificed forest is retired and false the specificed forest is not retired.
xdmp.databaseIsRebalancerEnableThis function returns the rebalancer enable setting for the specified database.
xdmp.databaseIsReplicaTests if a database is a replica of a foreign database.
xdmp.databaseJournalArchivePurgePurge journal archive before last incremental backup from a directory.
xdmp.databaseNameReturn the name of the database with the given ID.
xdmp.databaseNodeQueryRolesetsReturn a sequence of query-rolesets that are required for proper querying of the given database nodes with Element Level Security.
xdmp.databaseNonblockingTimestampReturns the most recent commit timestamp for which a query on the database will not block waiting for transactions to commit or journal frames to arrive from a foreign master.
xdmp.databasePathNamespacesReturns the list of path namespaces for the given database id.
xdmp.databaseRestoreStarts an asynchronous restore of the specified list of forests from the backup data directory.
xdmp.databaseRestoreCancelCancels an outstanding restore job with the specified job ID, returning true if the cancel operation is successful, false if the cancel operation is not successful.
xdmp.databaseRestoreStatusChecks the status of the outstanding restore job with the specified job ID.
xdmp.databaseRestoreValidateValidates that the specified list of forests can be restored from the backup data directory.
xdmp.databasesReturns a sequence of the IDs of all the databases in the system.
xdmp.daynameFromDateReturns an xs:string representing the dayname value in the localized value of $arg.
xdmp.decodeFromNCNameInvertible function that decodes characters an NCName produced by xdmp:encode-for-NCName.
xdmp.defaultCollectionsReturns the collections any new document would get if the current user were to insert a document without specifying the collections.
xdmp.defaultPermissionsReturns the permissions any new document would get if the current user were to insert a document without specifying the default permissions.
xdmp.describeReturns a string representing the description of a given item sequence.
xdmp.diacriticLessReturns the specified string, converting all of the characters with diacritics to characters without diacritics.
xdmp.directoryReturns the documents from the database in a directory.
xdmp.directoryCreateCreates a directory.
xdmp.directoryDeleteDeletes a directory and all of its child and descendant documents and directories from the database.
xdmp.directoryLocksReturns locks of documents in a directory.
xdmp.directoryPropertiesReturns a sequence of properties documents, one for each document in the specified directory that has a corresponding properties document.
xdmp.documentAddCollectionsAdds the named document to the given collections.
xdmp.documentAddPermissionsAdds the given permissions to the given document or directory.
xdmp.documentAddPropertiesAdds a sequence of properties to the properties of a document.
xdmp.documentAssignAssign a document URI to a forest index, using the same algorithm as xdmp:document-insert.
xdmp.documentDeleteDeletes a document from the database.
xdmp.documentFilterFilters a wide variety of document formats, extracting metadata and text, and returning XHTML.
xdmp.documentForestReturns the forest ID of the forest in which a document (or a lock or a property) with the specified URI is stored.
xdmp.documentGetReturns the document in the file specified by $location.
xdmp.documentGetCollectionsReturns the collections to which a given document belongs.
xdmp.documentGetMetadataReturns the metadata value of a given document.
xdmp.documentGetMetadataValueReturns the metadata value of a given document.
xdmp.documentGetPermissionsReturns the permissions to a given document.
xdmp.documentGetPropertiesReturns the property values for a document's property.
xdmp.documentGetQualityReturns the quality of the specified document if the document exists.
xdmp.documentInsertInserts a new document into the database if a document with the specified URI does not already exist.
xdmp.documentLoadInserts a new document with the specified URI.
xdmp.documentLocksReturns the locks for one or more documents or directories.
xdmp.documentPartitionAssignAssign a document to a partition number, using the partition queries in the database or in the second argument.
xdmp.documentPropertiesReturns a sequence of properties documents, one for each of the specified documents that has a corresponding properties document.
xdmp.documentPutMetadataAdds metadata to the document.
xdmp.documentRemoveCollectionsRemoves the named document from the given collections.
xdmp.documentRemoveMetadataRemoves metadata with certain keys from a document.
xdmp.documentRemovePermissionsRemoves the given permissions from the named document or directory.
xdmp.documentRemovePropertiesRemoves a sequence of properties from the properties of a document.
xdmp.documentSetCollectionsSets the named document to belong to the given collections, replacing any previously set collections on the named document.
xdmp.documentSetMetadataSets metadata to the document.
xdmp.documentSetPermissionsSets the permissions on the named document (or directory) to the given permissions, replacing any permissions previously set on the document (or directory).
xdmp.documentSetPropertiesSets the properties of a document to the given sequence of elements, replacing any properties that already exist on the document.
xdmp.documentSetPropertySets a property on a document.
xdmp.documentSetQualitySets the quality of the document with the given URI.
xdmp.documentTimestampReturns timestamp of the most recent visible update to a document, lock, or property.
xdmp.effectiveVersionReturns the effective version of this host
xdmp.elapsedTimeReturns the elapsed time since the start of processing of this query.
xdmp.elementContentTypeReturns the schema-defined content-type of an element ("empty", "simple", "element-only", or "mixed").
xdmp.emailSend an email in an JavasCript program.
xdmp.encodeForNCNameInvertible function that escapes characters required to be part of an NCName.
xdmp.encodingLanguageDetectAnalyzes binary, text, or XML data and suggests possible pairs of encoding and language, with a confidence score for each pair.
xdmp.evalReturns the result of evaluating a string as a Javascript program.
xdmp.excelConvertConverts a Microsoft Excel document to XHTML.
xdmp.externalBinaryReturns an external binary node.
xdmp.externalBinaryPathReturn the path to the external file associated with an external binary document.
xdmp.externalSecurityReturns the external security ID for the specified external security name.
xdmp.filesystemDirectoryPerforms a directory listing of the given file pathname.
xdmp.filesystemDirectoryCreateCreates the directory specified by pathname.
xdmp.filesystemDirectoryDeleteDeletes the directory specified by pathname.
xdmp.filesystemFileReads a file from the filesystem.
xdmp.filesystemFileEncryptionStatusReturn the file's encryption status
xdmp.filesystemFileExistsReturn true if a file exists on a host; otherwise false.
xdmp.filesystemFileGetTimeReturns access and modification time for a file.
xdmp.filesystemFileLengthReads the length of a file from the filesystem.
xdmp.filesystemFilepathReturns the canonicalized file path of the input path.
xdmp.filesystemFileSetTimeSets access and modification time for a file.
xdmp.foreignClustersReturns the IDs of the foreign clusters.
xdmp.foreignClusterStatusReturns the status of a foreign cluster from a host's point of view as a JSON node.
xdmp.forestReturns the ID of the forest specified as the parameter.
xdmp.forestBackupBacks up forest data files.
xdmp.forestBackupStatusChecks the status of the specified forests for any outstanding backup jobs.
xdmp.forestClearClears forest data files, including all stands and journals.
xdmp.forestCountsReturns detailed forest statistics for a given forest as a Sequence of ObjectNodes.
xdmp.forestDatabasesReturns the database ID corresponding to the database to which the specified forest belongs.
xdmp.forestFailoverInfoReturn a sequence of pair of the forest IDs and host IDs for the failover forests and hosts of the given forest.
xdmp.forestHostReturn the host of the forest with the given id.
xdmp.forestNameReturn the name of the forest with the given ID.
xdmp.forestOnlineReturns true if the specified forest is online with a state of open, open replica or sync replicating if isReplica is true, or syncing replica if syncingOk is true, otherwise returns false.
xdmp.forestOpenReplicaReturns the forest ID for each specified forest or for each forest's replica if the forest is currently experiencing a local disk failover.
xdmp.forestRestartRestarts a forest.
xdmp.forestRestoreRestores forest data files.
xdmp.forestRollbackRolls forests back to a previous point in time, marking any fragment newer than the specified timestamp as deleted.
xdmp.forestsReturns a sequence of the IDs of all the forests in the system.
xdmp.forestStateReturns state of the forests
xdmp.forestStatusReturns the status of a forest as a Sequence of ObjectNodes.
xdmp.forestUpdatesAllowedReturn updates allowed state of the forest with the given ID.
xdmp.formatNumberReturns a formatted number value based on the picture argument.
xdmp.fromJSONAtomizes a JSON node, returning a JSON value.
xdmp.fromJsonStringParses a string as JSON, returning an item sequence.
xdmp.functionReturns a function value as an xdmp.function type.
xdmp.functionModuleReturns the module location (if any) that the xdmp:function value refers to.
xdmp.functionNameReturns the QName of the function(s) that the xdmp:function refers to.
xdmp.functionParameterNameReturns the name of the parameter at the designated (1-based) position from the given function's signature.
xdmp.functionParameterTypeReturns the type of the parameter at the designated (1-based) position from the given function's signature.
xdmp.functionReturnTypeReturns the return type from the given function's signature.
xdmp.functionSignatureReturns the signature of the function that the argument refers to.
xdmp.getCurrentRolesReturns all the current roles, both assigned and inherited by the current user and any received from amps.
xdmp.getCurrentUserReturns the name of the current user.
xdmp.getCurrentUseridReturns the ID of the current user.
xdmp.getInvokedPathReturns the path of the module that is being invoked.
xdmp.getOriginalUrlReturns the portion of the URL following the host_name:port_number.
xdmp.getOrphanedBinariesReturns a sequence of the IDs of all orphaned large binaries in a given forest.
xdmp.getRequestBodyFor PUT requests, returns the body of the request.
xdmp.getRequestClientAddressReturns as a string the internet address of the client from which the HTTP server request is issued.
xdmp.getRequestClientCertificateReturns the PEM encoded client certificate if one was presented.
xdmp.getRequestErrorFormatReturns the current error format for the request.
xdmp.getRequestFieldReturns the value of a named request field.
xdmp.getRequestFieldContentTypeThis function is used to extract the content type from the request field.
xdmp.getRequestFieldFilenameReturns a list of filenames from a multipart request for the field name specified.
xdmp.getRequestFieldNamesReturns a sequence of the request field names.
xdmp.getRequestHeaderReturns the value of a named request header.
xdmp.getRequestHeaderNamesReturns a sequence of request header names.
xdmp.getRequestMethodReturns the HTTP request method.
xdmp.getRequestPathReturns the HTTP request path.
xdmp.getRequestPortReturns the port of the request.
xdmp.getRequestProtocolReturns as a string the request protocol (either "http" or "https") Returns the empty sequence if it is not called from an HTTP server.
xdmp.getRequestUrlReturns the portion of the URL following the host_name:port_number.
xdmp.getRequestUserIf this App Server is using application-level authentication, returns the ID of the user in the last successful call to xdmp:login.
xdmp.getRequestUsernameIf this App Server is using application-level authentication, returns the username in the last successful call to xdmp:login.
xdmp.getResponseCodeReturns two nodes, the first containing the HTTP response code and the second containing the HTTP response message.
xdmp.getResponseEncodingReturns the encoding that the response from this server is in.
xdmp.getServerFieldReturns the value of a named server field.
xdmp.getServerFieldNamesReturns a sequence of the server field names.
xdmp.getSessionFieldReturns the value of a named session field from the session created by the xdmp:login function.
xdmp.getSessionFieldNamesReturns a sequence of the HTTP session field names from the session created by the xdmp:login function.
xdmp.getTransactionModeRetrieve the transaction mode for the current session.
xdmp.getUrlRewriterPathReturns the URL of the URL rewriter handler for this application server.
xdmp.groupReturns the ID of the group specified in the parameter.
xdmp.groupGetAuditEventTypeEnabledThis function returns the audit event type's enabled setting for the audit configuration.
xdmp.groupHostsReturns the IDs of all hosts belonging to the group with the given ID.
xdmp.groupNameReturns the name of the group with the given ID.
xdmp.groupsReturns a sequence of the IDs of all the groups in the system.
xdmp.groupServersReturns the IDs of all App Servers belonging to the group with the given ID.
xdmp.gssServerNegotiateThis function is used for kerberos GSS authentication in application level authentication.
xdmp.gunzipGet a node from a gzip node.
xdmp.gzipCreate a gzip node from a node.
xdmp.hash32Returns the 32-bit hash of a string.
xdmp.hash64Returns the 64-bit hash of a string.
xdmp.hasPrivilegeTests whether the current user has at least one of a given set of privileges.
xdmp.hexToIntegerParses a hexadecimal string, returning an integer.
xdmp.hmacMd5Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
xdmp.hmacSha1Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
xdmp.hmacSha256Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
xdmp.hmacSha512Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
xdmp.hostReturns the ID of the host named in the parameter.
xdmp.hostForestsReturns a sequence of forest IDs in the specified host.
xdmp.hostGetSslFipsEnabledReturns whether fips mode is enabled.
xdmp.hostGroupReturns the ID of the group that the specified host belongs to.
xdmp.hostModeReturns this host mode
xdmp.hostModeDescriptionReturn the description string for this host mode setting
xdmp.hostNameReturns the name of the specified host.
xdmp.hostsReturns a sequence of the IDs of all the hosts in the cluster.
xdmp.hostStatusReturns the status of a host as a JSON node.
xdmp.httpDeleteSends an http DELETE request to the http server specified in the URI to delete the specified resource.
xdmp.httpGetSends the http GET method to the specified URI.
xdmp.httpHeadSends the http HEAD method to the specified URI.
xdmp.httpOptionsSends the http OPTIONS method to the specified URI.
xdmp.httpPostSends an http POST request to the server.
xdmp.httpPutSends an HTTP PUT request to an HTTP server.
xdmp.initcapReturns the string where the first letter of each token has been uppercased.
xdmp.integerToBinaryReturns a binary representation of an integer.
xdmp.integerToHexReturns a hexadecimal representation of an integer.
xdmp.integerToOctalReturns an octal representation of an integer.
xdmp.invokeReturns the result of evaluating a module at the given path.
xdmp.invokeFunctionReturns the result of evaluating a JavaScript function value.
xdmp.isWhitespaceNodeReturns true if the node is a text node containing only whitespace.
xdmp.keyFromQNameConstruct a context-independent string from a QName.
xdmp.keystoreExportExports all encryption keys stored in the MarkLogic embedded KMS.
xdmp.keystoreImportImport encryption keys into the MarkLogic embedded KMS from an exported encrypted file (see keystore-export).
xdmp.keystoreStatusReturns the status of the keystore
xdmp.keystoreValidateExportedValidates the content of an exported keystore file, see keystore-export and keystore-import
xdmp.ldapLookupReturns an ldap entry.
xdmp.ldapSearchReturns ldap search result.
xdmp.load[DEPRECATED: use xdmp:document-load instead] Inserts a new document from the XML file at $path if a document with the specified URI does not already exist.
xdmp.lockAcquireAcquire a lock on a document or directory for an extended amount of time.
xdmp.lockForUpdateAcquires an intent exclusive transaction lock on a URI.
xdmp.lockReleaseUnlock a document or directory.
xdmp.logLogs a message into a specific app server error log file.
xdmp.loginLogs in a user on an application server that is using application-level authentication and sends a session cookie containing the session ID to the user's browser.
xdmp.logLevelRetrieves the current server log level.
xdmp.logoutLogs the current user out of the session on the server.
xdmp.lshift64Left-shift a 64-bit integer value.
xdmp.md5Calculates the md5 hash of the given argument.
xdmp.mergeStarts merging the forests of the database, subject to specified options.
xdmp.mergeCancelCancel the merge with the specified merge ID on a forest with the specified forest ID.
xdmp.mergingReturns the forest IDs of any currently merging database forests.
xdmp.mimetypesThis function returns all the mimetypes specifications of the cluster.
xdmp.modulesDatabaseReturns the database ID of the modules database.
xdmp.modulesRootReturns the current root path for modules.
xdmp.monthNameFromDateReturns month name, calculated from the localized value of $arg.
xdmp.mul64Muliply two 64-bit integer values, discarding overflow.
xdmp.multipartDecodeExtract the parts from a multipart encoding.
xdmp.multipartEncodeCreate a multipart encoding of the specified node.
xdmp.nodeCollectionsReturns any collections for the node's document in the database.
xdmp.nodeDatabaseReturns the database id where the parameter is stored.
xdmp.nodeDeleteDeletes a node from the database.
xdmp.nodeInsertAfterAdds an immediately following sibling to a node.
xdmp.nodeInsertBeforeAdds an immediately preceding sibling to a node.
xdmp.nodeInsertChildAdds a new last child to a node.
xdmp.nodeKindReturns an xs:string representing the node's kind: either "document", "element", "attribute", "text", "namespace", "processing-instruction", "binary", or "comment".
xdmp.nodeMetadataReturns the metadata value of a given node.
xdmp.nodeMetadataValueReturns the metadata value of a node for a particular key.
xdmp.nodePermissionsReturns the permissions to a node's document.
xdmp.nodeQueryRolesetsReturn a sequence of query-rolesets that are required for proper querying with Element Level Security if the node is inserted into the database with the given document-insert options.
xdmp.nodeReplaceReplaces a node.
xdmp.nodeUriReturns the document-uri property of the parameter or its ancestor.
xdmp.not64NOT a 64-bit integer value.
xdmp.octalToIntegerParses an octal string, returning an integer.
xdmp.or64OR two 64-bit integer values.
xdmp.parseDateTimeParses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
xdmp.parseYymmddParses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
xdmp.partitionForestsReturns a seequence of forest IDs with the specified partition number
xdmp.pathReturns a string whose value corresponds to the path of the node.
xdmp.pdfConvertConverts a PDF file to XHTML.
xdmp.permissionReturns a permission object corresponding to the named role and capability given.
xdmp.platformReturns the operating-system platform upon which MarkLogic Server is running ("solaris", "winnt", "linux", or "macosx").
xdmp.positionReturns an integer value representing the starting position of a string within the search string.
xdmp.powerpointConvertConverts a Microsoft Powerpoint document to XHTML.
xdmp.prettyPrintReturns a well-formatted XQuery module.
xdmp.privilegeReturns the privilege ID for the specified privilege name.
xdmp.privilegeRolesReturns the set of all roles that have a given privilege.
xdmp.productEditionReturns the current MarkLogic product edition.
xdmp.productEnvironmentReturns the current MarkLogic product environment.
xdmp.QNameFromKeyConstruct a QName from a string of the form "{namespaceURI}localname".
xdmp.quarterFromDateReturns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of $arg.
xdmp.queryMetersReturns the current value of the resource meters for this query sequence as a JSON node.
xdmp.queryPartitionsThis function returns the partition numbers of the partitions that the specified query will be searched on.
xdmp.queryTraceEnables or disables tracing of this query.
xdmp.quoteReturns the unevaluated serialized representation of the input parameter as a string.
xdmp.randomReturns a random unsigned integer between 0 and a number up to 64 bits long.
xdmp.rangePartitionForestsGiven a value, the function returns a list of forests that have ranges the value falls into.
xdmp.redirectResponseRedirects the App Server response to a given location.
xdmp.removeOrphanedBinaryRemove an orphaned large binary
xdmp.requestReturns the unique key of the current request.
xdmp.requestCancelCancel the request with the given host, server, and request IDs.
xdmp.requestStatusReturns the status of a running request as a Sequence of ObjectNodes.
xdmp.requestTimestampReturns the system timestamp for this request if the request is a query statement.
xdmp.resolveUriResolves a relative URI against an absolute URI.
xdmp.restartRestart servers on hosts.
xdmp.rethrowWithin the catch section of a try-catch expression, re-throw the currently caught error.
xdmp.roleReturns the role ID for the specified role name.
xdmp.roleNameReturns the role name for the specified role id.
xdmp.roleRolesReturns the set of all roles inherited by a given role, including roles directly assigned to the role and roles inherited from other roles.
xdmp.rollbackRoll back the current transaction.
xdmp.rsaGenerateGenerate a new RSA public/private key pair.
xdmp.rshift64Right-shift a 64-bit integer value.
xdmp.saveSerializes a node as text and saves it to a file.
xdmp.schemaDatabaseReturns the database ID of the schema database associated with the current database.
xdmp.securityAssertTests whether the current user has at least one of a given set of privileges.
xdmp.securityDatabaseReturns the database ID of the security database associated with the current database.
xdmp.serverReturn the ID(s) of the App Servers, XDBC Servers, ODBC Servers, or Task Servers with the given name.
xdmp.serverCollationReturn the default collation of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverCoordinateSystemReturn the default coordinate system of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverDatabaseReturn the database ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverDefaultXqueryVersionReturn the default xquery version of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverGroupReturn the ID of the group for an App Server, XDBC Server, ODBC Server, or Task Server.
xdmp.serverModulesDatabaseReturn the modules database ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverNameReturn the name of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverPortReturn the port of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverRootReturn the root of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serversReturns a sequence of the IDs of all the App Servers (HTTP, XDBC, ODBC, and TaskServer) in the system.
xdmp.serverSslCertificateTemplateReturn the SSL certificate template ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverStatusReturns the status of an app-server on a host as a Sequence of ObjectNodes.
xdmp.setRequestTimeLimitChanges the time limit for an actively running request to the specified value.
xdmp.setResponseCodeSets the response code and message.
xdmp.setResponseContentTypeSets the response content-type.
xdmp.setResponseEncodingSets the response encoding.
xdmp.setResponseOutputMethodSets the serialization method.
xdmp.setServerFieldSets the value of a named server field.
xdmp.setServerFieldPrivilegeSets the privilege of a named server field.
xdmp.setSessionFieldSets the value of a named session field for the session created by the xdmp:login function.
xdmp.setTransactionModeSet the transaction mode for the current session.
xdmp.setTransactionNameSet the name of a local or remote transaction.
xdmp.setTransactionTimeLimitSet the transaction time limit for a local or remote transaction.
xdmp.sha1Calculates the SHA1 hash of the given argument.
xdmp.sha256Calculates the SHA256 hash of the given argument.
xdmp.sha384Calculates the SHA384 hash of the given argument.
xdmp.sha512Calculates the SHA512 hash of the given argument.
xdmp.shutdownShutdown servers on hosts.
xdmp.sleepDelays for a specific amount of time.
xdmp.softwareVersionReturns this host's software version
xdmp.spawnPlace the specified module on the task queue for evaluation.
xdmp.sqlExecutes an ad hoc SQL query.
xdmp.startJournalArchivingStarts journal archiving to the specified list of forests.
xdmp.step64Combines an initial hash with a subsequent hash.
xdmp.stopJournalArchivingStops journal archiving to the specified list of forests.
xdmp.strftimeFormats a dateTime value using POSIX strftime.
xdmp.subbinaryReturns a binary node made up of a subset of the given binary node.
xdmp.tidyRun tidy on the specified html document to convert the document to well-formed and clean XHTML.
xdmp.timestampToWallclockConverts a 64 bit timestamp value to an xs:dateTime.
xdmp.toJSONConstructs a JSON document.
xdmp.toJsonStringReturns a string representing a JSON serialization of a given item sequence.
xdmp.traceSignal a trace event.
xdmp.traceEnabledReturns whether or not a trace event is enabled.
xdmp.transactionReturns the transaction ID for the current transaction, or transaction IDs for all transactions with the given name.
xdmp.transactionCommitExplicitly commit a transaction running on a named host.
xdmp.transactionLocksReturns all URIs currently locked for read or write by a transaction.
xdmp.transactionRollbackExplicitly roll back a transaction running on a named host.
xdmp.triggersDatabaseReturns the database ID of the triggers database associated with the current database.
xdmp.typeReturns the name of the simple type of the atomic value argument as an xs:QName.
xdmp.unquoteParses a string as XML, returning one or more document nodes.
xdmp.uriContentTypeReturns the content type of the given URI as matched in the mimetypes configuration.
xdmp.uriFormatReturns the format of the given URI as matched in the mimetypes configuration.
xdmp.uriIsFileReturns true if a given URI refers to a file which exists on the current application server.
xdmp.urlDecodeConverts URL-encoded string to plaintext.
xdmp.urlEncodeConverts plaintext into URL-encoded string.
xdmp.userReturns the user ID for the specified user name.
xdmp.userExternalSecurityReturns external security id and user name for an external user.
xdmp.useridRolesReturns all roles assigned to a user, including roles directly assigned to the user and roles inherited by other roles.
xdmp.userLastLoginReturns the last-login node for the current user.
xdmp.userRolesReturns all roles assigned to a user, including roles directly assigned to the user and roles inherited by other roles.
xdmp.validateReturns an element containing a summary of validation errors in a node.
xdmp.versionReturns the current MarkLogic Server version.
xdmp.wallclockToTimestampConverts an xs:dateTime to a 64 bit timestamp value.
xdmp.weekdayFromDateReturns an xs:integer between 1 and 7, both inclusive, representing the weekday value in the localized value of $arg.
xdmp.weekFromDateReturns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of $arg.
xdmp.wordConvertConverts a Microsoft Word document to XHTML.
xdmp.x509CertificateExtractReturns the XML representation of the specified X.509 certificate.
xdmp.x509CertificateGenerateGenerate a new PEM-encoded X.509 certificate.
xdmp.x509CertificateIssuerNameReturns the issuer distinguished name for the specified X.509 certificate.
xdmp.x509CertificateSubjectNameReturns the subject distinguished name for the specified X.509 certificate.
xdmp.xaCompleteCompletes (commits or rolls back) a prepared XA transaction.
xdmp.xaForgetForgets a remembered completed XA transaction.
xdmp.xor64XOR two 64-bit integer values.
xdmp.xqueryEvalReturns the result of evaluating a string as an XQuery module.
xdmp.xsltEvalExecutes an XSLT stylesheet against a node.
xdmp.xsltInvokeExecutes an XSLT stylesheet against a node.
xdmp.yeardayFromDateReturns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of $arg.
xdmp.zipCreateCreate a zip file from a list of nodes.
xdmp.zipGetGet a named file from a zip document.
xdmp.zipManifestReturn a manifest for this zip file.
XMLDocument.attributesThis is inherited from the XMLNode object. The attributes of this node.
XMLDocument.childNodesThis is inherited from the XMLNode object. The children of this node.
XMLDocument.documentFormatThis is inherited from the Document object. The format of the document node, "JSON", "XML", "TEXT", or "BINARY".
XMLDocument.documentURIThe URI of this document.
XMLDocument.firstChildThis is inherited from the XMLNode object. The first child of this node, if any.
XMLDocument.getElementByIdGet the element in this document with the given id, if any.
XMLDocument.getElementsByTagNameReturn all the elements in the document with the given name.
XMLDocument.getElementsByTagNameNSReturn all the elements in the document with the given localname and namespace URI.
XMLDocument.hasAttributesThis is inherited from the XMLNode object. Whether this node has attributes.
XMLDocument.hasChildNodesThis is inherited from the XMLNode object. Whether this node has any children.
XMLDocument.isEqualNodeThis is inherited from the XMLNode object. Whether this node is equal to another node.
XMLDocument.isSameNodeThis is inherited from the XMLNode object. Whether this node is the same exact node as another node.
XMLDocument.lastChildThis is inherited from the XMLNode object. The last child of this node, if any.
XMLDocument.localNameThis is inherited from the XMLNode object. Return the local name of this node.
XMLDocument.namespaceURIThis is inherited from the XMLNode object. Return the namespace URI of this node.
XMLDocument.nextSiblingThis is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any.
XMLDocument.nodeNameThis is inherited from the XMLNode object. The DOM name of the node.
XMLDocument.nodeValueThis is inherited from the XMLNode object. The DOM value of the node.
XMLDocument.ownerDocumentThis is inherited from the XMLNode object. The document node containing this node, if any.
XMLDocument.parentNodeThis is inherited from the XMLNode object. The node that is this node's parent.
XMLDocument.prefixThis is inherited from the XMLNode object. Return the namespace prefix of this node.
XMLDocument.previousSiblingThis is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any.
XMLDocument.rootThis is inherited from the Document object. The root node of the document.
XMLDocument.textContentThis is inherited from the XMLNode object. The DOM text value of the node.
XMLNode.attributesThe attributes of this node.
XMLNode.baseURIThis is inherited from the Node object. Returns a string representing the base URI of the node.
XMLNode.childNodesThe children of this node.
XMLNode.firstChildThe first child of this node, if any.
XMLNode.hasAttributesWhether this node has attributes.
XMLNode.hasChildNodesWhether this node has any children.
XMLNode.isEqualNodeWhether this node is equal to another node.
XMLNode.isSameNodeWhether this node is the same exact node as another node.
XMLNode.lastChildThe last child of this node, if any.
XMLNode.localNameReturn the local name of this node.
XMLNode.namespaceURIReturn the namespace URI of this node.
XMLNode.nextSiblingThe node that is the immediately following sibling of this node, if any.
XMLNode.nodeKindThis is inherited from the Node object. Return a string indicating the type of the node.
XMLNode.nodeNameThe DOM name of the node.
XMLNode.nodeTypeThis is inherited from the Node object. Return the DOM code indicating the type of the node.
XMLNode.nodeValueThe DOM value of the node.
XMLNode.ownerDocumentThe document node containing this node, if any.
XMLNode.parentNodeThe node that is this node's parent.
XMLNode.prefixReturn the namespace prefix of this node.
XMLNode.previousSiblingThe node that is the immediately preceding sibling of this node, if any.
XMLNode.textContentThe DOM text value of the node.
XMLNode.xpathThis is inherited from the Node object. Evaluate an XPath using the node as context.
xs.date.addReturns the end of a time period by adding an xs.yearMonthDuration to the xs.date that starts the period.
xs.date.eqEquality comparison on xs.date values
xs.date.geGreater-than or equal comparison on xs.date values
xs.date.gtGreater-than comparison on xs.date values
xs.date.leLess-than or equal comparison on xs.date values
xs.date.ltLess-than comparison on xs.date values
xs.date.neNot equal comparison on xs.date values
xs.date.subtractReturns the difference between two xs.dates as an xs.dayTimeDuration.
xs.dateTime.addReturns the end of a time period by adding an xs.yearMonthDuration to the xs.dateTime that starts the period.
xs.dateTime.eqEquality comparison on xs.dateTime values
xs.dateTime.geGreater-than or equal comparison on xs.dateTime values
xs.dateTime.gtGreater-than comparison on xs.dateTime values
xs.dateTime.leLess-than or equal comparison on xs.dateTime values
xs.dateTime.ltLess-than comparison on xs.dateTime values.
xs.dateTime.neNot equal comparison on xs.dateTime values
xs.dateTime.subtractReturns the difference between two xs.dateTimes as an xs.dayTimeDuration.
xs.dayTimeDuration.addAdds two xs.dayTimeDurations.
xs.dayTimeDuration.divideDivides an xs.dayTimeDuration by an number.
xs.dayTimeDuration.eqEquality comparison on xs.dayTimeDuration values
xs.dayTimeDuration.geGreater-than or equal comparison on xs.dayTimeDuration values
xs.dayTimeDuration.gtGreater-than comparison on xs.dayTimeDuration values
xs.dayTimeDuration.leLess-than or equal comparison on xs.dayTimeDuration values
xs.dayTimeDuration.ltLess-than comparison on xs.dayTimeDuration values.
xs.dayTimeDuration.multiplyMultiplies an xs.dayTimeDuration by a number.
xs.dayTimeDuration.neNot equal comparison on xs.dayTimeDuration values
xs.dayTimeDuration.subtractSubtracts one xs.dayTimeDuration from another.
xs.gDay.eqEquality comparison on xs.gDay values
xs.gDay.neNot equal comparison on xs.gDay values
xs.gMonth.eqEquality comparison on xs.gMonth values
xs.gMonth.neNot equal comparison on xs.gMonth values
xs.gMonthDay.eqEquality comparison on xs.gMonthDay values
xs.gMonthDay.neNot equal comparison on xs.gMonthDay values
xs.gYear.eqEquality comparison on xs.gYear values
xs.gYear.neNot equal comparison on xs.gYear values
xs.gYearMonth.eqEquality comparison on xs.gYearMonth values
xs.gYearMonth.neNot equal comparison on xs.gYearMonth values
xs.time.addAdds the value of the hours, minutes and seconds components of an xs.dayTimeDuration to an xs.time value.
xs.time.eqEquality comparison on xs.time values
xs.time.geGreater-than or equal comparison on xs.time values
xs.time.gtGreater-than comparison on xs.time values
xs.time.leLess-than or equal comparison on xs.time values
xs.time.ltLess-than comparison on xs.time values
xs.time.neNot equal comparison on xs.time values
xs.time.subtractReturns the difference between two xs.times as an xs.dayTimeDuration.
xs.yearMonthDuration.addAdds two xs.yearMonthDuration.
xs.yearMonthDuration.divideDivides an xs.yearMonthDuration by an number.
xs.yearMonthDuration.eqEquality comparison on xs.yearMonthDuration values
xs.yearMonthDuration.geGreater-than or equal comparison on xs.yearMonthDuration values
xs.yearMonthDuration.gtGreater-than comparison on xs.yearMonthDuration values
xs.yearMonthDuration.leLess-than or equal comparison on xs.yearMonthDuration values
xs.yearMonthDuration.ltLess-than comparison on xs.yearMonthDuration values.
xs.yearMonthDuration.multiplyMultiplies an xs.yearMonthDuration by a number.
xs.yearMonthDuration.neNot equal comparison on xs.yearMonthDuration values
xs.yearMonthDuration.subtractSubtracts one xs.yearMonthDuration from another.
Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy