xdmp.databaseRestoreValidate

xdmp.databaserestorevalidatexdmpdatabaserestorevalidate

/apidoc/8.0/xdmp:database-restore-validate.xml

Validates that the specified list of forests can be restored from the backup data directory. Returns a database restore set node.

A sequence of forest IDs.

forestIDs

String[]

A backup data directory pathname.

pathname

String

The date and time to restore the forest data to.

restoreToTime

Date?

Whether to include replica forests

include-replicas

Boolean?

Whether to restore from archived journals. Defaults to false.

journal-archiving

Boolean?

Path to where archived journals are stored. Defaults to the backup data directory.

journal-archive-path

String?

Whether to restore using incremental backups. Defaults to false.

incremental-backup

Boolean?

Path to where incremental backups are stored. Defaults to the backup data directory.

incremental-backup-path

String?

Object

http://marklogic.com/xdmp/privileges/xdmp-database-restore-validate

xdmp.databaseRestoreValidate(
  xdmp.databaseForests(
            xdmp.database("MyDB")),
    // previously backed-up dir
    "/tmp/database_backup"
)
=>
{
    "tagInfo": {
        "version": "8.0-20141119",
        "jobid": "1975326905393827288",
        "startdate": "2014-11-19T10:37:37",
        "enddate": "2014-11-19T10:37:38"
    }
    ,
    "forests": [
        {
            "forestName": "forest1",
            "forestId": "12393306467180079458",
            "forestStatus": "okay",
            "directoryPath": "/tmp/database_backup/20141119-1037377997450",
            "directoryStatus": "okay",
            "action": "restore",
            "incrementalBackup": false,
            "journalArchiving": false
        },
        {
            "forestName": "forest2",
            "forestId": "2102578687500930109",
            "forestStatus": "okay",
            "directoryPath": "/tmp/database_backup/20141119-1037377997450",
            "directoryStatus": "okay",
            "action": "restore",
            "incrementalBackup": false,
            "journalArchiving": false
        }
    ],
    "databases": [
        {
            "databaseName": "MyDB",
            "databaseId": "13433268924640794832",
            "assignmentPolicyName": "bucket",
            "databaseForests": [
                {
                    "forestName": "forest1",
                    "forestId": "12393306467180079458"
                },
                {
                    "forestName": "forest2",
                    "forestId": "2102578687500930109"
                }
            ]
        }
    ]
}