Skip To Content

Upgrade ArcGIS Data Store

ArcGIS Data Store is registered with the GIS Server site that is set as the hosting server for an ArcGIS Enterprise deployment. You must upgrade all components of this deployment to the same version.

Prepare to upgrade ArcGIS Data Store

Carefully review the following information and complete any required actions before you upgrade ArcGIS Data Store:

  • Obtain new authorization files from My Esri and apply them to Portal for ArcGIS and ArcGIS Server before upgrading to 11.0.
  • Upgrading directly to ArcGIS Data Store 11.0 from version 10.6.1 or earlier is not supported. To upgrade ArcGIS Data Store 10.6.1 or earlier, first upgrade to an interim version (10.7.x - 10.9.x) and then upgrade that version to 11.0. Read the upgrade documentation for the interim version to confirm direct upgrades are supported for the ArcGIS Data Store version you start with.
  • Read the ArcGIS Data Store 11.0 system requirements to ensure your hardware meets current requirements.
  • Before upgrading a relational data store or tile cache data store, check the size of the ArcGIS Data Store directory on each machine. Ensure that the machine contains enough free disk space to accommodate double the size of the ArcGIS Data Store directory.
  • Create a backup of all data stores in the deployment, and store the backup files in a remote, secure location.
  • Download the latest ArcGIS Data Store, Portal for ArcGIS, ArcGIS Server, and ArcGIS Web Adaptor software installation files from My Esri.
  • Do not uninstall the previous version of ArcGIS Data Store. Running the 11.0 ArcGIS Data Store setup will automatically upgrade your ArcGIS Data Store 10.7 or later deployment to 11.0. There is no need to obtain and install each previously released version in sequence.
  • For the ArcGIS Enterprise portal to function, it must be the same version as the hosting server and the hosting server must be the same version as ArcGIS Data Store. You also need to reinstall your ArcGIS Web Adaptor instances to the same version as ArcGIS Server.
  • If portal has a federated ArcGIS GeoEvent Server site, stop the ArcGIS GeoEvent Server service on all machines before you upgrade ArcGIS Server.
  • If you have a tile cache data store that is running in primary-standby mode, ensure the standby machine has access to the default backup location before you upgrade. If it does not, there will be no default backup location for your tile cache data store after you upgrade, and you will have to configure one.
  • If you have a tile cache data store that contains more than one machine and you are upgrading from 10.7.x, 10.8.x, or 10.9, you must also open ports 29079–29090 and 4369 in the firewall.
  • If you upgrade an ArcGIS Data Store 10.9 object store to 11.0, you must open ports 29878 (HTTP) and 29879 (HTTPS) on the object store machines to allow the hosting server to communicate with the object store. At 10.9, port 9900 was used. This port is no longer required. You must also open ports 9880 (HTTP) and ports 9820, 9830, and 9840 (TCP) for communication between object store machines if the object store is deployed in cluster mode.
  • The following ports must be available on the relational data store machines before you upgrade: 25672, 44369, 45671, and 45672. The first two must be available, the second two must be open for communication with the hosting server or other federated ArcGIS GIS Server sites. If you do not open these ports, you cannot create service webhooks (a beta feature at this release) in the ArcGIS Enterprise deployment.
  • ArcGIS Data Store 11.0 object stores deployed in cluster mode must contain an odd number of machines. When you upgrade a clustered 10.9 object store to 11.0, you may need to add a machine to the object store after you upgrade.
  • If you're upgrading a 10.8.1 spatiotemporal big data store, check to see if the ArcGIS Enterprise deployment contains ArcGIS GeoEvent Server map services that use a square or hexagon aggregation. If it does, you must complete additional steps after upgrading the spatiotemporal big data store to correct a rendering issue.
  • ArcGIS Data Store is always used as part of an ArcGIS Enterprise deployment, and you must upgrade certain components of the deployment before you upgrade ArcGIS Data Store. Read the next section and upgrade the required ArcGIS Enterprise components before you upgrade ArcGIS Data Store.

ArcGIS Enterprise upgrade order

The recommended order to upgrade the components in your ArcGIS Enterprise deployment is as follows:

  1. Upgrade Portal for ArcGIS.
  2. Upgrade ArcGIS Web Adaptor (for Portal for ArcGIS) for IIS or Java (Windows).
  3. Upgrade the ArcGIS Server site serving as the portal's hosting server.
  4. Upgrade ArcGIS Web Adaptor (for ArcGIS Server) for IIS or Java (Windows).
  5. Upgrade ArcGIS Data Store.
  6. If your ArcGIS Enterprise deployment includes them, upgrade federated servers.

    Most federated servers must match the version of the base ArcGIS Enterprise deployment. For information on supported versions for federated servers, see Federate an ArcGIS Server with your portal.

    See the upgrade information for the type of federated servers you need to upgrade.

