Skip To Content

ArcGIS Data Store command utility reference

Command utilities are installed with ArcGIS Data Store to allow the data store administrator to manage the data store. This topic describes the utilities and provides syntax and examples.

All utilities must be run on the ArcGIS Data Store machine. You can find the utilities in the <ArcGIS Data Store installation directory>\datastore\tools directory.

You can type the utility name followed by --help to get syntax assistance.

Note:

Your login must be a member of the Windows Administrator group and you must open the Command Prompt with the option to Run as Administrator to use the ArcGIS Data Store utilities.

allowconnection

For security reasons, all connections to the data store are made through the ArcGIS Server site by default. If you want to open a relational data store for connections from an additional machine, you can use the allowconnection command utility.

The allowconnection utility can only be run on the primary relational data store machine.

Syntax

allowconnection <host name> <user name> [<database>]

Specify the name of the computer you want to allow to connect to the relational data store (host name) and one of the database accounts used by the data store (user name): either the data store administrator, replica owner, geodatabase administrator, or managed user (the user who publishes feature layer data), which you can obtain using the listadminusers or listmanageduser utility. You can also specify the name of the data store database but, since there is only one database used to store hosted feature layer data, this value is optional.

Example

In this example, a connection is allowed from the workcom computer to the relational data store when connections are made as the hqo.n_1E7 managed user.

allowconnection workcom hqo.n_1E7

backupdatastore

If you need to create a relational data store backup between scheduled backup times, use the backupdatastore utility. You would manually create a full backup prior to upgrading the data store or before making a large number of changes to the data store.

The backupdatastore utility can only be run on the primary data store machine. Backupdatastore creates a backup of a relational data store only.

Syntax

backupdatastore <backup name>

Example

In this example, a full backup file named project1bu is created in the backup location you specified for the data store using the changebackuplocation utility.

backupdatastore project1bu

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

changebackuplocation

Data store backup files are stored on the same machine as the data store by default. You should move your backup files to a separate machine to ensure you can access them if the data store is inaccessible.

Set the data store service to run using a domain account, grant that account read and write access to a shared network directory, and use the changebackuplocation utility to move your data store backup files to the shared directory on a different machine.

The changebackuplocation utility only applies to backups created for a relational data store.

Syntax

changebackuplocation <new directory path> [--is-shared-folder <true|false>] [--keep-old-backups <true|false>]

Specify --is-shared-folder true if the backup location is on a shared network machine. If you want existing backup files to be moved to the new location, specify --keep-old-backups true.

Example

In this example, backups will be created in the shared ds_backups directory on the machine sysshare. Any backups that exist in the current backup directory will be moved to this new location.

changebackuplocation \\sysshare\ds_backups --is-shared-folder true --keep-old-backups true

You are going to change the data store backup directory.
Do you want to continue (Yes or No)?Yes

changedbproperties

The changedbproperties utility allows you to change different properties depending on the type of data store you run it against. Relational data stores accept up to 150 connections by default. You can use the --max-connections property with the changedbproperties utility to change the number of connections allowed. When determining how many connections your data store requires, take into consideration that ArcGIS Data Store internal processes can take up to five connections. Also consider how many concurrent connections your ArcGIS Data Store machine can accept and continue to perform well. If the machine running ArcGIS Data Store doesn't have a lot of memory, you may need to decrease the number of connections allowed.

When you change the maximum number of connections allowed, the number is changed on both the primary and standby data store machine.

Syntax

changedbproperties --store <relational | tileCache | spatiotemporal> [configuration option]

