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.

104 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.binaryIsExternal Test whether or not a binary node represents an external binary.
xdmp.binaryIsLarge Check whether a binary node is a large binary.
xdmp.binaryIsSmall Check whether a binary node is a small binary.
xdmp.binarySize Returns the size of the data, in bytes, represented by a binary node.
xdmp.bootstrapHosts 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.clusterEffectiveVersion Returns the current MarkLogic Server effective version.
xdmp.clusterFedramp Returns whether MarkLogic Server is running in a FedRAMP certified environment.
xdmp.clusterName Returns the name of the cluster with the specified ID.
xdmp.clusterQuorumExists Returns whether there exists a quorum in the specified cluster.
xdmp.clusterVersionAtLeast Returns true current MarkLogic Server effective version is equal or greater that the version
xdmp.collationCanonicalUri Returns the canonical URI for the given URI, if it represents a valid collation.
xdmp.collationLocales Returns an enumeration of supported collation locales.
xdmp.configurationTimestamp Returns timestamp of last configuration changed
xdmp.database Returns the ID of the database named in the parameter.
xdmp.databaseAssignmentPolicy This function returns the assignment policy for the specified database.
xdmp.databaseDescribeIndexes Return the list of range index specifications for the given database ID.
xdmp.databaseDirectoryCreation This function returns the directory creation setting for the specified database.
xdmp.databaseEncryptionAtRest Returns the encryption at rest setting for the database identified by database-id
xdmp.databaseEncryptionKeyId Returns the encryption key ID for the database identified by database-id
xdmp.databaseForests Returns a sequence of forest IDs in the specified database.
xdmp.databaseGlobalNonblockingTimestamp Returns the most recent commit timestamp for which a query on the database including its foreign database will not block waiting for transactions to commit or journal frames to arrive from a foreign master.
xdmp.databaseIsForestRetired This function returns true if the specified forest is retired and false the specified forest is not retired.
xdmp.databaseIsRebalancerEnable This function returns the rebalancer enable setting for the specified database.
xdmp.databaseIsReplica Tests if a database is a replica of a foreign database.
xdmp.databaseName Return the name of the database with the given ID.
xdmp.databaseNonblockingTimestamp Returns the most recent commit timestamp for which a query on the database will not block waiting for transactions to commit or journal frames to arrive from a foreign master.
xdmp.databasePathNamespaces Returns the list of path namespaces for the given database id.
xdmp.databases Returns a sequence of the IDs of all the databases in the system.
xdmp.documentForest Returns the forest ID of the forest in which a document (or a lock or a property) with the specified URI is stored.
xdmp.documentGet Returns the document in the file specified by $location.
xdmp.documentTimestamp Returns timestamp of the most recent visible update to a document, lock, or property.
xdmp.effectiveVersion Returns the effective version of this host
xdmp.elapsedTime Returns the elapsed time since the start of processing of this query.
xdmp.externalBinary Returns an external binary node.
xdmp.externalBinaryPath Return the path to the external file associated with an external binary document.
xdmp.foreignClusters Returns the IDs of the foreign clusters.
xdmp.forest Returns the ID of the forest specified as the parameter.
xdmp.forestDatabases Returns the database ID corresponding to the database to which the specified forest belongs, or empty sequence if the forest belongs to no database.
xdmp.forestFailoverInfo Return a sequence of pair of the forest IDs and host IDs for the failover forests and hosts of the given forest.
xdmp.forestHost Return the host of the forest with the given id.
xdmp.forestName Return the name of the forest with the given ID.
xdmp.forests Returns a sequence of the IDs of all the forests in the system.
xdmp.forestUpdatesAllowed Return updates allowed state of the forest with the given ID.
xdmp.getOrphanedBinaries 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.groupGetAuditEventTypeEnabled This function returns the audit event type's enabled setting for the audit configuration.
xdmp.groupHosts Returns the IDs of all hosts belonging to the group with the given ID.
xdmp.groupName Returns the name of the group with the given ID.
xdmp.groupPortServers Returns the IDs of all port App Servers belonging to the group with the given ID.
xdmp.groups Returns a sequence of the IDs of all the groups in the system.
xdmp.groupServers Returns the IDs of all App Servers belonging to the group with the given ID.
xdmp.groupTaskServer Returns the ID of the Task Server belonging to the group with the given ID.
xdmp.healthcheckStatus Returns the health check status of each component in the current cluster.
xdmp.host Returns the ID of the host named in the parameter.
xdmp.hostForests Returns a sequence of forest IDs in the specified host.
xdmp.hostGroup Returns the ID of the group that the specified host belongs to.
xdmp.hostMode Returns this host mode
xdmp.hostModeDescription Return the description string for this host mode setting
xdmp.hostName Returns the name of the specified host.
xdmp.hosts Returns a sequence of the IDs of all the hosts in the cluster.
xdmp.log Flush the log of the specific app server error log file.
xdmp.logLevel Retrieves the current server log level.
xdmp.mimetypes This function returns all the mimetypes specifications of the cluster.
xdmp.modulesDatabase Returns the database ID of the modules database.
xdmp.modulesRoot Returns the current root path for modules.
xdmp.platform Returns the operating-system platform upon which MarkLogic Server is running ("winnt", "linux", or "macosx").
xdmp.prettyPrint Returns a well-formatted XQuery module.
xdmp.productEdition Returns the current MarkLogic product edition.
xdmp.productEnvironment Returns the current MarkLogic product environment.
xdmp.queryMeters Returns the current value of the resource meters for this query sequence as a JSON node.
xdmp.queryTrace Enables or disables tracing of this query.
xdmp.removeOrphanedBinary 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.schemaDatabase Returns the database ID of the schema database associated with the current database.
xdmp.securityDatabase Returns the database ID of the security database associated with the current database.
xdmp.server Return the ID(s) of the App Servers, XDBC Servers, ODBC Servers, or Task Servers with the given name.
xdmp.serverCollation Return the default collation of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverCoordinateSystem Return the default coordinate system of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverDatabase Return the database ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverDefaultXqueryVersion Return the default xquery version of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverGroup Return the ID of the group for an App Server, XDBC Server, ODBC Server, or Task Server.
xdmp.serverKind Return the kind of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverMaxThreads 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.serverModulesDatabase Return the modules database ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverName Return the name of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverPort Return the port of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverRoot Return the root of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.servers Returns a sequence of the IDs of all the App Servers (HTTP, XDBC, ODBC, and TaskServer) in the system.
xdmp.serverSessionTimeout Return the session timeout of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverSslCertificateTemplate Return the SSL certificate template ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.softwareVersion Returns this host's software version
xdmp.streamable Returns a sequence of strings describing the streaming nature of the argument value.
xdmp.subbinary Returns a binary node made up of a subset of the given binary node.
xdmp.trace Signal a trace event.
xdmp.traceEnabled Returns whether or not a trace event is enabled.
xdmp.triggersDatabase Returns the database ID of the triggers database associated with the current database.
xdmp.uriContentType Returns the content type of the given URI as matched in the mimetypes configuration.
xdmp.uriFormat Returns the format of the given URI as matched in the mimetypes configuration.
xdmp.validate Returns an element containing a summary of validation errors in a node.
xdmp.version Returns the current MarkLogic Server version.