Loading TOC...

xdmp 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:

396 functions
Function nameDescription
xdmp.accessReturns whether a given action on the specified document URI would succeed.
xdmp.add64Add two 64-bit integer values, discarding overflow.
xdmp.addResponseHeaderAdds an HTTP response header field.
xdmp.ampReturns the amp ID for the specified amp.
xdmp.ampRolesReturns the set of all roles assigned to an amp, including roles directly assigned to the amp and roles inherited by other roles.
xdmp.and64AND two 64-bit integer values.
xdmp.applyApplies an xdmp:function with the given parameters.
xdmp.architectureReturns the hardware architecture upon which MarkLogic Server is running.
xdmp.arrayValuesReturns the array values as a Sequence.
xdmp.atomizableReturns true if a value could be atomized without error.
xdmp.base64DecodeConverts base64-encoded string to plaintext.
xdmp.base64EncodeConverts plaintext into base64-encoded string.
xdmp.binaryDecodeConverts an encoded byte sequence, passed in as a binary node, from the specified encoding to a unicode string.
xdmp.binaryIsExternalTest whether or not a binary node represents an external binary.
xdmp.binaryIsLargeCheck whether a binary node is a large binary.
xdmp.binaryIsSmallCheck whether a binary node is a small binary.
xdmp.binarySizeReturns the size of the data, in bytes, represented by a binary node.
xdmp.binaryToIntegerParses a binary string, returning an integer.
xdmp.bootstrapHostsReturns a sequence of the IDs of all the bootstrap hosts in the cluster.
xdmp.cacheStatusReturns the status of the caches as a Sequence of ObjectNodes.
xdmp.callerDialectReturns the dialect (e.g., "javascript", "1.0-ml", etc) of the caller or the empty sequence if no dialect information is available.
xdmp.canGrantRolesTests whether a user can grant or revoke a set of roles.
xdmp.castableAsReturns true if a value is castable.
xdmp.clusterReturns the ID of the cluster named in the parameter.
xdmp.clusterEffectiveVersionReturns the current MarkLogic Server effective version.
xdmp.clusterNameReturns the name of the cluster with the specified ID.
xdmp.clusterVersionAtLeastReturns true current MarkLogic Server effective version is equal or greater that the version
xdmp.collationCanonicalUriReturns the canonical URI for the given URI, if it represents a valid collation.
xdmp.collectionDeleteDeletes from the database every document in a collection.
xdmp.collectionLocksReturns locks of documents in a collection.
xdmp.collectionPropertiesReturns a sequence of properties documents, one for each document in the specified collection(s) that has a corresponding properties document.
xdmp.commitCommit the current transaction to the database.
xdmp.configurationTimestampReturns timestamp of last configuration changed
xdmp.credentialReturns the credential
xdmp.credentialIdReturns the id of a named credential.
xdmp.credentialsReturns the credentials that the current user is allowed to use.
xdmp.cryptCalculates the password hash for the given password and salt.
xdmp.crypt2Calculates the password hash for the given plain-text password.
xdmp.databaseReturns the ID of the database named in the parameter.
xdmp.databaseAssignmentPolicyThis function returns the assignment policy for the specified database.
xdmp.databaseBackupStarts an asynchronous backup of the specified list of forests to the backup data directory.
xdmp.databaseBackupCancelCancels 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.databaseBackupPurgePurge old backups from a directory.
xdmp.databaseBackupStatusChecks the status of the outstanding backup job with the specified job ID.
xdmp.databaseBackupValidateValidates that the specified list of forests can be backed up to the backup data directory.
xdmp.databaseDirectoryCreationThis function returns the directory creation setting for the specified database.
xdmp.databaseEncryptionAtRestReturns the encryption at rest setting for the database identified by database-id
xdmp.databaseEncryptionKeyIdReturns the encryption key ID for the database identified by database-id
xdmp.databaseForestsReturns a sequence of forest IDs in the specified database.
xdmp.databaseGlobalNonblockingTimestampReturns 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.databaseIncrementalBackupStarts an asynchronous incremental backup of the specified list of forests to the backup data directory.
xdmp.databaseIncrementalBackupValidateValidates that the specified list of forests can be backed up to the backup data directory.
xdmp.databaseIsForestRetiredThis function returns true if the specificed forest is retired and false the specificed forest is not retired.
xdmp.databaseIsRebalancerEnableThis function returns the rebalancer enable setting for the specified database.
xdmp.databaseIsReplicaTests if a database is a replica of a foreign database.
xdmp.databaseJournalArchivePurgePurge journal archive before last incremental backup from a directory.
xdmp.databaseNameReturn the name of the database with the given ID.
xdmp.databaseNodeQueryRolesetsReturn a sequence of query-rolesets that are required for proper querying of the given database nodes with Element Level Security.
xdmp.databaseNonblockingTimestampReturns 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.databasePathNamespacesReturns the list of path namespaces for the given database id.
xdmp.databaseRestoreStarts an asynchronous restore of the specified list of forests from the backup data directory.
xdmp.databaseRestoreCancelCancels 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.databaseRestoreStatusChecks the status of the outstanding restore job with the specified job ID.
xdmp.databaseRestoreValidateValidates that the specified list of forests can be restored from the backup data directory.
xdmp.databasesReturns a sequence of the IDs of all the databases in the system.
xdmp.daynameFromDateReturns an xs:string representing the dayname value in the localized value of $arg.
xdmp.decodeFromNCNameInvertible function that decodes characters an NCName produced by xdmp:encode-for-NCName.
xdmp.defaultCollectionsReturns the collections any new document would get if the current user were to insert a document without specifying the collections.
xdmp.defaultPermissionsReturns the permissions any new document would get if the current user were to insert a document without specifying the default permissions.
xdmp.describeReturns a string representing the description of a given item sequence.
xdmp.diacriticLessReturns the specified string, converting all of the characters with diacritics to characters without diacritics.
xdmp.directoryReturns the documents from the database in a directory.
xdmp.directoryCreateCreates a directory.
xdmp.directoryDeleteDeletes a directory and all of its child and descendant documents and directories from the database.
xdmp.directoryLocksReturns locks of documents in a directory.
xdmp.directoryPropertiesReturns a sequence of properties documents, one for each document in the specified directory that has a corresponding properties document.
xdmp.documentAddCollectionsAdds the named document to the given collections.
xdmp.documentAddPermissionsAdds the given permissions to the given document or directory.
xdmp.documentAddPropertiesAdds a sequence of properties to the properties of a document.
xdmp.documentAssignAssign a document URI to a forest index, using the same algorithm as xdmp:document-insert.
xdmp.documentDeleteDeletes a document from the database.
xdmp.documentFilterFilters a wide variety of document formats, extracting metadata and text, and returning XHTML.
xdmp.documentForestReturns the forest ID of the forest in which a document (or a lock or a property) with the specified URI is stored.
xdmp.documentGetReturns the document in the file specified by $location.
xdmp.documentGetCollectionsReturns the collections to which a given document belongs.
xdmp.documentGetMetadataReturns the metadata value of a given document.
xdmp.documentGetMetadataValueReturns the metadata value of a given document.
xdmp.documentGetPermissionsReturns the permissions to a given document.
xdmp.documentGetPropertiesReturns the property values for a document's property.
xdmp.documentGetQualityReturns the quality of the specified document if the document exists.
xdmp.documentInsertInserts a new document into the database if a document with the specified URI does not already exist.
xdmp.documentLoadInserts a new document with the specified URI.
xdmp.documentLocksReturns the locks for one or more documents or directories.
xdmp.documentPartitionAssignAssign a document to a partition number, using the partition queries in the database or in the second argument.
xdmp.documentPropertiesReturns a sequence of properties documents, one for each of the specified documents that has a corresponding properties document.
xdmp.documentPutMetadataAdds metadata to the document.
xdmp.documentRemoveCollectionsRemoves the named document from the given collections.
xdmp.documentRemoveMetadataRemoves metadata with certain keys from a document.
xdmp.documentRemovePermissionsRemoves the given permissions from the named document or directory.
xdmp.documentRemovePropertiesRemoves a sequence of properties from the properties of a document.
xdmp.documentSetCollectionsSets the named document to belong to the given collections, replacing any previously set collections on the named document.
xdmp.documentSetMetadataSets metadata to the document.
xdmp.documentSetPermissionsSets the permissions on the named document (or directory) to the given permissions, replacing any permissions previously set on the document (or directory).
xdmp.documentSetPropertiesSets the properties of a document to the given sequence of elements, replacing any properties that already exist on the document.
xdmp.documentSetPropertySets a property on a document.
xdmp.documentSetQualitySets the quality of the document with the given URI.
xdmp.documentTimestampReturns timestamp of the most recent visible update to a document, lock, or property.
xdmp.effectiveVersionReturns the effective version of this host
xdmp.elapsedTimeReturns the elapsed time since the start of processing of this query.
xdmp.elementContentTypeReturns the schema-defined content-type of an element ("empty", "simple", "element-only", or "mixed").
xdmp.emailSend an email in a JavasCript program.
xdmp.encodeForNCNameInvertible function that escapes characters required to be part of an NCName.
xdmp.encodingLanguageDetectAnalyzes binary, text, or XML data and suggests possible pairs of encoding and language, with a confidence score for each pair.
xdmp.evalReturns the result of evaluating a string as a Javascript program.
xdmp.excelConvertConverts a Microsoft Excel document to XHTML.
xdmp.externalBinaryReturns an external binary node.
xdmp.externalBinaryPathReturn the path to the external file associated with an external binary document.
xdmp.externalSecurityReturns the external security ID for the specified external security name.
xdmp.filesystemDirectoryPerforms a directory listing of the given file pathname.
xdmp.filesystemDirectoryCreateCreates the directory specified by pathname.
xdmp.filesystemDirectoryDeleteDeletes the directory specified by pathname.
xdmp.filesystemFileReads a file from the filesystem.
xdmp.filesystemFileEncryptionStatusReturn the file's encryption status
xdmp.filesystemFileExistsReturn true if a file exists on a host; otherwise false.
xdmp.filesystemFileGetTimeReturns access and modification time for a file.
xdmp.filesystemFileLengthReads the length of a file from the filesystem.
xdmp.filesystemFilepathReturns the canonicalized file path of the input path.
xdmp.filesystemFileSetTimeSets access and modification time for a file.
xdmp.foreignClustersReturns the IDs of the foreign clusters.
xdmp.foreignClusterStatusReturns the status of a foreign cluster from a host's point of view as a JSON node.
xdmp.forestReturns the ID of the forest specified as the parameter.
xdmp.forestBackupBacks up forest data files.
xdmp.forestBackupStatusChecks the status of the specified forests for any outstanding backup jobs.
xdmp.forestClearClears forest data files, including all stands and journals.
xdmp.forestCountsReturns detailed forest statistics for a given forest as a Sequence of ObjectNodes.
xdmp.forestDatabasesReturns the database ID corresponding to the database to which the specified forest belongs.
xdmp.forestFailoverInfoReturn a sequence of pair of the forest IDs and host IDs for the failover forests and hosts of the given forest.
xdmp.forestHostReturn the host of the forest with the given id.
xdmp.forestNameReturn the name of the forest with the given ID.
xdmp.forestOnlineReturns 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.forestOpenReplicaReturns the forest ID for each specified forest or for each forest's replica if the forest is currently experiencing a local disk failover.
xdmp.forestRestartRestarts a forest.
xdmp.forestRestoreRestores forest data files.
xdmp.forestRollbackRolls forests back to a previous point in time, marking any fragment newer than the specified timestamp as deleted.
xdmp.forestsReturns a sequence of the IDs of all the forests in the system.
xdmp.forestStateReturns state of the forests
xdmp.forestStatusReturns the status of a forest as a Sequence of ObjectNodes.
xdmp.forestUpdatesAllowedReturn updates allowed state of the forest with the given ID.
xdmp.formatNumberReturns a formatted number value based on the picture argument.
xdmp.fromJSONAtomizes a JSON node, returning a JSON value.
xdmp.fromJsonStringParses a string as JSON, returning an item sequence.
xdmp.functionReturns a function value as an xdmp.function type.
xdmp.functionModuleReturns the module location (if any) that the xdmp:function value refers to.
xdmp.functionNameReturns the QName of the function(s) that the xdmp:function refers to.
xdmp.functionParameterNameReturns the name of the parameter at the designated (1-based) position from the given function's signature.
xdmp.functionParameterTypeReturns the type of the parameter at the designated (1-based) position from the given function's signature.
xdmp.functionReturnTypeReturns the return type from the given function's signature.
xdmp.functionSignatureReturns the signature of the function that the argument refers to.
xdmp.getCurrentRolesReturns all the current roles, both assigned and inherited by the current user and any received from amps.
xdmp.getCurrentUserReturns the name of the current user.
xdmp.getCurrentUseridReturns the ID of the current user.
xdmp.getInvokedPathReturns the path of the module that is being invoked.
xdmp.getOriginalUrlReturns the portion of the URL following the host_name:port_number.
xdmp.getOrphanedBinariesReturns a sequence of the IDs of all orphaned large binaries in a given forest.
xdmp.getRequestBodyFor PUT requests, returns the body of the request.
xdmp.getRequestClientAddressReturns as a string the internet address of the client from which the HTTP server request is issued.
xdmp.getRequestClientCertificateReturns the PEM encoded client certificate if one was presented.
xdmp.getRequestErrorFormatReturns the current error format for the request.
xdmp.getRequestFieldReturns the value of a named request field.
xdmp.getRequestFieldContentTypeThis function is used to extract the content type from the request field.
xdmp.getRequestFieldFilenameReturns a list of filenames from a multipart request for the field name specified.
xdmp.getRequestFieldNamesReturns a sequence of the request field names.
xdmp.getRequestHeaderReturns the value of a named request header.
xdmp.getRequestHeaderNamesReturns a sequence of request header names.
xdmp.getRequestMethodReturns the HTTP request method.
xdmp.getRequestPathReturns the HTTP request path.
xdmp.getRequestPortReturns the port of the request.
xdmp.getRequestProtocolReturns as a string the request protocol (either "http" or "https") Returns the empty sequence if it is not called from an HTTP server.
xdmp.getRequestUrlReturns the portion of the URL following the host_name:port_number.
xdmp.getRequestUserIf this App Server is using application-level authentication, returns the ID of the user in the last successful call to xdmp:login.
xdmp.getRequestUsernameIf this App Server is using application-level authentication, returns the username in the last successful call to xdmp:login.
xdmp.getResponseCodeReturns two nodes, the first containing the HTTP response code and the second containing the HTTP response message.
xdmp.getResponseEncodingReturns the encoding that the response from this server is in.
xdmp.getServerFieldReturns the value of a named server field.
xdmp.getServerFieldNamesReturns a sequence of the server field names.
xdmp.getSessionFieldReturns the value of a named session field from the session created by the xdmp:login function.
xdmp.getSessionFieldNamesReturns a sequence of the HTTP session field names from the session created by the xdmp:login function.
xdmp.getTransactionModeRetrieve the transaction mode for the current session.
xdmp.getUrlRewriterPathReturns the URL of the URL rewriter handler for this application server.
xdmp.groupReturns the ID of the group specified in the parameter.
xdmp.groupGetAuditEventTypeEnabledThis function returns the audit event type's enabled setting for the audit configuration.
xdmp.groupHostsReturns the IDs of all hosts belonging to the group with the given ID.
xdmp.groupNameReturns the name of the group with the given ID.
xdmp.groupsReturns a sequence of the IDs of all the groups in the system.
xdmp.groupServersReturns the IDs of all App Servers belonging to the group with the given ID.
xdmp.gssServerNegotiateThis function is used for kerberos GSS authentication in application level authentication.
xdmp.gunzipGet a node from a gzip node.
xdmp.gzipCreate a gzip node from a node.
xdmp.hash32Returns the 32-bit hash of a string.
xdmp.hash64Returns the 64-bit hash of a string.
xdmp.hasPrivilegeTests whether the current user has at least one of a given set of privileges.
xdmp.hexToIntegerParses a hexadecimal string, returning an integer.
xdmp.hmacMd5Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
xdmp.hmacSha1Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
xdmp.hmacSha256Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
xdmp.hmacSha512Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
xdmp.hostReturns the ID of the host named in the parameter.
xdmp.hostForestsReturns a sequence of forest IDs in the specified host.
xdmp.hostGetSslFipsEnabledReturns whether fips mode is enabled.
xdmp.hostGroupReturns the ID of the group that the specified host belongs to.
xdmp.hostModeReturns this host mode
xdmp.hostModeDescriptionReturn the description string for this host mode setting
xdmp.hostNameReturns the name of the specified host.
xdmp.hostsReturns a sequence of the IDs of all the hosts in the cluster.
xdmp.hostStatusReturns the status of a host as a JSON node.
xdmp.httpDeleteSends an http DELETE request to the http server specified in the URI to delete the specified resource.
xdmp.httpGetSends the http GET method to the specified URI.
xdmp.httpHeadSends the http HEAD method to the specified URI.
xdmp.httpOptionsSends the http OPTIONS method to the specified URI.
xdmp.httpPostSends an http POST request to the server.
xdmp.httpPutSends an HTTP PUT request to an HTTP server.
xdmp.initcapReturns the string where the first letter of each token has been uppercased.
xdmp.integerToBinaryReturns a binary representation of an integer.
xdmp.integerToHexReturns a hexadecimal representation of an integer.
xdmp.integerToOctalReturns an octal representation of an integer.
xdmp.invokeReturns the result of evaluating a module at the given path.
xdmp.invokeFunctionReturns the result of evaluating a JavaScript function value.
xdmp.isWhitespaceNodeReturns true if the node is a text node containing only whitespace.
xdmp.keyFromQNameConstruct a context-independent string from a QName.
xdmp.keystoreExportExports all encryption keys stored in the MarkLogic embedded KMS.
xdmp.keystoreImportImport encryption keys into the MarkLogic embedded KMS from an exported encrypted file (see keystore-export).
xdmp.keystoreStatusReturns the status of the keystore
xdmp.keystoreValidateExportedValidates the content of an exported keystore file, see keystore-export and keystore-import
xdmp.ldapLookupReturns an ldap entry.
xdmp.ldapSearchReturns 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.lockAcquireAcquire a lock on a document or directory for an extended amount of time.
xdmp.lockForUpdateAcquires an intent exclusive transaction lock on a URI.
xdmp.lockReleaseUnlock a document or directory.
xdmp.logLogs a message into a specific app server error log file.
xdmp.loginLogs 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.logLevelRetrieves the current server log level.
xdmp.logoutLogs the current user out of the session on the server.
xdmp.lshift64Left-shift a 64-bit integer value.
xdmp.md5Calculates the md5 hash of the given argument.
xdmp.mergeStarts merging the forests of the database, subject to specified options.
xdmp.mergeCancelCancel the merge with the specified merge ID on a forest with the specified forest ID.
xdmp.mergingReturns the forest IDs of any currently merging database forests.
xdmp.mimetypesThis function returns all the mimetypes specifications of the cluster.
xdmp.modulesDatabaseReturns the database ID of the modules database.
xdmp.modulesRootReturns the current root path for modules.
xdmp.monthNameFromDateReturns month name, calculated from the localized value of $arg.
xdmp.mul64Muliply two 64-bit integer values, discarding overflow.
xdmp.multipartDecodeExtract the parts from a multipart encoding.
xdmp.multipartEncodeCreate a multipart encoding of the specified node.
xdmp.nodeCollectionsReturns any collections for the node's document in the database.
xdmp.nodeDatabaseReturns the database id where the parameter is stored.
xdmp.nodeDeleteDeletes a node from the database.
xdmp.nodeInsertAfterAdds an immediately following sibling to a node.
xdmp.nodeInsertBeforeAdds an immediately preceding sibling to a node.
xdmp.nodeInsertChildAdds a new last child to a node.
xdmp.nodeKindReturns an xs:string representing the node's kind: either "document", "element", "attribute", "text", "namespace", "processing-instruction", "binary", or "comment".
xdmp.nodeMetadataReturns the metadata value of a given node.
xdmp.nodeMetadataValueReturns the metadata value of a node for a particular key.
xdmp.nodePermissionsReturns the permissions to a node's document.
xdmp.nodeQueryRolesetsReturn 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.nodeReplaceReplaces a node.
xdmp.nodeUriReturns the document-uri property of the parameter or its ancestor.
xdmp.not64NOT a 64-bit integer value.
xdmp.octalToIntegerParses an octal string, returning an integer.
xdmp.or64OR two 64-bit integer values.
xdmp.parseDateTimeParses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
xdmp.parseYymmddParses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
xdmp.partitionForestsReturns a seequence of forest IDs with the specified partition number
xdmp.passiveHasPrivilegeTests whether the current user has at least one of a given set of privileges.
xdmp.passiveSecurityAssertTests whether the current user has at least one of a given set of privileges.
xdmp.pathReturns a string whose value corresponds to the path of the node.
xdmp.pdfConvertConverts a PDF file to XHTML.
xdmp.permissionReturns a permission object corresponding to the named role and capability given.
xdmp.platformReturns the operating-system platform upon which MarkLogic Server is running ("solaris", "winnt", "linux", or "macosx").
xdmp.positionReturns an integer value representing the starting position of a string within the search string.
xdmp.powerpointConvertConverts a Microsoft Powerpoint document to XHTML.
xdmp.prettyPrintReturns a well-formatted XQuery module.
xdmp.privilegeReturns the privilege ID for the specified privilege name.
xdmp.privilegeRolesReturns the set of all roles that have a given privilege.
xdmp.productEditionReturns the current MarkLogic product edition.
xdmp.productEnvironmentReturns the current MarkLogic product environment.
xdmp.QNameFromKeyConstruct a QName from a string of the form "{namespaceURI}localname".
xdmp.quarterFromDateReturns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of $arg.
xdmp.queryMetersReturns the current value of the resource meters for this query sequence as a JSON node.
xdmp.queryPartitionsThis function returns the partition numbers of the partitions that the specified query will be searched on.
xdmp.queryTraceEnables or disables tracing of this query.
xdmp.quoteReturns the unevaluated serialized representation of the input parameter as a string.
xdmp.randomReturns a random unsigned integer between 0 and a number up to 64 bits long.
xdmp.rangePartitionForestsGiven a value, the function returns a list of forests that have ranges the value falls into.
xdmp.redirectResponseRedirects the App Server response to a given location.
xdmp.removeOrphanedBinaryRemove an orphaned large binary
xdmp.requestReturns the unique key of the current request.
xdmp.requestCancelCancel the request with the given host, server, and request IDs.
xdmp.requestStatusReturns the status of a running request as a Sequence of ObjectNodes.
xdmp.requestTimestampReturns the system timestamp for this request if the request is a query statement.
xdmp.resolveUriResolves a relative URI against an absolute URI.
xdmp.restartRestart servers on hosts.
xdmp.rethrowWithin the catch section of a try-catch expression, re-throw the currently caught error.
xdmp.roleReturns the role ID for the specified role name.
xdmp.roleNameReturns the role name for the specified role id.
xdmp.roleRolesReturns the set of all roles inherited by a given role, including roles directly assigned to the role and roles inherited from other roles.
xdmp.rollbackRoll back the current transaction.
xdmp.rsaGenerateGenerate a new RSA public/private key pair.
xdmp.rshift64Right-shift a 64-bit integer value.
xdmp.saveSerializes a node as text and saves it to a file.
xdmp.schemaDatabaseReturns the database ID of the schema database associated with the current database.
xdmp.securityAssertTests whether the current user has at least one of a given set of privileges.
xdmp.securityDatabaseReturns the database ID of the security database associated with the current database.
xdmp.serverReturn the ID(s) of the App Servers, XDBC Servers, ODBC Servers, or Task Servers with the given name.
xdmp.serverCollationReturn the default collation of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverCoordinateSystemReturn the default coordinate system of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverDatabaseReturn the database ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverDefaultXqueryVersionReturn the default xquery version of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverGroupReturn the ID of the group for an App Server, XDBC Server, ODBC Server, or Task Server.
xdmp.serverModulesDatabaseReturn the modules database ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverNameReturn the name of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverPortReturn the port of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverRootReturn the root of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serversReturns a sequence of the IDs of all the App Servers (HTTP, XDBC, ODBC, and TaskServer) in the system.
xdmp.serverSslCertificateTemplateReturn the SSL certificate template ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID.
xdmp.serverStatusReturns the status of an app-server on a host as a Sequence of ObjectNodes.
xdmp.setRequestTimeLimitChanges the time limit for an actively running request to the specified value.
xdmp.setResponseCodeSets the response code and message.
xdmp.setResponseContentTypeSets the response content-type.
xdmp.setResponseEncodingSets the response encoding.
xdmp.setResponseOutputMethodSets the serialization method.
xdmp.setServerFieldSets the value of a named server field.
xdmp.setServerFieldPrivilegeSets the privilege of a named server field.
xdmp.setSessionFieldSets the value of a named session field for the session created by the xdmp:login function.
xdmp.setTransactionModeSet the transaction mode for the current session.
xdmp.setTransactionNameSet the name of a local or remote transaction.
xdmp.setTransactionTimeLimitSet the transaction time limit for a local or remote transaction.
xdmp.sha1Calculates the SHA1 hash of the given argument.
xdmp.sha256Calculates the SHA256 hash of the given argument.
xdmp.sha384Calculates the SHA384 hash of the given argument.
xdmp.sha512Calculates the SHA512 hash of the given argument.
xdmp.shutdownShutdown servers on hosts.
xdmp.sleepDelays for a specific amount of time.
xdmp.softwareVersionReturns this host's software version
xdmp.spawnPlace the specified module on the task queue for evaluation.
xdmp.sqlExecutes an ad hoc SQL query.
xdmp.sqlPlanReturns a node representing the query plan of the given SQL SELECT query.
xdmp.startJournalArchivingStarts journal archiving to the specified list of forests.
xdmp.step64Combines an initial hash with a subsequent hash.
xdmp.stopJournalArchivingStops journal archiving to the specified list of forests.
xdmp.strftimeFormats a dateTime value using POSIX strftime.
xdmp.subbinaryReturns a binary node made up of a subset of the given binary node.
xdmp.tidyRun tidy on the specified html document to convert the document to well-formed and clean XHTML.
xdmp.timestampToWallclockConverts a 64 bit timestamp value to an xs:dateTime.
xdmp.toJSONConstructs a JSON document.
xdmp.toJsonStringReturns a string representing a JSON serialization of a given item sequence.
xdmp.traceSignal a trace event.
xdmp.traceEnabledReturns whether or not a trace event is enabled.
xdmp.transactionReturns the transaction ID for the current transaction, or transaction IDs for all transactions with the given name.
xdmp.transactionCommitExplicitly commit a transaction running on a named host.
xdmp.transactionLocksReturns all URIs currently locked for read or write by a transaction.
xdmp.transactionRollbackExplicitly roll back a transaction running on a named host.
xdmp.triggersDatabaseReturns the database ID of the triggers database associated with the current database.
xdmp.typeReturns the name of the simple type of the atomic value argument as an xs:QName.
xdmp.unquoteParses a string as XML, returning one or more document nodes.
xdmp.uriContentTypeReturns the content type of the given URI as matched in the mimetypes configuration.
xdmp.uriFormatReturns the format of the given URI as matched in the mimetypes configuration.
xdmp.uriIsFileReturns true if a given URI refers to a file which exists on the current application server.
xdmp.urlDecodeConverts URL-encoded string to plaintext.
xdmp.urlEncodeConverts plaintext into URL-encoded string.
xdmp.userReturns the user ID for the specified user name.
xdmp.userExternalSecurityReturns external security id and user name for an external user.
xdmp.useridRolesReturns all roles assigned to a user, including roles directly assigned to the user and roles inherited by other roles.
xdmp.userLastLoginReturns the last-login node for the current user.
xdmp.userRolesReturns all roles assigned to a user, including roles directly assigned to the user and roles inherited by other roles.
xdmp.validateReturns an element containing a summary of validation errors in a node.
xdmp.versionReturns the current MarkLogic Server version.
xdmp.wallclockToTimestampConverts an xs:dateTime to a 64 bit timestamp value.
xdmp.weekdayFromDateReturns an xs:integer in the range 1 to 7, inclusive, representing the weekday value in the localized value of $arg.
xdmp.weekFromDateReturns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of $arg.
xdmp.wordConvertConverts a Microsoft Word document to XHTML.
xdmp.x509CertificateExtractReturns the XML representation of the specified X.509 certificate.
xdmp.x509CertificateGenerateGenerate a new PEM-encoded X.509 certificate.
xdmp.x509CertificateIssuerNameReturns the issuer distinguished name for the specified X.509 certificate.
xdmp.x509CertificateSubjectNameReturns the subject distinguished name for the specified X.509 certificate.
xdmp.xaCompleteCompletes (commits or rolls back) a prepared XA transaction.
xdmp.xaForgetForgets a remembered completed XA transaction.
xdmp.xor64XOR two 64-bit integer values.
xdmp.xqueryEvalReturns the result of evaluating a string as an XQuery module.
xdmp.xsltEvalExecutes an XSLT stylesheet against a node.
xdmp.xsltInvokeExecutes an XSLT stylesheet against a node.
xdmp.yeardayFromDateReturns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of $arg.
xdmp.zipCreateCreate a zip file from a list of nodes.
xdmp.zipGetGet a named file from a zip document.
xdmp.zipManifestReturn a manifest for this zip file.
Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy