Skip to content

backupList ​

Command: backupList
Category: Backup & Recovery
Status: Production Ready

Description ​

List available backups

Syntax ​

bash
hana-cli backupList [directory] [options]

Aliases ​

  • blist
  • listBackups
  • backups

Command Diagram ​

Parameters ​

Positional Arguments ​

ParameterTypeDescription
directorystringDirectory to scan for backups (optional)

Options ​

OptionAliasTypeDefaultDescription
--directory--dirstring-Directory to scan for backups
--backupType--typestring"all"Type of backup. Choices: table, schema, database, all
--sortBy--sortstring"date"Sort backups by field. Choices: name, date, size, type
--order-ostring"desc"Sort order. Choices: asc, desc
--limit-lnumber50Limit number of results
--showDetails--detailsbooleanfalseShow detailed backup information including metadata
--help-hboolean-Show help

Connection Parameters ​

OptionAliasTypeDefaultDescription
--admin-abooleanfalseConnect via admin (default-env-admin.json)
--conn-string-Connection filename to override default-env.json

Troubleshooting ​

OptionAliasTypeDefaultDescription
--disableVerbose--quietbooleanfalseDisable verbose output - removes all extra output that is only helpful to human readable interface
--debug-dbooleanfalseDebug hana-cli itself by adding output of LOTS of intermediate details

Examples ​

Basic Usage ​

bash
hana-cli backupList

List all backups in the default directory (~/.hana-cli/backups) sorted by date.

List Backups in Custom Directory ​

bash
hana-cli backupList --directory /backups

List backups from a specific directory.

Filter by Backup Type ​

bash
hana-cli backupList --type table

Show only table backups.

Sort and Limit Results ​

bash
hana-cli backupList --sortBy size --order desc --limit 10

Show the 10 largest backups sorted by size.

Show Detailed Information ​

bash
hana-cli backupList --showDetails

Display full metadata for each backup including timestamps and file information.

Combined Filters ​

bash
hana-cli backupList --dir /data/backups --type schema --sortBy name --limit 20

List schema backups from a specific directory, sorted by name, limited to 20 results.

See the Commands Reference for other commands in this category.

See Also ​