backupdatastore

This utility is used with all ArcGIS Data Store types.

Use this utility to create a full backup of a data store between scheduled backup times. For example, create a backup of each data store prior to upgrading ArcGIS Data Store or before making a large number of changes to a data store.

The backupdatastore utility can be run for only one data store type at a time.

The following table indicates where to run the backupdatastore utility and what the utility does for each data store type:

Data store type	Machine	Behavior
Relational store	Run the backupdatastore utility on the primary relational store machine.	The backupdatastore utility always creates a full backup of the relational store.
Object store	The backupdatastore utility can be run on any machine in the cluster.	The backupdatastore utility always creates a full backup of the object store for video service data and hosted 3D layer caches. Feature layer query caches are not included in the backup file.
Spatiotemporal big data store	The backupdatastore utility can be run on any machine in the cluster.	The first time you run the backupdatastore utility for a spatiotemporal big data store after setting a backup location, a full backup is created. Subsequent use of the backupdatastore utility creates a backup file containing only the changes since the initial full backup.
Graph store	The backupdatastore utility can be run on any machine in the graph store.	The backupdatastore utility always creates a full backup of the graph store.

Before you run the backupdatastore utility, ensure that the backup location for the data store is large enough to accommodate backups. To change data store backup locations, use the configurebackuplocation utility.

For more information about ArcGIS Data Store backups, see Manage ArcGIS Data Store backups.

Syntax

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

You must provide a name for the backup file.

If you do not specify the --store option, the relational value is assumed.

If you do not specify the --location option, backup files are written to the data store's default backup location.

To specify one of the other registered backup locations instead, use the --location option. You can either provide the backup name or the backup type and location. When you use the type= and location= arguments, separate them by a semicolon (;).

Supported arguments for the --location option are as follows:

Argument	Description
name=	You can use the backup location name to indicate the registered backup location. If you specify a name, you do not need to use the type= and location= arguments.
type=	If you do not specify a backup location name, you must specify the backup location type and physical location. Type values and their descriptions are as follows: fs—A file share s3—An Amazon Simple Storage Service (S3) bucket azure—A Microsoft Azure Blob Storage container
location=	Use the location= argument to indicate the physical location of the registered backup location. This argument must be used with the type= argument. For file shares, provide the file path. For S3 buckets, provide the bucket name. For Azure Blob Storage containers, provide the container name.

Examples

In this example, the backupdatastore utility creates a full backup file named project1bu in the default backup location of the relational store. By including --prompt no, the utility does not prompt for a confirmation response.

./backupdatastore.sh project1bu --prompt no

backupdatastore project1bu --prompt no

In this example, a backup file named localbu5 is created for the spatiotemporal big data store in a file share location, which you named gadbu when you configured the backup location.

./backupdatastore.sh localbu5 --store spatiotemporal --location 'name=gadbu'
You are going to back up the data store. This could take some time, depending on the size of your data store.
Please do not interrupt the process once it has started.

Do you want to continue (Yes or No)?Yes

backupdatastore localbu5 --store spatiotemporal --location name=gadbu
You are going to back up the data store. This could take some time, depending on the size of your data store.
Please do not interrupt the process once it has started.

Do you want to continue (Yes or No)?Yes

In this example, a backup is created of a spatiotemporal big data store in an Azure Blob Storage container named blob4backups, and the backup file created is named spds311016:

./backupdatastore.sh spds311016 --store spatiotemporal --location 'type=azure;location=blob4backups'
You are going to back up the data store. This could take some time, depending on the size of your data store.
Please do not interrupt the process once it has started.

Do you want to continue (Yes or No)?Yes

backupdatastore spds311016 --store spatiotemporal --location type=azure;location=blob4backups
You are going to back up the data store. This could take some time, depending on the size of your data store.
Please do not interrupt the process once it has started.

Do you want to continue (Yes or No)?Yes