Possible configuration options:

  • max-connections: Use this parameter to specify the maximum number of connections allowed to a relational data store. The number specified cannot be smaller than 10. This parameter is not supported for spatiotemporal big data stores or tile cache data stores.
  • heap-size: Use this parameter to change the amount of heap memory used by a spatiotemporal big data store. By default, this type of data store will use half the available RAM when it starts. This parameter is not supported for relational or tile cache data stores.
  • reallocation: By default, this parameter is set to true, which means data in a spatiotemporal big data store will distribute data to other shards if any one shard is unavailable. If you need to perform maintenance on a shard, such as upgrading it, you can temporarily shut off reallocation by setting this parameter to false. Reallocation will be suspended for the amount of time set for the max-allocation-off parameter. This parameter only applies to spatiotemporal big data stores.
  • max-allocation-off: The setting for this parameter is used when you set the reallocation parameter to off. By default, max-allocation-off is set to 60 minutes. That means, if you temporarily shut off reallocation, it will start again after 60 minutes. If you need more or less time than that perform the maintenance task for which you suspended reallocation, change the time setting for max-allocation-off. This parameter only applies to spatiotemporal big data stores.
  • prompt: When you run this utility, you are prompted to confirm the action you specified. If you automate the use of this utility, set the prompt parameter to false; otherwise, the script will not proceed until you answer the prompt.

Example

In this example, the number of maximum connections allowed to a relational data store is set to 100:

changedbproperties --store relational --max-connections 100

You are changing the following database properties:
         max number of connections to 100 (on all data store machines)

Changing database configurations could cause the database to restart. Please do not interrupt the process once it has started.

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

changeloglocation

If you do not want the data store to use the default error log file location of <ArcGIS Data Store installation directory>\arcgisdatastore\logs, you can run the changeloglocation utility to create error log files in a different directory.

The ArcGIS Data Store account must have write privileges to the folder you specify.

Syntax

changeloglocation <directory path>

Example

In this example, log files will be created in the local directory, d:\datastorefiles\logs.

changeloglocation 'd:\datastorefiles\logs'

changenosqldslocation

Tile cache data stores can get large if you store a lot of high-resolution tiles in it. In those cases, you might want to move the data to either another drive on the same server or to a shared location on a different server.

If you move the data to a shared directory, you must grant read and write permissions on the directory to the user running the ArcGIS Data Store process (Linux) or service (Windows).

changenosqldslocation <path> [--prompt {yes | no}]

In this example, the databases that store scene layer caches are moved to a shared directory named dstorecache on machine server2.

changenosqldslocation \\server2\dstorecache

changepassword

ArcGIS Data Store randomly generates user names and passwords for the database accounts used for relational data stores. If your site requires you to set your own passwords, obtain the passwords for data store accounts, and run changepassword to reset passwords.

Use the listadminusers utility to get user names and passwords for administrator users and the listmanageduser utility to get the user name and password for the feature data owner.

The changepassword utility can only be run on the primary relational data store machine.

Syntax

changepassword <user name> <new password> [--prompt {yes | no}]

Tip:

If you need to script password changes, include a flag to suppress the confirmation prompt, as in the following example:

changepassword gwi_n2Te0 Phfl4mp! --prompt no

Example

In this example, the password is changed for user gwi_n2Te0 to Phfl4mp!.

changepassword gwi_n2Te0 Phfl4mp!

You are going to change the password for user gwi_n2Te0.
Do you want to continue (Yes or No)?Yes

changestaginglocation

When you restore your feature layer data, ArcGIS Data Store extracts the compressed backup files on a staging location. That means you need to have a staging location that can accommodate this uncompressed data. If you have a lot of data in your relational data store, you might want to set up a separate staging location and specify that for data store recovery.

Syntax

changestaginglocation <directory path>

Example

In this example, the designated staging location is \\netserver\stage.

changestaginglocation \\netserver\stage

configuredatastore

After you install ArcGIS Data Store, you can run the configuredatastore utility to create a data store and register it with an ArcGIS Server site. You can create the following types of data stores using this command:

  • A data store for your hosted feature layer data (relational)
  • A data store for hosted scene layer tile caches (tile cache)
  • A data store for archived observational data (spatiotemporal)