Steps to upgrade ArcGIS Data Store

Once you have your installation files and backup files and have upgraded the hosting server, complete the upgrade steps for each type of data store. All data stores registered to the same ArcGIS Server site must run the same ArcGIS Data Store release. Keep the following in mind when upgrading ArcGIS Data Store:

  • Always install ArcGIS Data Store on all machines in a data store before reconfiguring the data store.
  • Do not uninstall ArcGIS Data Store before installing the new version.
  • If you have primary and standby machines in your relational or tile cache data store, install the new version of ArcGIS Data Store on the primary and standby machines, and then reconfigure the data store from either machine.
  • If you have multiple tile cache data store, spatiotemporal big data store, or object store machines configured with the hosting server site, install the new version of ArcGIS Data Store on every data store machine.

You can upgrade using an interactive wizard-driven experience by launching the Setup.exe program, or run Setup.exe to install the software only and run the configuredatastore utility from a command prompt or script to silently upgrade ArcGIS Data Store. No matter which method you use, the Setup.exe installation file detects and updates the existing installation of ArcGIS Data Store.

Note:

Upgrading ArcGIS Data Store restarts the ArcGIS Data Store service.

Upgrade using an interactive wizard-driven experience

After you complete the steps outlined in Prepare to upgrade ArcGIS Data Store and have upgraded the ArcGIS Enterprise components that must be upgraded before ArcGIS Data Store, follow these steps to upgrade your data stores using an interactive wizard. If you want to upgrade using commands instead, proceed to the next section.

  1. If you are using a spatiotemporal big data store with ArcGIS GeoEvent Server, sign in to ArcGIS GeoEvent Server Manager and stop the feature services used to archive data.
  2. Update the ArcGIS Data Store installation on every data store machine.

    To update the installation, run the ArcGIS Data Store Setup.exe on every machine that participates in a data store that is configured with the same hosting server. Do not uninstall the existing ArcGIS Data Store installation.

    When you install ArcGIS Data Store to upgrade from 10.9.1 or earlier, all data store types—relational, tile cache, object, graph, and spatiotemporal big data store—are installed. If ArcGIS Data Store is installed on Microsoft Windows, after you upgrade, you can remove data store types that were never configured and that you don't need.

  3. During the installation, read the license agreement and accept it, or exit if you do not agree with the terms.

    If you accept the license agreement, the ArcGIS Data Store setup program displays the features that will be installed.

  4. The account used by your existing installation is prepopulated in the ArcGIS Data Store input box. Provide the password for the account.

    Typically, this is the password you defined when installing the software. If the password has changed since you installed the software, you need to provide the password you designated when modifying the account. If the password is not validated successfully, an error message is displayed indicating the password is invalid. If you are unsure of the password for the account, contact your system administrator.

  5. Caution:

    When the installation program completes, it automatically opens the Data Store Configuration wizard in your default browser. Do no proceed with configuration until you have installed the same version of ArcGIS Data Store on every data store machine.

  6. Once you have updated the ArcGIS Data Store installation on all data store machines, open a supported web browser and clear the browser cache, including cookies.
  7. Run the Data Store Configuration wizard to configure each type of data store to complete the upgrade.

    How many times you run the Data Store Configuration wizard depends on your configuration.

    • For relational and tile cache (primary-standby mode) data stores, connect to either the primary or standby machine from the Data Store Configuration wizard. Completing the steps in the wizard upgrades the data store on both machines.
    • If your relational and tile cache data stores are on the same machine, you only have to run the Data Store Configuration wizard once to upgrade both data stores.
    • For tile cache (cluster mode) and spatiotemporal big data stores, connect to any of the clustered tile cache or spatiotemporal big data store machines from the Data Store Configuration wizard. Complete the steps in the wizard to upgrade all machines in that data store.

  8. The following steps take you through the Data Store Configuration wizard.
  9. In the Data Store Configuration wizard, provide the URL for the hosting server and the username and password of an ArcGIS Server administrator for the hosting server and click Next.
  10. ArcGIS Data Store checks each machine for each data store registered with this hosting server to be sure it meets the following prerequisites:
    • All machines in the data stores associated with this hosting server have the same version of ArcGIS Data Store installed.
    • All machines in the data stores associated with this hosting server are accessible.
    • The hosting server is accessible.

    If any prerequisites are not met, they appear on the Prerequisite Check page in the status for each data store type. You must correct any problems before you can proceed with upgrading.

  11. Once all prerequisites are met, the Prerequisite Check page shows each data store to be upgraded. Click Next to reconfigure these data stores with the hosting server and complete the upgrade.
  12. When configuration completes, the Upgrade Status page appears.
    • For each data store that was upgraded successfully, success appears in Status field. For highly available relational or tile cache (primary-standby mode) data stores, a status appears for both machines. If all data store machines upgraded successfully, click Next to proceed to the Configuration Status page. You can close the Data Store Configuration wizard at this point.
    • If any upgrades were not successful, that data store or machine shows a failed status, and messages are displayed to help you troubleshoot the problem. Correct the problems and run the Data Store Configuration wizard again to upgrade the machines that previously failed.
  13. If you have a spatiotemporal big data store, confirm the spatiotemporal big data store shows a status of healthy.

    To determine a data store's status, log in to the ArcGIS Server Administrator Directory for the hosting server and run the validate REST command.

  14. If the ArcGIS Enterprise portal has federated ArcGIS GeoEvent Server, ArcGIS GeoAnalytics Server, ArcGIS Mission Server, or ArcGIS Knowledge Server sites, upgrade these sites.

    Once the federated sites are upgraded, confirm that the services running on the sites are functional.

