Loading TOC...

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.databaseBackup Starts an asynchronous backup of the specified list of forests to the backup data directory.
xdmp.databaseBackupCancel 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.databaseBackupPurge Purge old backups from a directory.
xdmp.databaseBackupStatus Checks the status of the outstanding backup job with the specified job ID.
xdmp.databaseBackupValidate Validates that the specified list of forests can be backed up to the backup data directory.
xdmp.databaseIncrementalBackup Starts an asynchronous incremental backup of the specified list of forests to the backup data directory.
xdmp.databaseIncrementalBackupValidate Validates that the specified list of forests can be backed up to the backup data directory.
xdmp.databaseJournalArchivePurge Purge journal archive before last incremental backup from a directory.
xdmp.databaseRestore Starts an asynchronous restore of the specified list of destination forests from the backup data directory.
xdmp.databaseRestoreCancel 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.databaseRestoreStatus Checks the status of the outstanding restore job with the specified job ID.
xdmp.databaseRestoreValidate Validates that the specified list of destination forests can be restored from the backup data directory.
xdmp.filesystemDirectory Performs a directory listing of the given file pathname.
xdmp.filesystemDirectoryCreate Creates the directory specified by pathname.
xdmp.filesystemDirectoryDelete Deletes the directory specified by pathname.
xdmp.filesystemFile Reads a file from the filesystem.
xdmp.filesystemFileDelete Deletes the file specified by pathname.
xdmp.filesystemFileEncryptionStatus Return the encryption status of a file.
xdmp.filesystemFileExists Return true if a file exists on a host; otherwise false.
xdmp.filesystemFileGetTime Returns access and modification time for a file.
xdmp.filesystemFileLength Reads the length of a file from the filesystem.
xdmp.filesystemFilepath Returns the canonicalized file path of the input path.
xdmp.filesystemFileSetTime Sets access and modification time for a file.
xdmp.forestBackup Backs up forest data files.
xdmp.forestBackupStatus Checks the status of the specified forests for any outstanding backup jobs.
xdmp.forestClear Clears forest data files, including all stands and journals.
xdmp.forestDatabaseReplicationResume Resume database replication with the specified forest IDs.
xdmp.forestDatabaseReplicationSuspend Suspend database replication with the specified forest IDs.
xdmp.forestOpenReplica 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.forestRestart Restarts a forest.
xdmp.forestRestore Restores forest data files.
xdmp.forestRollback Rolls forests back to a previous point in time, marking any fragment newer than the specified timestamp as deleted.
xdmp.forestValidateReplicaIndex Validate index data for the database replica forests of the specified forests.
xdmp.groupCacheClear Clears specified caches for the target group.
xdmp.mergeCancel 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.startJournalArchiving Starts journal archiving to the specified list of forests.
xdmp.stopJournalArchiving Stops journal archiving to the specified list of forests.