When you publish a hosted scene layer, ArcGIS creates a hosted feature layer, hosted scene layer, and scene cache. To accommodate this, ArcGIS Data Store creates both a relational data store and a data store for scene tile caches. If you prefer to use your existing GIS server managed database to store hosted feature layer data, the configuredatastore utility gives you the option to create just a scene tile cache data store.

Note:

Be aware that if you use your own managed database for hosted feature layer data, you cannot use ArcGIS Data Store tools to administer the database. In other words, you manage users and backups using tools available with your DBMS. You also cannot take advantage of high availability functionality offered through ArcGIS Data Store.

Syntax

configuredatastore <ArcGIS Server admin URL> <ArcGIS Server administrator> <ArcGIS Server administrator password> 
<data directory> [--stores <relational | tileCache | spatiotemporal>] [--nosql-only true|false]

The ArcGIS Server admin URL is in the format https://gisserver.domain.com:6443/arcgis. Note that even if your ArcGIS Server site uses a web adaptor, provide the URL in the aforementioned format.

Provide the user name and password for a built-in (not enterprise) user who has administrator privileges in ArcGIS Server.

The data directory is the location on the local machine where you want the data store files to be created.

Configure a specific type of data store

You can configure an ArcGIS Data Store for hosted feature layer data by specifying relational with the --stores operation. This also prepares a data store for hosted scene layer tile caches.

If you want to use your own managed database as the data store for hosted feature layer data but you want to publish hosted scene layers, specify tileCache with the --stores operation. This will register only the data store used for scene layer cached tiles and will not create a data store for feature layer data.

Legacy:

In previous releases, you would specify the --nosql-only operation set to true to create a data store only for scene layer cached tiles. This operation is still present so existing scripts continue to function. In future, use the --stores operation set to tileCache instead.

If you use the ArcGIS GeoEvent Extension for Server and want to store high volume and high velocity observational data, specify spatiotemporal with the --stores operation. Do not use the Data Store Configuration wizard to configure a spatiotemporal big data store; dismiss the wizard when it opens after installation of ArcGIS Data Store. You can create both a relational and spatiotemporal big data store on the same machine by specifying relational,spatiotemporal with the --stores operation; however, it is not recommended you run both on the same machine, as they will compete for memory and other resources.

See the ArcGIS GeoEvent Extension for Server help for more information on working with spatiotemporal big data stores.

Example

In this example, a data store for hosted feature layer data (relational data store) is created. The URL for the ArcGIS Server that will use the data store is https://dataserver.mydomain.com:6443/arcgis, the site administrator user name and password are admin and Iph33l$ik respectively, and the data directory for the data store is C:\datastore\data\.

configuredatastore https://dataserver.mydomain.com:6443/arcgis admin Iph33l$ik c:\datastore\data\ --stores relational

configureserviceaccount

The configureserviceaccount utility changes the login used for the ArcGIS Data Store account. When you set the account using this utility, you can export the account information to a file. Note that the password is encrypted in the file. You can use this file to import the same account information if, for example, you set up another ArcGIS Data Store and want to use the same account. In that case, run the configureserviceaccount utility on the new machine and import the file with the account information.

You can also use this utility to update the password of the ArcGIS Data Store account. If the password for the Windows login changes, run the utility and specify a new password for the existing Windows account.

Syntax

configureserviceaccount [--username <Windows account>] [--password <account password>]
[--readconfig <user configuration file>] [--writeconfig <user configuration file>]

Example

In this example, configureserviceaccount sets the mynetwork\datastore account to run the ArcGIS Data Store service and grants this account the privileges required on ArcGIS Data Store system folders and files.

configureserviceaccount --username mynetwork\datastore --password SewL0ng

Note that changing the account under which the service runs causes the service to restart.

In this example, the ArcGIS Data Store account is changed, and the account information is written to a file (adsainfo) at C:\adminfiles.

configureserviceaccount --username mynetwork\datastore --password SewL0ng --writeconfig C:\adminfiles\adsainfo

In this example, ArcGIS Data Store is installed on a different machine, and the administrator runs the configureserviceaccount utility to set the same account using the file created in the previous example.