Upgrade using commands

Rather than run the setup program, you can run the Setup.exe file at a command prompt or in a batch script to update the ArcGIS Data Store. To avoid receiving a prompt to proceed with the upgrade, run the command in silent mode. To do so, include the /qb parameter in the script.

After you complete the steps outlined in Prepare to upgrade ArcGIS Data Store and have upgraded the ArcGIS Enterprise components that must be upgraded before ArcGIS Data Store, run the ArcGIS Data Store setup file on every machine in the data store to install the new software version. Next, run configuredatastore on every data store machine to upgrade.

  1. If you are using a spatiotemporal big data store with ArcGIS GeoEvent Server, sign in to ArcGIS GeoEvent Server Manager and stop the feature services used to archive data.
  2. Update the ArcGIS Data Store installation on every data store machine.

    Run the Setup.exe file from a command prompt or in a script on every machine in your data store. For example, if you have a highly available relational data store (two machines) and a highly available spatiotemporal big data store that includes three machines, run the Setup.exe file on all five machines before you proceed with configuration.

    Note:

    Do not uninstall the existing ArcGIS Data Store installation.

    When you install ArcGIS Data Store to upgrade from 10.9.1 or earlier, all data store types—relational, tile cache, object, graph, and spatiotemporal big data store—are installed. If ArcGIS Data Store is installed on Microsoft Windows, after you upgrade, you can remove data store types that were never configured and that you don't need.

    When upgrading using Setup.exe in silent mode, you must specify the ArcGIS Data Store account. Typically, this is the account you defined when installing the software. If the account has changed since you installed, you need to provide the username and password you designated when modifying the ArcGIS Data Storeaccount.

    If you do not specify the ArcGIS Data Store account, or it does not match the account used by your current installation, the installation process displays a message indicating the credentials could not be validated. As a result, the installation will exit.

    In the following example, the account used by the software is myaccount:

    <path to ArcGIS Data Store setup download folder>\Setup.exe /qb USER_NAME=myaccount PASSWORD=mypassword

    For example, to run the command with a domain account, such as mydomain\myaccount, with the password 4myI.s0nly, type the following:

    \\machinename\mydownloadfolder\Setup.exe /qb USER_NAME=mydomain\myaccount PASSWORD=4myI.s0nly

    Caution:

    Command line parameters are case sensitive. If you are having trouble upgrading, confirm the case matches the properties as shown in the examples.

  3. After you install the new version of ArcGIS Data Store on every machine in the data store, reconfigure each type of data store to complete the upgrade.
  4. Use the configuredatastore command utility to reconfigure the data store with the same GIS Server site you were using before upgrading. You must run the command prompt as an administrator on the machine where ArcGIS Data Store is installed.

    How many times you run the configuredatastore utility depends on your configuration.

    • For data stores running in primary-standby mode, sign in to either the primary or standby machine as the user who installed ArcGIS Data Store and run the configuredatastore utility. This upgrades the data store on both the primary and standby machines.
    • If your relational and tile cache data stores are on the same machine, running the configuredatastore utility upgrades both.
    • For data stores running in cluster mode, sign in to any of the machines as the user who installed ArcGIS Data Store and run the configuredatastore utility. This upgrades all machines in the clustered data store.

    In this example, the configuredatastore utility is run on a machine where both the relational and tile cache data stores are running. Both data stores are configured with the GIS Server site https://myserver.network.com:6443/arcgis:

    configuredatastore https://myserver.network.com:6443/arcgis serveradmin MyAdminPassword C:\arcgisdatastore --stores relational,tilecache

    In this example, the configuredatastore utility is run on one of the machines in a spatiotemporal big data store that is configured with the GIS Server site https://gisserver.mynetwork.com:6443/arcgis:

    configuredatastore https://gisserver.mynetwork.com:6443/arcgis serveradmin MyAdminPassword C:\arcgisdatastore --stores spatiotemporal

    Running the configuredatastore utility restarts ArcGIS Data Store on all machines in the data store.

    Before upgrading, ArcGIS Data Store confirms that all machines in the data store have the same version of ArcGIS Data Store installed and all machines are accessible. If any machines are not updated or accessible, ArcGIS Data Store cannot proceed with the upgrade. Correct the installation or network problems and run the configuredatastore utility again.

  5. If you have a spatiotemporal big data store, confirm the spatiotemporal big data store shows a status of healthy.

    To determine a data store's status, log in to the ArcGIS Server Administrator Directory for the hosting server and run the validate REST command.

  6. If the ArcGIS Enterprise portal has federated ArcGIS GeoEvent Server, ArcGIS GeoAnalytics Server, ArcGIS Mission Server, or ArcGIS Knowledge Server sites, upgrade these sites.

    Once the federated sites are upgraded, confirm that the services running on the sites are functional.

