Restore Project

Restore the data of a project from a backup archive file to be found on the Opal file system. The destination project must exist and can have a name different from the original one (beware that this could break views). Default behavior is to stop when an item to restore already exist (override can be forced).

opal restore-project <CREDENTIALS> [OPTIONS] [XTRAS]

Options

Option	Description
--project PROJECT, -pr PROJECT	Destination project name
--archive ARCHIVE, -ar ARCHIVE	Archive directory or zip file path in the Opal file system
--arpassword ARPASSWORD, -arp ARPASSWORD	Password to decrypt zip archive (optional)
--force, -f	Force overwriting existing items (table, view, resource, report). Files override is not checked.

Credentials

Authentication can be done by username/password credentials OR by personal access token OR by certificate/private key pair (two-way SSL authentication).

Option	Description
--opal OPAL, -o OPAL	Opal server base url
--user USER, -u USER	Credentials auth: user name (requires a password)
--password PASSWORD, -p PASSWORD	Credentials auth: user password (requires a user name)
--token TOKEN, -tk TOKEN	Token auth: user’s personal access token
--ssl-cert SSL_CERT, -sc SSL_CERT	Two-way SSL auth: certificate/public key file (requires a private key)
--ssl-key SSL_KEY, -sk SSL_KEY	Two-way SSL auth: private key file (requires a certificate)

Extras

Option	Description
-h, --help	Show the command help’s message.
--verbose, -v	Verbose output.
--json, -j	Output pretty-print JSON

Example

Restore a project from the archive folder CNSIM into an existing project:

opal restore-project --opal https://opal-demo.obiba.org --user administrator --password password --project datashield --archive /home/administrator/backup/CNSIM