configureserviceaccount --readconfig C:\adminfiles\adsainfo

deletebackup

The deletebackup utility allows you to delete backup files you created for relational data stores. First, run the listbackups utility to see the names and creation times of your manual backups. You can then run the deletebackup utility to delete the manual backup you no longer need.

Note that you can only delete backups that are not required to recover your data store. For example, you cannot delete the most recent full backup of a relational data store.

Syntax

deletebackup <backup name>

Example

deletebackup featuresMarchbu
You are attempting to delete backup 'featuresMarchbu'. This operation is irreversible.

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

Operation completed successfully

describedatastore

The describedatastore utility allows you to see the following information about an ArcGIS Data Store installation:

  • Backup, log file, staging, and scene tile cache data locations used by the data store
  • Whether the backup location is on a network share
  • How often a full backup is created of the relational data store (Backup schedule)
  • How many days backup files are retained
  • Whether or not the data store is running (Data store status)
  • The date and time that the standby data store became the primary data store (Last failover); not displayed if failover has never occurred
  • The names of the primary and standby machines (if applicable) that participate in the data store (Member machines)
  • Maximum connections allowed to a relational data store
  • The URL of the ArcGIS Server site with which the data store is registered (Owning System URL)
  • The URL of the portal that is using the ArcGIS Server site as its hosting server (Portal URL)
  • The number of current feature layer connections to the data store
  • The remaining free disk space on the data store machine

Syntax

describedatastore

Example

describedatastore

Information of ArcGIS DataStore sthiu0_5T
================================================
Backup location...........\\nwshare\dsbackups
Is backup folder shared...true
Staging location..........C:\arcgisdatastore\staging
Tile cache location.......C:\arcgisdatastore\nosqldata
Log location..............C:\arcgisdatastore\logs
Backup schedule...........{"schedule-starttime":"00:00:00","schedule-frequency":"Every 7 DAYS"}
Days backup retained......31
Data store status.........Started
Last failover.............20150130190334005
Member machines...........DSPRIMARY.DOMAIN.COM, DSFAILOVER.DOMAIN.COM
Maximum connections.......150
Owning system URL.........https://gisserver_webadaptor.esri.com/arcgis
Portal for ArcGIS URL.....https://portal_webadaptor.esri.com/arcgis
Number of connections.....8 connection(s) to managed database
Free disk space...........174.00GB

exportmanageddb

The exportmanageddb utility creates a dump file of the database that stores hosted feature layer data, metadata about the data store, and all databases that store hosted scene layer caches. Export the data store if you need to make a backup of the data store to be restored to an ArcGIS Data Store installation that is on a machine with a different operating system or is a different ArcGIS Data Store release.

Be sure no one edits feature layers or publishes to your portal before you import the data store to the new machine. Also be sure the location to which you export the data store contains enough storage space for the hosted feature layer database's dump file and copies of all your hosted scene layer cache databases.

The exportmanageddb utility does not export spatiotemporal big data stores.

Syntax

exportmanageddb <backup name> --destination <output location> [--include-tilecache <true|false>] [--prompt {yes|no}]

If you do not specify the --destination option and output location, a directory called dbdump will be created (if it does not already exist) in the data store's default backup location, and the export files will be placed in a new directory there. For example, if your data store's default backup directory is \\sysshare\ds_backups and you specify dsexp1 for the backup name but do not specify an output location, the exported relational data store, tile cache data store, and their associated files are placed in the following location: \\sysshare\ds_backups\dbdump\dsexp1.

Use the include-tilecache operation to specify whether to include all the hosted scene layer tile cache databases in the export. By default, these databases are included. You might exclude these databases from the export (--include-tilecache false ) if you included them in the last export you did, and you know that no additional hosted scene layers were published to your portal since then.

Example

In the following example, the dump file, copies of the hosted scene layer cache databases, and associated data store files are output to a shared network directory named preupgradeexp on a server named backupserver. Since the include-tilecache operation is not specified in this example, all hosted scene layer cache databases will be included in the export.