Considerations after upgrading ArcGIS Data Store

ArcGIS Data Store backups that you created before upgrading cannot be used to restore an ArcGIS Data Store deployment. Therefore, it is recommended that you create full backups of all data stores after upgrading. This provides you with a usable full backup in case anything happens before your next scheduled backup.

After upgrading, confirm that your data stores are accessible. You can do this from ArcGIS Server Manager or the ArcGIS Server Administrator Directory. Also confirm that your hosted feature and scene layers still work.

Instructions for validating your data stores and confirming that layers are running from ArcGIS Server Manager are provided below.

The last section below includes steps you must complete after upgrading a spatiotemporal big data store from 10.8.1 if the ArcGIS Enterprise deployment includes ArcGIS GeoEvent Server map services that use square or hexagon aggregations.

Validate data stores

You can sign in to ArcGIS Server Manager to validate that your GIS Server site can still communicate with each of your data stores.

Follow these steps to validate a data store from ArcGIS Server Manager:

  1. Sign in to ArcGIS Server Manager.
  2. Go to Site > Data Stores.
  3. Check the box next to the data store you want to validate. (ArcGIS_Data_Store).
  4. Click Validate.

If the data store is running and the GIS Server site can communicate with it, a green check mark appears in the Status column.

Confirm layers work

You should also ensure your services are still working after you upgrade.

  1. Sign in to ArcGIS Server Manager.
  2. Go to Services > Hosted.
  3. Check to see that all services are running.

Correct ArcGIS GeoEvent Server map service rendering issues

To correct rendering issues caused by BUG-000139639, you must run the upgradedatasource utility on the spatiotemporal big data store after upgrading it from 10.8.1 if you have ArcGIS GeoEvent Server map services that are configured to use square or hexagon aggregation.

  1. From a command line window, open the ArcGIS Data Store tools directory on any machine in the spatiotemporal big data store.

    You must open the window as a Windows administrator.

  2. Run the listdatasources utility to list the GeoEvent Server map services.

    listdatasources.bat

  3. Run the upgradedatasource utility.

    No one can access the map services while their sources are being upgraded. You can specify the name of a map service when you run the upgradedatasource utility so only one service at a time is affected. Or, you can run the upgradedatasource utility without any names and all services will be upgraded. That means, though, no one can access any of the services until all are upgraded.

    In this example, all GeoEvent Server map services are upgraded:

    upgradedatasource.bat

    In this example, only one service—deliveryroutes—is upgraded.

    upgradedatasource.bat deliveryroutes