Graph store example

In this example, a default backup location is registered for the graph store. The location is a file share directory named graphbu on sysshare. The backup location name is graph_defaultbu.

configurebackuplocation --operation register --store graph 
--location "type=fs;location=\\sysshare\graphbu;name=graph_defaultbu"

Object store example

In this example, a default backup location is registered for the object store. The location is a file share directory named videobu on netshare. The backup location name is object_defaultbu.

configurebackuplocation --operation register --store object 
--location "type=fs;location=\\netshare\videobu;name=object_defaultbu"

Spatiotemporal big data store example

In this example, a backup location is registered for a spatiotemporal big data store. The location is an Azure Blob storage location named dsbackups. The backup location is named sbds_defaultbu. Credentials to access the Blob storage location are provided.

configurebackuplocation --operation register --store spatiotemporal 
--location "type=azure;location=dsbackups;name=sbds_defaultbu;username=azureaccountlogin;password=zpw4azureaccount"

Tile cache data store (cluster mode) example

In this example, a default backup location is registered for a tile cache data store deployed in cluster mode. The location is an S3 bucket with a subfolder named scene. The bucket resides in the US East (Ohio) AWS region. The backup location name is tc_defaultbu. Credentials to access the bucket are provided.

configurebackuplocation --operation register --store tileCache 
--location "type=s3;location=backups/scene;name=tc_defaultbu;region=us-east-2;username=abc12345;password=dearliz@a0"

Specify one of the backup locations as the default location

When you have multiple backup locations defined for a graph store, object store, tile cache data store, or spatiotemporal big data store, you can designate one of them as the default backup location. After you do that, backups created by ArcGIS Data Store (automatic backups) will write the backup files to that location.

Run the configurebackuplocation utility with the setdefault operation and specify the registered backup location. If you named the backup location when you registered it, you can use the name to designate the location.

configurebackuplocation --operation setdefault --store graph --location "location=\\sysshare2\gsbackups24"

configurebackuplocation --operation setdefault --store object --location "name=s3_backups"

configurebackuplocation --operation setdefault --store spatiotemporal --location "name=bu_container"

configurebackuplocation --operation setdefault --store tileCache --location "type=s3;location=bu_bucket;
username=hijklmn1234567;password=z9y8x7w6v5u4t3s2r1q0;region=ap-northeast-1"

Change backup frequency

If your organization members publish and edit large numbers of hosted layers, or you archive large volumes of streaming data, increase the frequency of backups.

Your backup location must have enough room to store all the backup files. Backup size varies depending on the amount of data you have, but if you use default backup settings, backups contain two full backups. The size of these files depends on the amount and size of your data. If you reenable point-in-time recovery for relational data stores, the backups also include seven days of incremental backup files by default.

If you decide to create backups manually and want to disable automatic backups, set the backup frequency to 0. If you disable automatic backups, you must create the backups yourself to guard against data loss in the event of machine failure or other data catastrophe.

The updatebackupschedule utility is installed in the <ArcGIS Data Store installation directory>\datastore\tools directory.

Change how long automatic relational data store backup files are retained

The backup directory retains relational data store backup files for seven days by default. This means if you keep the default backup frequency (every four days) and retention schedules (seven days), the backup directory contains two full backups. If you reenable point-in-time recovery, the backup directory also contains seven days of incremental backup files. The size of these files depends on the amount and size of your data. The machine that stores your backups must have enough disk space for all these files. If you increase the backup frequency, consider decreasing the retention period for the backup files. In the previous section, the backup frequency was increased to every day. To prevent your backup directory from becoming too large, decrease the backup file retention period.

The syntax to run the updatebackupretaindays utility is as follows:

updatebackupretaindays <number of days>

In the following example, backup file retention time is changed to four days:

updatebackupretaindays 4

Run a utility to create a data store backup

You can use the backupdatastore utility to make a full backup of the specified data store. You may want to manually create a full backup before making a large number of changes to the data store or before upgrading the data store. Or you may want to create a backup to preserve a copy of the data in a particular state, for example, at the end of the first phase of a project.

Running the backupdatastore utility for a relational data store always creates a full backup of the data store.

The first time you run the backupdatastore utility for a tile cache data store, backup copies are made of all existing tile cache data store databases. Similarly, the first time you run the backupdatastore utility for a spatiotemporal big data store, a full backup is created. Because both of these types of data stores can be very large, each time you run the backupdatastore utility after the first time, the utility only creates backup copies of data that was created since the last time you ran the utility.

The login you use to connect to the data store machine to run the backupdatastore utility must have read and write access to the data store backup location.

The syntax to run the backupdatastore utility is as follows:

backupdatastore [<backup file name>] [--store {relational | tileCache | spatiotemporal | graph | object}] [--location <backup_arguments>] [--prompt {yes | no}]

Arguments for the --location parameter are as follows and must be separated with semicolons (;):

• type=—Valid types are fs (file share), s3 (Amazon Simple Storage Service (S3) bucket), or azure (Microsoft Azure Blob storage container).
• name=—If you assigned names to the backup locations you configured for your data store, you can use the location name to specify where you want backup files created when running the backupdatastore utility.
• location=—If you do not specify a backup location name, you must specify the backup type and location. For file shares, provide the file path. For S3 buckets, provide the bucket name. For Azure Blob storage containers, provide the container name.

Provide a meaningful backup name for the file so you can find it when you want to restore the data. If you do not specify a name, the utility assigns a default name to the file. The default name is in the format datastorename-timestamp. For example, if your data store is named corpds and you create the backup on July 10, 2014, at 14:25:49:554 UTC, the backup file name is corpds-20140710142549554.

You will be asked to confirm that you want to create a backup. Type yes or y to proceed with backup creation.

backupdatastore --store tileCache --prompt no

Delete manual data store backups

When you no longer need a relational data store, graph store, or object store backup file that you created using the backupdatastore utility, run the configurebackuplocaton utility with the --operation option set to list to get all the backup locations for a data store. Next, run the listbackups utility with each location to get the names of the backup files in each location. When you determine which backup files must be deleted, and run the deletebackup utility for each location and file to remove the unneeded file. For example, after you upgrade your data store and confirm all layers are performing as expected, you can delete the data store backups you created before upgrading.

In this example, the relational data store backup file preupgrade1104_bu is deleted from backup location \\systemserver\backups:

configurebackuplocation  --operation list --store relational 
Backups locations for relational data store:
=====================================================================================
Type  Location                                         isDefault 
=====================================================================================
fs    \\ourserver\datastore\backups\rel                true
fs    \\systemserver\backups                           false


listbackups --store relational --location "\\systemserver\backups"

Backup_Name                      Status           Backup_Time         Mode
====================================================================================
phase1proj_bu                    BackupComplete   2023-03-08 14:12    manual
phase2proj_bu                    BackupComplete   2023-06-21 11:43    manual
preupgrade1104_bu                BackupComplete   2022-11-04 09:30    manual


deletebackup preupgrade1104_bu --store relational --location "\\systemserver\backups"
You are attempting to delete backup 'preupgrade1104_bu'. This operation is irreversible.

Do you wish to continue (Yes or No)?yes

Operation completed successfully