Loading TOC...

xdmp functions (Admin)

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

34 functions
Function nameDescription
xdmp:database-backupStarts an asynchronous backup of the specified list of forests to the backup data directory.
xdmp:database-backup-cancelCancels 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-purgePurge old backups from a directory.
xdmp:database-backup-statusChecks the status of the outstanding backup job with the specified job ID.
xdmp:database-backup-validateValidates that the specified list of forests can be backed up to the backup data directory.
xdmp:database-incremental-backupStarts an asynchronous incremental backup of the specified list of forests to the backup data directory.
xdmp:database-incremental-backup-validateValidates that the specified list of forests can be backed up to the backup data directory.
xdmp:database-journal-archive-purgePurge journal archive before last incremental backup from a directory.
xdmp:database-restoreStarts an asynchronous restore of the specified list of forests from the backup data directory.
xdmp:database-restore-cancelCancels 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-statusChecks the status of the outstanding restore job with the specified job ID.
xdmp:database-restore-validateValidates that the specified list of forests can be restored from the backup data directory.
xdmp:filesystem-directoryPerforms a directory listing of the given file pathname.
xdmp:filesystem-directory-createCreates the directory specified by pathname.
xdmp:filesystem-directory-deleteDeletes the directory specified by pathname.
xdmp:filesystem-fileReads a file from the filesystem.
xdmp:filesystem-file-encryption-statusReturn the file's encryption status
xdmp:filesystem-file-existsReturn true if a file exists on a host; otherwise false.
xdmp:filesystem-file-get-timeReturns access and modification time for a file.
xdmp:filesystem-file-lengthReads the length of a file from the filesystem.
xdmp:filesystem-file-set-timeSets access and modification time for a file.
xdmp:filesystem-filepathReturns the canonicalized file path of the input path.
xdmp:forest-backupBacks up forest data files.
xdmp:forest-backup-statusChecks the status of the specified forests for any outstanding backup jobs.
xdmp:forest-clearClears forest data files, including all stands and journals.
xdmp:forest-open-replicaReturns 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-restartRestarts a forest.
xdmp:forest-restoreRestores forest data files.
xdmp:forest-rollbackRolls forests back to a previous point in time, marking any fragment newer than the specified timestamp as deleted.
xdmp:merge-cancelCancel the merge with the specified merge ID on a forest with the specified forest ID.
xdmp:restartRestart servers on hosts.
xdmp:shutdownShutdown servers on hosts.
xdmp:start-journal-archivingStarts journal archiving to the specified list of forests.
xdmp:stop-journal-archivingStops journal archiving to the specified list of forests.
Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy