MarkLogic Server 11.0 Product Documentation
xdmp functions (Admin)

For the complete list of functions and categories in this namespace, refer to the main xdmp functions page.

39 functions
Function name Description
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-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-journal-archive-purge Purge journal archive before last incremental backup from a directory.
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: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: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-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-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-validate-replica-index Validate index data for the database replica forests of the specified forests.
xdmp:group-cache-clear Clears specified caches for the target group.
xdmp:merge-cancel Cancel the merge with the specified merge ID on a forest with the specified forest ID.
xdmp:restart Restart servers on hosts.
xdmp:shutdown Shutdown servers on hosts.
xdmp:start-journal-archiving Starts journal archiving to the specified list of forests.
xdmp:stop-journal-archiving Stops journal archiving to the specified list of forests.
Powered by MarkLogic Server | Terms of Use | Privacy Policy