| XQUERY/XSLT API DOCUMENTATION 4.2 |
All XQuery & XSLT Functions MarkLogic Built-In Functions Admin (xdmp:) AppServer (xdmp:) Classifier (cts:) Debug (dbg:) Document Conversion (xdmp:) Extension (xdmp:) Documents, Directories, Properties, and Locks Functions Extension Functions Function Values Functions HTTP Functions JSON Functions MarkLogic Server Functions Search Functions XML Functions XQuery Context Functions XSLT Functions map (map:) Math (math:) Profile (prof:) Search (cts:) cts:query Constructors Functions Geospatial Functions Geospatial Lexicon Functions Lexicon Functions Search Functions Search Clustering Functions Security (xdmp:) Server Monitoring (xdmp:) Spell (spell:) Update (xdmp:) XQuery Library Modules Admin Library (admin:) Actions Functions Appserver Functions Database Functions Forest Functions Group Functions Host Functions Mimetypes Functions Scheduler Functions Alerting (alert:) Elastic Compute Cloud (ec2:) Entity Enrichment (entity:) Flexible Replication (flexrep:) Geospatial Supporting Functions GEO Functions GeoRSS Functions GML Functions KML Functions MCGM Functions Information Studio (info:) Information Studio Developer (infodev:) Library Services (dls:) cts:query Constructor Functions Document Management Functions Document Update Functions Retention Policy Functions XInclude Functions Modular Documents XInclude Functions XPointer Functions PKI (pki:) Plugin (plugin:) Search (search:) Security-sec (sec:) Spelling Dictionary Management (spell:) Thesaurus (thsr:) Triggers (trgr:) Triggers Library (trgr:) WordProcessingML (ooxml:) ZIP Package (ooxml:) CPF Functions Content Processing Framework (cpf:) CSS Conversion (css:) DocBook Conversion (dbk:) Domains (dom:) Excel Conversion (excel:) Generic Conversion (cvt:) Links (lnk:) MSWord Conversion (msword:) PDF Conversion (pdf:) Pipelines (p:) Powerpoint Conversion (ppt:) XHTML Conversion (xhtml:) W3C-Standard Functions Accessor (fn:) AnyURI (fn:) Boolean (fn:) Context (fn:) DurationDateTime (fn:) Error and Trace (fn:) Node (fn:) Numeric (fn:) QName (fn:) Sequence (fn:) String (fn:) XSLT (fn:) W3C XQuery/XSLT Reference W3C XQuery Functions W3C XQuery Language W3C XSLT Language
This page was generated September 12, 2012 6:01 AM | XQuery & XSLT Built-In & Modules Function Reference
XQuery & XSLT Built-In & Module Functions
The following table lists the APIs that correspond to the MarkLogic Built-In Functions. Click on a function name to go directly to the detailed function description, or use the tree on the left to navigate to the functions by group.
Function Summary
cts:and-not-query | Returns a query specifying the set difference of the matches specified by two sub-queries.
| cts:and-not-query-negative-query
| Returns the negative (second parameter) query used to construct the specified query.
| cts:and-not-query-positive-query
| Returns the positive (first parameter) query used to construct the specified query.
cts:and-query | Returns a query specifying the intersection of the matches specified by the sub-queries.
| cts:and-query-options
| Returns the options for the specified query.
| cts:and-query-queries
| Returns a sequence of the queries that were used to construct the specified query.
cts:arc-intersection | Returns the point at the intersection of two arcs.
cts:avg | Returns a frequency-weighted average of a sequence.
cts:bearing | Returns the true bearing in radians of the path from the first point to the second.
cts:box | Returns a geospatial box value.
cts:box-east | Returns a box's eastern boundary.
cts:box-north | Returns a box's northern boundary.
cts:box-south | Returns a box's southern boundary.
cts:box-west | Returns a box's western boundary.
cts:circle | Returns a geospatial circle value.
cts:circle-center | Returns a circle's center point.
cts:circle-radius | Returns a circle's radius.
cts:classify | Classifies a sequence of nodes based on training data.
cts:cluster | Produces a set of clusters from a sequence of nodes.
cts:collection-match | Returns values from the collection lexicon that match the specified wildcard pattern.
cts:collection-query | Returns a query matching documents in the collections with the given URIs.
| cts:collection-query-uris
| Returns the URIs used to construct the specified query.
cts:collections | Returns values from the collection lexicon.
cts:confidence | Returns the confidence of a node, or of the context node if no node is provided.
cts:contains | Returns true if any of a sequence of nodes matches a query.
cts:count | Returns a frequency-weighted count of a sequence.
cts:deregister | Deregister a registered query, explicitly releasing the associated resources.
cts:destination | Returns the point at the given distance (in miles) along the given bearing (in radians) from the starting point.
cts:directory-query | Returns a query matching documents in the directories with the given URIs.
| cts:directory-query-depth
| Returns the depth used to construct the specified query.
| cts:directory-query-uris
| Returns the URIs used to construct the specified query.
cts:distance | Returns the distance (in miles) between two points.
cts:distinctive-terms | Return the most "relevant" terms in the model nodes (that is, the terms with the highest scores).
cts:document-fragment-query | Returns a query that matches all documents where $query matches any document fragment.
| cts:document-fragment-query-query
| Returns the query used to construct the specified query.
cts:document-query | Returns a query matching documents with the given URIs.
| cts:document-query-uris
| Returns the URIs used to construct the specified query.
cts:element-attribute-pair-geospatial-boxes | Returns boxes derived from the specified element point lexicon(s).
cts:element-attribute-pair-geospatial-query | Returns a cts:query matching elements by name which has specific attributes representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
| cts:element-attribute-pair-geospatial-query-element-name
| Returns the QNames used to construct the specified query.
| cts:element-attribute-pair-geospatial-query-latitude-name
| Returns the QNames used to construct the specified query.
| cts:element-attribute-pair-geospatial-query-longitude-name
| Returns the QNames used to construct the specified query.
| cts:element-attribute-pair-geospatial-query-options
| Returns the options for the specified query.
| cts:element-attribute-pair-geospatial-query-region
| Returns the geographical regions with which the specified query was constructed.
| cts:element-attribute-pair-geospatial-query-weight
| Returns the weight with which the specified query was constructed.
cts:element-attribute-pair-geospatial-value-match | Returns values from the specified element attribute pair geospatial value lexicon(s) that match the specified wildcard pattern.
cts:element-attribute-pair-geospatial-values | Returns values from the specified element-attribute-pair geospatial value lexicon(s).
cts:element-attribute-range-query | Returns a cts:query matching element-attributes by name with a range-index entry equal to a given value.
| cts:element-attribute-range-query-attribute-name
| Returns the QNames used to construct the specified query.
| cts:element-attribute-range-query-element-name
| Returns the QNames used to construct the specified query.
| cts:element-attribute-range-query-operator
| Returns the operator used to construct the specified query.
| cts:element-attribute-range-query-options
| Returns the options for the specified query.
| cts:element-attribute-range-query-value
| Returns the value used to construct the specified query.
| cts:element-attribute-range-query-weight
| Returns the weight with which the specified query was constructed.
cts:element-attribute-value-co-occurrences | Returns value co-occurrences from the specified element or element-attribute value lexicon(s).
cts:element-attribute-value-geospatial-co-occurrences | Returns value co-occurrences from the specified element-attribute value lexicon with the specified geospatial lexicon.
cts:element-attribute-value-match | Returns values from the specified element-attribute value lexicon(s) that match the specified pattern.
cts:element-attribute-value-query | Returns a query matching elements by name with attributes by name with text content equal a given phrase.
| cts:element-attribute-value-query-attribute-name
| Returns the attribute QNames used to construct the specified query.
| cts:element-attribute-value-query-element-name
| Returns the element QNames used to construct the specified query.
| cts:element-attribute-value-query-options
| Returns the options for the specified query.
| cts:element-attribute-value-query-text
| Returns the text used to construct the specified query.
| cts:element-attribute-value-query-weight
| Returns the weight with which the specified query was constructed.
cts:element-attribute-value-ranges | Returns value ranges from the specified element-attribute value lexicon(s).
cts:element-attribute-values | Returns values from the specified element-attribute value lexicon(s).
cts:element-attribute-word-match | Returns words from the specified element-attribute word lexicon(s) that match a wildcard pattern.
cts:element-attribute-word-query | Returns a query matching elements by name with attributes by name with text content containing a given phrase.
| cts:element-attribute-word-query-attribute-name
| Returns the attribute QNames used to construct the specified query.
| cts:element-attribute-word-query-element-name
| Returns the element QNames used to construct the specified query.
| cts:element-attribute-word-query-options
| Returns the options for the specified query.
| cts:element-attribute-word-query-text
| Returns the text used to construct the specified query.
| cts:element-attribute-word-query-weight
| Returns the weight with which the specified query was constructed.
cts:element-attribute-words | Returns words from the specified element-attribute word lexicon(s).
cts:element-child-geospatial-boxes | Returns boxes derived from the specified element point lexicon(s).
cts:element-child-geospatial-query | Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
| cts:element-child-geospatial-query-child-name
| Returns the QNames used to construct the specified query.
| cts:element-child-geospatial-query-element-name
| Returns the QNames used to construct the specified query.
| cts:element-child-geospatial-query-options
| Returns the options for the specified query.
| cts:element-child-geospatial-query-region
| Returns the geographical regions with which the specified query was constructed.
| cts:element-child-geospatial-query-weight
| Returns the weight with which the specified query was constructed.
cts:element-child-geospatial-value-match | Returns values from the specified element child geospatial value lexicon(s) that match the specified wildcard pattern.
cts:element-child-geospatial-values | Returns values from the specified element-child geospatial value lexicon(s).
cts:element-geospatial-boxes | Returns boxes derived from the specified element point lexicon(s).
cts:element-geospatial-query | Returns a cts:query matching elements by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point.
| cts:element-geospatial-query-element-name
| Returns the QNames used to construct the specified query.
| cts:element-geospatial-query-options
| Returns the options for the specified query.
| cts:element-geospatial-query-region
| Returns the geographical regions with which the specified query was constructed.
| cts:element-geospatial-query-weight
| Returns the weight with which the specified query was constructed.
cts:element-geospatial-value-match | Returns values from the specified element geospatial value lexicon(s) that match the specified wildcard pattern.
cts:element-geospatial-values | Returns values from the specified element geospatial value lexicon(s).
cts:element-pair-geospatial-boxes | Returns boxes derived from the specified element point lexicon(s).
cts:element-pair-geospatial-query | Returns a cts:query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point.
| cts:element-pair-geospatial-query-element-name
| Returns the QNames used to construct the specified query.
| cts:element-pair-geospatial-query-latitude-name
| Returns the QNames used to construct the specified query.
| cts:element-pair-geospatial-query-longitude-name
| Returns the QNames used to construct the specified query.
| cts:element-pair-geospatial-query-options
| Returns the options for the specified query.
| cts:element-pair-geospatial-query-region
| Returns the geographical regions with which the specified query was constructed.
| cts:element-pair-geospatial-query-weight
| Returns the weight with which the specified query was constructed.
cts:element-pair-geospatial-value-match | Returns values from the specified element pair geospatial value lexicon(s) that match the specified wildcard pattern.
cts:element-pair-geospatial-values | Returns values from the specified element-pair geospatial value lexicon(s).
cts:element-query | Returns a cts:query matching elements by name with the content constrained by the given cts:query in the second parameter.
| cts:element-query-element-name
| Returns the QNames used to construct the specified query.
| cts:element-query-query
| Returns the query used to construct the element query.
cts:element-range-query | Returns a cts:query matching elements by name with a range-index entry equal to a given value.
| cts:element-range-query-element-name
| Returns the QNames used to construct the specified query.
| cts:element-range-query-operator
| Returns the operator used to construct the specified query.
| cts:element-range-query-options
| Returns the options for the specified query.
| cts:element-range-query-value
| Returns the value used to construct the specified query.
| cts:element-range-query-weight
| Returns the weight with which the specified query was constructed.
cts:element-value-co-occurrences | 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:element-value-geospatial-co-occurrences | Returns value co-occurrences from the specified element value lexicon with the specified geospatial lexicon.
cts:element-value-match | Returns values from the specified element value lexicon(s) that match the specified wildcard pattern.
cts:element-value-query | Returns a query matching elements by name with text content equal a given phrase.
| cts:element-value-query-element-name
| Returns the QNames used to construct the specified query.
| cts:element-value-query-options
| Returns the options for the specified query.
| cts:element-value-query-text
| Returns the text used to construct the specified query.
| cts:element-value-query-weight
| Returns the weight with which the specified query was constructed.
cts:element-value-ranges | Returns value ranges from the specified element value lexicon(s).
cts:element-values | Returns values from the specified element value lexicon(s).
cts:element-word-match | Returns words from the specified element word lexicon(s) that match a wildcard pattern.
cts:element-word-query | Returns a query matching elements by name with text content containing a given phrase.
| cts:element-word-query-element-name
| Returns the QNames used to construct the specified query.
| cts:element-word-query-options
| Returns the options for the specified query.
| cts:element-word-query-text
| Returns the text used to construct the specified query.
| cts:element-word-query-weight
| Returns the weight with which the specified query was constructed.
cts:element-words | Returns words from the specified element word lexicon.
cts:entity-highlight | Returns a copy of the node, replacing any entities found with the specified expression.
cts:field-word-match | Returns words from the specified field word lexicon(s) that match a wildcard pattern.
cts:field-word-query | Returns a query matching text content containing a given phrase in the specified field.
| cts:field-word-query-field-name
| Returns the names used to construct the specified cts:field-word-query.
| cts:field-word-query-options
| Returns the options for the specified cts:field-word-query.
| cts:field-word-query-text
| Returns the text used to construct the specified cts:field-word-query.
| cts:field-word-query-weight
| Returns the weight with which the specified query was constructed.
cts:field-words | 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: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:geospatial-co-occurrences | Returns value co-occurrences from the geospatial lexicons.
cts:highlight | Returns a copy of the node, replacing any text matching the query with the specified expression.
cts:locks-query | Returns a query that matches all documents where $query matches document-locks.
| cts:locks-query-query
| Returns the query used to construct the specified query.
cts:near-query | Returns a query matching all of the specified queries, where the matches occur within the specified distance from each other.
| cts:near-query-distance
| Returns the distance used to construct the near query.
| cts:near-query-options
| Returns the options for the specified query.
| cts:near-query-queries
| Returns the query sequence used to construct the near query.
| cts:near-query-weight
| Returns the weight with which the specified query was constructed.
cts:not-query | Returns a query specifying the matches not specified by its sub-query.
| cts:not-query-query
| Returns the query used to construct the specified query.
| cts:not-query-weight
| Returns the weight with which the specified query was constructed.
cts:or-query | Returns a query specifying the union of the matches specified by the sub-queries.
| cts:or-query-queries
| Returns a sequence of the queries that were used to construct the specified query.
cts:point | Returns a point value.
cts:point-latitude | Returns a point's latitude value.
cts:point-longitude | Returns a point's longitude value.
cts:polygon | Returns a geospatial polygon value.
cts:polygon-vertices | Returns a polygon's vertices.
cts:properties-query | Returns a query that matches all documents where $query matches document-properties.
| cts:properties-query-query
| 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:query | Creates a query.
cts:register | Register a query for later use.
cts:registered-query | Returns a query matching fragments specified by previously registered queries (see cts:register).
| cts:registered-query-ids
| Returns the registered query identifiers used to construct the specified query.
| cts:registered-query-options
| Returns the options for the specified query.
| cts:registered-query-weight
| Returns the weight with which the specified query was constructed.
cts:remainder | Returns an estimated search result size for a node, or of the context node if no node is provided.
cts:reverse-query | Returns a query matching the model nodes.
| cts:reverse-query-nodes
| Returns the nodes used to construct the specified query.
| cts:reverse-query-weight
| 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:search | Returns a relevance-ordered sequence of nodes specified by a given query.
cts:shortest-distance | Returns the great circle distance (in miles) between a point and an arc.
cts:similar-query | Returns a query matching nodes similar to the model nodes.
| cts:similar-query-nodes
| Returns the nodes used to construct the specified query.
| cts:similar-query-weight
| Returns the weight with which the specified query was constructed.
cts:stem | Returns the stem(s) for a word.
cts:sum | Returns a frequency-weighted sum of a sequence.
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:train | Produces a set of classifiers from a list of labeled training documents.
cts:uri-match | Returns values from the URI lexicon that match the specified wildcard pattern.
cts:uris | Returns values from the URI lexicon.
cts:walk | Walks a node, evaluating an expression with any text matching a query.
cts:word-match | Returns words from the word lexicon that match the wildcard pattern.
cts:word-query | Returns a query matching text content containing a given phrase.
| cts:word-query-options
| Returns the options for the specified query.
| cts:word-query-text
| Returns the text used to construct the specified query.
| cts:word-query-weight
| Returns the weight with which the specified query was constructed.
cts:words | Returns words from the word lexicon.
dbg:attach | Attach to a request and stop it for debugging.
dbg:attached | Return the request ID's of attached requests in a given server.
dbg:break | Set a breakpoint at the given expression ID.
dbg:breakpoints | Returns a sequence of expression ID's representing existing breakpoints for the given request.
dbg:clear | Clear a breakpoint at the given expression ID.
dbg:connect | Connect to a Server (http, xdbc, or task) for debugging.
dbg:connected | Return the ID's of servers that are connected by the debugger.
dbg:continue | Continue evaluation of the request.
dbg:detach | Detach from a stopped request.
dbg:disconnect | End the debugging of a server.
dbg:eval | Evaluate a string as an XQuery for debugging.
dbg:expr | Returns a description/representation of a given expression.
dbg:finish | Continue evaluation of the request until the end of the current function.
dbg:function | Returns the expression ID representing the function defined in a module with a given name.
dbg:invoke | Invoke a module for debugging.
dbg:line | Returns a sequence of expression ID's found on a given line of a stopped request.
dbg:next | Continue evaluation of the request until the beginning or end of an expression that is not a descendant of the current expression.
dbg:out | Continue evaluation of the request until the end of the current expression.
dbg:stack | Return the stack trace for a given request.
dbg:status | Return the debugging status of given requests.
dbg:step | Continue evaluation of the request until the beginning or end of an expression.
dbg:stop | Placing this call in XQuery will instruct the evaluator to stop a request for debugging.
dbg:stopped | Return the request ID's of stopped requests in a given server.
dbg:value | Evaluate an expression in the context of the identified stopped request.
dbg:wait | Wait until at least one of the given requests stops or all complete evaluating.
exsl:node-set | Returns a sequence of nodes based on the input object.
exsl:object-type | Returns a string that contains the type-name of the object passed as the argument.
map:clear | Clear a map.
map:count | Returns the number of entries used in the map.
map:delete | Delete a value from a map.
map:get | Get a value from a map.
map:keys | Get the keys used in the map.
map:map | Creates a map.
map:put | Put a value into a map at the given key.
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:cos | Returns the cosine of x, in the range from -1 to +1 (inclusive).
math:cosh | Returns the hyperbolic cosine of x.
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:log | Returns the base-e logarithm of x.
math:log10 | Returns the base-10 logarithm of x.
math:modf | Returns x broken up into fraction and integer.
math:pow | Returns x^y.
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:tan | Returns the tangent of x.
math:tanh | Returns the hyperbolic tangent of x, in the range from -1 to +1 (inclusive).
prof:allowed | Returns the value of the Profile Allow setting for the App Server or Task Server upon which the target request is running.
prof:disable | Disable profiling for this request.
prof:enable | Enable profiling for this request.
prof:eval | Evaluate a string as an XQuery for profiling.
prof:invoke | Profiles and returns the result of evaluating a module at the given path.
prof:report | Return a prof:report node containing the current state of profiling statistics for the given request.
prof:reset | Clear any accumulated profiling statistics for the requests.
prof:value | Evaluate an expression in the context of the current evaluating statement and return the profiling report for its evaluation.
prof:xslt-eval | Evaluate a string as an XSLT stylesheet for profiling.
prof:xslt-invoke | Profiles and returns the result of evaluating an XSLT stylesheet at the given path.
spell:double-metaphone | Given a word returns the two metaphone keys.
spell:is-correct | Returns true() if the specified word is spelled correctly, otherwise returns false().
spell:levenshtein-distance | Given two strings, returns the Levenshtein distance between those strings.
spell:suggest | Suggests a list of spellings for a word.
spell:suggest-detailed | Suggests a list of spellings for a word.
xdmp:access | Returns whether a given action on the specified document URI would succeed.
xdmp:add-response-header | Adds an HTTP response header field.
xdmp:add64 | Add two 64-bit integer values, discarding overflow.
xdmp:amp | Returns the amp ID for the specified amp.
xdmp:amp-roles | 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:base64-decode | Converts base64-encoded string to plaintext.
xdmp:base64-encode | Converts plaintext into base64-encoded string.
xdmp:binary-decode | Converts an encoded byte sequence, passed in as a binary node, from the specified encoding to a unicode string.
xdmp:can-grant-roles | Tests whether a user can grant or revoke a set of roles.
xdmp:castable-as | Returns true if a value is castable.
xdmp:collation-canonical-uri | Returns the canonical URI for the given URI, if it represents a valid collation.
xdmp:collection-delete | Deletes from the database every document in a collection.
xdmp:collection-locks | Returns locks of documents in a collection.
xdmp:collection-properties | Returns a sequence of properties documents, one for each document in the specified collection(s) that has a corresponding properties document.
xdmp:crypt | Calculates the password hash for the given password and salt.
xdmp:current-last | Returns the size of the current node list.
xdmp:current-position | Returns the position of the current item.
xdmp:database | Returns the the ID of the database named in the the parameter.
xdmp:database-backup | Starts an asynchronous backup of the specified list of forests to the backup data directory.
xdmp:database-backup-cancel | 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:database-backup-purge | Purge old backups from a directory.
xdmp:database-backup-status | Checks the status of the outstanding backup job with the specified job ID.
xdmp:database-backup-validate | Validates that the specified list of forests can be backed up to the backup data directory.
xdmp:database-forests | Returns a sequence of forest IDs in the specified database.
xdmp:database-name | Return the name of the database with the given ID.
xdmp:database-restore | Starts an asynchronous restore of the specified list of forests from the backup data directory.
xdmp:database-restore-cancel | 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:database-restore-status | Checks the status of the outstanding restore job with the specified job ID.
xdmp:database-restore-validate | 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:default-collections | Returns the collections any new document would get if the current user were to insert a document without specifying the collections.
xdmp:default-permissions | 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:diacritic-less | Returns the specified string, converting all of the characters with diacritics to characters without diacritics.
xdmp:directory | Returns the documents in a directory.
xdmp:directory-create | Creates a directory.
xdmp:directory-delete | Deletes a directory and all of its child and descendant documents and directories from the database.
xdmp:directory-locks | Returns locks of documents in a directory.
xdmp:directory-properties | Returns a sequence of properties documents, one for each document in the specified directory that has a corresponding properties document.
xdmp:document-add-collections | Adds the named document to the given collections.
xdmp:document-add-permissions | Adds the given permissions to the given document or directory.
xdmp:document-add-properties | Adds a sequence of properties to the properties of a document.
xdmp:document-assign | Assign a document URI to a forest index, using the same algorithm as xdmp:document-insert.
xdmp:document-delete | Deletes a document from the database.
xdmp:document-forest | Returns the forest ID of the forest in which a document (or a lock or a property) with the specified URI is stored.
xdmp:document-get | Returns the document in the file specified by $location.
xdmp:document-get-collections | Returns the collections to which a given document belongs.
xdmp:document-get-permissions | Returns the permissions to a given document.
xdmp:document-get-properties | Returns the property values for a document's property.
xdmp:document-get-quality | Returns the quality of the specified document if the document exists.
xdmp:document-insert | Inserts a new document into the database if a document with the specified URI does not already exist.
xdmp:document-load | Inserts a new document with the specified URI.
xdmp:document-locks | Returns the locks for one or more documents or directories.
xdmp:document-properties | Returns a sequence of properties documents, one for each of the specified documents that has a corresponding properties document.
xdmp:document-remove-collections | Removes the named document from the given collections.
xdmp:document-remove-permissions | Removes the given permissions from the named document or directory.
xdmp:document-remove-properties | Removes a sequence of properties from the properties of a document.
xdmp:document-set-collections | Sets the named document to belong to the given collections, replacing any previously set collections on the named document.
xdmp:document-set-permissions | Sets the permissions on the named document (or directory) to the given permissions, replacing any permissions previously set on the document (or directory).
xdmp:document-set-properties | Sets the properties of a document to the given sequence of elements, replacing any properties that already exist on the document.
xdmp:document-set-property | Sets a property on a document.
xdmp:document-set-quality | Sets the quality of the document with the given URI.
xdmp:elapsed-time | Returns the elapsed time since the start of processing of this query.
xdmp:element-content-type | Returns the schema-defined content-type of an element ("empty", "simple", "element-only", or "mixed").
xdmp:email | Send an email in an XQuery program.
xdmp:encoding-language-detect | Analyzes binary, text, or XML data and suggests possible pairs of encoding and language, with a confidence score for each pair.
xdmp:estimate | Returns the number of fragments selected by an expression.
xdmp:eval | Returns the result of evaluating a string as an XQuery module.
xdmp:eval-in | [DEPRECATED: use xdmp:eval with the database option instead] Returns the result of evaluating a string as an XQuery module in a given database.
xdmp:excel-convert | Converts a Microsoft Excel document to XHTML.
xdmp:exists | Returns true if any fragment is selected by an expression, false if no fragments are selected.
xdmp:filesystem-directory | Performs a directory listing of the given file pathname.
xdmp:filesystem-file | Reads a file from the filesystem.
xdmp:forest | Returns the the ID of the forest specified as the parameter.
xdmp:forest-backup | Backs up forest data files.
xdmp:forest-clear | Clears forest data files.
xdmp:forest-counts | Returns detailed forest statistics for a given forest.
xdmp:forest-databases | Returns the database ID corresponding to the database to which the specified forest belongs.
xdmp:forest-name | Return the name of the forest with the given id.
xdmp:forest-open-replica | Returns a forest id or its open replica id if it is currently experiencing a local disk failover.
xdmp:forest-restart | Restarts a forest.
xdmp:forest-restore | Restores forest data files.
xdmp:forest-rollback | Rolls forests back to a previous point in time, marking any fragment newer than the specified timestamp as deleted.
xdmp:forest-status | Returns the status of a forest.
xdmp:forests | Returns a sequence of the IDs of all the forests in the system.
xdmp:format-number | Returns a formatted number value based on the picture argument.
xdmp:from-json | Parses a string as JSON, returning an item sequence.
xdmp:function | Returns a function value as an xdmp:function type.
xdmp:function-module | Returns the module location (if any) that the xdmp:function value refers to.
xdmp:function-name | Returns the QName of the function(s) that the xdmp:function refers to.
xdmp:get | [DEPRECATED: use xdmp:document-get instead] Returns the document in the XML file specified by $path.
xdmp:get-current-roles | Returns all the current roles, both assigned and inherited by the current user and any received from amps.
xdmp:get-current-user | Returns the name of the current user.
xdmp:get-request-body | For PUT requests, returns the body of the request.
xdmp:get-request-client-address | Returns as a string the internet address of the client from which the HTTP server request is issued.
xdmp:get-request-client-certificate | Returns the PEM encoded client certificate if one was presented.
xdmp:get-request-field | Returns the value of a named request field.
xdmp:get-request-field-content-type | This function is used to extract the content type from the request field.
xdmp:get-request-field-filename | Returns a list of filenames from a multipart request for the field name specified.
xdmp:get-request-field-names | Returns a sequence of the request field names.
xdmp:get-request-header | Returns the value of a named request header.
xdmp:get-request-header-names | Returns a sequence of request header names.
xdmp:get-request-method | Returns the HTTP request method.
xdmp:get-request-path | Returns the HTTP request path.
xdmp:get-request-protocol | 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:get-request-url | Returns the portion of the URL following the host_name:port_number.
xdmp:get-request-user | Returns the id of the current user.
xdmp:get-request-username | Returns the username from the Authorization header of this App Server request.
xdmp:get-response-code | Returns two nodes, the first containing the HTTP response code and the second containing the HTTP response message.
xdmp:get-response-encoding | Returns the encoding that the response from this server is in.
xdmp:get-server-field | Returns the value of a named server field.
xdmp:get-server-field-names | Returns a sequence of the server field names.
xdmp:get-session-field | Returns the value of a named session field from the session created by the xdmp:login function.
xdmp:get-session-field-names | Returns a sequence of the HTTP session field names from the session created by the xdmp:login function.
xdmp:get-url-rewriter-path | Returns the URL of the URL rewriter handler for this application server.
xdmp:group | Returns the the ID of the group specified in the parameter.
xdmp:group-hosts | Returns the IDs of all hosts belonging to the group with the given ID.
xdmp:group-name | Returns the the name of the group with the given ID.
xdmp:group-servers | Returns the the IDs of all 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:has-privilege | Tests whether the current user has at least one of a given set of privileges.
xdmp:hash32 | Returns the 32-bit hash of a string.
xdmp:hash64 | Returns the 64-bit hash of a string.
xdmp:hex-to-integer | Parses a hexadecimal string, returning an integer.
xdmp:host | Returns the the ID of the host named in the parameter.
xdmp:host-name | Returns the the name of the host ID specified as the parameter.
xdmp:host-status | Returns the status of a host.
xdmp:hosts | Returns a sequence of the IDs of all the hosts in the system.
xdmp:http-delete | Sends an http DELETE request to the http server specified in the URI to delete the specified resource.
xdmp:http-get | Sends the http GET method to the specified URI.
xdmp:http-head | Sends the http HEAD method to the specified URI.
xdmp:http-options | Sends the http OPTIONS method to the specified URI.
xdmp:http-post | Sends the http POST request to the server.
xdmp:http-put | Sends an HTTP PUT request to an HTTP server.
xdmp:integer-to-hex | Returns a hexadecimal representation of an integer.
xdmp:integer-to-octal | Returns an octal representation of an integer.
xdmp:invoke | Returns the result of evaluating a module at the given path.
xdmp:invoke-in | [DEPRECATED: use xdmp:invoke with the database option instead] Returns the result of evaluating a module at the given path.
xdmp:key-from-QName | Construct a context-independent string from a QName.
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:lock-acquire | Acquire a lock on a document or directory for an extended amount of time.
xdmp:lock-for-update | Acquires an intent exclusive lock on a URI.
xdmp:lock-release | Unlock a document or directory.
xdmp:log | Logs a debug message to the log file <install_dir>/Logs/ErrorLog.txt.
xdmp:log-level | Retrieves the current server log level.
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: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:merge-cancel | 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:modules-database | Returns the database ID of the modules database.
xdmp:modules-root | Returns the current root path for modules.
xdmp:mul64 | Muliply two 64-bit integer values, discarding overflow.
xdmp:node-database | Returns the database id where the parameter is stored.
xdmp:node-delete | Deletes a node from the database.
xdmp:node-insert-after | Adds an immediately following sibling to a node.
xdmp:node-insert-before | Adds an immediately preceding sibling to a node.
xdmp:node-insert-child | Adds a new last child to a node.
xdmp:node-kind | Returns an xs:string representing the node's kind: either "document", "element", "attribute", "text", "namespace", "processing-instruction", "binary", or "comment".
xdmp:node-replace | Replaces a node.
xdmp:node-uri | Returns the document-uri property of the parameter or its ancestor.
xdmp:not64 | NOT a 64-bit integer value.
xdmp:octal-to-integer | Parses an octal string, returning an integer.
xdmp:or64 | OR two 64-bit integer values.
xdmp:parse-dateTime | Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
xdmp:parse-yymmdd | Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
xdmp:path | Returns a string whose value corresponds to the path of the node.
xdmp:pdf-convert | Converts a PDF file to XHTML.
xdmp:permission | Returns a permission element in the security namespace corresponding to the named role and capability given.
xdmp:plan | Returns an XML element recording information about how the given expression will be processed by the index.
xdmp:platform | Returns the operating-system platform upon which MarkLogic Server is running ("solaris", "winnt", "linux", or "macosx").
xdmp:powerpoint-convert | Converts a Microsoft Powerpoint document to XHTML.
xdmp:pretty-print | Returns a well-formatted XQuery module.
xdmp:privilege | Returns the privilege ID for the specified privilege name.
xdmp:privilege-roles | Returns the set of all roles that have a given privilege.
xdmp:product-edition | Returns the current MarkLogic product edition.
xdmp:QName-from-key | Construct a QName from a string of the form "{namespaceURI}localname".
xdmp:query-meters | Returns the current value of the resource meters for this query sequence.
xdmp:query-trace | 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:redirect-response | Redirects the App Server response to a given location.
xdmp:request | Returns the unique key of the current request.
xdmp:request-cancel | Cancel the request with the given host, server, and request IDs.
xdmp:request-status | Returns the status of a running request.
xdmp:request-timestamp | Returns the system timestamp for this request if the request is a query statement.
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:role-roles | 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:rshift64 | Right-shift a 64-bit integer value.
xdmp:save | Serializes a node as text and saves it to a file.
xdmp:schema-database | Returns the database ID of the schema database associated with the current database.
xdmp:security-assert | Tests whether the current user has at least one of a given set of privileges.
xdmp:security-database | Returns the database ID of the security database associated with the current database.
xdmp:server | Returns the the ID(s) of the App Server specified in the parameter.
xdmp:server-name | Return the name of the App Server with the given ID.
xdmp:server-status | Returns the status of an app-server on a host.
xdmp:servers | Returns a sequence of the IDs of all the App Servers in the system.
xdmp:set | Set the value of a variable to the specified expression.
xdmp:set-request-time-limit | Changes the time limit for an actively running request to the specified value.
xdmp:set-response-code | Sets the response code and message.
xdmp:set-response-content-type | Sets the response content-type.
xdmp:set-response-encoding | Sets the response encoding.
xdmp:set-server-field | Sets the value of a named server field.
xdmp:set-server-field-privilege | Sets the privilege of a named server field.
xdmp:set-session-field | Sets the value of a named session field for the session created by the xdmp:login function.
xdmp:shutdown | Shutdown servers on hosts.
xdmp:sleep | Delays for a specific amount of time.
xdmp:spawn | Place the specified module on the task queue for evaluation.
xdmp:spawn-in | [DEPRECATED: use xdmp:spawn with the database option instead] Place the specified module on the task queue for evaluation.
xdmp:step64 | Combines an initial hash with a subsequent hash.
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:to-json | Returns a string representing a JSON serialization of a given item sequence.
xdmp:trace | Signal a trace event.
xdmp:triggers-database | Returns the database ID of the triggers database associated with the current database.
xdmp:unpath | Evaluate a string as an XPath and return the corresponding node(s).
xdmp:unquote | Parses a string as XML, returning one or more document nodes.
xdmp:uri-content-type | Returns the content type of the given URI as matched in the mimetypes configuration.
xdmp:uri-format | Returns the format of the given URI as matched in the mimetypes configuration.
xdmp:uri-is-file | Returns true if a given URI refers to a file which exists on the current application server.
xdmp:url-decode | Converts URL-encoded string to plaintext.
xdmp:url-encode | Converts plaintext into URL-encoded string.
xdmp:user | Returns the user ID for the specified user name.
xdmp:user-last-login | Returns the last-login node for the specified user ID.
xdmp:user-roles | Returns all roles assigned to a user, including roles directly assigned to the user and roles inherited by other roles.
xdmp:value | Evaluate an expression in the context of the current evaluating statement.
xdmp:version | Returns the current MarkLogic Server version.
xdmp:with-namespaces | Evaluates the expression in the context of a specific set of namespace bindings.
xdmp:word-convert | Converts a Microsoft Word document to XHTML.
xdmp:x509-certificate-extract | Returns the XML representation of the specified X.509 certificate.
xdmp:xor64 | XOR two 64-bit integer values.
xdmp:xquery-version | Returns the XQuery language version of the calling module.
xdmp:xslt-eval | Executes an XSLT stylesheet against a node.
xdmp:xslt-invoke | Executes an XSLT stylesheet against a node.
xdmp:zip-create | Create a zip file from a list of nodes.
xdmp:zip-get | Get a named file from a zip document.
xdmp:zip-manifest | Return a manifest for this zip file.

© Copyright 2002-2012 MarkLogic Corporation. All rights reserved.