exportmanageddb preupgradeexp --destination \\backupserver

You are attempting to back up database 'db_e3hsm and nosql databases'. This could take a long time, depending on the size of your data.
Please do not interrupt the process once it has started.

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

importmanageddb

If you exported an ArcGIS Data Store containing hosted feature layer or hosted scene layer cache databases (or both), you can use the importmanageddb utility to restore the data store. You can restore to an upgraded ArcGIS Data Store machine or to an ArcGIS Data Store installation on a machine with a different operating system than the source ArcGIS Data Store.

If you want ArcGIS Data Store to be registered with the same ArcGIS Server site it was before, specify --bound true and do not specify a --server-url. Note that --bound is set to true by default. Be sure to restart the ArcGIS Server site after restoring.

If you restore and want to register the data store with a new ArcGIS Server site, specify the --server-url when you import the data store.

By default, the relational data store and all the hosted scene layer cache databases that make up the tile cache data store in the export file are imported. If you do not want to include the hosted scene layer cache databases, specify the --include-tilecache operation set to false.

The importmanageddb utility does not import spatiotemporal big data stores.

Syntax

importmanageddb <backup name> --source-loc <source backup location> --data-dir <data store data directory> 
--server-admin <user name of ArcGIS Server admin> --server-password <password of ArcGIS Server admin>
[--include-tilecache <true|false>] [--bound {true|false}] [--server-url <ArcGIS Server URL registered with data store>] 
[--prompt {yes|no}]

Example

In the following example, the data store is restored to a newer release ArcGIS Data Store installation. The new ArcGIS Data Store data directory is specified. The data store is still bound to the existing ArcGIS Server site, so the data store and existing hosted feature and scene layers continue to function. Restart your ArcGIS Server site to allow hosted feature and scene layers to be published to the new machine.

importmanageddb preupgradeexp --source-loc \\backupserver\dbdump\preupgradeexp --data-dir c:\arcgis\datastore 
--server-admin siteadmin --server-password $Aup.4s --bound true

listadminusers

The listadminusers utility returns the user names and passwords for the administrator, replica owner, and geodatabase administrator of a relational data store.

Syntax

listadminusers

Example

listadminusers

Admin users for ArcGIS Data store ds_abcd1234
=================================================
Database Admin User.... adm_32ret / tT30!bYk22jF
Database Repl User..... dsrepuser / uWn/MV0678h4
GDB Admin User......... sde / iO=Qst751*pb

listbackups

The listbackups utility returns the names of full relational data store backups and the location to which they are written. The listbackups utility also returns the backup status (whether it completed or not), the time the backup started, and whether the backup was created manually using the backupdatastore utility or created automatically by ArcGIS Data Store.

You can run listbackups to see whether a backup completed or is still running, determine how many manual backups you have, or confirm a file name before running the deletebackup utility.

Syntax

listbackups

Example

listbackups

Backup_Name                      Status           Backup_Time         Mode
====================================================================================
phase1proj_bu                    BackupComplete   2014-03-08 14:12    manual
phase2proj_bu                    BackupComplete   2014-06-21 11:43    manual
ds_gdt1oomh-20141103160748082    BackupComplete   2014-11-01 03:00    scheduled

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

listmanageduser

The listmanageduser utility returns the user name and password of the relational data store's managed user. The managed user is the database account that owns the hosted feature layer data in the data store.

Syntax

listmanageduser

Example

listmanageduser

Managed user for ArcGIS Data store ds_abcd1234
================================================
UserName     Password             Database
gwi_n2Te0    4cXddhZhve=Y         db_qv5e1

registerdatastore

The data store retains information about the ArcGIS Server site machine names. If you move your ArcGIS Server site to new machines (for example, if you got new hardware or if the existing ArcGIS Server machines failed), you must unregister the data store from ArcGIS Server to remove this information. Once ArcGIS Server is on a new machine, you can register the data store with the ArcGIS Server site using the registerdatastore command utility.

