Loading TOC...

xdmp functions (MarkLogic Server)

The MarkLogic Server extension functions are XQuery extensions that return MarkLogic Server-specific information, such as the version of MarkLogic Server, the IDs of the hosts in the cluster, and so on.

98 functions
Function name Description
xdmp:access Returns whether a given action on the specified document URI would succeed.
xdmp:architecture Returns the hardware architecture upon which MarkLogic Server is running.
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:bootstrap-hosts Returns a sequence of the IDs of all the bootstrap hosts in the cluster.
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-name Returns the name of the cluster with the specified ID.
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:configuration-timestamp Returns timestamp of last configuration changed
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-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-is-forest-retired This function returns true if the specificed forest is retired and false the specificed 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-name Return the name of the database with the given ID.
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:databases Returns a sequence of the IDs of all the databases in the system.
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-timestamp Returns timestamp of the most recent visible update to a document, lock, or property.
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: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:foreign-clusters Returns the IDs of the foreign clusters.
xdmp:forest Returns the ID of the forest specified as the parameter.
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-updates-allowed Return updates allowed state of the forest with the given ID.
xdmp:forests Returns a sequence of the IDs of all the forests in the system.
xdmp:get [DEPRECATED: use xdmp:document-get instead] Returns the document in the XML file specified by $path.
xdmp:get-orphaned-binaries Returns a sequence of the IDs of all orphaned large binaries in a given forest.
xdmp:group Returns the ID of the group specified in the parameter.
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: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-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:hosts Returns a sequence of the IDs of all the hosts in the cluster.
xdmp:log Logs a message into a specific app server error log file.
xdmp:log-level Retrieves the current server log level.
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:platform Returns the operating-system platform upon which MarkLogic Server is running ("winnt", "linux", or "macosx").
xdmp:pretty-print Returns a well-formatted XQuery module.
xdmp:product-edition Returns the current MarkLogic product edition.
xdmp:product-environment Returns the current MarkLogic product environment.
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:remove-orphaned-binary Remove an orphaned large binary
xdmp:request Returns the unique key of the current request.
xdmp:rethrow Within the catch section of a try-catch expression, re-throw the currently caught error.
xdmp:schema-database Returns the database ID of the schema database associated with the current database.
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-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-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:servers Returns a sequence of the IDs of all the App Servers (HTTP, XDBC, ODBC, and TaskServer) in the system.
xdmp:software-version Returns this host's software version
xdmp:subbinary Returns a binary node made up of a subset of the given binary node.
xdmp:trace Signal a trace event.
xdmp:trace-enabled Returns whether or not a trace event is enabled.
xdmp:triggers-database Returns the database ID of the triggers database associated with the current database.
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:validate Returns an element containing a summary of validation errors in a node.
xdmp:version Returns the current MarkLogic Server version.