Skip to main content
show_backup(backup_name=”, datasource_name=None, options=)[source]

Shows information about one or more backups accessible via the data source specified by input parameter datasource_name.

Parameters

backup_name (str) –

Name of the backup. An empty string or ‘*’ will show all existing backups. Any text followed by a ‘*’ will show backups whose name starts with that text. The default value is ‘’.

datasource_name (str) –

Data source through which the backup is accessible.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • backup_id – ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ‘’.

  • backup_type – Show backups by type. This option is ignored if backup_id is non-empty. Allowed values are:

    • all – Show all backup types.

    • full – Show full backups only.

    • incremental – Show incremental backups only.

    • differential – Show differential backups only.

    The default value is ‘all’.

  • show_contents – Show the contents of the backed-up snapshots. Allowed values are:

    • none – Don’t show snapshot contents.

    • object_names – Show backed-up object names, and for tables, sizing detail.

    • object_files – Show backed-up object names, and for tables, sizing detail and associated files.

    The default value is ‘none’.

  • no_error_if_not_exists – Whether or not to suppress the error if the specified backup does not exist. Allowed values are:

    • true

    • false

    The default value is ‘false’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

backup_name (str) –

Value of input parameter backup_name.

backup_description (list of dicts of str to str) –

Details about the overall backup(s).

backup_ids (list of dicts of str to str) –

Details about the individual snapshots contained within the backup(s).

backup_contents (list of dicts of str to str) –

When show_contents is object_names, the names of the backed-up objects as well as sizing detail of any backed-up tables; when object_files, the names of the backed-up objects as well as sizing detail and associated data files of any backed-up tables.

deleted_backup_ids (list of dicts of str to str) –

IDs of any snapshots that have been deleted from the containing backup(s).

info (dict of str to str) –

Additional information.