Note that this is used to register the data store to the same ArcGIS Server site it was registered to previously. The data store contains the data for the hosted layers on the existing ArcGIS Server site. Registering it to a different ArcGIS Server site does not re-create the hosted feature layers, scene layer caches, or stream service data archives.

The registerdatastore utility can only be run on the primary data store machine.

Syntax

registerdatastore <ArcGIS Server URL> <ArcGIS Server site administrator user name> <ArcGIS Server site administrator password>

Example

In this example, the data store is reregistered to an ArcGIS Server site with the URL https://gisserver.domain.com:6443/arcgis. The ArcGIS Server primary site administrator user name is agsadmin with the password Tan$p0n.

registerdatastore https://gisserver.domain.com:6443/arcgis agsadmin Tan$p0n

removemachine

Use the removemachine utility to remove one of the following from an ArcGIS Data Store installation:

  • Remove a standby machine from a relational data store. Can be run on standby machine or from the primary machine in the case where the standby machine is unavailable.
  • Remove a standby machine from a tile cache data store. Can be run on standby machine or from the primary machine in the case where the standby machine is unavailable.
  • Remove a machine from a spatiotemporal big data store. Note that you cannot run removemachine on a spatiotemporal big data store composed of only one machine.

Syntax

removemachine <machine name> [--prompt <yes | no>]

Example

In this example, the spatiotemporal big data store machine, gefour, is removed from the data store.

removemachine gefour

removestandbymachine

Legacy:

Esri has deprecated the removestandbymachine utility. It is still present to allow existing scripts to continue working, but you should start using the removemachine utility instead.

You can use the remove ArcGIS Server REST command from the ArcGIS Server site administrator to remove a standby machine from a relational or tile cache data store. However, if the ArcGIS Server site is unavailable, you won't be able to log in to the site administrator to do this. In those cases, run the removestandbymachine utility to remove a standby machine from the data store.

The removestandbymachine utility can only be run on the standby machine of a relational and tile cache data stores.

Syntax

removestandbymachine <machine name> [--prompt <yes | no>]

Example

In this example, the standby machine is named dsserver2.

removestandbymachine dsserver2

restoredatastore

If you lose access to the data used by your portal's hosted feature layers, use your backup files and the restoredatastore command utility to recover your data stores.

If you cannot recover the data store, install ArcGIS Data Store on a new machine and restore the most recent backup to the new machine.

If you want to roll the data back to a specific time in the past, restore on top of the existing data store. Note that you can only restore to a previous state for which you have backup files available. For example, if you only retain backups for five days, you can only recover the data store to a point in time within those five days.

The restoredatastore utility can only be run on the primary ArcGIS Data Store machine. The restoredatastore utility does not restore stream service archive data (data used in spatiotemporal big data stores).

Syntax

restoredatastore [--target {most-recent | yyyy-mm-dd-hh:mm:ss | <backup file>}] [--source-loc <location of backup files>] 
[--bound <true|false>] [--data-dir <new data store directory>] [--prompt {yes | no}]

When restoring after a crash or to move the data store, specify --target most-recent. If restoring to a point in time, specify the date and time (in UTC) to which you want to restore the data store. If you have a specific backup file you want to restore, specify the backup file name instead. If you do not specify a target, the most recent backup is restored.

By default, the restored data store is associated (bound) with its ArcGIS Server site. Only specify --bound false if you want to restore the data store without maintaining the association with the data store's ArcGIS Server site. You would only do this as a last resort if the previous ArcGIS Server site was lost and could not be recovered; you could restore the data store unbound and configure it with a new federated ArcGIS Server site. However, the feature layers that used the data in the data store would no longer exist. You would have to connect to the data store database to extract the data to another format and republish it to the portal.

Example

In this example, the most recent backup is from \\buserver\data\backups to C:\arcgisdatastore. Since the data store remains bound by default to the ArcGIS Server site with which it was registered, you do not have to specify --bound true.

