MarkLogic Server 11.0 Product Documentationxdmp functions
The table below lists all the
xdmp built-in
functions (in this namespace:
http://marklogic.com/xdmp).
You can also view these functions broken down by category:
470 functions
| Function name | Description |
|---|---|
| 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:add-response-trailer | Adds a HTTP Trailer when HTTP chunked transfer is enabled. |
| 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:annotation | Returns the named annotation from the function. |
| xdmp:apply | Applies an xdmp:function with the given parameters. |
| xdmp:architecture | Returns the hardware architecture upon which MarkLogic Server is running. |
| xdmp:atomizable | Returns true if a value could be atomized without error. |
| xdmp:aws-region | Returns the current Amazon Web Services region. |
| xdmp:aws-services-domain | Returns the current Amazon Web Services services domain. |
| xdmp:aws-services-partition | Returns the current Amazon Web Services services partition. |
| xdmp:azure-environment | Returns the current Microsoft Azure Environment. |
| xdmp:azure-region | Returns the current Microsoft Azure Region. |
| 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:binary-is-external | Test whether or not a binary node represents an external binary. |
| xdmp:binary-is-large | Check whether a binary node is a large binary. |
| xdmp:binary-is-small | Check whether a binary node is a small binary. |
| xdmp:binary-size | Returns the size of the data, in bytes, represented by a binary node. |
| xdmp:binary-to-integer | Parses a binary string, returning an integer. |
| xdmp:bootstrap-hosts | Returns a sequence of the IDs of all the bootstrap hosts in the cluster. |
| xdmp:cache-status | Returns the status of the caches. |
| xdmp:caller-dialect | Returns the dialect (e.g., "javascript", "1.0-ml", etc) of the caller or the empty sequence if no dialect information is available. |
| 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:certificate-validate-key-pair | Checks if a public key and private key match within an asymmetric encryption sequence. |
| xdmp:cluster | Returns the ID of the cluster named in the parameter. |
| xdmp:cluster-effective-version | Returns the current MarkLogic Server effective version. |
| xdmp:cluster-fedramp | Returns whether MarkLogic Server is running in a FedRAMP certified environment. |
| xdmp:cluster-name | Returns the name of the cluster with the specified ID. |
| xdmp:cluster-quorum-exists | Returns whether there exists a quorum in the specified cluster. |
| xdmp:cluster-version-at-least | Returns true current MarkLogic Server effective version is equal or greater that the version |
| xdmp:collation-canonical-uri | Returns the canonical URI for the given URI, if it represents a valid collation. |
| xdmp:collation-locales | Returns an enumeration of supported collation locales. |
| xdmp:collection-delete | Deletes from the database every document in a collection. |
| xdmp:collection-id | Return the ID of a collection specified by URI. |
| 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:collections | Returns the IDs of all collections in the system. |
| xdmp:commit | Commit the current transaction to the database. |
| xdmp:configuration-timestamp | Returns timestamp of last configuration changed |
| xdmp:credential | Returns the credential |
| xdmp:credential-id | 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:current-last | Returns the size of the current node list. |
| xdmp:current-position | Returns the position of the current item. |
| xdmp:database | Returns the ID of the database named in the parameter. |
| xdmp:database-assignment-policy | This function returns the assignment policy for the specified database. |
| 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-describe-indexes | Return the list of range index specifications for the given database ID. |
| xdmp:database-directory-creation | This function returns the directory creation setting for the specified database. |
| xdmp:database-encryption-at-rest | Returns the encryption at rest setting for the database identified by database-id |
| xdmp:database-encryption-key-id | Returns the encryption key ID for the database identified by database-id |
| xdmp:database-forests | Returns a sequence of forest IDs in the specified database. |
| xdmp:database-global-nonblocking-timestamp | 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:database-incremental-backup | Starts an asynchronous incremental backup of the specified list of forests to the backup data directory. |
| xdmp:database-incremental-backup-validate | Validates that the specified list of forests can be backed up to the backup data directory. |
| xdmp:database-is-forest-retired | This function returns true if the specified forest is retired and false the specified forest is not retired. |
| xdmp:database-is-rebalancer-enable | This function returns the rebalancer enable setting for the specified database. |
| xdmp:database-is-replica | Tests if a database is a replica of a foreign database. |
| xdmp:database-journal-archive-purge | Purge journal archive before last incremental backup from a directory. |
| xdmp:database-name | Return the name of the database with the given ID. |
| xdmp:database-node-query-rolesets | Return a sequence of query-rolesets that are required for proper querying of the given database nodes with Element Level Security. |
| xdmp:database-nonblocking-timestamp | 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:database-path-namespaces | Returns the list of path namespaces for the given database id. |
| xdmp:database-restore | Starts an asynchronous restore of the specified list of destination 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 destination 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:dayname-from-date | Returns a string representing the dayname value in the localized value of $arg. |
| xdmp:decode-from-NCName | Invertible function that decodes characters an NCName produced by xdmp:encode-for-NCName. |
| 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 from the database 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-filter | Filters a wide variety of document formats, extracting metadata and text, and returning XHTML. |
| 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-metadata | Returns the metadata value of a given document. |
| xdmp:document-get-metadata-value | Returns the metadata value of a given document. |
| 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-partition-assign | Assign a document to a partition number, using the partition queries in the database or in the second argument. |
| xdmp:document-properties | Returns a sequence of properties documents, one for each of the specified documents that has a corresponding properties document. |
| xdmp:document-put-metadata | Adds metadata to the document. |
| xdmp:document-remove-collections | Removes the named document from the given collections. |
| xdmp:document-remove-metadata | Removes metadata with certain keys from a document. |
| 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-metadata | Sets metadata to the 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:document-timestamp | Returns timestamp of the most recent visible update to a document, lock, or property. |
| xdmp:eager | Returns the value of its argument, evaluated eagerly. |
| xdmp:effective-version | Returns the effective version of this host |
| 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:encode-for-NCName | Invertible function that escapes characters required to be part of an NCName. |
| 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:external-binary | Returns an external binary node. |
| xdmp:external-binary-path | Return the path to the external file associated with an external binary document. |
| xdmp:external-security | Returns the external security ID for the specified external security name. |
| xdmp:filesystem-directory | Performs a directory listing of the given file pathname. |
| xdmp:filesystem-directory-create | Creates the directory specified by pathname. |
| xdmp:filesystem-directory-delete | Deletes the directory specified by pathname. |
| xdmp:filesystem-file | Reads a file from the filesystem. |
| xdmp:filesystem-file-delete | Deletes the file specified by pathname. |
| xdmp:filesystem-file-encryption-status | Return the encryption status of a file. |
| xdmp:filesystem-file-exists | Return true if a file exists on a host; otherwise false. |
| xdmp:filesystem-file-get-time | Returns access and modification time for a file. |
| xdmp:filesystem-file-length | Reads the length of a file from the filesystem. |
| xdmp:filesystem-file-set-time | Sets access and modification time for a file. |
| xdmp:filesystem-filepath | Returns the canonicalized file path of the input path. |
| xdmp:foreign-cluster-status | Returns the status of a foreign cluster from a host's point of view. |
| xdmp:foreign-clusters | Returns the IDs of the foreign clusters. |
| xdmp:forest | Returns the ID of the forest specified as the parameter. |
| xdmp:forest-backup | Backs up forest data files. |
| xdmp:forest-backup-status | Checks the status of the specified forests for any outstanding backup jobs. |
| xdmp:forest-clear | Clears forest data files, including all stands and journals. |
| xdmp:forest-counts | Returns detailed forest statistics for a given forest . |
| xdmp:forest-database-replication-resume | Resume database replication with the specified forest IDs. |
| xdmp:forest-database-replication-suspend | Suspend database replication with the specified forest IDs. |
| xdmp:forest-databases | 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:forest-failover-info | Return a sequence of pair of the forest IDs and host IDs for the failover forests and hosts of the given forest. |
| xdmp:forest-host | Return the host of the forest with the given id. |
| xdmp:forest-name | Return the name of the forest with the given ID. |
| xdmp:forest-online | 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:forest-open-replica | 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: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-state | Returns state of the forests |
| xdmp:forest-status | Returns the status of a forest. |
| xdmp:forest-updates-allowed | Return updates allowed state of the forest with the given ID. |
| xdmp:forest-validate-replica-index | Validate index data for the database replica forests of the specified forests. |
| 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 | Atomizes a JSON node, returning a JSON value. |
| xdmp:from-json-string | 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:function-parameter-name | Returns the name of the parameter at the designated (1-based) position from the given function's signature. |
| xdmp:function-parameter-type | Returns the type of the parameter at the designated (1-based) position from the given function's signature. |
| xdmp:function-return-type | Returns the return type from the given function's signature. |
| xdmp:function-signature | Returns the signature of the function that the argument refers to. |
| xdmp:functions | Returns all in-scope functions. |
| 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-current-userid | Returns the ID of the current user. |
| xdmp:get-invoked-path | Returns the path of the module that is being invoked. |
| xdmp:get-original-url | Returns the portion of the URL following the host_name:port_number. |
| xdmp:get-orphaned-binaries | Returns a sequence of the IDs of all orphaned large binaries in a given forest. |
| xdmp:get-request-body | For PUT or DELETE 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-error-format | Returns the current error format for the request. |
| 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-port | Returns the port of the request. |
| 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 | If this App Server is using application-level authentication, returns the ID of the user in the last successful call to xdmp:login . |
| xdmp:get-request-username | If this App Server is using application-level authentication, returns the username in the last successful call to xdmp:login . |
| 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-transaction-mode | Retrieve the transaction mode for the current session. |
| xdmp:get-url-rewriter-path | 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:group-cache-clear | Clears specified caches for the target group. |
| xdmp:group-get-audit-event-type-enabled | This function returns the audit event type's enabled setting for the audit configuration. |
| xdmp:group-hosts | Returns the IDs of all hosts belonging to the group with the given ID. |
| xdmp:group-name | Returns the name of the group with the given ID. |
| xdmp:group-port-servers | Returns the IDs of all port App Servers belonging to the group with the given ID. |
| xdmp:group-servers | Returns the IDs of all App Servers belonging to the group with the given ID. |
| xdmp:group-task-server | Returns the ID of the Task Server belonging to the group with the given ID. |
| xdmp:groups | Returns a sequence of the IDs of all the groups in the system. |
| xdmp:gss-server-negotiate | 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: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:healthcheck-status | Returns the health check status of each component in the current cluster. |
| xdmp:hex-to-integer | Parses a hexadecimal string, returning an integer. |
| xdmp:hmac-md5 | Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments. |
| xdmp:hmac-sha1 | Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments. |
| xdmp:hmac-sha256 | Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments. |
| xdmp:hmac-sha512 | 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:host-forests | Returns a sequence of forest IDs in the specified host. |
| xdmp:host-get-ssl-fips-enabled | Returns whether fips mode is enabled. |
| xdmp:host-group | Returns the ID of the group that the specified host belongs to. |
| xdmp:host-mode | Returns this host mode |
| xdmp:host-mode-description | Return the description string for this host mode setting |
| xdmp:host-name | Returns the name of the specified host. |
| xdmp:host-status | Returns the status of a host. |
| xdmp:hosts | Returns a sequence of the IDs of all the hosts in the cluster. |
| 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 an http POST request to the server. |
| xdmp:http-put | 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:integer-to-binary | Returns a binary representation of an integer. |
| 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 an XQuery or Server-Side JavaScript module at the given path. |
| xdmp:invoke-function | Returns the result of evaluating an XQuery function value. |
| xdmp:invoke-in | [DEPRECATED: use xdmp:invoke with the database option instead] Returns the result of evaluating a module at the given path. |
| xdmp:is-whitespace-node | Returns true if the node is a text node containing only whitespace. |
| xdmp:javascript-eval | Returns the result of evaluating a string as a JavaScript module. |
| xdmp:json-pointer | Resolve a (relative) JSON pointer (see RFC 6901) in the context of a node and return the result, if any. |
| xdmp:json-validate | Validate a JSON node against a JSON Schema. |
| xdmp:json-validate-node | Validate a JSON node against a JSON Schema. |
| xdmp:json-validate-report | Validate a JSON node against a JSON Schema and return an error report. |
| xdmp:json-validate-report-node | Validate a JSON node against a JSON Schema and return an error report. |
| xdmp:jwt-decode | Extracts the contents of a JWT object. |
| xdmp:jwt-validate | Validates the signature of a JWT. |
| xdmp:key-from-QName | Construct a context-independent string from a QName. |
| xdmp:keystore-export | Exports all encryption keys stored in the MarkLogic embedded KMS. |
| xdmp:keystore-import | Import encryption keys into the MarkLogic embedded KMS from an exported encrypted file (see keystore-export). |
| xdmp:keystore-set-current-host | Set current KMS host to the first one matching the user-specified name for all online MarkLogic nodes in the cluster. |
| xdmp:keystore-synchronize | Synchronize the Keystore's cache containing the keys used for encryption and decryption. |
| xdmp:keystore-validate-exported | Validates the content of an exported keystore file, see keystore-export and keystore-import |
| xdmp:lazy | Returns the value of its argument, evaluated lazily. |
| xdmp:ldap-lookup | Returns an ldap entry. |
| xdmp:ldap-search | 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:lock-acquire | Acquire a lock on a document or directory for an extended amount of time. |
| xdmp:lock-for-update | Acquires an intent exclusive transaction lock on a URI. |
| xdmp:lock-release | Unlock a document or directory. |
| xdmp:log | Flush the log of the specific app server error log file. |
| xdmp:log-level | Retrieves the current server log level. |
| xdmp:logfile-scan | Scan a file in ErrorLog.txt format filtering by date range and regular expression. |
| 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:logmessage-parse | Parse messages from logfile to xml, json, raw, or complex (XML with more elements) format. |
| 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:mimetypes | This function returns all the mimetypes specifications of the cluster. |
| xdmp:modules-database | Returns the database ID of the modules database. |
| xdmp:modules-root | Returns the current root path for modules. |
| xdmp:month-name-from-date | Returns month name, calculated from the localized value of $arg. |
| xdmp:mul64 | Multiply two 64-bit integer values, discarding overflow. |
| xdmp:multipart-decode | Extract the parts from a multipart encoding. |
| xdmp:multipart-encode | Create a multipart encoding of the specified node. |
| xdmp:node-collections | Returns any collections for the node's document in the database. |
| 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-metadata | Returns the metadata value of a given node. |
| xdmp:node-metadata-value | Returns the metadata value of a node for a particular key. |
| xdmp:node-permissions | Returns the permissions to a node's document. |
| xdmp:node-query-rolesets | 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: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-permission | Returns a permission element in the security namespace corresponding to the element or object given. |
| xdmp:parse-yymmdd | Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. |
| xdmp:partition-forests | Returns a sequence of forest IDs with the specified partition number |
| xdmp:passive-has-privilege | Tests whether the current user has at least one of a given set of privileges. |
| xdmp:passive-security-assert | 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: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:plannable | Returns a boolean showing whether the given expression is suitable to use with xdmp:plan. |
| xdmp:platform | Returns the operating-system platform upon which MarkLogic Server is running ("winnt", "linux", or "macosx"). |
| xdmp:position | Returns an integer value representing the starting position of a string within the search string. |
| 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-kind | Return the kind of the specified privilege. |
| xdmp:privilege-name | Return the name of the specified privilege. |
| xdmp:privilege-roles | Returns the set of all roles that have a given privilege. |
| xdmp:privileges | Returns the IDs of all privileges in the system. |
| xdmp:product-edition | Returns the current MarkLogic product edition. |
| xdmp:product-environment | Returns the current MarkLogic product environment. |
| xdmp:QName-from-key | Construct a QName from a string of the form "{namespaceURI}localname". |
| xdmp:quarter-from-date | Returns an integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of $arg. |
| xdmp:query-meters | Returns the current value of the resource meters for this query sequence. |
| xdmp:query-partitions | This function returns the partition numbers of the partitions that the specified query will be searched on. |
| 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:range-partition-forests | Given a value, the function returns a list of forests that have ranges the value falls into. |
| xdmp:redirect-response | Redirects the App Server response to a given location. |
| xdmp:remove-orphaned-binary | Remove an orphaned large binary |
| 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-log-delete | Deletes the value stored under the specified $key for the current request. |
| xdmp:request-log-get | Retrieves the value stored under the specified $key for the current request. |
| xdmp:request-log-put | Stores or updates a (key, value) pair for the current request. |
| 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:resolve-uri | 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:role-compartment | Return the compartment of the specified role. |
| xdmp:role-description | Return the description of the specified role. |
| xdmp:role-get-default-collections | Return the default collections of specified role. |
| xdmp:role-get-default-permissions | Return the default permissions of specified role. |
| xdmp:role-name | Returns the role name for the specified role id. |
| xdmp:role-privileges | Return the IDs of privileges of specified role. |
| xdmp:role-roles | If the parameter $inherit is true, 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:roles | Returns the IDs of all roles in the system. |
| xdmp:rollback | Roll back the current transaction. |
| xdmp:rsa-generate | 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: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 | Return the ID(s) of the App Servers, XDBC Servers, ODBC Servers, or Task Servers with the given name. |
| xdmp:server-collation | Return the default collation of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp:server-coordinate-system | Return the default coordinate system of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp:server-database | Return the database ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp:server-default-xquery-version | Return the default xquery version of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp:server-group | Return the ID of the group for an App Server, XDBC Server, ODBC Server, or Task Server. |
| xdmp:server-kind | Return the kind of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp:server-max-threads | Return the maximum number of server threads allowed on each host in the group of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp:server-modules-database | Return the modules database ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp:server-name | Return the name of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp:server-port | Return the port of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp:server-root | Return the root of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp:server-session-timeout | Return the session timeout of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp:server-ssl-certificate-template | Return the SSL certificate template ID of the App Server, XDBC Server, ODBC Server, or Task 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 (HTTP, XDBC, ODBC, and TaskServer) in the system. |
| xdmp:set | Set the value of a variable to the specified expression. |
| xdmp:set-request-limit | Changes the meter limit ( elapsed-time/lock-count/read-size ) for an actively running request to the specified value. |
| xdmp:set-request-limits | Changes multiple meter limits ( elapsed-time/lock-count/read-size ) for an actively running request to the specified value. |
| xdmp:set-request-time-limit | Changes the time limit for an actively running request to the specified value. |
| xdmp:set-response-chunked-encoding | Enabble/disables chunked encoding |
| xdmp:set-response-code | Sets the response code and message. |
| xdmp:set-response-compression | Enabble/disables HTTP GZIP Response compression |
| xdmp:set-response-content-type | Sets the response content-type. |
| xdmp:set-response-encoding | Sets the response encoding. |
| xdmp:set-response-output-method | Sets the serialization method. |
| 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:set-transaction-mode | Set the transaction mode for the current session. |
| xdmp:set-transaction-name | Set the name of a local or remote transaction. |
| xdmp:set-transaction-time-limit | 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:software-version | Returns this host's software version |
| xdmp:spawn | Place the specified module on the task queue for evaluation. |
| xdmp:spawn-function | Place the specified function value 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:sql | Executes an ad hoc SQL query. |
| xdmp:sql-plan | Returns a node representing the query plan of the given SQL SELECT query. |
| xdmp:start-journal-archiving | Starts journal archiving to the specified list of forests. |
| xdmp:step64 | Combines an initial hash with a subsequent hash. |
| xdmp:stop-journal-archiving | Stops journal archiving to the specified list of forests. |
| xdmp:streamable | Returns a sequence of strings describing the streaming nature of the argument value. |
| 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:timestamp-to-wallclock | Converts a 64 bit timestamp value to an xs:dateTime. |
| xdmp:to-json | Constructs a JSON document. |
| xdmp:to-json-string | Returns a string representing a JSON serialization of a given item sequence. |
| xdmp:trace | Signal a trace event. |
| xdmp:trace-enabled | 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:transaction-commit | Explicitly commit a transaction running on a named host. |
| xdmp:transaction-locks | Returns all URIs currently locked for read or write by a transaction. |
| xdmp:transaction-rollback | Explicitly roll back a transaction running on a named host. |
| xdmp:triggers-database | 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: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-external-security | Returns external security id and user name for an external user. |
| xdmp:user-get-default-collections | Return the default collections of specified user. |
| xdmp:user-get-default-permissions | Return the default permissions of specified user. |
| xdmp:user-last-login | Returns the last-login node for the current user. |
| xdmp:user-privileges | Return IDs of all privileges that a user have. |
| xdmp:user-roles | Returns all roles assigned to a user, including roles directly assigned to the user and roles inherited by other roles. |
| xdmp:userid-roles | 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:value | Evaluate an expression in the context of the current evaluating statement. |
| xdmp:version | Returns the current MarkLogic Server version. |
| xdmp:wallclock-to-timestamp | Converts an xs:dateTime to a 64 bit timestamp value. |
| xdmp:week-from-date | Returns an integer between 1 and 53, both inclusive, representing the week value in the localized value of $arg. |
| xdmp:weekday-from-date | Returns an integer in the range 1 to 7, inclusive, representing the weekday value in the localized value of $arg. |
| 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:x509-certificate-generate | Generate a new PEM-encoded X.509 certificate. |
| xdmp:x509-certificate-issuer-name | Returns the issuer distinguished name for the specified X.509 certificate. |
| xdmp:x509-certificate-subject-name | Returns the subject distinguished name for the specified X.509 certificate. |
| xdmp:xa-complete | Completes (commits or rolls back) a prepared XA transaction. |
| xdmp:xa-forget | Forgets a remembered completed XA transaction. |
| 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:yearday-from-date | Returns an integer between 1 and 366, both inclusive, representing the yearday value in the localized value of $arg. |
| 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. |