Loading TOC...

JavaScript Functions By Category (1923)

The following table lists all Server-Side JavaScript functions in the MarkLogic API reference, including all built-in functions available to JavaScript.
1922 functions
Function name Description
AccessPlan.prototype.col This method identifies a column, where the column name is unique.
AccessPlan.prototype.except This 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.explain This method returns a representation of the builtin execution plan.
AccessPlan.prototype.export This 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.groupBy This method collapses a group of rows into a single row.
AccessPlan.prototype.intersect This 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.joinCrossProduct This method yields one output row set that concatenates every left row with every right row.
AccessPlan.prototype.joinDoc This 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.joinDocUri This method adds a uri column to rows based on an existing fragment id column to identify the source document for each row.
AccessPlan.prototype.joinInner This method returns all rows from multiple tables where the join condition is met.
AccessPlan.prototype.joinLeftOuter This method yields one output row set with the rows from an inner join as well as rows from the left row set.
AccessPlan.prototype.limit This method specifies the maximum number of rows to be returned by this Plan.
AccessPlan.prototype.map This method applies the specified function to each row returned by the plan to produce a different result row.
AccessPlan.prototype.offset This 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.offsetLimit This 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.orderBy This method sorts the row set by the specified order definition.
AccessPlan.prototype.prepare This method prepares the specified plan for execution as an optional final step before execution.
AccessPlan.prototype.reduce This 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.result This 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.select This call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set.
AccessPlan.prototype.union This method yields all of the rows from the input row sets.
AccessPlan.prototype.where This method restricts the row set to rows matched by the boolean expression.
AccessPlan.prototype.whereDistinct This method removes duplicate rows from the row set.
alert.actionGetDescription This function returns the description of a given action.
alert.actionGetModule This function returns the module of a given action.
alert.actionGetModuleDb This function returns the module database of a given action.
alert.actionGetModuleRoot This function returns the module root of a given action.
alert.actionGetName This function returns the name of a given action.
alert.actionGetOptions This function returns the options of a given action.
alert.actionInsert This function inserts the specified action into the collection.
alert.actionRemove This function removes the named action from the database or throws an exception if the action does not exist.
alert.actionSetDescription This function returns the action with the description of the action updated.
alert.actionSetModule This function returns the action with the module of the action updated.
alert.actionSetModuleDb This function sets the module database of a given action.
alert.actionSetModuleRoot This function sets the module root of a given action.
alert.actionSetName This function returns the action with the name of the action updated.
alert.actionSetOptions This function returns the action with the options of the action updated.
alert.configDelete Remove an alerting configuration identified by the specified URI.
alert.configGet Gets the config associated with the specified URI.
alert.configGetCpfDomainNames This function returns the CPF domain names set in the specified alerting configuration.
alert.configGetDescription This function provides returns the description set in the specified alerting configuration.
alert.configGetId This function returns the ID of the specified alerting configuration.
alert.configGetName This function returns the name set in the specified an alerting configuration.
alert.configGetOptions This function returns the options set in specified alerting configuration.
alert.configGetTriggerIds This function returns the trigger IDs set in the specified alerting configuration.
alert.configGetUri This function returns the URI set in the specified alerting configuration.
alert.configInsert Inserts a config into the database.
alert.configSetCpfDomainNames This function sets the CPF domain names in the specified alerting configuration.
alert.configSetDescription This function sets the description within the specified alerting configuration.
alert.configSetName This function sets the name in the specified alerting configuration.
alert.configSetOptions This function sets the options in the specified alerting configuration.
alert.configSetTriggerIds This function sets the trigger IDs in the specified alerting configuration.
alert.createTriggers Create triggers that invoke the standard alerting trigger module.
alert.findMatchingRules Returns a list of all rules associated with the specified config that match the specified document.
alert.getActions This function retrieves all the named actions in the specified config URI.
alert.getAllRules This function returns all rules visible to the current user.
alert.getMyRules This function returns all rules associated with the current user.
alert.invokeMatchingActions Finds the rules that match the specified document and invokes their associated actions.
alert.makeAction This function creates the specified action.
alert.makeConfig Create an alerting configuration associated with a particular URI.
alert.makeLogAction Create a standard logging action named "log".
alert.makeRule This function creates the specified rule.
alert.removeTriggers Remove triggers whose IDs are listed in the config.
alert.ruleActionQuery This function creates a query to find rules with any of the specified actions.
alert.ruleGetAction This function returns the action of a given rule.
alert.ruleGetDescription This function returns the description of a given rule.
alert.ruleGetId This function returns the ID of a given rule.
alert.ruleGetName This function returns the name of a given rule.
alert.ruleGetOptions This function returns the options of a given rule.
alert.ruleGetQuery Get the cts.query corresponding to the rule's query expression.
alert.ruleGetUserId This function returns the user ID of a given rule.
alert.ruleIdQuery This function creates a query to find rules with any of the specified IDs.
alert.ruleInsert This function inserts rule into the database associated with the specified alerting configuration.
alert.ruleNameQuery This function creates a query to find rules with any of the specified names.
alert.ruleRemove This function removes the specified rule from the collection.
alert.ruleSetAction This function returns the rule with the action updated.
alert.ruleSetDescription This function returns the rule with the description of the rule updated.
alert.ruleSetName This function returns the rule with the name of the rule updated.
alert.ruleSetOptions This function returns the rule with the options of the rule updated.
alert.ruleSetQuery Set the cts:query corresponding to the rule's query expression.
alert.ruleSetUserId This function returns the rule with the user ID updated.
alert.ruleUserIdQuery This function creates a query to find rules with any of the specified user IDs.
alert.spawnMatchingActions Finds the rules that match the specified document and spawns their associated actions.
ArrayNode.baseURI This is inherited from the Node object. Returns a string representing the base URI of the node.
ArrayNode.length Length property on ArrayNode
ArrayNode.nodeKind This is inherited from the Node object. Return a string indicating the type of the node.
ArrayNode.nodeType This is inherited from the Node object. Return the DOM code indicating the type of the node.
ArrayNode.xpath This is inherited from the Node object. Evaluate an XPath using the node as context.
Attr.attributes This is inherited from the XMLNode object. The attributes of this node.
Attr.childNodes This is inherited from the XMLNode object. The children of this node.
Attr.firstChild This is inherited from the XMLNode object. The first child of this node, if any.
Attr.hasAttributes This is inherited from the XMLNode object. Whether this node has attributes.
Attr.hasChildNodes This is inherited from the XMLNode object. Whether this node has any children.
Attr.isEqualNode This is inherited from the XMLNode object. Whether this node is equal to another node.
Attr.isId Whether this is an ID attribute.
Attr.isSameNode This is inherited from the XMLNode object. Whether this node is the same exact node as another node.
Attr.isSpecified Whether this attribute is specified explicitly or was defaulted from a schema.
Attr.lastChild This is inherited from the XMLNode object. The last child of this node, if any.
Attr.localName This is inherited from the XMLNode object. Return the local name of this node.
Attr.namespaceURI This is inherited from the XMLNode object. Return the namespace URI of this node.
Attr.nextSibling This is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any.
Attr.nodeName This is inherited from the XMLNode object. The DOM name of the node.
Attr.nodeValue This is inherited from the XMLNode object. The DOM value of the node.
Attr.ownerDocument This is inherited from the XMLNode object. The document node containing this node, if any.
Attr.ownerElement The element that contains this attribute.
Attr.parentNode This is inherited from the XMLNode object. The node that is this node's parent.
Attr.prefix This is inherited from the XMLNode object. Return the namespace prefix of this node.
Attr.previousSibling This is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any.
Attr.textContent This is inherited from the XMLNode object. The DOM text value of the node.
BinaryNode.baseURI This is inherited from the Node object. Returns a string representing the base URI of the node.
BinaryNode.nodeKind This is inherited from the Node object. Return a string indicating the type of the node.
BinaryNode.nodeType This is inherited from the Node object. Return the DOM code indicating the type of the node.
BinaryNode.xpath This is inherited from the Node object. Evaluate an XPath using the node as context.
BooleanNode.baseURI This is inherited from the Node object. Returns a string representing the base URI of the node.
BooleanNode.nodeKind This is inherited from the Node object. Return a string indicating the type of the node.
BooleanNode.nodeType This is inherited from the Node object. Return the DOM code indicating the type of the node.
BooleanNode.xpath This is inherited from the Node object. Evaluate an XPath using the node as context.
cdict.dictionaryDelete Delete a custom dictionary.
cdict.dictionaryRead Retrieve the custom dictionary for a language.
cdict.dictionaryWrite Insert or update a custom dictionary for language.
cdict.getLanguages Return the ISO language codes for all licensed languages.
CharacterData.attributes This is inherited from the XMLNode object. The attributes of this node.
CharacterData.childNodes This is inherited from the XMLNode object. The children of this node.
CharacterData.data The character data.
CharacterData.firstChild This is inherited from the XMLNode object. The first child of this node, if any.
CharacterData.hasAttributes This is inherited from the XMLNode object. Whether this node has attributes.
CharacterData.hasChildNodes This is inherited from the XMLNode object. Whether this node has any children.
CharacterData.isElementContentWhitespace Whether this text node is ignorable whitespace.
CharacterData.isEqualNode This is inherited from the XMLNode object. Whether this node is equal to another node.
CharacterData.isSameNode This is inherited from the XMLNode object. Whether this node is the same exact node as another node.
CharacterData.lastChild This is inherited from the XMLNode object. The last child of this node, if any.
CharacterData.length The length of the character data (codepoints).
CharacterData.localName This is inherited from the XMLNode object. Return the local name of this node.
CharacterData.namespaceURI This is inherited from the XMLNode object. Return the namespace URI of this node.
CharacterData.nextSibling This is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any.
CharacterData.nodeName This is inherited from the XMLNode object. The DOM name of the node.
CharacterData.nodeValue This is inherited from the XMLNode object. The DOM value of the node.
CharacterData.ownerDocument This is inherited from the XMLNode object. The document node containing this node, if any.
CharacterData.parentNode This is inherited from the XMLNode object. The node that is this node's parent.
CharacterData.prefix This is inherited from the XMLNode object. Return the namespace prefix of this node.
CharacterData.previousSibling This is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any.
CharacterData.substring A substring of the character data, starting at a given offset and continuing for a given length.
CharacterData.textContent This is inherited from the XMLNode object. The DOM text value of the node.
CharacterData.wholeText The text of the text node concatenated with its logically adjacent text nodes.
clang.deleteUserLanguage This function returns user languages configuration with any existing configuration item for a given language removed.
clang.languageConfigDelete This function removes all custom language configuration from the cluster configuration files.
clang.languageConfigRead This function reads the custom language configuration specification from the cluster configuration files.
clang.languageConfigWrite This function saves a custom language configuration specification to the cluster configuration files.
clang.lexer This function constructs a custom lexer configuration item, suitable for use with clang.userLanguagePlugin.
clang.stemmer This function constructs a custom stemmer configuration item, suitable for use with clang.userLanguagePlugin.
clang.updateUserLanguage Add or replace a configuration item for a language in the given language configuration item, and return the new configuration.
clang.userLanguage This function constructs a user language configuration item, suitable for use with clang.languageConfigUpdate.
clang.userLanguagePlugin This function constructs a user language plugin configuration item, suitable for use with clang.userLanguage.
cma.applyConfig Apply a named configuration, overriding parameters and setting options.
cma.generateConfig Retrieve an individual resource, set of resources, or full cluster configuration; generate a configuration from scenarios.
Comment.data This is inherited from the CharacterData object. The character data.
Comment.isElementContentWhitespace This is inherited from the CharacterData object. Whether this text node is ignorable whitespace.
Comment.length This is inherited from the CharacterData object. The length of the character data (codepoints).
Comment.substring This is inherited from the CharacterData object. A substring of the character data, starting at a given offset and continuing for a given length.
Comment.wholeText This is inherited from the CharacterData object. The text of the text node concatenated with its logically adjacent text nodes.
console.assert If value is true, do nothing.
console.debug Logs 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.dir Logs 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.error Logs 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.log Logs 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.trace Logs 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.warn Logs 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.
cpf.checkTransition Verify that the current transition is the correct one for the document.
cpf.documentGetError Fetch a trace of the error that caused the document's processing to fail, if any.
cpf.documentGetLastUpdated Determine the date and time of the last update to the document's content, if any.
cpf.documentGetProcessingStatus Determine the document's current processing status, if any.
cpf.documentGetState Determine the document's current state, if any.
cpf.documentSetError Set the document's error trace to the given value.
cpf.documentSetLastUpdated Set the date and time of the document's last update.
cpf.documentSetProcessingStatus Set the document's processing status to the given value.
cpf.documentSetState Set the document's state to the given state.
cpf.failure Concludes the state action in failure, advancing the state as defined by the state transition.
cpf.success Concludes the action successfully, advancing the state as defined by the transition.
cts.aggregate Executes a user-defined extension aggregate function against a value lexicon or n-way co-occurence of multiple value lexicons.
cts.andNotQuery Returns a query specifying the set difference of the matches specified by two sub-queries.
cts.andNotQueryNegativeQuery Returns the negative (second parameter) query used to construct the specified query.
cts.andNotQueryPositiveQuery Returns the positive (first parameter) query used to construct the specified query.
cts.andQuery Returns a query specifying the intersection of the matches specified by the sub-queries.
cts.andQueryOptions Returns the options for the specified query.
cts.andQueryQueries Returns 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.avgAggregate Returns 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.boostQuery Returns a query specifying that matches to $matching-query should have their search relevance scores boosted if they also match $boosting-query.
cts.boostQueryBoostingQuery Returns the boosting (second parameter) query used to construct the specified boost query.
cts.boostQueryMatchingQuery Returns 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.box Returns a geospatial box value.
cts.boxEast Returns a box's eastern boundary.
cts.boxIntersects [DEPRECATED: use geo:box-intersects instead] Returns true if the box intersects with a region.
cts.boxNorth Returns a box's northern boundary.
cts.boxSouth Returns a box's southern boundary.
cts.boxWest Returns a box's western boundary.
cts.circle Returns a geospatial circle value.
cts.circleCenter Returns a circle's center point.
cts.circleIntersects [DEPRECATED: use geo:circle-intersects instead] Returns true if the circle intersects with a region.
cts.circleRadius Returns a circle's radius.
cts.classify Classifies an array of nodes based on training data.
cts.cluster Produces a set of clusters from an array of nodes.
cts.collectionMatch Returns values from the collection lexicon that match the specified wildcard pattern.
cts.collectionQuery Returns a query matching documents in the collections with the given URIs.
cts.collectionQueryUris Returns the URIs used to construct the specified query.
cts.collectionReference Creates a reference to the collection lexicon, for use as a parameter to cts:value-tuples.
cts.collections Returns values from the collection lexicon.
cts.complexPolygon Returns a geospatial complex polygon value.
cts.complexPolygonContains [DEPRECATED: use geo:complex-polygon-contains instead] Returns true if the complex-polygon contains a region.
cts.complexPolygonInner Returns 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.complexPolygonOuter Returns a complex polygon's outer polygon.
cts.confidence Returns the confidence of a node, or of the context node if no node is provided.
cts.confidenceOrder Creates a confidence-based ordering clause, for use as an option to cts.search .
cts.contains Returns true if any of a sequence of values matches a query.
cts.correlation Returns the frequency-weighted correlation given a 2-way co-occurrence.
cts.countAggregate Returns the count of a value lexicon.
cts.covariance Returns the frequency-weighted sample covariance given a 2-way co-occurrence.
cts.covarianceP Returns the frequency-weighted covariance of the population given a 2-way co-occurrence.
cts.deregister Deregister 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.directoryQuery Returns a query matching documents in the directories with the given URIs.
cts.directoryQueryDepth Returns the depth used to construct the specified query.
cts.directoryQueryUris Returns the URIs used to construct the specified query.
cts.distance [DEPRECATED: use geo:distance instead] Returns the distance (in miles) between two points.
cts.distinctiveTerms Return the most "relevant" terms in the model nodes (that is, the terms with the highest scores).
cts.doc Returns the document stored in the database at the specified URI.
cts.documentFragmentQuery Returns a query that matches all documents where $query matches any document fragment.
cts.documentFragmentQueryQuery Returns the query used to construct the specified query.
cts.documentOrder Creates a document-based ordering clause, for use as an option to cts.search .
cts.documentQuery Returns a query matching documents with the given URIs.
cts.documentQueryUris Returns the URIs used to construct the specified query.
cts.elementAttributePairGeospatialBoxes Returns boxes derived from the specified element point lexicon(s).
cts.elementAttributePairGeospatialQuery Returns a 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.elementAttributePairGeospatialQueryElementName Returns the QNames used to construct the specified query.
cts.elementAttributePairGeospatialQueryLatitudeName Returns the QNames used to construct the specified query.
cts.elementAttributePairGeospatialQueryLongitudeName Returns the QNames used to construct the specified query.
cts.elementAttributePairGeospatialQueryOptions Returns the options for the specified query.
cts.elementAttributePairGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.elementAttributePairGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.elementAttributePairGeospatialValueMatch Returns values from the specified element attribute pair geospatial value lexicon(s) that match the specified wildcard pattern.
cts.elementAttributePairGeospatialValues Returns values from the specified element-attribute-pair geospatial value lexicon(s).
cts.elementAttributeRangeQuery Returns a cts:query matching element-attributes by name with a range-index entry equal to a given value.
cts.elementAttributeRangeQueryAttributeName Returns the QNames used to construct the specified query.
cts.elementAttributeRangeQueryElementName Returns the QNames used to construct the specified query.
cts.elementAttributeRangeQueryOperator Returns the operator used to construct the specified query.
cts.elementAttributeRangeQueryOptions Returns the options for the specified query.
cts.elementAttributeRangeQueryValue Returns the value used to construct the specified query.
cts.elementAttributeRangeQueryWeight Returns the weight with which the specified query was constructed.
cts.elementAttributeReference Creates a reference to an element attribute value lexicon, for use as a parameter to cts:value-tuples.
cts.elementAttributeValueCoOccurrences Returns value co-occurrences from the specified element or element-attribute value lexicon(s).
cts.elementAttributeValueGeospatialCoOccurrences Returns value co-occurrences from the specified element-attribute value lexicon with the specified geospatial lexicon.
cts.elementAttributeValueMatch Returns values from the specified element-attribute value lexicon(s) that match the specified pattern.
cts.elementAttributeValueQuery Returns a query matching elements by name with attributes by name with text content equal a given phrase.
cts.elementAttributeValueQueryAttributeName Returns the attribute QNames used to construct the specified query.
cts.elementAttributeValueQueryElementName Returns the element QNames used to construct the specified query.
cts.elementAttributeValueQueryOptions Returns the options for the specified query.
cts.elementAttributeValueQueryText Returns the text used to construct the specified query.
cts.elementAttributeValueQueryWeight Returns the weight with which the specified query was constructed.
cts.elementAttributeValueRanges Returns value ranges from the specified element-attribute value lexicon(s).
cts.elementAttributeValues Returns values from the specified element-attribute value lexicon(s).
cts.elementAttributeWordMatch Returns words from the specified element-attribute word lexicon(s) that match a wildcard pattern.
cts.elementAttributeWordQuery Returns a query matching elements by name with attributes by name with text content containing a given phrase.
cts.elementAttributeWordQueryAttributeName Returns the attribute QNames used to construct the specified query.
cts.elementAttributeWordQueryElementName Returns the element QNames used to construct the specified query.
cts.elementAttributeWordQueryOptions Returns the options for the specified query.
cts.elementAttributeWordQueryText Returns the text used to construct the specified query.
cts.elementAttributeWordQueryWeight Returns the weight with which the specified query was constructed.
cts.elementAttributeWords Returns words from the specified element-attribute word lexicon(s).
cts.elementChildGeospatialBoxes Returns boxes derived from the specified element point lexicon(s).
cts.elementChildGeospatialQuery Returns a 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.elementChildGeospatialQueryChildName Returns the QNames used to construct the specified query.
cts.elementChildGeospatialQueryElementName Returns the QNames used to construct the specified query.
cts.elementChildGeospatialQueryOptions Returns the options for the specified query.
cts.elementChildGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.elementChildGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.elementChildGeospatialValueMatch Returns values from the specified element child geospatial value lexicon(s) that match the specified wildcard pattern.
cts.elementChildGeospatialValues Returns values from the specified element-child geospatial value lexicon(s).
cts.elementGeospatialBoxes Returns boxes derived from the specified element point lexicon(s).
cts.elementGeospatialQuery Returns a 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.elementGeospatialQueryElementName Returns the QNames used to construct the specified query.
cts.elementGeospatialQueryOptions Returns the options for the specified query.
cts.elementGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.elementGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.elementGeospatialValueMatch Returns values from the specified element geospatial value lexicon(s) that match the specified wildcard pattern.
cts.elementGeospatialValues Returns values from the specified element geospatial value lexicon(s).
cts.elementPairGeospatialBoxes Returns boxes derived from the specified element point lexicon(s).
cts.elementPairGeospatialQuery Returns a 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.elementPairGeospatialQueryElementName Returns the QNames used to construct the specified query.
cts.elementPairGeospatialQueryLatitudeName Returns the QNames used to construct the specified query.
cts.elementPairGeospatialQueryLongitudeName Returns the QNames used to construct the specified query.
cts.elementPairGeospatialQueryOptions Returns the options for the specified query.
cts.elementPairGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.elementPairGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.elementPairGeospatialValueMatch Returns values from the specified element pair geospatial value lexicon(s) that match the specified wildcard pattern.
cts.elementPairGeospatialValues Returns values from the specified element-pair geospatial value lexicon(s).
cts.elementQuery Returns a cts:query matching elements by name with the content constrained by the given cts:query in the second parameter.
cts.elementQueryElementName Returns the QNames used to construct the specified query.
cts.elementQueryQuery Returns the query used to construct the element query.
cts.elementRangeQuery Returns a cts:query matching elements by name with a range-index entry equal to a given value.
cts.elementRangeQueryElementName Returns the QNames used to construct the specified query.
cts.elementRangeQueryOperator Returns the operator used to construct the specified query.
cts.elementRangeQueryOptions Returns the options for the specified query.
cts.elementRangeQueryValue Returns the value used to construct the specified query.
cts.elementRangeQueryWeight Returns the weight with which the specified query was constructed.
cts.elementReference Creates 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.elementValueCoOccurrences Returns value co-occurrences (that is, pairs of values, both of which appear in the same fragment) from the specified element value lexicon(s).
cts.elementValueGeospatialCoOccurrences Returns value co-occurrences from the specified element value lexicon with the specified geospatial lexicon.
cts.elementValueMatch Returns values from the specified element value lexicon(s) that match the specified wildcard pattern.
cts.elementValueQuery Returns a query matching elements by name with text content equal a given phrase.
cts.elementValueQueryElementName Returns the QNames used to construct the specified query.
cts.elementValueQueryOptions Returns the options for the specified query.
cts.elementValueQueryText Returns the text used to construct the specified query.
cts.elementValueQueryWeight Returns the weight with which the specified query was constructed.
cts.elementValueRanges Returns value ranges from the specified element value lexicon(s).
cts.elementValues Returns values from the specified element value lexicon(s).
cts.elementWalk Returns a copy of the node, replacing any elements found with the specified expression.
cts.elementWordMatch Returns words from the specified element word lexicon(s) that match a wildcard pattern.
cts.elementWordQuery Returns a query matching elements by name with text content containing a given phrase.
cts.elementWordQueryElementName Returns the QNames used to construct the specified query.
cts.elementWordQueryOptions Returns the options for the specified query.
cts.elementWordQueryText Returns the text used to construct the specified query.
cts.elementWordQueryWeight Returns the weight with which the specified query was constructed.
cts.elementWords Returns words from the specified element word lexicon.
cts.entity Returns a cts:entity object.
cts.entityDictionary Returns a cts:entity-dictionary object.
cts.entityDictionaryGet Retrieve an entity dictionary previously cached in the database.
cts.entityDictionaryParse Construct a cts:entity-dictionary object by parsing it from a formatted string.
cts.entityHighlight Find entities in a node and replace each matched entity with the result returned by a callback function.
cts.entityWalk Walk an XML document or element node, evaluating a callback function against any matching entities.
cts.estimate Returns the number of fragments selected by a search.
cts.exists Returns true if any fragment is selected by the search, false if no fragments are selected.
cts.falseQuery Returns a query that matches no fragments.
cts.fieldRangeQuery Returns a cts:query matching fields by name with a range-index entry equal to a given value.
cts.fieldRangeQueryFieldName Returns the fieldname used to construct the specified query.
cts.fieldRangeQueryOperator Returns the operator used to construct the specified query.
cts.fieldRangeQueryOptions Returns the options for the specified query.
cts.fieldRangeQueryValue Returns the value used to construct the specified query.
cts.fieldRangeQueryWeight Returns the weight with which the specified query was constructed.
cts.fieldReference Creates a reference to a field value lexicon, for use as a parameter to cts.valueTuples.
cts.fieldValueCoOccurrences Returns value co-occurrences (that is, pairs of values, both of which appear in the same fragment) from the specified field value lexicon(s).
cts.fieldValueMatch Returns values from the specified field value lexicon(s) that match the specified wildcard pattern.
cts.fieldValueQuery Returns a query matching text content containing a given value in the specified field.
cts.fieldValueQueryFieldName Returns the names used to construct the specified cts:field-value-query.
cts.fieldValueQueryOptions Returns the options for the specified cts:field-value-query.
cts.fieldValueQueryText Returns the values used to construct the specified cts:field-value-query.
cts.fieldValueQueryWeight Returns the weight with which the specified query was constructed.
cts.fieldValueRanges Returns value ranges from the specified field value lexicon(s).
cts.fieldValues Returns values from the specified field value lexicon(s).
cts.fieldWordMatch Returns words from the specified field word lexicon(s) that match a wildcard pattern.
cts.fieldWordQuery Returns a query matching fields whose content contains the given phrase.
cts.fieldWordQueryFieldName Returns the names used to construct the specified cts:field-word-query.
cts.fieldWordQueryOptions Returns the options for the specified cts:field-word-query.
cts.fieldWordQueryText Returns the text used to construct the specified cts:field-word-query.
cts.fieldWordQueryWeight Returns the weight with which the specified query was constructed.
cts.fieldWords Returns words from the specified field word lexicon.
cts.fitness Returns the fitness of a node, or of the context node if no node is provided.
cts.fitnessOrder Creates a fitness-based ordering clause, for use as an option to cts.search .
cts.frequency Returns an integer representing the number of times in which a particular value occurs in a value lexicon lookup (for example, cts:element-values).
cts.geospatialAttributePairReference Creates a reference to a geospatial attribute pair range index, for use as a parameter to cts.valueTuples This function will throw an exception if the specified range index does not exist.
cts.geospatialBoxes Returns boxes derived from the specified point lexicon(s).
cts.geospatialCoOccurrences Find value co-occurrences from two geospatial lexicons.
cts.geospatialElementChildReference Creates a reference to a geospatial element child range index, for use as a parameter to cts.valueTuples.
cts.geospatialElementPairReference Creates a reference to a geospatial element pair range index, for use as a parameter to cts.valueTuples.
cts.geospatialElementReference Creates a reference to a geospatial element range index, for use as a parameter to cts.valueTuples.
cts.geospatialJsonPropertyChildReference Creates a reference to a geospatial json property child range index, for use as a parameter to cts:value-tuples cts.valueTuples.
cts.geospatialJsonPropertyPairReference Creates a reference to a geospatial JSON property pair range index, for use as a parameter to cts.valueTuples.
cts.geospatialJsonPropertyReference Creates a reference to a geospatial json property range index, for use as a parameter to cts.valueTuples.
cts.geospatialPathReference Creates a reference to a geospatial path range index, for use as a parameter to cts.valueTuples.
cts.geospatialRegionPathReference Create 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.geospatialRegionQuery Construct a query to match regions in documents that satisfy a specified relationship relative to other regions.
cts.geospatialRegionQueryOperation Returns the comparison operation specified when constructing the input query.
cts.geospatialRegionQueryOptions Returns the options specified when constructing the input query.
cts.geospatialRegionQueryReference Returns the geospatial region path index reference(s) specified when constructing the input query.
cts.geospatialRegionQueryRegion Returns the region criteria specified when constructing the input query.
cts.geospatialRegionQueryWeight Returns the weight specified when constructing the input query.
cts.highlight Returns a copy of the node, replacing any text matching the query with the specified expression.
cts.indexOrder Creates a index-based ordering clause, for use as an option to cts.search .
cts.jsonPropertyChildGeospatialQuery Returns a 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.jsonPropertyChildGeospatialQueryChildName Returns the names used to construct the specified query.
cts.jsonPropertyChildGeospatialQueryOptions Returns the options for the specified query.
cts.jsonPropertyChildGeospatialQueryPropertyName Returns the names used to construct the specified query.
cts.jsonPropertyChildGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.jsonPropertyChildGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.jsonPropertyGeospatialQuery Returns a 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.jsonPropertyGeospatialQueryOptions Returns the options for the specified query.
cts.jsonPropertyGeospatialQueryPropertyName Returns the json property names used to construct the specified query.
cts.jsonPropertyGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.jsonPropertyGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.jsonPropertyPairGeospatialQuery Returns a 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.jsonPropertyPairGeospatialQueryLatitudeName Returns the property names used to construct the specified query.
cts.jsonPropertyPairGeospatialQueryLongitudeName Returns the property names used to construct the specified query.
cts.jsonPropertyPairGeospatialQueryOptions Returns the options for the specified query.
cts.jsonPropertyPairGeospatialQueryPropertyName Returns the property names used to construct the specified query.
cts.jsonPropertyPairGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.jsonPropertyPairGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.jsonPropertyRangeQuery Returns a cts:query matching JSON properties by name with a range-index entry equal to a given value.
cts.jsonPropertyRangeQueryOperator Returns the operator used to construct the specified query.
cts.jsonPropertyRangeQueryOptions Returns the options for the specified query.
cts.jsonPropertyRangeQueryPropertyName Returns the JSON property name used to construct the specified query.
cts.jsonPropertyRangeQueryValue Returns the value used to construct the specified query.
cts.jsonPropertyRangeQueryWeight Returns the weight with which the specified query was constructed.
cts.jsonPropertyReference Creates a reference to a JSON property value lexicon, for use as a parameter to cts:value-tuples.
cts.jsonPropertyScopeQuery Returns a cts:query matching JSON properties by name with the content constrained by the given cts:query in the second parameter.
cts.jsonPropertyScopeQueryPropertyName Returns the JSON property name used to construct the specified query.
cts.jsonPropertyScopeQueryQuery Returns the query used to construct the property scope query.
cts.jsonPropertyValueQuery Returns a query matching JSON properties by name with value equal the given value.
cts.jsonPropertyValueQueryOptions Returns the options for the specified query.
cts.jsonPropertyValueQueryPropertyName Returns the JSON property name used to construct the specified query.
cts.jsonPropertyValueQueryText Returns the text used to construct the specified query.
cts.jsonPropertyValueQueryValue Returns the value used to construct the specified query.
cts.jsonPropertyValueQueryWeight Returns the weight with which the specified query was constructed.
cts.jsonPropertyWordMatch Returns words from the specified JSON property word lexicon(s) that match a wildcard pattern.
cts.jsonPropertyWordQuery Returns a query matching JSON properties by name with text content containing a given phrase.
cts.jsonPropertyWordQueryOptions Returns the options for the specified query.
cts.jsonPropertyWordQueryPropertyName Returns the name used to construct the specified query.
cts.jsonPropertyWordQueryText Returns the text used to construct the specified query.
cts.jsonPropertyWordQueryWeight Returns the weight with which the specified query was constructed.
cts.jsonPropertyWords Returns words from the specified JSON property word lexicon.
cts.linearModel Returns a linear model that fits the frequency-weighted data set.
cts.linestring Returns a geospatial linestring value.
cts.linestringVertices Returns a linestring's vertices.
cts.locksFragmentQuery Returns a query that matches all documents where $query matches document-locks.
cts.locksFragmentQueryQuery Returns the query used to construct the specified query.
cts.lsqtQuery Returns only documents before LSQT or a timestamp before LSQT for stable query results.
cts.lsqtQueryOptions Returns the options for the specified query.
cts.lsqtQueryTemporalCollection Returns the name of the temporal collection used to construct specified query.
cts.lsqtQueryTimestamp Returns timestamp used to construct the specified query.
cts.lsqtQueryWeight Returns the weight with which the specified query was constructed.
cts.matchRegions Find regions in documents that have a spatial relationship to one or more caller-supplied regions.
cts.max Returns the maximal value given a value lexicon.
cts.median Returns a frequency-weighted median of a sequence.
cts.min Returns the minimal value given a value lexicon.
cts.nearQuery Returns a query matching all of the specified queries, where the matches occur within the specified distance from each other.
cts.nearQueryDistance Returns the distance used to construct the near query.
cts.nearQueryOptions Returns the options for the specified query.
cts.nearQueryQueries Returns the query sequence used to construct the near query.
cts.nearQueryWeight Returns the weight with which the specified query was constructed.
cts.notInQuery Returns a query matching the first subquery, where those matches do not occur within 0 distance of the other query.
cts.notInQueryNegativeQuery Returns the negative (second parameter) query used to construct the specified query.
cts.notInQueryPositiveQuery Returns the positive (first parameter) query used to construct the specified query.
cts.notQuery Returns a query specifying the matches not specified by its sub-query.
cts.notQueryQuery Returns the query used to construct the specified query.
cts.notQueryWeight Returns the weight with which the specified query was constructed.
cts.orQuery Returns a query specifying the union of the matches specified by the sub-queries.
cts.orQueryOptions Returns the options for the specified query.
cts.orQueryQueries Returns a sequence of the queries that were used to construct the specified query.
cts.parse Parses a query string
cts.parseWkt [DEPRECATED: use geo:parse-wkt instead] Returns a sequence of geospatial regions parsed from Well-Known Text format.
cts.partOfSpeech Returns the part of speech for a cts:token, if any.
cts.pathGeospatialQuery Returns a 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.pathGeospatialQueryOptions Returns the options for the specified query.
cts.pathGeospatialQueryPathExpression Returns the path expressions used to construct the specified query.
cts.pathGeospatialQueryRegion Returns the geographical regions with which the specified query was constructed.
cts.pathGeospatialQueryWeight Returns the weight with which the specified query was constructed.
cts.pathRangeQuery Returns 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.pathRangeQueryOperator Returns the operator used to construct the specified query.
cts.pathRangeQueryOptions Returns the options for the specified query.
cts.pathRangeQueryPathName Returns the path expression used to construct the specified query.
cts.pathRangeQueryValue Returns the value used to construct the specified query.
cts.pathRangeQueryWeight Returns the weight with which the specified query was constructed.
cts.pathReference Creates a reference to a path value lexicon, for use as a parameter to cts:value-tuples.
cts.percentile Returns a sequence of percentile(s) given a sequence of percentage(s).
cts.percentRank Returns the rank of a value in a data set as a percentage of the data set.
cts.period Creates a period value, for use as a parameter to cts:period-range-query or cts:period-compare-query.
cts.periodCompare Compares two periods using the specified comparision operator.
cts.periodCompareQuery Returns a cts:query matching documents that have relevant pair of period values.
cts.periodCompareQueryAxis1 Returns the name of the first axis used to construct the specified query.
cts.periodCompareQueryAxis2 Returns the name of the second axis used to construct the specified query.
cts.periodCompareQueryOperator Returns the operator used to construct the specified query.
cts.periodCompareQueryOptions Returns the options for the specified query.
cts.periodRangeQuery Returns a cts:query matching axis by name with a period value with an operator.
cts.periodRangeQueryAxis Returns the axis name used to construct the specified query.
cts.periodRangeQueryOperator Returns the operator used to construct the specified query.
cts.periodRangeQueryOptions Returns the options for the specified query.
cts.periodRangeQueryPeriod Returns the period used to construct the specified query.
cts.plan Returns an array of JavaScript objects recording information about how the given search will be processed by the index.
cts.point Returns a point value.
cts.pointLatitude Returns a point's latitude value.
cts.pointLongitude Returns a point's longitude value.
cts.polygon Returns 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.polygonVertices Returns a polygon's vertices.
cts.propertiesFragmentQuery Returns a query that matches all documents where $query matches document-properties.
cts.propertiesFragmentQueryQuery Returns the query used to construct the specified query.
cts.quality Returns the quality of a node, or of the context node if no node is provided.
cts.qualityOrder Creates a quality-based ordering clause, for use as an option to cts.search .
cts.query Creates a query.
cts.rangeQuery Returns a cts:query matching specified nodes with a range-index entry compared to a given value.
cts.rangeQueryIndex Returns the range index used to construct the specified query.
cts.rangeQueryOperator Returns the operator used to construct the specified query.
cts.rangeQueryOptions Returns the options for the specified query.
cts.rangeQueryValue Returns the value used to construct the specified query.
cts.rangeQueryWeight Returns the weight with which the specified query was constructed.
cts.rank Returns the rank of a value in a data set.
cts.referenceCollation Accessor for the collation of a reference to a string value lexicon.
cts.referenceCoordinateSystem Accessor for the coordinate-system of a reference to a geospatial lexicon.
cts.referenceNullable Returns true() if the reference is nullable, false() otherwise.
cts.referenceParse Creates a reference to a value lexicon by parsing its XML or JSON representation, for use as a parameter to cts:value-tuples.
cts.referenceScalarType Accessor 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.register Register a query for later use.
cts.registeredQuery Returns a query matching fragments specified by previously registered queries (see cts:register).
cts.registeredQueryIds Returns the registered query identifiers used to construct the specified query.
cts.registeredQueryOptions Returns the options for the specified query.
cts.registeredQueryWeight Returns the weight with which the specified query was constructed.
cts.relevanceInfo Return the relevance score computation report for a node.
cts.remainder Returns an estimated search result size for a node, or of the context node if no node is provided.
cts.reverseQuery Construct a query that matches serialized cts queries, based on a set of model input nodes.
cts.reverseQueryNodes Returns the nodes used to construct the specified query.
cts.reverseQueryWeight Returns the weight with which the specified query was constructed.
cts.score Returns the score of a node, or of the context node if no node is provided.
cts.scoreOrder Creates a score-based ordering clause, for use as an option to cts.search .
cts.search Returns 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.similarQuery Returns a query matching nodes similar to the model nodes.
cts.similarQueryNodes Returns the nodes used to construct the specified query.
cts.similarQueryWeight Returns the weight with which the specified query was constructed.
cts.stddev Returns a frequency-weighted sample standard deviation given a value lexicon.
cts.stddevP Returns a frequency-weighted standard deviation of the population given a value lexicon.
cts.stem Returns the stem(s) for a word.
cts.sumAggregate Returns the sum of the values given a value lexicon.
cts.thresholds Compute precision, recall, the F measure, and thresholds for the classes computed by the classifier, by comparing with the labels for the same set.
cts.tokenize Tokenizes 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.train Produces a set of classifiers from a list of labeled training documents.
cts.tripleRangeQuery Returns a cts:query matching triples with a triple index entry equal to the given values.
cts.tripleRangeQueryObject Returns the object value used to construct the specified query.
cts.tripleRangeQueryOperator Returns the operators used to construct the specified query.
cts.tripleRangeQueryOptions Returns the options for the specified query.
cts.tripleRangeQueryPredicate Returns the predicate value used to construct the specified query.
cts.tripleRangeQuerySubject Returns the subject value used to construct the specified query.
cts.tripleRangeQueryWeight Returns the weight with which the specified query was constructed.
cts.triples Returns values from the triple index.
cts.tripleValueStatistics Returns statistics from the triple index for the values given.
cts.trueQuery Returns a query that matches all fragments.
cts.unordered Specifies that results should be unordered, for use with cts.search .
cts.uriMatch Returns values from the URI lexicon that match the specified wildcard pattern.
cts.uriReference Creates a reference to the URI lexicon, for use as a parameter to cts:value-tuples.
cts.uris Returns values from the URI lexicon.
cts.validDocumentPatchPath Parses path expressions and resolves namespaces using the $map parameter.
cts.validExtractPath Parses path expressions and resolves namespaces using the $map parameter.
cts.validIndexPath Parses path expressions and resolves namespaces based on the server run-time environment.
cts.validOpticPath Parses path expressions and resolves namespaces using the $map parameter.
cts.validTdeContext Parses path expressions and resolves namespaces using the $map parameter.
cts.valueCoOccurrences Returns value co-occurrences (that is, pairs of values, both of which appear in the same fragment) from the specified value lexicon(s).
cts.valueMatch Returns values from the specified value lexicon(s) that match the specified wildcard pattern.
cts.valueRanges Returns value ranges from the specified value lexicon(s).
cts.values Returns values from the specified value lexicon(s).
cts.valueTuples Returns value co-occurrence tuples (that is, tuples of values, each of which appear in the same fragment) from the specified value lexicons.
cts.variance Returns a frequency-weighted sample variance given a value lexicon.
cts.varianceP Returns a frequency-weighted variance of the population given a value lexicon.
cts.walk Walks a node, evaluating a callback function for any text matching a query.
cts.wordMatch Returns words from the word lexicon that match the wildcard pattern.
cts.wordQuery Returns a query matching text content containing a given phrase.
cts.wordQueryOptions Returns the options for the specified query.
cts.wordQueryText Returns the text used to construct the specified query.
cts.wordQueryWeight Returns the weight with which the specified query was constructed.
cts.words Returns words from the word lexicon.
dls.asOfQuery This function returns a query that matches the most recent numbered version of documents that were created before the specified date and time.
dls.authorQuery This function returns a query that matches documents authored by the specified user.
dls.breakCheckout This function breaks (unlocks) a checked-out document
dls.documentAddCollections This function adds the named document to the specified collections.
dls.documentAddPermissions This function adds the specified permissions for the named document.
dls.documentAddProperties This function adds the specified properties to any existing properties associated with the named document.
dls.documentCheckin This function checks in (unlocks) the document at the specified URI to allow other users to modify the document.
dls.documentCheckout This function checks out (locks) the document at the specified URI to prevent other users from modifying the document.
dls.documentCheckoutStatus This function returns a checkout element containing the checkout status of the specified document.
dls.documentCheckoutUpdateCheckin This function allows you to checkout, update, and checkin a managed document in a single transaction.
dls.documentDelete This function removes the specified managed document.
dls.documentExtractPart This function extracts an element from an existing document and creates a new document from the extracted element.
dls.documentGetPermissions This function gets the permissions for the specified document from the point of view of the Library Services API.
dls.documentHistory Returns the version history of the document located at the specified URI.
dls.documentIncludeQuery This function returns a query that matches any managed document that has an XInclude link that exactly matches the specified URI.
dls.documentInsertAndManage This function inserts a document into the database and places the document under management.
dls.documentIsManaged This function determines whether or not the document at the specified URI is managed.
dls.documentManage This function places a document under management.
dls.documentPurge This function deletes all numbered versions of the specified managed document and its referenced documents, as specified by the rention policies set by dls:retention-rule.
dls.documentRemoveCollections This function removes the named document from the specified collection.
dls.documentRemovePermissions This function removes the specified permissions from the named document.
dls.documentRemoveProperties This function removes the specified properties from the named document.
dls.documentRetentionRules This function a sequence of dls:retentionRule element nodes.
dls.documentSetCollections This function sets the named document to the specified collections.
dls.documentSetPermissions This function sets the specified permissions for the named document.
dls.documentSetProperties This function sets the properties of a document to the given sequence of elements.
dls.documentSetProperty This function sets a property on a document.
dls.documentSetQuality This function sets the quality of the document with the given URI.
dls.documentsQuery This function returns a query that matches the latest versions of the managed documents in the database.
dls.documentUnmanage Removes the specified document from management.
dls.documentUpdate This function updates the managed document at the specified URI with the specified contents.
dls.documentVersion This function returns a particular version of a managed document.
dls.documentVersionAsOf This function returns the most recent version of a document as of a point in time.
dls.documentVersionDelete This function removes the specified version of the managed document at the specified URI.
dls.documentVersionQuery This function returns a query that matches the specified version of the managed documents.
dls.documentVersionsQuery This function returns a query that matches any version of the specified URI.
dls.documentVersionUri This function returns the URI of the specified version of the document located at the specified URI.
dls.documentVersionUris This function returns the URIs of all versions of a managed document.
dls.latestValidationResults Returns a report describing the status of an upgrade from a pre-MarkLogic 8 DLS repository.
dls.linkExpand This function performs a single level expansion of a single XInclude reference.
dls.linkReferences This function returns a list of all the distinct URIs of documents referenced (either directly or indirectly) in the expansion of the node.
dls.nodeExpand This function recursively examines the node for XInclude references and expands them, following the rules of the XInclude specification.
dls.purge This function deletes all numbered versions of managed documents and its referenced documents (such as /foo/bar.xml_versions/1-bar.xml), as specified by the rention policy set by one or more dls.retentionRule functions.
dls.retentionRule This function creates and returns a retention rule element.
dls.retentionRuleInsert This function inserts retention rules into the database.
dls.retentionRuleRemove This function removes the specified retention rules from the database.
dls.retentionRules This function returns the specified retention rules from the database.
dls.setUpgradeStatus Sets DLS the upgrade status to current or compatibility-mode.
dls.startUpgrade Upgrades a previous version DLS Database to the current format.
dls.validateAllDocuments Returns a report of the status of the DLS upgrade process.
Document.baseURI This is inherited from the Node object. Returns a string representing the base URI of the node.
Document.documentFormat The format of the document node, "JSON", "XML", "TEXT", or "BINARY"
Document.nodeKind This is inherited from the Node object. Return a string indicating the type of the node.
Document.nodeType This is inherited from the Node object. Return the DOM code indicating the type of the node.
Document.root The root node of the document.
Document.xpath This is inherited from the Node object. Evaluate an XPath using the node as context.
DocumentsSearch.filter Specifies filtering the documents by inspecting the contents of matched and ordered documents to populate the slice.
DocumentsSearch.map Specifies a function similar to Array.prototype.map() to apply to each document within the slice or the configuration for the built-in mapper.
DocumentsSearch.orderBy Specifies the sort order for matched documents.
DocumentsSearch.reduce Specifies a function similar to Array.prototype.reduce() to apply to each document within the slice.
DocumentsSearch.result Executes 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.slice Specifies a subsequence of matched, sorted, and filtered documents to retrieve.
DocumentsSearch.where Specifies which documents to match based on the indexes over the documents.
DocumentsSearch.withOptions Configure advanced document search options.
Element.attributes This is inherited from the XMLNode object. The attributes of this node.
Element.childNodes This is inherited from the XMLNode object. The children of this node.
Element.firstChild This is inherited from the XMLNode object. The first child of this node, if any.
Element.getAttribute Get the value of the attribute of this element with the given name, if any.
Element.getAttributeNode Get the attribute of this element with the given name, if any.
Element.getAttributeNodeNS Get the attribute of this element with the given localname and namespace URI, if any.
Element.getAttributeNS Get the value of the attribute of this element with the given localname and namespace URI, if any.
Element.getElementsByTagName Return all the elements that are descendants of the current element that have the given name.
Element.getElementsByTagNameNS Return all the elements that are descendants of the current element that have the given localname and namespace URI.
Element.hasAttribute Whether this element has an attribute with the given name.
Element.hasAttributeNS Whether this element has an attribute the given localname and namespace URI.
Element.hasAttributes This is inherited from the XMLNode object. Whether this node has attributes.
Element.hasChildNodes This is inherited from the XMLNode object. Whether this node has any children.
Element.isEqualNode This is inherited from the XMLNode object. Whether this node is equal to another node.
Element.isSameNode This is inherited from the XMLNode object. Whether this node is the same exact node as another node.
Element.lastChild This is inherited from the XMLNode object. The last child of this node, if any.
Element.localName This is inherited from the XMLNode object. Return the local name of this node.
Element.namespaceURI This is inherited from the XMLNode object. Return the namespace URI of this node.
Element.nextSibling This is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any.
Element.nodeName This is inherited from the XMLNode object. The DOM name of the node.
Element.nodeValue This is inherited from the XMLNode object. The DOM value of the node.
Element.ownerDocument This is inherited from the XMLNode object. The document node containing this node, if any.
Element.parentNode This is inherited from the XMLNode object. The node that is this node's parent.
Element.prefix This is inherited from the XMLNode object. Return the namespace prefix of this node.
Element.previousSibling This is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any.
Element.schemaTypeInfo The schema type information associated with this element.
Element.textContent This is inherited from the XMLNode object. The DOM text value of the node.
entity.dictionaryInsert Put an entity dictionary into the database in the appropriate format.
entity.dictionaryLoad Load an entity dictionary from the filesystem into the database in the appropriate format.
entity.enrich Returns the entity-enriched XML for the given XML node using the provided dictionary.
entity.extract Extract entities from a document using the provided entity dictionary.
entity.skosDictionary Construct an entity dictionary from a SKOS ontology loaded into the database as triples.
Error.code For DOM errors, this is the DOM error code.
Error.data The data passed to the error.
Error.message The formatted error message.
Error.name The error name.
Error.retryable Whether the error can be retried.
Error.stack A string representation of the call stack.
Error.stackFrames An array of stack frames.
Error.toString A string representation of the error.
es.databasePropertiesGenerate Generate a database configuration artifact from a basic model.
es.extractionTemplateGenerate Generate 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.instanceConverterGenerate Generate an XQuery library module containing stub code for converting source data to entity instances.
es.instanceFromDocument Extract an in-memory entity instance from its envelope document as a JavaScript object.
es.instanceGetAttachments Extract attachments from an entity service document.
es.instanceJsonFromDocument Extract an entity instance from its envelope document, as JSON.
es.instanceXmlFromDocument Extract a canonical entity instance from its envelope document, as XML.
es.modelFromXml Create a basic model from an XML model descriptor, without validating the input descriptor for correctness.
es.modelGetTestInstances Generate entity instances of each entity type in a basic model.
es.modelToXml Serialize a basic model as an XML element.
es.modelValidate Validates an entity services model descriptor.
es.schemaGenerate Generate an XSD schema that can be used to validate instance data.
es.searchOptionsGenerate Generate a set of query options that can be used to query your entity instances using several MarkLogic server-side and client APIs.
es.versionTranslatorGenerate Generate a module that can be used to translate instances conforming to one version of a model into instances conforming to another version
FacetDefinition.groupInto Groups facet values into buckets between bound values as in a ValuesSearch definition.
FacetDefinition.map Specifies 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.orderBy Specifies the sort order for facet values, as in a ValuesSearch definition.
FacetDefinition.othersWhere Specify a query to apply to facets other than this one.
FacetDefinition.reduce Specifies 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.slice Specifies a subsequence of values to retrieve as in a ValuesSearch definition.
FacetDefinition.thisWhere Specify a query to apply only to this facet.
FacetDefinition.withOptions Configure advanced options for facet generation.
FacetsSearch.result Executes the facets search definition and returns the results.
FacetsSearch.where Specify one or an array of cts.query's used to qualify the facet values and the document result set (if requested).
FacetsSearch.withOptions Configure advanced options for facet generation.
fn.abs Returns the absolute value of $arg.
fn.adjustDateTimeToTimezone Adjusts an xs:dateTime value to a specific timezone, or to no timezone at all.
fn.adjustDateToTimezone Adjusts an xs:date value to a specific timezone, or to no timezone at all.
fn.adjustTimeToTimezone Adjusts an xs:time value to a specific timezone, or to no timezone at all.
fn.analyzeString The 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.avg Returns the average of the values in the input sequence $arg, that is, the sum of the values divided by the number of values.
fn.baseUri Returns the value of the base-uri property for the specified node.
fn.boolean Computes the effective boolean value of the sequence $arg.
fn.ceiling Returns the smallest (closest to negative infinity) number with no fractional part that is not less than the value of $arg.
fn.codepointEqual Returns true if the specified parameters are the same Unicode code point, otherwise returns false.
fn.codepointsToString Creates an xs:string from a sequence of Unicode code points.
fn.collection Returns all of the documents that belong to the specified collection(s).
fn.compare Returns -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.concat Returns the xs:string that is the concatenation of the values of the specified parameters.
fn.contains Returns true if the first parameter contains the string from the second parameter, otherwise returns false.
fn.count Returns the number of items in the value of $arg.
fn.currentDate Returns xs:date(fn:current-dateTime()).
fn.currentDateTime Returns the current dateTime value (with timezone) from the dynamic context.
fn.currentTime Returns xs:time(fn:current-dateTime()).
fn.data Takes a sequence of items and returns a sequence of atomic values.
fn.dayFromDate Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg.
fn.dayFromDateTime Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg.
fn.daysFromDuration Returns an xs:integer representing the days component in the canonical lexical representation of the value of $arg.
fn.deepEqual This function assesses whether two sequences are deep-equal to each other.
fn.defaultCollation Returns the value of the default collation property from the static context.
fn.distinctValues Returns the sequence that results from removing from $arg all but one of a set of values that are eq to one other.
fn.doc Returns the document(s) stored in the database at the specified URI(s).
fn.docAvailable If fn:doc($uri) returns a document node, this function returns true.
fn.document Returns the document(s) stored in the database at the specified URI(s).
fn.documentUri Returns the value of the document-uri property for the specified node.
fn.empty If the value of $arg is the empty sequence, the function returns true; otherwise, the function returns false.
fn.encodeForUri Invertible function that escapes characters required to be escaped inside path segments of URIs.
fn.endsWith Returns 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.exactlyOne Returns $arg if it contains exactly one item.
fn.exists If the value of $arg is not the empty sequence, the function returns true; otherwise, the function returns false.
fn.false Returns the xs:boolean value false.
fn.floor Returns the largest (closest to positive infinity) number with no fractional part that is not greater than the value of $arg.
fn.formatDate Returns a formatted date value based on the picture argument.
fn.formatDateTime Returns a formatted dateTime value based on the picture argument.
fn.formatNumber Returns a formatted string representation of value argument based on the supplied picture.
fn.formatTime Returns a formatted time value based on the picture argument.
fn.functionAvailable Returns 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.generateId Returns a string that uniquely identifies a given node.
fn.head Returns the first item in a sequence.
fn.hoursFromDateTime Returns an xs:integer between 0 and 23, both inclusive, representing the hours component in the localized value of $arg.
fn.hoursFromDuration Returns an xs:integer representing the hours component in the canonical lexical representation of the value of $arg.
fn.hoursFromTime Returns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of $arg.
fn.id Returns 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.idref Returns 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.implicitTimezone Returns the value of the implicit timezone property from the dynamic context.
fn.indexOf Returns a sequence of positive integers giving the positions within the sequence $seqParam of items that are equal to $srchParam.
fn.inScopePrefixes Returns the prefixes of the in-scope namespaces for $element.
fn.insertBefore Returns 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.iriToUri Idempotent function that escapes non-URI characters.
fn.lang This 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.localName Returns 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.localNameFromQName Returns an xs:NCName representing the local part of $arg.
fn.lowerCase Returns the specified string converting all of the characters to lower-case characters.
fn.matches Returns true if the specified $input matches the specified $pattern, otherwise returns false.
fn.max Selects 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.min Selects 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.minutesFromDateTime Returns an xs:integer value between 0 and 59, both inclusive, representing the minute component in the localized value of $arg.
fn.minutesFromDuration Returns an xs:integer representing the minutes component in the canonical lexical representation of the value of $arg.
fn.minutesFromTime Returns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of $arg.
fn.monthFromDate Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg.
fn.monthFromDateTime Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg.
fn.monthsFromDuration Returns an xs:integer representing the months component in the canonical lexical representation of the value of $arg.
fn.name Returns 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.namespaceUri Returns the namespace URI of the xs:QName of the node specified by $arg.
fn.namespaceUriForPrefix Returns the namespace URI of one of the in-scope namespaces for $element, identified by its namespace prefix.
fn.namespaceUriFromQName Returns the namespace URI for $arg as an xs:string.
fn.nilled Summary: Returns an xs:boolean indicating whether the argument node is "nilled".
fn.nodeName Returns an expanded-QName for node kinds that can have names.
fn.normalizeSpace Returns 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.normalizeUnicode Return the argument normalized according to the normalization criteria for a normalization form identified by the value of $normalizationForm.
fn.not Returns true if the effective boolean value is false, and false if the effective boolean value is true.
fn.number Returns the value indicated by $arg or, if $arg is not specified, the context item after atomization, converted to an xs:double.
fn.oneOrMore Returns $arg if it contains one or more items.
fn.prefixFromQName Returns an xs:NCName representing the prefix of $arg.
fn.QName Returns an xs:QName with the namespace URI given in $paramURI.
fn.remove Returns a new sequence constructed from the value of $target with the item at the position specified by the value of $position removed.
fn.replace Returns a string constructed by replacing the specified $pattern on the $input string with the specified $replacement string.
fn.resolveQName Returns 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.resolveUri Resolves a relative URI against an absolute URI.
fn.reverse Reverses the order of items in a sequence.
fn.root Returns the root of the tree to which $arg belongs.
fn.round Returns the number with no fractional part that is closest to the argument.
fn.roundHalfToEven The 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.secondsFromDateTime Returns an xs:decimal value between 0 and 60.999..., both inclusive representing the seconds and fractional seconds in the localized value of $arg.
fn.secondsFromDuration Returns an xs:decimal representing the seconds component in the canonical lexical representation of the value of $arg.
fn.secondsFromTime Returns an xs:decimal value between 0 and 60.999..., both inclusive, representing the seconds and fractional seconds in the localized value of $arg.
fn.startsWith Returns true if the first parameter starts with the string from the second parameter, otherwise returns false.
fn.staticBaseUri Returns the value of the base-uri property from the static context.
fn.string Returns the value of $arg represented as an xs:string.
fn.stringJoin Returns an xs:string created by concatenating the members of the $parameter1 sequence using $parameter2 as a separator.
fn.stringLength Returns an integer representing the length of the specified string.
fn.stringToCodepoints Returns the sequence of Unicode code points that constitute an xs:string.
fn.subsequence Returns 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.substring Returns a substring starting from the $startingLoc and continuing for $length characters.
fn.substringAfter Returns the substring created by taking all of the input characters that occur after the specified $after characters.
fn.substringBefore Returns the substring created by taking all of the input characters that occur before the specified $before characters.
fn.sum Returns a value obtained by adding together the values in $arg.
fn.tail Returns all but the first item in a sequence.
fn.timezoneFromDate Returns the timezone component of $arg if any.
fn.timezoneFromDateTime Returns the timezone component of $arg if any.
fn.timezoneFromTime Returns the timezone component of $arg if any.
fn.tokenize Returns a sequence of strings contructed by breaking the specified input into substrings separated by the specified $pattern.
fn.trace Return 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.translate Returns 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.true Returns the xs:boolean value true.
fn.typeAvailable Returns 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.unordered Returns the items of $sourceSeq in an implementation dependent order.
fn.unparsedText Reads a file stored in the database as either text or binary file and returns its contents as a string.
fn.unparsedTextAvailable Returns true if a call to unparsed-text would succeed with identical arguments.
fn.upperCase Returns the specified string converting all of the characters to upper-case characters.
fn.yearFromDate Returns an xs:integer representing the year component in the localized value of $arg.
fn.yearFromDateTime Returns an xs:integer representing the year component in the localized value of $arg.
fn.yearsFromDuration Returns an xs:integer representing the years component in the canonical lexical representation of the value of $arg.
fn.zeroOrOne Returns $arg if it contains zero or one items.
geo.approxCenter Return a point approximating the center of the given region.
geo.arcIntersection Returns the point at the intersection of two arcs.
geo.bearing Returns the true bearing in radians of the path from the first point to the second.
geo.boundingBoxes Returns a sequence of boxes that bound the given region.
geo.box Create a cts.box value from a node representing a box in one of the supported markup vocabularies, such as KML, GML, or GeoJSON.
geo.boxIntersects Returns true if the box intersects with a region.
geo.circle Create 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.circleIntersects Returns true if the circle intersects with a region.
geo.circlePolygon Construct a polygon approximating a circle.
geo.complexPolygon Create 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.complexPolygonContains Returns true if the complex-polygon contains a region.
geo.complexPolygonIntersects Returns true if the complex-polygon intersects with a region.
geo.coordinateSystemCanonical Get the canonical name for the coordinate system.
geo.countDistinctVertices Return a count of the distinct number of vertices in a region, taking tolerance into account.
geo.countVertices This function returns a count of the number of vertices in a region.
geo.defaultCoordinateSystem Get the canonical name for the coordinate system currently in effect.
geo.destination Returns the point at the given distance (in units) along the given bearing (in radians) from the starting point.
geo.distance Returns the distance (in units) between two points.
geo.distanceConvert This function converts a distance from one unit of measure to another.
geo.ellipsePolygon Construct a polygon approximating an ellipse.
geo.geohashDecode Given a geohash string, return the bounding box for that hash.
geo.geohashDecodePoint Given a geohash string, return the point for that hash.
geo.geohashEncode Compute a set of covering geohashes for the given region, to the given level of precision.
geo.geohashNeighbors Given a geohash string, return hashes for the neighbors.
geo.geohashPrecisionDimensions Given a geohash string, return the height and width for the given precision.
geo.geohashSubhashes Given a geohash string, return the 32 subhashes.
geo.geospatialQuery Returns a query matching points within given regions.
geo.geospatialQueryFromElements Returns a query matching points within given regions.
geo.geospatialQueryFromNodes Returns a query matching points within given regions.
geo.interiorPoint This function returns a point that is guaranteed to be inside the bounds of the given region.
geo.interiorPolygon Create a sequence of cts.polygon values from a polygon node in one of the supported markup vocabularies, such as KML or GML.
geo.linestring Create a cts.linestring value from a node representing a linestring in one of the supported markup vocabularies, such as GML or KML.
geo.linestringConcat Construct a linestring by concatenating the vertices of the input linestrings, in order.
geo.linestringReverse Construct a linestring with the vertices in reverse order.
geo.parse Convert nodes in one or more of the supported geospatial representations into cts.region values.
geo.parseWkb Returns a sequence of geospatial regions parsed from Well-Known Binary format.
geo.parseWkt Returns a sequence of geospatial regions parsed from Well-Known Text format.
geo.point Create a cts.point value from a node representing a point in one of the supported markup vocabularies, such as KML or GML.
geo.polygon Create a cts.polygon value from a sequence of point nodes in one of the supported markup vocabularies, such as KML or GML.
geo.polygonContains Returns true if the polygon contains a region.
geo.polygonIntersects Returns true if the polygon intersects with a region.
geo.polygonToLinestring Construct 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.regionAffineTransform Perform an affine transformation on a geospatial region.
geo.regionApproximate This function returns a simplified approximation of the region, using the Douglas-Peucker algorithm.
geo.regionClean This function fixes various problems with the region or raises an error if it is not repairable.
geo.regionContains Returns true if one region contains the other region.
geo.regionDe9im Calculates the Dimensionally Extended nine-Intersection Matrix (DE-9IM) of two geospatial regions.
geo.regionIntersects Returns true if the target region intersects with a region.
geo.regionRelate Compares geospatial regions based on a specified relationship.
geo.removeDuplicateVertices Remove duplicate (adjacent) vertices.
geo.shortestDistance Returns the great circle distance (in units) between a point and a region.
geo.toWkb Returns a binary node in Well-Known Binary format.
geo.toWkt Returns a sequence of strings in Well-Known Text format.
geo.validateWkb Returns true if the binary data can be parsed as WKB into a supported region type.
geo.validateWkt Returns true if the string is valid Well-Known Text for a supported region type.
geogml.box Create a cts:box value from a GML Envelope element.
geogml.circle Create a cts:circle value from a radius and GML Point element.
geogml.complexPolygon Create a cts:complex-polygon value from a GML Polygon element.
geogml.geospatialQuery Returns a cts:query matching points within given regions.
geogml.geospatialQueryFromElements Returns a cts:query matching points within given regions.
geogml.interiorPolygon Create a sequence of cts:polygon values from a GML Polygon element.
geogml.linestring Create a cts:linestring value from a GML LineString element.
geogml.parseGml Construct regions from GML elements.
geogml.point Create a cts:point value from a GML Point element.
geogml.polygon Create a cts:polygon value from a sequence of GML Point elements or a GML Polygon element.
geogml.toGml Construct GML elements from cts:region values.
geojson.box Create a cts:box value from GeoJSON bbox property.
geojson.circle Create a cts:circle value from a radius and a GeoJSON "Point" type geometry object.
geojson.complexPolygon Create a cts:complex-polygon value from a GeoJSON "Polygon" type geometry object.
geojson.geospatialQuery Returns a cts:query matching points within given regions.
geojson.geospatialQueryFromNodes Returns a cts:query matching points within given regions.
geojson.interiorPolygon Create a sequence of cts:polygon values from a GeoJSON "Polygon" type geometry object.
geojson.linestring Create a cts:linestring value from a GeoJSON "LineString" type geometry object.
geojson.multiLinestring Create a set of cts:linestring values from a GeoJSON "MultiLineString" type geometry object.
geojson.multiPoint Create a set of cts:point values from a GeoJSON "MultiPoint" type geometry object.
geojson.parseGeojson Convert GeoJSON object nodes into cts:region values.
geojson.point Create a cts:point value from a GeoJSON "Point" type geometry object.
geojson.polygon Create a cts:polygon value from a GeoJSON "Polygon" type geometry object or a sequence of GeoJSON "Point" type geometry objects.
geojson.toGeojson Convert cts:region values into GeoJSON object nodes.
geokml.box Create a cts:box value from a KML LatLongBox element.
geokml.circle Create a cts:circle value from a radius and KML Point or Location element.
geokml.complexPolygon Create a cts:complex-polygon value from a KML Polygon element.
geokml.geospatialQuery Returns a cts:query matching points within given regions.
geokml.geospatialQueryFromElements Returns a cts:query matching points within given regions.
geokml.interiorPolygon Create a sequence of cts:polygon values from a KML Polygon element.
geokml.linestring Create a cts:linestring value from a KML LineString element.
geokml.parseKml Construct regions from KML elements.
geokml.point Create a cts:point value from a KML Point or Location element.
geokml.polygon Create a cts:polygon value from a KML polygon or a sequence of KML Point or Location elements.
geokml.toKml Construct KML elements from cts:region values.
georss.circle Create a cts:circle value from a radius and GeoRSS point element.
georss.complexPolygon Create a cts:complex-polygon value from a GeoRSS "Polygon" element.
georss.geospatialQuery Returns a cts:query matching points within given regions.
georss.linestring Create a cts:linestring value from a GeoRSS line element.
georss.parseGeorss Construct zero or more cts:region values from GeoRSS XML elements.
georss.point Create a cts:point value from a GeoRSS point element.
georss.polygon Create a cts:polygon value from a sequence of GeoRSS point elements or a GeoRSS polygon element.
georss.toGeorss Convert cts:region values to GeoRSS XML elements.
Global-Object.declareUpdate Declares the statement to be an update.
Global-Object.require Imports a module at the specified location, and returns a JavaScript object.
IteratePlan.prototype.explain This method returns a representation of the builtin execution plan.
IteratePlan.prototype.export This 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.result This 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.bucketName Names 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.byExample Constructs a cts.query working by example.
jsearch.collections Creates a jsearch object for searching within the scope of the union of one or more collections.
jsearch.databaseLexicon Identifies the lexicon for all words in the database as input for the jsearch.words method.
jsearch.documents Creates a DocumentsSearch object to define and execute a search for documents.
jsearch.documentSelect Applies 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.elementAttributeLexicon Identifies the word lexicon for an attribute of an element as input for the jsearch.words method.
jsearch.elementLexicon Identifies the word lexicon for an element as input for the jsearch.words method.
jsearch.facet Creates a FacetDefinition object to define the value enumeration as part of a facet search.
jsearch.facets Creates a FacetsSearch object to define and execute a report listing value facets and, optionally, a page of documents.
jsearch.fieldLexicon Identifies the word lexicon for a field as input for the jsearch.words method.
jsearch.jsonPropertyLexicon Identifies the word lexicon for a JSON property as input for the jsearch.words method.
jsearch.makeBuckets Returns 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.makeHeatmap Returns 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.tuples Creates 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.udf Identifies 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.values Creates a ValuesSearch object to define and execute a search for a list of indexed values.
jsearch.words Creates a WordsSearch object to define and execute a search for a list of indexed words.
json.checkConfig This function checks a json configuration object and returns a report.
json.config This function creates a configuration object for a specified strategy.
json.transformFromJson This function transforms a JSON document to XML using the default ("basic") strategy.
json.transformToJson This function transforms an XML document to JSON using the default ("basic") strategy if none is supplied.
json.transformToJsonObject This function transforms an XML document to JSON and returns an object.
json.transformToJsonXml This function transforms an XML document to JSON and returns an xml element.
math.acos Returns the arc cosine of x, in radians, in the range from 0 to pi (inclusive).
math.asin Returns the arc sine of x, in radians, in the range from -pi/2 to +pi/2 (inclusive).
math.atan Returns the arc tangent of x, in radians.
math.atan2 Returns 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.ceil Returns the smallest integer greater than or equal to x.
math.correlation Returns the Pearson correlation coefficient of a data set.
math.cos Returns the cosine of x, in the range from -1 to +1 (inclusive).
math.cosh Returns the hyperbolic cosine of x.
math.cot Returns the cotangent of x.
math.covariance Returns the sample covariance of a data set.
math.covarianceP Returns the population covariance of a data set.
math.degrees Returns numeric expression converted from radians to degrees.
math.exp Returns e (approximately 2.71828182845905) to the xth power.
math.fabs Returns the absolute value of x.
math.floor Returns the largest integer less than or equal to x.
math.fmod Returns the remainder of x/y.
math.frexp Returns x broken up into mantissa and exponent, where x = mantissa*2^exponent.
math.ldexp Returns x*2^i.
math.linearModel Returns a linear model that fits the given data set.
math.linearModelCoeff Returns the coefficients of the linear model.
math.linearModelIntercept Returns the intercept of the linear model.
math.linearModelRsquared Returns the R^2 value of the linear model.
math.log Returns the base-e logarithm of x.
math.log10 Returns the base-10 logarithm of x.
math.median Returns the median of a sequence of values.
math.mode Returns the mode of a sequence.
math.modf Returns x broken up into fraction and integer.
math.percentile Returns a sequence of percentile(s) given a sequence of percentage(s).
math.percentRank Returns the rank of a value in a data set as a percentage of the data set.
math.pi Returns the value of pi.
math.pow Returns x^y.
math.radians Returns numeric expression converted from degrees to radians.
math.rank Returns the rank of a value in a data set.
math.sin Returns the sine of x, in the range from -1 to +1 (inclusive).
math.sinh Returns the hyperbolic sine of x.
math.sqrt Returns the square root of x.
math.stddev Returns the sample standard deviation of a sequence of values.
math.stddevP Returns the standard deviation of a population.
math.tan Returns the tangent of x.
math.tanh Returns the hyperbolic tangent of x, in the range from -1 to +1 (inclusive).
math.trunc Returns the number truncated to a certain number of decimal places.
math.variance Returns the sample variance of a sequence of values.
math.varianceP Returns the population variance of a sequence of values.
ModifyPlan.prototype.except This 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.explain This method returns a representation of the builtin execution plan.
ModifyPlan.prototype.export This 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.groupBy This method collapses a group of rows into a single row.
ModifyPlan.prototype.intersect This 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.joinCrossProduct This method yields one output row set that concatenates every left row with every right row.
ModifyPlan.prototype.joinDoc This 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.joinDocUri This method adds a uri column to rows based on an existing fragment id column to identify the source document for each row.
ModifyPlan.prototype.joinInner This method returns all rows from multiple tables where the join condition is met.
ModifyPlan.prototype.joinLeftOuter This method yields one output row set with the rows from an inner join as well as rows from the left row set.
ModifyPlan.prototype.limit This method specifies the maximum number of rows to be returned by this Plan.
ModifyPlan.prototype.map This method applies the specified function to each row returned by the plan to produce a different result row.
ModifyPlan.prototype.offset This 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.offsetLimit This 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.orderBy This method sorts the row set by the specified order definition.
ModifyPlan.prototype.prepare This method prepares the specified plan for execution as an optional final step before execution.
ModifyPlan.prototype.reduce This 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.result This 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.select This call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set.
ModifyPlan.prototype.union This method yields all of the rows from the input row sets.
ModifyPlan.prototype.where This method restricts the row set to rows matched by the boolean expression.
ModifyPlan.prototype.whereDistinct This method removes duplicate rows from the row set.
NamedNodeMap.getNamedItem Return the named node, if it exists in the map.
NamedNodeMap.getNamedItemNS Return the node with the given localname and namespace URI, if it exists in the map.
Node.baseURI Returns a string representing the base URI of the node.
Node.nodeKind Return a string indicating the type of the node.
Node.nodeType Return the DOM code indicating the type of the node.
Node.toObject This is inherited from the Value object. Return a JavaScript object value.
Node.toString This is inherited from the Value object. The atomic value of the object (for example, of the Node).
Node.valueOf This is inherited from the Value object. The atomic value of the object (for example, of the Node).
Node.xpath Evaluate an XPath using the node as context.
NodeBuilder.addAttribute Add an attribute node to the node tree the builder is building.
NodeBuilder.addBinary Add a binary node to the node tree the builder is building.
NodeBuilder.addBoolean Add a boolean node to the node tree the builder is building.
NodeBuilder.addComment Add an XML comment node to the node tree the builder is building.
NodeBuilder.addDocument Add a document node to the node tree the builder is building.
NodeBuilder.addElement Add an XML element node to the node tree the builder is building.
NodeBuilder.addNode Add a node to the node tree the builder is building.
NodeBuilder.addNull Add a null node to the node tree the builder is building.
NodeBuilder.addNumber Add a number node to the node tree the builder is building.
NodeBuilder.addProcessingInstruction Add an XML processing instruction node to the node tree the builder is building.
NodeBuilder.addText Add a text node to the node tree the builder is building.
NodeBuilder.endDocument Close out the current document node.
NodeBuilder.endElement Close out the current XML element node.
NodeBuilder.startDocument Start a new document node in the node tree the builder is building.
NodeBuilder.startElement Start a new XML element node in the node tree the builder is building.
NodeBuilder.toNode Return the node tree that has been built.
NodeList.item Return the nth node.
NodeList.length Return the number of nodes in the node list.
NullNode.baseURI This is inherited from the Node object. Returns a string representing the base URI of the node.
NullNode.nodeKind This is inherited from the Node object. Return a string indicating the type of the node.
NullNode.nodeType This is inherited from the Node object. Return the DOM code indicating the type of the node.
NullNode.xpath This is inherited from the Node object. Evaluate an XPath using the node as context.
NumberNode.baseURI This is inherited from the Node object. Returns a string representing the base URI of the node.
NumberNode.nodeKind This is inherited from the Node object. Return a string indicating the type of the node.
NumberNode.nodeType This is inherited from the Node object. Return the DOM code indicating the type of the node.
NumberNode.xpath This is inherited from the Node object. Evaluate an XPath using the node as context.
ObjectNode.baseURI This is inherited from the Node object. Returns a string representing the base URI of the node.
ObjectNode.nodeKind This is inherited from the Node object. Return a string indicating the type of the node.
ObjectNode.nodeType This is inherited from the Node object. Return the DOM code indicating the type of the node.
ObjectNode.xpath This is inherited from the Node object. Evaluate an XPath using the node as context.
op.add This function returns the sum of the specified numeric expressions.
op.and This function returns true if the specified boolean expressions all return true.
op.arrayAggregate This function constructs an array whose items are the result of evaluating the column for each row in the group or row set.
op.as This function defines a column by assigning the value of an expression over the rows in the row set.
op.asc This function sorts the specified columndef in ascending order.
op.avg This function averages the non-null values of the column for the rows in the group or row set.
op.call This 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.case This function returns the specified valueExpression if the specified valueExpression is true.
op.col Identifies a column where the column name is unique and a qualifier on the column name isn't necessary (and might not exist).
op.count This function counts the rows where the specified input column has a value.
op.desc This function sorts the specified columndef in descending order.
op.divide This function divides the left numericExpression by the right numericExpression and returns the value.
op.eq This function returns true if the left and right expressions return the same value.
op.fragmentIdCol Specifies a name for adding a fragment id column to the row set identifying the source documents for the rows from a view, lexicons or triples.
op.fromLexicons This function dynamically constructs a view from range indexes or the uri or collection lexicons.
op.fromLiterals Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements.
op.fromSPARQL This function dynamically constructs a row set based on an SPARQL SELECT query from triples.
op.fromSQL This function dynamically constructs a row set based on a SQL SELECT query from views.
op.fromTriples Reads rows by matching patterns in the triple index.
op.fromView This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
op.ge This function returns true if the value of the left expression is greater than or equal to the value of the right expression.
op.graphCol Identifies the graph for a triple providing one or more columns for a row.
op.groupConcat This function concatenates the non-null values of the column for the rows in the group or row set.
op.gt This function returns true if the value of the left expression is greater than the value of the right expression.
op.import This function instantiates a plan from the JSON representation of a plan that was exported by the prototype.export function.
op.isDefined This 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.jsonArray This function constructs a JSON array during row processing.
op.jsonBoolean This function constructs a JSON boolean node with the specified value.
op.jsonDocument This function constructs a JSON document with the root content, which must be exactly one JSON object or array node.
op.jsonNull This function constructs a JSON null node.
op.jsonNumber This function constructs a JSON number node with the specified value.
op.jsonObject This function constructs a JSON object with the specified properties.
op.jsonString This function constructs a JSON text node with the specified value.
op.le This function returns true if the value of the left expression is less than or equal to the value of the right expression.
op.lt This function returns true if the value of the left expression is less than the value of the right expression.
op.max This function gets the largest non-null value of the column for the rows in the group or row set.
op.min This function gets the smallest non-null value of the column for the rows in the group or row set.
op.modulo This function returns the remainder afer the division of the dividend and divisor expressions.
op.multiply This function multipies the left numericExpression by the right numericExpression and returns the value.
op.ne This function returns true if the value of the left expression is not equal to the value of the right expression.
op.not This function returns true if neither of the specified boolean expressions return true.
op.on Specifies an equijoin using one columndef each from the left and right rows.
op.or This function returns true if either of the specified boolean expressions return true.
op.param This function creates a placeholder for a literal value in an expression or as the offset or max for a limit.
op.pattern This function builds the parameters for the op.fromTriples function.
op.prefixer This function factory returns a new function that takes a name parameter and prepends the specified base URI onto the name.
op.prop This function specifies the key expression and value content for a JSON property of a JSON object contructed by the op.jsonObject function.
op.sample This function randomly selects one non-null value of the column from the rows in the group or row set.
op.schemaCol Unambiguously identifies a column with the schema name, view name, and column name.
op.sequenceAggregate This call constructs a sequence whose items are the values of a column for each row in the group or row set.
op.sqlCondition This function returns a filter definition as input for a WHERE operation.
op.subtract This function subtracts the right numericExpression from the left numericExpression and returns the value.
op.sum This function adds the non-null values of the column for the rows in the group or row set.
op.toSource This function generates a server-side JavaScript source code representation of a plan from the JSON or JavaScript literal object representation of a plan that was exported by the prototype.export function.
op.uda This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin.
op.viewCol Identifies a column where the combination of view and column name is unique.
op.when This function executes the specified expression if the specified condition is true for the row.
op.xmlAttribute This function constructs an XML attribute with the name (which can be a string or QName) and atomic value.
op.xmlComment This function constructs an XML comment with the atomic value.
op.xmlDocument This function constructs an XML document with the root content, which must be exactly one node.
op.xmlElement This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
op.xmlPI This function constructs an XML processing instruction with the atomic value.
op.xmlText This function constructs an XML text node with the specified value.
op.xpath This function extracts a sequence of child nodes from a column with node values -- especially, the document nodes from a document join.
PreparePlan.prototype.explain This method returns a representation of the builtin execution plan.
PreparePlan.prototype.export This 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.map This method applies the specified function to each row returned by the plan to produce a different result row.
PreparePlan.prototype.reduce This 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.result This 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.attributes This is inherited from the XMLNode object. The attributes of this node.
ProcessingInstruction.childNodes This is inherited from the XMLNode object. The children of this node.
ProcessingInstruction.firstChild This is inherited from the XMLNode object. The first child of this node, if any.
ProcessingInstruction.hasAttributes This is inherited from the XMLNode object. Whether this node has attributes.
ProcessingInstruction.hasChildNodes This is inherited from the XMLNode object. Whether this node has any children.
ProcessingInstruction.isEqualNode This is inherited from the XMLNode object. Whether this node is equal to another node.
ProcessingInstruction.isSameNode This is inherited from the XMLNode object. Whether this node is the same exact node as another node.
ProcessingInstruction.lastChild This is inherited from the XMLNode object. The last child of this node, if any.
ProcessingInstruction.localName This is inherited from the XMLNode object. Return the local name of this node.
ProcessingInstruction.namespaceURI This is inherited from the XMLNode object. Return the namespace URI of this node.
ProcessingInstruction.nextSibling This is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any.
ProcessingInstruction.nodeName This is inherited from the XMLNode object. The DOM name of the node.
ProcessingInstruction.nodeValue This is inherited from the XMLNode object. The DOM value of the node.
ProcessingInstruction.ownerDocument This is inherited from the XMLNode object. The document node containing this node, if any.
ProcessingInstruction.parentNode This is inherited from the XMLNode object. The node that is this node's parent.
ProcessingInstruction.prefix This is inherited from the XMLNode object. Return the namespace prefix of this node.
ProcessingInstruction.previousSibling This is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any.
ProcessingInstruction.target The target of an XML processing instruction.
ProcessingInstruction.textContent This is inherited from the XMLNode object. The DOM text value of the node.
prof.eval Evaluate a string as JavaScript for profiling.
rdf.langString Returns an rdf:langString value with the given value and language tag.
rdf.langStringLanguage Returns the language of an rdf:langString value.
rdt.redact Apply redaction rules to a set of XML and/or JSON documents, returning the resulting documents.
rdt.ruleValidate Validate the redaction rules in one or more redaction rule collections and return the URIs of the rule documents validated.
sc.annotations Returns the schema annotations of the component, if any.
sc.attributeDecl Returns the attribute declaration of item, as a schema component, if any.
sc.attributes Returns the attribute declarations of the schema component, if any.
sc.canonicalPath Returns the canonical schema component path of the component.
sc.complexType Returns the complex type of item, as a schema component, if any.
sc.componentProperty Returns the named property of the schema component.
sc.elementDecl Returns the element declaration of item, as a schema component, if any.
sc.facets Returns the facets of the component, if any.
sc.functionParameterType Returns the declared parameter type of a specific parameter of the function item as a schema component.
sc.functionReturnType Returns the return type of a function item as a schema component.
sc.name Returns the name of the schema component, if any.
sc.particles Returns the particles of the schema component, if any.
sc.schema Returns the root schema of the item.
sc.schemaFromPath Get a schema object as a value based on its namespace and schema location hint.
sc.simpleType Returns the simple type of item, as a schema component, if any.
sc.type Returns the type of item, as a schema component, if any.
sc.typeApply Apply a type to an item to construct a typed instance of that type.
sc.typeNamed Returns the type with the given name, if any, as a schema component.
sem.binding Creates a sem:binding object, which is a sub-type of json:object (and map:map).
sem.bnode This function returns an identifier for a blank node, allowing the construction of a triple that refers to a blank node.
sem.coalesce Returns the value of the first argument that evaluates without error.
sem.curieExpand This function expands a CURIE (Compact URI) into a sem:iri object.
sem.curieShorten This function shortens an IRI into a CURIE (Compact URI) into a sem:iri object.
sem.databaseNodes This function returns database nodes backing given triples.
sem.datatype Returns the name of the simple type of the atomic value argument as a SPARQL style IRI.
sem.defaultGraphIri Returns the iri of the default graph.
sem.describe This function implements the Concise Bounded Description (CBD) specification to describe one or more nodes in the graph.
sem.graph This function returns all triples from a named graph in the database.
sem.graphAddPermissions Add permissions to the graph specified.
sem.graphDelete This function deletes a named graph, and its graph document containing metadata, from the database.
sem.graphGetPermissions Get permissions to the graph specified.
sem.graphInsert This function inserts triples into a named graph, creating the graph if necessary.
sem.graphRemovePermissions Remove permissions from the graph specified.
sem.graphSetPermissions Set permissions to the graph specified.
sem.if The 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.inMemoryStore Returns a sem:store constructor that queries from the sequence of sem:triple values passed in as an argument.
sem.invalid Returns a sem:invalid value with the given literal value and datatype IRI.
sem.invalidDatatype Returns the datatype IRI of a sem:invalid value.
sem.iri This is a constructor function that takes a string and constructs an item of type sem.iri from it.
sem.isBlank Returns true if the argument is an RDF blank node - that is, derived from type sem:blank.
sem.isIRI Returns true if the argument is an RDF IRI - that is, derived from type sem:iri, but not derived from type sem:blank.
sem.isLiteral Returns true if the argument is an RDF literal - that is, derived from type xs:anyAtomicType, but not derived from type sem:iri.
sem.isNumeric Returns true if the argument is a valid numeric RDF literal.
sem.lang Returns the language of the value passed in, or the empty string if the value has no language.
sem.langMatches Returns true if $lang-tag matches $lang-range according to the basic filtering scheme defined in RFC4647.
sem.prefixes This function returns a set of prefix mappings for use with CURIE processing.
sem.queryResultsSerialize This function implements the W3C SPARQL Query Results format.
sem.random Returns a random double between 0 and 1.
sem.rdfBuilder This function returns a function that builds triples from CURIE and blank node syntax.
sem.rdfGet This function returns sem:triples from a specified location.
sem.rdfInsert This function inserts triples into a specified database as one or more sem:triples documents.
sem.rdfLoad This function inserts an RDF document from a specified location into the designated database.
sem.rdfParse This function returns parsed sem:triple objects from a text format or XML.
sem.rdfSerialize This function returns a string or json or XML serialization of the provided triples.
sem.resolveIri Resolves a relative URI against an absolute URI.
sem.rulesetStore The sem:ruleset-store function returns a set of triples derived by applying the ruleset to the triples in the sem:store constructor provided in $store ("the triples that can be inferred from these rules").
sem.sameTerm Returns true if the arguments are the same RDF term as defined by the RDF concepts specification.
sem.sparql Executes a SPARQL query against the database.
sem.sparqlPlan Return a node representing the query plan of the given SPARQL query.
sem.sparqlUpdate Executes a SPARQL Update operation against the database.
sem.sparqlValues This function executes a SPARQL SELECT query using passed-in bindings participating as a starting point for the query.
sem.store The 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.timezoneString Returns the timezone of an xs:dateTime value as a string.
sem.transitiveClosure From a starting set of seeds, follow a given set of predicates, to a given depth, and return all unique node IRIs.
sem.triple Creates a triple object, which represents an RDF triple containing atomic values representing the subject, predicate, object, and optionally graph identifier (graph IRI).
sem.tripleGraph Returns the graph identifier (graph IRI) from a sem:triple value.
sem.tripleObject Returns the object from a sem:triple value.
sem.triplePredicate Returns the predicate from a sem:triple value.
sem.tripleSubject Returns the subject from a sem:triple value.
sem.typedLiteral Returns a value to represent the RDF typed literal with lexical value $value and datatype IRI $datatype.
sem.unknown Returns a sem:unknown value with the given literal value and datatype IRI.
sem.unknownDatatype Returns the datatype IRI of a sem:unknown value.
sem.uuid Return a UUID URN (RFC4122) as a sem:iri value.
sem.uuidString Return a string that is the scheme specific part of random UUID URN (RFC4122).
Sequence.from Create a Sequence object from an array-like or iterable object.
Sequence.prototype.@@iterator Return an iterator object.
Sequence.prototype.toArray Return an array containing the values in the Sequence.
Sequence.toObject This is inherited from the Value object. Return a JavaScript object value.
Sequence.toString This is inherited from the Value object. The atomic value of the object (for example, of the Node).
Sequence.valueOf This is inherited from the Value object. The atomic value of the object (for example, of the Node).
spell.addWord Add the word $word to the dictionary at $uri.
spell.doubleMetaphone Given a word returns the two metaphone keys.
spell.insert Load the words in $dict into the dictionary at $uri.
spell.isCorrect Returns true() if the specified word is spelled correctly, otherwise returns false().
spell.levenshteinDistance Given two strings, returns the Levenshtein distance between those strings.
spell.load Add the words from the file specified in $path to the dictionary at $uri.
spell.makeDictionary Creates a dictionary node from a sequence of words.
spell.removeWord Remove the word $word from the dictionary at $uri.
spell.romanize Returns the romanization of the string, substituting basic Latin letters for the letters in the string, according to their sound.
spell.suggest Suggests a list of spellings for a word.
spell.suggestDetailed Suggests a list of spellings for a word.
sql.bitLength Returns the length of the string "str" in bits.
sql.collatedString Returns an rdf.collatedString value with the given value and collation tag.
sql.collatedStringCollation Returns the collation of an sql.collatedString value.
sql.columnID Returns the column ID from a schema name, a view name and a column name.
sql.day Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg.
sql.dayname Returns an xs:string representing the dayname value in the localized value of $arg.
sql.difference Returns an integer value that indicates the difference between the SOUNDEX values of two character expressions.
sql.glob Returns true if the specified $input glob the specified $pattern, otherwise returns false.
sql.hours Returns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of $arg.
sql.ifnull If the first expression is NULL, then the value of the second expression is returned.
sql.insert Returns 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.instr Find the starting location of a pattern in a string.
sql.left Returns a string that is the leftmost characters of the target string.
sql.like Returns true if the specified $input like the specified $pattern, otherwise returns false.
sql.ltrim Return a string that removes leading empty spaces in the input string.
sql.minutes Returns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of $arg.
sql.month Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg.
sql.monthname Returns month name, calculated from the localized value of $arg.
sql.nullif Returns a NULL value if the two specified values are equal.
sql.octetLength Returns the length of the string "str" in bits.
sql.quarter Returns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of $arg.
sql.rand Return a random number.
sql.repeat Returns a string that concatenates the first argument as many times as specified by the second argument.
sql.right Returns a string that is the rightmost characters of the target string.
sql.rtrim Return a string that removes trailing empty spaces in the input string.
sql.seconds Returns an xs:decimal value between 0 and 60.999..., both inclusive, representing the seconds and fractional seconds in the localized value of $arg.
sql.sign Returns the sign of number x.
sql.soundex Returns a four-character (SOUNDEX) code to evaluate the similarity of two strings.
sql.space Returns a string that is the given number of spaces.
sql.strpos Returns an integer value representing the starting position of a string within the search string.
sql.timestampadd Returns a xs:string? timestamp created by adding a number to the given dateTimeType field of a given timestamp.
sql.timestampdiff Returns the difference in dateTimeType field of two given timestamps.
sql.trim Return a string that removes leading empty spaces in the input string.
sql.week Returns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of $arg.
sql.year Returns an xs:integer representing the year component in the localized value of $arg.
sql.yearday Returns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of $arg.
tde.getView This function returns a view's description using a schema and a view name.
tde.nodeDataExtract Extracts 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.templateInsert This 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.validate In addition to xdmp.validate that can be used for validating against the extraction template schema.
temporal.advanceLsqt This 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.axes This function returns all the axis names defined in the schema databases.
temporal.axisCreate This function constructs an axis definition based on the existing range indexes that can be added to a temporal collection in subsequent API calls.
temporal.axisGetEnd This function returns the range index used to define the end of the period by the named axis.
temporal.axisGetStart This function returns the range index used to define the start of the period by the named axis.
temporal.axisRemove This function removes an axis definition from the schema database.
temporal.collectionCreate This function constructs a named and protected temporal collection in the schema database with the specified system and optional valid axes.
temporal.collectionGetAxis This function returns the name of either the system or valid axis in the named temporal collection.
temporal.collectionGetOptions This function returns the options set on the temporal collection.
temporal.collectionRemove This function removes the named temporal collection from the Security database.
temporal.collections This function returns all of the temporal collection names in the schema database.
temporal.collectionSetOptions This function sets the options on the temporal collection.
temporal.documentDelete This function deletes the temporal document identified by the given URI.
temporal.documentInsert This function inserts a document into the database and stores it as a temporal document.
temporal.documentLoad This function inserts a document into the database and stores it as a temporal document.
temporal.documentPeriod This 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.documentProtect Protects a temporal document from certain temporal operations, such as update, delete or wipe for a specific period of time.
temporal.documentWipe Deletes all versions of a temporal document.
temporal.getLsqt This function returns the Last Stable Query Time (LSQT) for the collection at current moment.
temporal.getLsqtAutomation This function returns whether Last Stable Query Time (LSQT) management is automatically managed (true) or not automatically managed (false).
temporal.getLsqtAutomationLag When 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.getLsqtAutomationPeriod This function returns how often Last Stable Query Time (LSQT) is automatically advanced, in milliseconds.
temporal.getUseLsqt This function specifies whether the named temporal collection has LSQT (Last Stable Query Time) enabled (true) or disabled (false).
temporal.nodeDelete Deletes a node from the database.
temporal.nodeInsertAfter Adds an immediately following sibling to a node in a temporal document.
temporal.nodeInsertBefore Adds an immediately preceding sibling to a node in a temporal document.
temporal.nodeInsertChild Adds a new last child to a node in a temporal document.
temporal.nodeReplace Replaces a node in a temporal document.
temporal.setLsqtAutomation This function sets whether Last Stable Query Time (LSQT) management is automatic.
temporal.setUseLsqt This function enables or disables the use of LSQT (Last Stable Query Time) on the named collection.
temporal.statementGetSystemTime This function gets the system start time on temporal documents that are inserted or deleted in the same statement as this function.
temporal.statementSetDocumentVersionUri This 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.statementSetSystemTime This function sets the system start time on temporal documents that are inserted or deleted in the same statement as this function.
Text.data This is inherited from the CharacterData object. The character data.
Text.isElementContentWhitespace This is inherited from the CharacterData object. Whether this text node is ignorable whitespace.
Text.length This is inherited from the CharacterData object. The length of the character data (codepoints).
Text.substring This is inherited from the CharacterData object. A substring of the character data, starting at a given offset and continuing for a given length.
Text.wholeText This is inherited from the CharacterData object. The text of the text node concatenated with its logically adjacent text nodes.
thsr.addSynonym Adds a synonym to the specified thesaurus entry.
thsr.expand Returns a query that searches for all the query strings specified in $query and their synonyms as found in $entries.
thsr.insert Load the entries in $thsr into the thesaurus at $uri.
thsr.load Load the file specified in $path to the thesaurus at $uri.
thsr.lookup Returns all entries for term $term in the thesaurus document(s) at $uri.
thsr.queryLookup Returns 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.removeEntry Removes all entries that exactly match $entry from the thesaurus documents(s) at $uri.
thsr.removeSynonym Removes synonym $synonym from thesaurus entry $entry.
thsr.removeTerm Removes all entries with term $term from the thesaurus document(s) at $uri.
thsr.setEntry Adds the entry $entry to the thesaurus at $uri.
tieredstorage.databaseCreateSubDatabase This function creates a database with the name $database-name and make the created database the sub database of the database designated by $database-id.
tieredstorage.databaseCreateSuperDatabase This function creates a database with the name $database-name and make the created database the super database of the database designated by $database-id.
tieredstorage.databaseDeleteSubDatabase This function disassociates the sub database designated by $delete-dbid with the super-database designated by $database-id and deletes the sub database.
tieredstorage.databaseDeleteSuperDatabase This function disassociates the super database designated by $delete-dbid with the sub-database designated by $database-id and deletes the super database.
tieredstorage.databasePartitionNumbers This function returns the partition numbers of the forests in the database
tieredstorage.databasePartitions This function returns the names of the partitions in the named database.
tieredstorage.forestCombine This function combines data in multiple forests into one new forest.
tieredstorage.forestMigrate This function moves data in a forest to new data directories and optionally sets new host for the forest.
tieredstorage.partitionDelete This function deletes all forests in the specified partition.
tieredstorage.partitionDeleteQuery This function deletes the query from the specified partition.
tieredstorage.partitionForests This function returns a sequence of ids for the forests in the named partition.
tieredstorage.partitionGetExclusionEnabled This function returns the safe-to-exclude setting for the database.
tieredstorage.partitionGetQuery This function returns the query of a partition specified by the partition number.
tieredstorage.partitionMigrate This function migrates all forests in a partition to the specified data directory and hosts.
tieredstorage.partitionNumberForests This function returns the IDs of the forests with the specified partition-number in the named database.
tieredstorage.partitionQueries This function returns all the queries in this schema database.
tieredstorage.partitionResize This function either creates or combines forests in a partition.
tieredstorage.partitionSetAvailability This function sets the availability of the partition to either online or offline.
tieredstorage.partitionSetExclusionEnabled By default, when a search query is given to MarkLogic, all query partitions are searched, regardless of the query assignment policy set on the partition.
tieredstorage.partitionSetQuery This function sets the query for a partition specified by the partition number.
tieredstorage.partitionSetUpdatesAllowed This function sets update-allowed state for the forests in the specified partition.
tieredstorage.partitionTransfer This function detaches forests in a partition from one database and attaches them to another.
tieredstorage.queryPartitionCreate This function creates forests on specified hosts and forms a partition with the specified partition number.
tieredstorage.rangePartitionCreate This function creates forests on the specified hosts and forms a range partition with the specified partition range.
TuplesSearch.aggregate Applies one or more aggregates to the tuples.
TuplesSearch.map Specifies a function similar to Array.prototype.map() to apply to each tuple within the slice or the configuration for the built-in mapper.
TuplesSearch.orderBy Specifies the sort method for the tuples.
TuplesSearch.reduce Specifies a function similar to Array.prototype.reduce() to apply to each tuple within the slice.
TuplesSearch.result Executes the tuples search definition and returns results.
TuplesSearch.slice Specifies a subset of tuples to retrieve.
TuplesSearch.where Specifies which documents have the co-occurring values.
TuplesSearch.withOptions Configure advanced options for a tuples query.
TypeInfo.isDerivedFrom Whether this type is derived from a named type by the selected methods.
TypeInfo.toObject This is inherited from the Value object. Return a JavaScript object value.
TypeInfo.toString This is inherited from the Value object. The atomic value of the object (for example, of the Node).
TypeInfo.typeName The local name of the type.
TypeInfo.typeNamespace The namespace URI of the type.
TypeInfo.valueOf This is inherited from the Value object. The atomic value of the object (for example, of the Node).
Value.toObject Return a JavaScript object value.
Value.toString The atomic value of the object (for example, of the Node).
Value.valueOf The 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.toObject This is inherited from the Value object. Return a JavaScript object value.
ValueIterator.toString This is inherited from the Value object. The atomic value of the object (for example, of the Node).
ValueIterator.valueOf This is inherited from the Value object. The atomic value of the object (for example, of the Node).
ValuesSearch.aggregate Applies one or more aggregates to the values in the index.
ValuesSearch.groupInto Groups the values into buckets between bound values, which must appear in increasing order.
ValuesSearch.map Specify a function similar to Array.prototype.map() to apply to each value within the slice, or configure the built-in mapper.
ValuesSearch.match Limits the values to those that match the pattern.
ValuesSearch.orderBy Specifies the sort order for values.
ValuesSearch.reduce Specifies 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.result Executes 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.slice Specifies a subsequence of values to retrieve.
ValuesSearch.where Specifies which documents have values in the index.
ValuesSearch.withOptions Configure advanced options for a values query.
view.addColumn This function adds column specifications to the current set of column specifications on the named view in the named schema.
view.addField This function adds a field to the named view.
view.addPermissions This function adds permissions to those already set for the named view in the named schema specification.
view.collection This function return the URI of the protected collection holding all the views.
view.collectionViewScope This function constructs a new collection-style view scope specification.
view.column This function constructs a new column specification.
view.columns This function returns the sequence of column specifications set in the named view in the named schema.
view.create This function creates a new view in the specified schema specification.
view.elementViewScope This function constructs a new element-style view scope specification.
view.field This function constructs a new element-style field specification for the named field.
view.fields This function returns the fields set on the named view.
view.get This function returns the named view from the named schema specification.
view.getBindings This function generates a binding map suitable for use with cts:parse from the named view.
view.getById This function returns the view with the specified id.
view.getColumn This function returns the named column specification set in the named view in the named schema.
view.getField This function returns the element specification for the named field.
view.getPermissions This function returns the permissions set on the specified view.
view.getViewScope This function returns the scope of the named view in the named schema.
view.remove This function removes the named view from the named schema specification.
view.removeById This function removes the view with the specified id.
view.removeColumn This function removes a column specification from the named view in the named schema.
view.removeField This function removes a field from the named view.
view.removePermissions This function removes permissions from those set for the named view in the named schema specification.
view.schemaAddPermissions This function adds permissions to the specified schema specification.
view.schemaCreate This function creates a new relational schema in the Schema database.
view.schemaGet This function returns the named schema specification document.
view.schemaGetPermissions This function returns the permissions set on the specified schema.
view.schemaRemove This function removes the specified schema.
view.schemaRemovePermissions This function removes permissions from the specified schema specification.
view.schemas This function returns all of the schema specifications.
view.schemaSetPermissions This function sets permissions on the specified schema specification.
view.setColumns This function replaces the current set of column specifications on the named view in the named schema with a new set of columns.
view.setFields This function sets the specified fields on the specified view.
view.setName This function renames the named view in the named schema specification.
view.setPermissions This function sets the permissions for the named view in the named schema specification.
view.setViewScope This function sets the scope of the named view in the named schema specification.
view.views This function returns all of the view specifications in the named schema.
WordsSearch.map Specifies a function similar to Array.prototype.map() to apply to each word within the slice.
WordsSearch.match Limits the words returned by a word lexicon query to those that match a wildcard pattern.
WordsSearch.orderBy Specifies the sort order for the words.
WordsSearch.reduce Specifies a function similar to Array.prototype.reduce() to apply to each word within the slice.
WordsSearch.result Executes 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.slice Specify a positional subset of words to retrieve.
WordsSearch.where Limit the words returned by a word lexicon query to those in documents selected by a query.
WordsSearch.withOptions Configure advanced options for a words query.
xdmp.access Returns whether a given action on the specified document URI would succeed.
xdmp.add64 Add two 64-bit integer values, discarding overflow.
xdmp.addResponseHeader Adds an HTTP response header field.
xdmp.amp Returns the amp ID for the specified amp.
xdmp.ampRoles Returns the set of all roles assigned to an amp, including roles directly assigned to the amp and roles inherited by other roles.
xdmp.and64 AND two 64-bit integer values.
xdmp.apply Applies an xdmp:function with the given parameters.
xdmp.architecture Returns the hardware architecture upon which MarkLogic Server is running.
xdmp.arrayValues Returns the array values as a Sequence.
xdmp.atomizable Returns true if a value could be atomized without error.
xdmp.awsRegion Returns the current Amazon Web Services region.
xdmp.awsServicesDomain Returns the current Amazon Web Services services domain.
xdmp.awsServicesPartition Returns the current Amazon Web Services services partition.
xdmp.base64Decode Converts base64-encoded string to plaintext.
xdmp.base64Encode Converts plaintext into base64-encoded string.
xdmp.binaryDecode Converts an encoded byte sequence, passed in as a binary node, from the specified encoding to a unicode string.
xdmp.binaryIsExternal Test whether or not a binary node represents an external binary.
xdmp.binaryIsLarge Check whether a binary node is a large binary.
xdmp.binaryIsSmall Check whether a binary node is a small binary.
xdmp.binarySize Returns the size of the data, in bytes, represented by a binary node.
xdmp.binaryToInteger Parses a binary string, returning an integer.
xdmp.bootstrapHosts Returns a sequence of the IDs of all the bootstrap hosts in the cluster.
xdmp.cacheStatus Returns the status of the caches as a Sequence of ObjectNodes.
xdmp.callerDialect Returns the dialect (e.g., "javascript", "1.0-ml", etc) of the caller or the empty sequence if no dialect information is available.
xdmp.canGrantRoles Tests whether a user can grant or revoke a set of roles.
xdmp.castableAs Returns true if a value is castable.
xdmp.cluster Returns the ID of the cluster named in the parameter.
xdmp.clusterEffectiveVersion Returns the current MarkLogic Server effective version.
xdmp.clusterName Returns the name of the cluster with the specified ID.
xdmp.clusterVersionAtLeast Returns true current MarkLogic Server effective version is equal or greater that the version
xdmp.collationCanonicalUri Returns the canonical URI for the given URI, if it represents a valid collation.
xdmp.collectionDelete Deletes from the database every document in a collection.
xdmp.collectionLocks Returns locks of documents in a collection.
xdmp.collectionProperties Returns a sequence of properties documents, one for each document in the specified collection(s) that has a corresponding properties document.
xdmp.commit Commit the current transaction to the database.
xdmp.configurationTimestamp Returns timestamp of last configuration changed
xdmp.credential Returns the credential
xdmp.credentialId Returns the id of a named credential.
xdmp.credentials Returns the credentials that the current user is allowed to use.
xdmp.crypt Calculates the password hash for the given password and salt.
xdmp.crypt2 Calculates the password hash for the given plain-text password.
xdmp.database Returns the ID of the database named in the parameter.
xdmp.databaseAssignmentPolicy This function returns the assignment policy for the specified database.
xdmp.databaseBackup Starts an asynchronous backup of the specified list of forests to the backup data directory.
xdmp.databaseBackupCancel Cancels 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.databaseBackupPurge Purge old backups from a directory.
xdmp.databaseBackupStatus Checks the status of the outstanding backup job with the specified job ID.
xdmp.databaseBackupValidate Validates that the specified list of forests can be backed up to the backup data directory.
xdmp.databaseDirectoryCreation This function returns the directory creation setting for the specified database.
xdmp.databaseEncryptionAtRest Returns the encryption at rest setting for the database identified by database-id
xdmp.databaseEncryptionKeyId Returns the encryption key ID for the database identified by database-id
xdmp.databaseForests Returns a sequence of forest IDs in the specified database.
xdmp.databaseGlobalNonblockingTimestamp Returns 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.databaseIncrementalBackup Starts an asynchronous incremental backup of the specified list of forests to the backup data directory.
xdmp.databaseIncrementalBackupValidate Validates that the specified list of forests can be backed up to the backup data directory.
xdmp.databaseIsForestRetired This function returns true if the specificed forest is retired and false the specificed forest is not retired.
xdmp.databaseIsRebalancerEnable This function returns the rebalancer enable setting for the specified database.
xdmp.databaseIsReplica Tests if a database is a replica of a foreign database.
xdmp.databaseJournalArchivePurge Purge journal archive before last incremental backup from a directory.
xdmp.databaseName Return the name of the database with the given ID.
xdmp.databaseNodeQueryRolesets Return a sequence of query-rolesets that are required for proper querying of the given database nodes with Element Level Security.
xdmp.databaseNonblockingTimestamp Returns 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.databasePathNamespaces Returns the list of path namespaces for the given database id.
xdmp.databaseRestore Starts an asynchronous restore of the specified list of forests from the backup data directory.
xdmp.databaseRestoreCancel Cancels 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.databaseRestoreStatus Checks the status of the outstanding restore job with the specified job ID.
xdmp.databaseRestoreValidate Validates that the specified list of forests can be restored from the backup data directory.
xdmp.databases Returns a sequence of the IDs of all the databases in the system.
xdmp.daynameFromDate Returns an xs:string representing the dayname value in the localized value of $arg.
xdmp.decodeFromNCName Invertible function that decodes characters an NCName produced by xdmp:encode-for-NCName.
xdmp.defaultCollections Returns the collections any new document would get if the current user were to insert a document without specifying the collections.
xdmp.defaultPermissions Returns the permissions any new document would get if the current user were to insert a document without specifying the default permissions.
xdmp.describe Returns a string representing the description of a given item sequence.
xdmp.diacriticLess Returns the specified string, converting all of the characters with diacritics to characters without diacritics.
xdmp.directory Returns the documents from the database in a directory.
xdmp.directoryCreate Creates a directory.
xdmp.directoryDelete Deletes a directory and all of its child and descendant documents and directories from the database.
xdmp.directoryLocks Returns locks of documents in a directory.
xdmp.directoryProperties Returns a sequence of properties documents, one for each document in the specified directory that has a corresponding properties document.
xdmp.documentAddCollections Adds the named document to the given collections.
xdmp.documentAddPermissions Adds the given permissions to the given document or directory.
xdmp.documentAddProperties Adds a sequence of properties to the properties of a document.
xdmp.documentAssign Assign a document URI to a forest index, using the same algorithm as xdmp:document-insert.
xdmp.documentDelete Deletes a document from the database.
xdmp.documentFilter Filters a wide variety of document formats, extracting metadata and text, and returning XHTML.
xdmp.documentForest Returns the forest ID of the forest in which a document (or a lock or a property) with the specified URI is stored.
xdmp.documentGet Returns the document in the file specified by $location.
xdmp.documentGetCollections Returns the collections to which a given document belongs.
xdmp.documentGetMetadata Returns the metadata value of a given document.
xdmp.documentGetMetadataValue Returns the metadata value of a given document.
xdmp.documentGetPermissions Returns the permissions to a given document.
xdmp.documentGetProperties Returns the property values for a document's property.
xdmp.documentGetQuality Returns the quality of the specified document if the document exists.
xdmp.documentInsert Inserts a new document into the database if a document with the specified URI does not already exist.
xdmp.documentLoad Inserts a new document with the specified URI.
xdmp.documentLocks Returns the locks for one or more documents or directories.
xdmp.documentPartitionAssign Assign a document to a partition number, using the partition queries in the database or in the second argument.
xdmp.documentProperties Returns a sequence of properties documents, one for each of the specified documents that has a corresponding properties document.
xdmp.documentPutMetadata Adds metadata to the document.
xdmp.documentRemoveCollections Removes the named document from the given collections.
xdmp.documentRemoveMetadata Removes metadata with certain keys from a document.
xdmp.documentRemovePermissions Removes the given permissions from the named document or directory.
xdmp.documentRemoveProperties Removes a sequence of properties from the properties of a document.
xdmp.documentSetCollections Sets the named document to belong to the given collections, replacing any previously set collections on the named document.
xdmp.documentSetMetadata Sets metadata to the document.
xdmp.documentSetPermissions Sets the permissions on the named document (or directory) to the given permissions, replacing any permissions previously set on the document (or directory).
xdmp.documentSetProperties Sets the properties of a document to the given sequence of elements, replacing any properties that already exist on the document.
xdmp.documentSetProperty Sets a property on a document.
xdmp.documentSetQuality Sets the quality of the document with the given URI.
xdmp.documentTimestamp Returns timestamp of the most recent visible update to a document, lock, or property.
xdmp.effectiveVersion Returns the effective version of this host
xdmp.elapsedTime Returns the elapsed time since the start of processing of this query.
xdmp.elementContentType Returns the schema-defined content-type of an element ("empty", "simple", "element-only", or "mixed").
xdmp.email Send an email in a JavasCript program.
xdmp.encodeForNCName Invertible function that escapes characters required to be part of an NCName.
xdmp.encodingLanguageDetect Analyzes binary, text, or XML data and suggests possible pairs of encoding and language, with a confidence score for each pair.
xdmp.eval Returns the result of evaluating a string as a Javascript program.
xdmp.excelConvert Converts a Microsoft Excel document to XHTML.
xdmp.externalBinary Returns an external binary node.
xdmp.externalBinaryPath Return the path to the external file associated with an external binary document.
xdmp.externalSecurity Returns the external security ID for the specified external security name.
xdmp.filesystemDirectory Performs a directory listing of the given file pathname.
xdmp.filesystemDirectoryCreate Creates the directory specified by pathname.
xdmp.filesystemDirectoryDelete Deletes the directory specified by pathname.
xdmp.filesystemFile Reads a file from the filesystem.
xdmp.filesystemFileEncryptionStatus Return the encryption status of a file.
xdmp.filesystemFileExists Return true if a file exists on a host; otherwise false.
xdmp.filesystemFileGetTime Returns access and modification time for a file.
xdmp.filesystemFileLength Reads the length of a file from the filesystem.
xdmp.filesystemFilepath Returns the canonicalized file path of the input path.
xdmp.filesystemFileSetTime Sets access and modification time for a file.
xdmp.foreignClusters Returns the IDs of the foreign clusters.
xdmp.foreignClusterStatus Returns the status of a foreign cluster from a host's point of view as a JSON node.
xdmp.forest Returns the ID of the forest specified as the parameter.
xdmp.forestBackup Backs up forest data files.
xdmp.forestBackupStatus Checks the status of the specified forests for any outstanding backup jobs.
xdmp.forestClear Clears forest data files, including all stands and journals.
xdmp.forestCounts Returns detailed forest statistics for a given forest as a Sequence of ObjectNodes.
xdmp.forestDatabaseReplicationResume Resume database replication with the specified forest IDs.
xdmp.forestDatabaseReplicationSuspend Suspend database replication with the specified forest IDs.
xdmp.forestDatabases Returns the database ID corresponding to the database to which the specified forest belongs, or empty sequence if the forest belongs to no database.
xdmp.forestFailoverInfo Return a sequence of pair of the forest IDs and host IDs for the failover forests and hosts of the given forest.
xdmp.forestHost Return the host of the forest with the given id.
xdmp.forestName Return the name of the forest with the given ID.
xdmp.forestOnline Returns 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.forestOpenReplica Returns the forest ID for each specified forest or for each forest's replica if the forest is currently experiencing a local disk failover.
xdmp.forestRestart Restarts a forest.
xdmp.forestRestore Restores forest data files.
xdmp.forestRollback Rolls forests back to a previous point in time, marking any fragment newer than the specified timestamp as deleted.
xdmp.forests Returns a sequence of the IDs of all the forests in the system.
xdmp.forestState Returns state of the forests
xdmp.forestStatus Returns the status of a forest as a Sequence of ObjectNodes.
xdmp.forestUpdatesAllowed Return updates allowed state of the forest with the given ID.
xdmp.formatNumber Returns a formatted number value based on the picture argument.
xdmp.fromJSON Atomizes a JSON node, returning a JSON value.
xdmp.fromJsonString Parses a string as JSON, returning an item sequence.
xdmp.function Returns a function value as an xdmp.function type.
xdmp.functionModule Returns the module location (if any) that the xdmp:function value refers to.
xdmp.functionName Returns the QName of the function(s) that the xdmp:function refers to.
xdmp.functionParameterName Returns the name of the parameter at the designated (1-based) position from the given function's signature.
xdmp.functionParameterType Returns the type of the parameter at the designated (1-based) position from the given function's signature.
xdmp.functionReturnType Returns the return type from the given function's signature.
xdmp.functionSignature Returns the signature of the function that the argument refers to.
xdmp.getCurrentRoles Returns all the current roles, both assigned and inherited by the current user and any received from amps.
xdmp.getCurrentUser Returns the name of the current user.
xdmp.getCurrentUserid Returns the ID of the current user.
xdmp.getInvokedPath Returns the path of the module that is being invoked.
xdmp.getOriginalUrl Returns the portion of the URL following the host_name:port_number.
xdmp.getOrphanedBinaries Returns a sequence of the IDs of all orphaned large binaries in a given forest.
xdmp.getRequestBody For PUT requests, returns the body of the request.
xdmp.getRequestClientAddress Returns as a string the internet address of the client from which the HTTP server request is issued.
xdmp.getRequestClientCertificate Returns the PEM encoded client certificate if one was presented.
xdmp.getRequestErrorFormat Returns the current error format for the request.
xdmp.getRequestField Returns the value of a named request field.
xdmp.getRequestFieldContentType This function is used to extract the content type from the request field.
xdmp.getRequestFieldFilename Returns a list of filenames from a multipart request for the field name specified.
xdmp.getRequestFieldNames Returns a sequence of the request field names.
xdmp.getRequestHeader Returns the value of a named request header.
xdmp.getRequestHeaderNames Returns a sequence of request header names.
xdmp.getRequestMethod Returns the HTTP request method.
xdmp.getRequestPath Returns the HTTP request path.
xdmp.getRequestPort Returns the port of the request.
xdmp.getRequestProtocol Returns as a string the request protocol (either "http" or "https") Returns the empty sequence if it is not called from an HTTP server.
xdmp.getRequestUrl Returns the portion of the URL following the host_name:port_number.
xdmp.getRequestUser If this App Server is using application-level authentication, returns the ID of the user in the last successful call to xdmp:login.
xdmp.getRequestUsername If this App Server is using application-level authentication, returns the username in the last successful call to xdmp:login.
xdmp.getResponseCode Returns two nodes, the first containing the HTTP response code and the second containing the HTTP response message.
xdmp.getResponseEncoding Returns the encoding that the response from this server is in.
xdmp.getServerField Returns the value of a named server field.
xdmp.getServerFieldNames Returns a sequence of the server field names.
xdmp.getSessionField Returns the value of a named session field from the session created by the xdmp:login function.
xdmp.getSessionFieldNames Returns a sequence of the HTTP session field names from the session created by the xdmp:login function.
xdmp.getTransactionMode Retrieve the transaction mode for the current session.
xdmp.getUrlRewriterPath Returns the URL of the URL rewriter handler for this application server.
xdmp.group Returns the ID of the group specified in the parameter.
xdmp.groupGetAuditEventTypeEnabled This function returns the audit event type's enabled setting for the audit configuration.
xdmp.groupHosts Returns the IDs of all hosts belonging to the group with the given ID.
xdmp.groupName Returns the name of the group with the given ID.
xdmp.groupPortServers Returns the IDs of all port App Servers belonging to the group with the given ID.
xdmp.groups Returns a sequence of the IDs of all the groups in the system.
xdmp.groupServers Returns the IDs of all App Servers belonging to the group with the given ID.
xdmp.groupTaskServer Returns the ID of the Task Server belonging to the group with the given ID.
xdmp.gssServerNegotiate This function is used for kerberos GSS authentication in application level authentication.
xdmp.gunzip Get a node from a gzip node.
xdmp.gzip Create a gzip node from a node.
xdmp.hash32 Returns the 32-bit hash of a string.
xdmp.hash64 Returns the 64-bit hash of a string.
xdmp.hasPrivilege Tests whether the current user has at least one of a given set of privileges.
xdmp.hexToInteger Parses a hexadecimal string, returning an integer.
xdmp.hmacMd5 Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
xdmp.hmacSha1 Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
xdmp.hmacSha256 Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
xdmp.hmacSha512 Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
xdmp.host Returns the ID of the host named in the parameter.
xdmp.hostForests Returns a sequence of forest IDs in the specified host.
xdmp.hostGetSslFipsEnabled Returns whether fips mode is enabled.
xdmp.hostGroup Returns the ID of the group that the specified host belongs to.
xdmp.hostMode Returns this host mode
xdmp.hostModeDescription Return the description string for this host mode setting
xdmp.hostName Returns the name of the specified host.
xdmp.hosts Returns a sequence of the IDs of all the hosts in the cluster.
xdmp.hostStatus Returns the status of a host as a JSON node.
xdmp.httpDelete Sends an http DELETE request to the http server specified in the URI to delete the specified resource.
xdmp.httpGet Sends the http GET method to the specified URI.
xdmp.httpHead Sends the http HEAD method to the specified URI.
xdmp.httpOptions Sends the http OPTIONS method to the specified URI.
xdmp.httpPost Sends an http POST request to the server.
xdmp.httpPut Sends an HTTP PUT request to an HTTP server.
xdmp.initcap Returns the string where the first letter of each token has been uppercased.
xdmp.integerToBinary Returns a binary representation of an integer.
xdmp.integerToHex Returns a hexadecimal representation of an integer.
xdmp.integerToOctal Returns an octal representation of an integer.
xdmp.invoke Returns the result of evaluating an XQuery or Server-Side JavaScript module at the given path.
xdmp.invokeFunction Returns the result of evaluating a JavaScript function value.
xdmp.isWhitespaceNode Returns true if the node is a text node containing only whitespace.
xdmp.keyFromQName Construct a context-independent string from a QName.
xdmp.keystoreExport Exports all encryption keys stored in the MarkLogic embedded KMS.
xdmp.keystoreImport Import encryption keys into the MarkLogic embedded KMS from an exported encrypted file (see keystore-export).
xdmp.keystoreValidateExported Validates the content of an exported keystore file, see keystore-export and keystore-import
xdmp.ldapLookup Returns an ldap entry.
xdmp.ldapSearch Returns 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.lockAcquire Acquire a lock on a document or directory for an extended amount of time.
xdmp.lockForUpdate Acquires an intent exclusive transaction lock on a URI.
xdmp.lockRelease Unlock a document or directory.
xdmp.log Logs a message into a specific app server error log file.
xdmp.login Logs 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.logLevel Retrieves the current server log level.
xdmp.logout Logs the current user out of the session on the server.
xdmp.lshift64 Left-shift a 64-bit integer value.
xdmp.md5 Calculates the md5 hash of the given argument.
xdmp.merge Starts merging the forests of the database, subject to specified options.
xdmp.mergeCancel Cancel the merge with the specified merge ID on a forest with the specified forest ID.
xdmp.merging Returns the forest IDs of any currently merging database forests.
xdmp.mimetypes This function returns all the mimetypes specifications of the cluster.
xdmp.modulesDatabase Returns the database ID of the modules database.
xdmp.modulesRoot Returns the current root path for modules.
xdmp.monthNameFromDate Returns month name, calculated from the localized value of $arg.
xdmp.mul64 Muliply two 64-bit integer values, discarding overflow.
xdmp.multipartDecode Extract the parts from a multipart encoding.
xdmp.multipartEncode Create a multipart encoding of the specified node.
xdmp.nodeCollections Returns any collections for the node's document in the database.
xdmp.nodeDatabase Returns the database id where the parameter is stored.
xdmp.nodeDelete Deletes a node from the database.
xdmp.nodeInsertAfter Adds an immediately following sibling to a node.
xdmp.nodeInsertBefore Adds an immediately preceding sibling to a node.
xdmp.nodeInsertChild Adds a new last child to a node.
xdmp.nodeKind Returns an xs:string representing the node's kind: either "document", "element", "attribute", "text", "namespace", "processing-instruction", "binary", or "comment".
xdmp.nodeMetadata Returns the metadata value of a given node.
xdmp.nodeMetadataValue Returns the metadata value of a node for a particular key.
xdmp.nodePermissions Returns the permissions to a node's document.
xdmp.nodeQueryRolesets Return 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.nodeReplace Replaces a node.
xdmp.nodeUri Returns the document-uri property of the parameter or its ancestor.
xdmp.not64 NOT a 64-bit integer value.
xdmp.octalToInteger Parses an octal string, returning an integer.
xdmp.or64 OR two 64-bit integer values.
xdmp.parseDateTime Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
xdmp.parseYymmdd Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
xdmp.partitionForests Returns a seequence of forest IDs with the specified partition number
xdmp.passiveHasPrivilege Tests whether the current user has at least one of a given set of privileges.
xdmp.passiveSecurityAssert Tests whether the current user has at least one of a given set of privileges.
xdmp.path Returns a string whose value corresponds to the path of the node.
xdmp.pdfConvert Converts a PDF file to XHTML.
xdmp.permission Returns a permission object corresponding to the named role and capability given.
xdmp.platform Returns the operating-system platform upon which MarkLogic Server is running ("solaris", "winnt", "linux", or "macosx").
xdmp.position Returns an integer value representing the starting position of a string within the search string.
xdmp.powerpointConvert Converts a Microsoft Powerpoint document to XHTML.
xdmp.prettyPrint Returns a well-formatted XQuery module.
xdmp.privilege Returns the privilege ID for the specified privilege name.
xdmp.privilegeRoles Returns the set of all roles that have a given privilege.
xdmp.productEdition Returns the current MarkLogic product edition.
xdmp.productEnvironment Returns the current MarkLogic product environment.
xdmp.QNameFromKey Construct a QName from a string of the form "{namespaceURI}localname".
xdmp.quarterFromDate Returns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of $arg.
xdmp.queryMeters Returns the current value of the resource meters for this query sequence as a JSON node.
xdmp.queryPartitions This function returns the partition numbers of the partitions that the specified query will be searched on.
xdmp.queryTrace Enables or disables tracing of this query.
xdmp.quote Returns the unevaluated serialized representation of the input parameter as a string.
xdmp.random Returns a random unsigned integer between 0 and a number up to 64 bits long.
xdmp.rangePartitionForests Given a value, the function returns a list of forests that have ranges the value falls into.
xdmp.redirectResponse Redirects the App Server response to a given location.
xdmp.removeOrphanedBinary Remove an orphaned large binary
xdmp.request Returns the unique key of the current request.
xdmp.requestCancel Cancel the request with the given host, server, and request IDs.
xdmp.requestStatus Returns the status of a running request as a Sequence of ObjectNodes.
xdmp.requestTimestamp Returns the system timestamp for this request if the request is a query statement.
xdmp.resolveUri Resolves a relative URI against an absolute URI.
xdmp.restart Restart servers on hosts.
xdmp.rethrow Within the catch section of a try-catch expression, re-throw the currently caught error.
xdmp.role Returns the role ID for the specified role name.
xdmp.roleName Returns the role name for the specified role id.
xdmp.roleRoles Returns the set of all roles inherited by a given role, including roles directly assigned to the role and roles inherited from other roles.
xdmp.rollback Roll back the current transaction.
xdmp.rsaGenerate Generate a new RSA public/private key pair.
xdmp.rshift64 Right-shift a 64-bit integer value.
xdmp.save Serializes a node as text and saves it to a file.
xdmp.schemaDatabase Returns the database ID of the schema database associated with the current database.
xdmp.securityAssert Tests whether the current user has at least one of a given set of privileges.
xdmp.securityDatabase Returns the database ID of the security database associated with the current database.
xdmp.server Return the ID(s) of the App Servers, XDBC Servers, ODBC Servers, or Task Servers with the given name.
xdmp.serverCollation Return the default collation of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverCoordinateSystem Return the default coordinate system of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverDatabase Return the database ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverDefaultXqueryVersion Return the default xquery version of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverGroup Return the ID of the group for an App Server, XDBC Server, ODBC Server, or Task Server.
xdmp.serverKind Return the kind of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverModulesDatabase Return the modules database ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverName Return the name of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverPort Return the port of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverRoot Return the root of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.servers Returns a sequence of the IDs of all the App Servers (HTTP, XDBC, ODBC, and TaskServer) in the system.
xdmp.serverSslCertificateTemplate Return the SSL certificate template ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverStatus Returns the status of an app-server on a host as a Sequence of ObjectNodes.
xdmp.setRequestTimeLimit Changes the time limit for an actively running request to the specified value.
xdmp.setResponseCode Sets the response code and message.
xdmp.setResponseContentType Sets the response content-type.
xdmp.setResponseEncoding Sets the response encoding.
xdmp.setResponseOutputMethod Sets the serialization method.
xdmp.setServerField Sets the value of a named server field.
xdmp.setServerFieldPrivilege Sets the privilege of a named server field.
xdmp.setSessionField Sets the value of a named session field for the session created by the xdmp:login function.
xdmp.setTransactionMode Set the transaction mode for the current session.
xdmp.setTransactionName Set the name of a local or remote transaction.
xdmp.setTransactionTimeLimit Set the transaction time limit for a local or remote transaction.
xdmp.sha1 Calculates the SHA1 hash of the given argument.
xdmp.sha256 Calculates the SHA256 hash of the given argument.
xdmp.sha384 Calculates the SHA384 hash of the given argument.
xdmp.sha512 Calculates the SHA512 hash of the given argument.
xdmp.shutdown Shutdown servers on hosts.
xdmp.sleep Delays for a specific amount of time.
xdmp.softwareVersion Returns this host's software version
xdmp.spawn Place the specified module on the task queue for evaluation.
xdmp.sql Executes an ad hoc SQL query.
xdmp.startJournalArchiving Starts journal archiving to the specified list of forests.
xdmp.step64 Combines an initial hash with a subsequent hash.
xdmp.stopJournalArchiving Stops journal archiving to the specified list of forests.
xdmp.strftime Formats a dateTime value using POSIX strftime.
xdmp.subbinary Returns a binary node made up of a subset of the given binary node.
xdmp.tidy Run tidy on the specified html document to convert the document to well-formed and clean XHTML.
xdmp.timestampToWallclock Converts a 64 bit timestamp value to an xs:dateTime.
xdmp.toJSON Constructs a JSON document.
xdmp.toJsonString Returns a string representing a JSON serialization of a given item sequence.
xdmp.trace Signal a trace event.
xdmp.traceEnabled Returns whether or not a trace event is enabled.
xdmp.transaction Returns the transaction ID for the current transaction, or transaction IDs for all transactions with the given name.
xdmp.transactionCommit Explicitly commit a transaction running on a named host.
xdmp.transactionLocks Returns all URIs currently locked for read or write by a transaction.
xdmp.transactionRollback Explicitly roll back a transaction running on a named host.
xdmp.triggersDatabase Returns the database ID of the triggers database associated with the current database.
xdmp.type Returns the name of the simple type of the atomic value argument as an xs:QName.
xdmp.unquote Parses a string as XML, returning one or more document nodes.
xdmp.uriContentType Returns the content type of the given URI as matched in the mimetypes configuration.
xdmp.uriFormat Returns the format of the given URI as matched in the mimetypes configuration.
xdmp.uriIsFile Returns true if a given URI refers to a file which exists on the current application server.
xdmp.urlDecode Converts URL-encoded string to plaintext.
xdmp.urlEncode Converts plaintext into URL-encoded string.
xdmp.user Returns the user ID for the specified user name.
xdmp.userExternalSecurity Returns external security id and user name for an external user.
xdmp.useridRoles Returns all roles assigned to a user, including roles directly assigned to the user and roles inherited by other roles.
xdmp.userLastLogin Returns the last-login node for the current user.
xdmp.userRoles Returns all roles assigned to a user, including roles directly assigned to the user and roles inherited by other roles.
xdmp.validate Returns an element containing a summary of validation errors in a node.
xdmp.version Returns the current MarkLogic Server version.
xdmp.wallclockToTimestamp Converts an xs:dateTime to a 64 bit timestamp value.
xdmp.weekdayFromDate Returns an xs:integer in the range 1 to 7, inclusive, representing the weekday value in the localized value of $arg.
xdmp.weekFromDate Returns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of $arg.
xdmp.wordConvert Converts a Microsoft Word document to XHTML.
xdmp.x509CertificateExtract Returns the XML representation of the specified X.509 certificate.
xdmp.x509CertificateGenerate Generate a new PEM-encoded X.509 certificate.
xdmp.x509CertificateIssuerName Returns the issuer distinguished name for the specified X.509 certificate.
xdmp.x509CertificateSubjectName Returns the subject distinguished name for the specified X.509 certificate.
xdmp.xaComplete Completes (commits or rolls back) a prepared XA transaction.
xdmp.xaForget Forgets a remembered completed XA transaction.
xdmp.xor64 XOR two 64-bit integer values.
xdmp.xqueryEval Returns the result of evaluating a string as an XQuery module.
xdmp.xsltEval Executes an XSLT stylesheet against a node.
xdmp.xsltInvoke Executes an XSLT stylesheet against a node.
xdmp.yeardayFromDate Returns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of $arg.
xdmp.zipCreate Create a zip file from a list of nodes.
xdmp.zipGet Get a named file from a zip document.
xdmp.zipManifest Return a manifest for this zip file.
XMLDocument.attributes This is inherited from the XMLNode object. The attributes of this node.
XMLDocument.childNodes This is inherited from the XMLNode object. The children of this node.
XMLDocument.documentFormat This is inherited from the Document object. The format of the document node, "JSON", "XML", "TEXT", or "BINARY".
XMLDocument.documentURI The URI of this document.
XMLDocument.firstChild This is inherited from the XMLNode object. The first child of this node, if any.
XMLDocument.getElementById Get the element in this document with the given id, if any.
XMLDocument.getElementsByTagName Return all the elements in the document with the given name.
XMLDocument.getElementsByTagNameNS Return all the elements in the document with the given localname and namespace URI.
XMLDocument.hasAttributes This is inherited from the XMLNode object. Whether this node has attributes.
XMLDocument.hasChildNodes This is inherited from the XMLNode object. Whether this node has any children.
XMLDocument.isEqualNode This is inherited from the XMLNode object. Whether this node is equal to another node.
XMLDocument.isSameNode This is inherited from the XMLNode object. Whether this node is the same exact node as another node.
XMLDocument.lastChild This is inherited from the XMLNode object. The last child of this node, if any.
XMLDocument.localName This is inherited from the XMLNode object. Return the local name of this node.
XMLDocument.namespaceURI This is inherited from the XMLNode object. Return the namespace URI of this node.
XMLDocument.nextSibling This is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any.
XMLDocument.nodeName This is inherited from the XMLNode object. The DOM name of the node.
XMLDocument.nodeValue This is inherited from the XMLNode object. The DOM value of the node.
XMLDocument.ownerDocument This is inherited from the XMLNode object. The document node containing this node, if any.
XMLDocument.parentNode This is inherited from the XMLNode object. The node that is this node's parent.
XMLDocument.prefix This is inherited from the XMLNode object. Return the namespace prefix of this node.
XMLDocument.previousSibling This is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any.
XMLDocument.root This is inherited from the Document object. The root node of the document.
XMLDocument.textContent This is inherited from the XMLNode object. The DOM text value of the node.
XMLNode.attributes The attributes of this node.
XMLNode.baseURI This is inherited from the Node object. Returns a string representing the base URI of the node.
XMLNode.childNodes The children of this node.
XMLNode.firstChild The first child of this node, if any.
XMLNode.hasAttributes Whether this node has attributes.
XMLNode.hasChildNodes Whether this node has any children.
XMLNode.isEqualNode Whether this node is equal to another node.
XMLNode.isSameNode Whether this node is the same exact node as another node.
XMLNode.lastChild The last child of this node, if any.
XMLNode.localName Return the local name of this node.
XMLNode.namespaceURI Return the namespace URI of this node.
XMLNode.nextSibling The node that is the immediately following sibling of this node, if any.
XMLNode.nodeKind This is inherited from the Node object. Return a string indicating the type of the node.
XMLNode.nodeName The DOM name of the node.
XMLNode.nodeType This is inherited from the Node object. Return the DOM code indicating the type of the node.
XMLNode.nodeValue The DOM value of the node.
XMLNode.ownerDocument The document node containing this node, if any.
XMLNode.parentNode The node that is this node's parent.
XMLNode.prefix Return the namespace prefix of this node.
XMLNode.previousSibling The node that is the immediately preceding sibling of this node, if any.
XMLNode.textContent The DOM text value of the node.
XMLNode.xpath This is inherited from the Node object. Evaluate an XPath using the node as context.
xs.date.add Returns the end of a time period by adding an xs.yearMonthDuration to the xs.date that starts the period.
xs.date.eq Equality comparison on xs.date values
xs.date.ge Greater-than or equal comparison on xs.date values
xs.date.gt Greater-than comparison on xs.date values
xs.date.le Less-than or equal comparison on xs.date values
xs.date.lt Less-than comparison on xs.date values
xs.date.ne Not equal comparison on xs.date values
xs.date.subtract Returns the difference between two xs.dates as an xs.dayTimeDuration.
xs.dateTime.add Returns the end of a time period by adding an xs.yearMonthDuration to the xs.dateTime that starts the period.
xs.dateTime.eq Equality comparison on xs.dateTime values
xs.dateTime.ge Greater-than or equal comparison on xs.dateTime values
xs.dateTime.gt Greater-than comparison on xs.dateTime values
xs.dateTime.le Less-than or equal comparison on xs.dateTime values
xs.dateTime.lt Less-than comparison on xs.dateTime values.
xs.dateTime.ne Not equal comparison on xs.dateTime values
xs.dateTime.subtract Returns the difference between two xs.dateTimes as an xs.dayTimeDuration.
xs.dayTimeDuration.add Adds two xs.dayTimeDurations.
xs.dayTimeDuration.divide Divides an xs.dayTimeDuration by an number.
xs.dayTimeDuration.eq Equality comparison on xs.dayTimeDuration values
xs.dayTimeDuration.ge Greater-than or equal comparison on xs.dayTimeDuration values
xs.dayTimeDuration.gt Greater-than comparison on xs.dayTimeDuration values
xs.dayTimeDuration.le Less-than or equal comparison on xs.dayTimeDuration values
xs.dayTimeDuration.lt Less-than comparison on xs.dayTimeDuration values.
xs.dayTimeDuration.multiply Multiplies an xs.dayTimeDuration by a number.
xs.dayTimeDuration.ne Not equal comparison on xs.dayTimeDuration values
xs.dayTimeDuration.subtract Subtracts one xs.dayTimeDuration from another.
xs.gDay.eq Equality comparison on xs.gDay values
xs.gDay.ne Not equal comparison on xs.gDay values
xs.gMonth.eq Equality comparison on xs.gMonth values
xs.gMonth.ne Not equal comparison on xs.gMonth values
xs.gMonthDay.eq Equality comparison on xs.gMonthDay values
xs.gMonthDay.ne Not equal comparison on xs.gMonthDay values
xs.gYear.eq Equality comparison on xs.gYear values
xs.gYear.ne Not equal comparison on xs.gYear values
xs.gYearMonth.eq Equality comparison on xs.gYearMonth values
xs.gYearMonth.ne Not equal comparison on xs.gYearMonth values
xs.time.add Adds the value of the hours, minutes and seconds components of an xs.dayTimeDuration to an xs.time value.
xs.time.eq Equality comparison on xs.time values
xs.time.ge Greater-than or equal comparison on xs.time values
xs.time.gt Greater-than comparison on xs.time values
xs.time.le Less-than or equal comparison on xs.time values
xs.time.lt Less-than comparison on xs.time values
xs.time.ne Not equal comparison on xs.time values
xs.time.subtract Returns the difference between two xs.times as an xs.dayTimeDuration.
xs.yearMonthDuration.add Adds two xs.yearMonthDuration.
xs.yearMonthDuration.divide Divides an xs.yearMonthDuration by an number.
xs.yearMonthDuration.eq Equality comparison on xs.yearMonthDuration values
xs.yearMonthDuration.ge Greater-than or equal comparison on xs.yearMonthDuration values
xs.yearMonthDuration.gt Greater-than comparison on xs.yearMonthDuration values
xs.yearMonthDuration.le Less-than or equal comparison on xs.yearMonthDuration values
xs.yearMonthDuration.lt Less-than comparison on xs.yearMonthDuration values.
xs.yearMonthDuration.multiply Multiplies an xs.yearMonthDuration by a number.
xs.yearMonthDuration.ne Not equal comparison on xs.yearMonthDuration values
xs.yearMonthDuration.subtract Subtracts one xs.yearMonthDuration from another.