restoredatastore --target most-recent --source-loc \\buserver\data\backups --data-dir C:\arcgisdatastore

You are attempting to restore the data store from a data store backup. This process could take a long time, 
depending on the size of your data. Please do not interrupt the process once it has started.

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

In this example, the data store is restored from \\buserver\data\backups to the state it was in at 2:30 p.m. (UTC) on July 17th, 2014.

restoredatastore --target 2014-07-17-14:30:00 --source-loc \\buserver\data\backups

You are attempting to restore the data store from a data store backup. This process could take a long time, 
depending on the size of your data. Please do not interrupt the process once it has started.

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

revokeconnection

If you used the allowconnection utility to temporarily allow another client to connect directly to the relational data store, you can revoke the connection ability by running the revokeconnection utility.

The revokeconnection utility can only be run on the primary data store machine.

Syntax

revokeconnection <host name> <user name> [<database>]

Example

In this example, the data store database will no longer accept connections from the workcom machine when logged in as user hqo.n_1E7.

revokeconnection workcom hqo.n_1E7

unregisterdatastore

You can use the unregisterdatastore command utility to do the following:

  • Unregister a primary relational or tile cache data store machine from your ArcGIS Server site. Only do this if you have deleted the hosted feature and tile layers that use the data in the data store. If you don't, you will have unusable layers left in your portal and unusable services running on your hosting server.

    Note that if you have a standby machine, you must first remove it from the data store before you can unregister the primary machine.

  • Unregister a single-machine spatiotemporal big data store.

You would unregister a data store from your ArcGIS Server site if you decide you no longer want to use the data store or the services that depend on it. When you unregister a machine from the data store, ArcGIS Server can no longer connect to that machine, and all services that contained data from the unregistered data store will no longer function. This command does not delete the data, however; if you decide you still need the data store, you can use the registerdatastore or configuredatastore utility to add it back.

The unregisterdatastore utility can only be run on the primary data store machine.

Syntax

unregisterdatastore [--prompt {yes | no}]

Example

Here, the unregisterdatastore utility is run with a prompt returned. This is the default behavior. To suppress the prompt, specify --prompt No.

unregisterdatastore

You are going to unregister the data store.
Do you want to continue (Yes or No)?Yes

updatebackupretaindays

ArcGIS Data Store retains relational data store backup files for seven days by default. You can change how often backup files are purged from the backup directory by running the updatebackupretaindays utility.

The updatebackupretaindays utility can only be run on the primary data store machine.

Syntax

updatebackupretaindays <number of days>

Example

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

updatebackupretaindays 10

updatebackupschedule

By default, ArcGIS Data Store creates a full backup every four days. You can change how often a full backup is created by running the updatebackupschedule utility.

Specify a start time using 24-hour clock notation, for example, 00:00:00 for midnight and 13:00:00 for 1 p.m. Use the frequency option to specify the number of days between backups. To disable automatic backups, set the frequency to 0. If you disable automatic backups, be sure to run the backupdatastore utility to create full backups manually.

You can only run the updatebackupschedule utility on the primary data store machine.

Syntax

updatebackupschedule [--starttime <local server time>] --frequency <number of days>

If you do not specify a new start time, the existing start time setting does not change.

Example

In this example, full backups will take place at 11 p.m. (local server time) every 10 days:

updatebackupschedule --starttime 23:00:00 --frequency 10

updatelicense

If your ArcGIS for Server license expires, you must update the license on the ArcGIS for Server site. The license information is also stored in the ArcGIS Data Store relational data store; therefore, after updating the license of the ArcGIS for Server site with which the data store is configured, you must update the license in the data store. To do that, run the updatelicense utility from the machine where your primary ArcGIS Data Store is installed. If you have a standby ArcGIS Data Store, the updated license will be replicated to it.

Syntax

updatelicense

Example

After you update the ArcGIS for Server license, run the updatelicense utility to move the new license to the data store.

updatelicense