restore-datalake¶

Description¶

Restore the datalake from a backup that was taken. Backup to be used for restore is identified based on the information provided in the restore request. BackupId and BackupName are mutually exclusive. Only one of them can be provided. If both are provided, BackupId takes precedence.

Synopsis¶

  restore-datalake
--datalake-name <value>
[--backup-id <value>]
[--backup-name <value>]
[--include-database | --no-include-database]
[--skip-ranger-hms-metadata | --no-skip-ranger-hms-metadata]
[--skip-atlas-metadata | --no-skip-atlas-metadata]
[--skip-ranger-audits | --no-skip-ranger-audits]
[--skip-atlas-indexes | --no-skip-atlas-indexes]
[--backup-location-override <value>]
[--skip-validation | --no-skip-validation]
[--validation-only | --no-validation-only]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--datalake-name (string)

The name of the datalake to be restored. When backup-id is not provided, the most recent successful backup on datalake with the provided name would be used.

--backup-id (string)

The ID of the backup to be used to perform a restore. The ID could refer to backup of any datalake in the same account. This is the only way to restore from a backup that was taken on a datalake with a different name. This field is required if the –backup-location-override field is used.

--backup-name (string)

The name of the backup. When provided, the restore will be performed using the latest successful backup whose name matches the parameter, and that was taken from the datalake that is being restored.

--include-database | --no-include-database (boolean)

DEPRECATED - The database is included in the restore by default. To skip it, use the –skip-ranger-hms-metadata flag.

--skip-ranger-hms-metadata | --no-skip-ranger-hms-metadata (boolean)

Skips the restore of the databases backing HMS/Ranger services. If this option is not provided, then by default the Atlas lineage will be restored if the backup used includes the Atlas lineage information.

--skip-atlas-metadata | --no-skip-atlas-metadata (boolean)

Skips the restore of the Atlas metadata. If this option is not provided, then by default the Atlas metadata will be restored if the backup used includes the Atlas metadata.

--skip-ranger-audits | --no-skip-ranger-audits (boolean)

Skips the restore of the Ranger audits. If this option is not provided, then by default the Ranger audits will be restored if the backup used includes the Ranger audits.

--skip-atlas-indexes | --no-skip-atlas-indexes (boolean)

Skips the restore of the Atlas indexes. If this option or –skipAtlasMetadata is not provided, then by default the Atlas indexes will be restored if the backup used includes the Atlas indexes. Redundant if –skipAtlasMetadata is included.

--backup-location-override (string)

Backup location. When provided, will be used to lookup the backup. If provided, the –backup-id parameter is required.

--skip-validation | --no-skip-validation (boolean)

Skips the validation steps that run prior to the restore. If this option is not provided, the validations are performed by default.

--validation-only | --no-validation-only (boolean)

Runs only the validation steps and then returns. If this option is not provided, the restore is performed as normal by default.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

accountId -> (string)

Account where the datalake exists.

restoreId -> (string)

Unique identifier of the restore operation performed.

backupId -> (string)

Unique identifier of the backup used to perform restore.

userCrn -> (string)

Crn of the user who triggered this operation.

internalState -> (string)

Provides the details of the internal state where the restore operation stands.

status -> (string)

Provide the current status.

startTime -> (string)

Time when the backup operation started.

endTime -> (string)

Time when the backup operation ended.

backupLocation -> (string)

Location of the backup to be used to perform restore.

operationStates -> (object)

Object representing the state of each service running a backup.

adminOperations -> (object)

The state of Cloudera Manager admin operations.

stopServices -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

startServices -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

precheckStoragePermission -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

rangerAuditCollectionValidation -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

dryRunValidation -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

hbase -> (object)

The state of each HBase backup/restore operation.

atlasEntityAuditEventTable -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

atlasJanusTable -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

solr -> (object)

The state of each Solr backup/restore operation.

edgeIndexCollection -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

fulltextIndexCollection -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

rangerAuditsCollection -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

vertexIndexCollection -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

edgeIndexCollectionDelete -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

fulltextIndexCollectionDelete -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

rangerAuditsCollectionDelete -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

vertexIndexCollectionDelete -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

database -> (object)

The state of the database backup/restore operation.

database -> (object)

Contains the status and failure reason of an operation.

status -> (string)

The status of the backup or restore operation.

failureReason -> (string)

The failure reason if the operation was not successful.

durationInMinutes -> (string)

The duration of each operation, in minutes.

predictedDurationInMinutes -> (string)

Predicted duration of the operation, in minutes.

backupName -> (string)

Name of the backup.

failureReason -> (string)

Reason for the failure.

runtimeVersion -> (string)

The runtime version of the datalake when the restore was initiated.

Form Factors¶

public