Skip to main content

listbackups

This utility is used with all ArcGIS Data Store types.

When run for the relational store, the listbackups utility only functions on the primary data store machine.

Run the listbackups utility to determine the following:

  • The time a backup operation started

  • Whether a backup completed or is still running

  • Whether the backup was created using the backupdatastore utility or created automatically by ArcGIS Data Store

  • Which backup files are viable. If the backup file is not returned by the listbackups utility, it cannot be used to restore the data store. For example, backup files created with an earlier ArcGIS Data Store release can be used to restore a data store only if the files are listed when you run the listbackups utility.

  • How many backup files you have, to determine whether you need to delete any

  • Confirm backup file names before running the deletebackup utility

When you run the listbackups utility, specify the backup location for which you want to see the list of backup files. If you do not specify a location, the listbackups utility returns backups for the default backup location.

Syntax

listbackups [--store {relational | spatiotemporal | graph | object}] [--location "<location_arguments>"]

If you do not specify a data store type (--store), the utility defaults to relational and returns the backups for the relational store running on that machine. If the relational store is not present on the machine where you run the utility, the utility will return an error message.

Use the --location option to discover information for backups in a specific registered backup location. If you do not specify a location, information is returned for the default backup location. Provide one of the following arguments with the --location option:

Argument

Description

name=

Provide the name of the backup location. You specified this name when you configured the backup location or, if you didn't specify a name, ArcGIS Data Store assigned a default name.

location=

Specify the path to the shared file directory, Amazon S3 bucket, or Azure Blob Storage container that you registered as a backup location.

Examples

In this example, backups are listed for the default backup location of a relational store:

./listbackups.sh --store relational

Backup_Name              Status           Backup_Time         Mode
=======================================================================
phase1proj_bu            BackupComplete   2023-03-08 14:12    manual
phase2proj_bu            BackupComplete   2023-02-21 11:43    manual
ds_gdt1omh-2023020130    BackupComplete   2023-02-01 03:00    scheduled
Backups located at: '/net/myserver.net.com/dsbackups'

listbackups --store relational

Backup_Name              Status           Backup_Time         Mode
=======================================================================
phase1proj_bu            BackupComplete   2023-03-08 14:12    manual
phase2proj_bu            BackupComplete   2023-02-21 11:43    manual
ds_gdt1omh-2023020130    BackupComplete   2023-02-01 03:00    scheduled

Backups located at: '\\myserver.net.com\dsbackups'

In this example, spatiotemporal big data store backups are listed for the backup location named sbdsbu:

./listbackups.sh --store spatiotemporal --location "name=sbdsbu"

Backup_Name          Status           Backup_Time         Mode
==================================================================
backup1              BackupComplete   2023-07-11 09:47    manual
Backups located at: '/net/myserver.ntw.com/spatiotemporal'

listbackups --store spatiotemporal --location "name=sbdsbu"

Backup_Name          Status           Backup_Time         Mode
==================================================================
backup1              BackupComplete   2023-07-11 09:47    manual

Backups located at: '\\myserver.net.com\spatiotemporal'