describedatastore
This utility is used with all ArcGIS Data Store types.
The describedatastore utility provides information about an ArcGIS Data Store installation. It reports what data store types are installed on the machine where you run the utility and provides information about each data store type on the machine.
Note:
If a data store is installed on the machine but not configured, it will show up as an available ArcGIS Data Store, but no additional information will be returned for that data store type.
Some information is common to all data store types, and some is specific to a type of data store. The following tables list and explain the properties returned by the describedatastore utility:
General properties
The values for these properties are the same for all data store types installed on the machine.
|
Property |
Description |
|---|---|
|
ArcGIS Data Store release |
The software release number for the ArcGIS Data Store installation. |
|
Staging location |
For the relational store, the staging location is where ArcGIS Data Store extracts the compressed backup files before restoring the data store. If a data store has a cloud storage location configured for backups, backup files are first placed in the staging location before they are copied to the cloud storage location. To change the staging location, use the changestaginglocation utility. |
|
Log location |
The file directory to which ArcGIS Data Store writes log files. To change the log file location, use the changeloglocation utility. |
|
Free disk space |
The amount of available disk space left on the machine where ArcGIS Data Store is installed. |
Common properties
These properties appear for each data store type, but their values are specific to the data store for which they are listed.
|
Property |
Description |
|---|---|
|
Backup location |
The default backup location used by each type of data store. |
|
Backup schedule |
For automated backups, how often a backup is created of each type of data store. |
|
Data store status |
Indicates whether the data store is running. |
|
Owning system URL |
The hosting GIS Server site with which the data store is registered. This is usually the same hosting server for all the data stores on the machine; however, it is possible to have data stores on the same machine that are used with different ArcGIS Enterprise deployments. |
|
Portal for ArcGIS URL |
This is usually the same Portal for ArcGIS URL for all the data stores on the machine; however, it is possible to have data stores on the same machine that are used with different ArcGIS Enterprise deployments. |
|
Registered machines |
A list of all machines in the specific data store type. This property lists all machines regardless of their status. |
Relational store properties
These properties are specific to a relational store deployment.
|
Property |
Description |
|---|---|
|
Days backup retained |
The number of days that relational store backup files are retained before ArcGIS Data Store deletes them. |
|
Is point-in-time-recovery enabled |
Indicates whether the relational store is configured to create incremental backups, which allow you to restore it to a specific point in time. This setting is configured using the changedbproperties utility. |
|
SSL enabled |
Indicates whether SSL communication is enabled. |
|
Threshold for READONLY mode |
The free disk space threshold at which the relational store will be placed in read-only mode. You can change this value for the relational store using the changedbproperties utility. |
|
Maximum connections |
Indicates the maximum allowed number of connections to the relational store. |
|
Number of connections |
The number of current feature layer connections to the relational store. |
|
Data store mode |
Indicates whether the data store is in read-write or read-only mode. |
|
Last failover |
This property reports the most recent date and time that the primary machine failed, resulting in the standby machine being promoted to the primary role. This property is not listed if the data store has never failed over. |
Object store properties
These properties are specific to an object store deployment.
|
Property |
Description |
|---|---|
|
Deployment mode |
Indicates whether the data store was deployed in single instance or cluster mode. Object stores created prior to ArcGIS Data Store 11.1 will report primary-standby mode but can contain only one machine. |
|
Heap size |
The value set using the changedbproperties utility. |
|
Coordinator machines |
The names of the machines in an object store cluster that are in the coordinator role for the cluster. In a single-instance object store, the single object store machine is listed. |
These properties are specific to an object store that uses cloud storage:
|
Property |
Description |
|---|---|
|
Cloud object store name |
The name assigned to the data store when the cloud location was configured as the object store. |
|
Cloud object store provider |
The cloud platform where the object store is located. |
|
Cloud object store bucket |
The name of the bucket or storage container that is used for the object store. |
Spatiotemporal big data store properties
These properties are specific to a spatiotemporal big data store deployment.
|
Property |
Description |
|---|---|
|
Is cluster finalized |
Indicates whether the cluster contains the required minimum number of coordinator and data machines to be initialized as a functional spatiotemporal big data store. This property is set to false until the required number of machines have been configured, at which time the property is set to true. This property does not change after the initial configuration of the spatiotemporal big data store cluster. |
|
Automatic rebalance |
If this property value is set to on, the spatiotemporal big data store distributes data to other machines if any one machine is unavailable. If this property value is set to off, data will not be redistributed if a machine is unavailable. This setting is changed using the changedbproperties utility. |
|
Max rebalance off time |
When you disable rebalancing (in which case, the Automatic rebalance property value will be set to off), it is only disabled for the number of minutes indicated by this property. At the end of this period of time, the Automatic rebalance property value will be set to on. This setting is changed using the changedbproperties utility. |
|
Threshold for READONLY mode |
The free disk space threshold at which the spatiotemporal big data store will be placed in read-only mode. |
|
Member machines |
A list of the active and available machines in the spatiotemporal big data store cluster. |
|
Data store mode |
Indicates whether the data store is in read-write or read-only mode. |
|
Current coordinator machine in cluster |
The machine in the spatiotemporal big data store that is currently acting as the coordinator of all machines in the cluster. |
|
Coordinator candidate machines in spatiotemporal cluster |
Machines in the spatiotemporal big data store that have the coordinator role assigned and, therefore, can become the current coordinator. |
|
Data machines in spatiotemporal cluster |
Machines in the spatiotemporal big data store that are assigned the data role. |
Graph store properties
These properties are specific to a graph store deployment.
|
Property |
Description |
|---|---|
|
Deployment mode |
Indicates whether the data store was deployed in single instance or cluster mode. |
|
Machines to be removed |
A graph store cluster must always contain three machines. If one machine fails and cannot be recovered, run the removemachine utility to remove it from the cluster. Doing so marks the machine to be removed, and that is reported by the describedatastore utility. This property is only reported if there is a machine that is marked for removal. |
|
Is cluster finalized |
Indicates whether the cluster contains three machines to be initialized as a functional graph store cluster. This property is set to false until three machines have been configured, at which time the property is set to true. This property does not change after the initial configuration of the graph store cluster. |
Syntax
describedatastore
Example
The describedatastore utility returns general information that applies to all data stores on a machine and returns separate sections that contain information specific to each type of data store.
You should have different data stores on different machines, but to allow you to see the information returned for each type, the following output shows a machine that has all ArcGIS Data Store types on the same machine. The first two sections (Available ArcGIS Data Stores and General Information) are always returned. The data store sections returned by describedatastore vary depending on what type of data store is present on the machine where you run the utility.
./describedatastore.sh
ArcGIS Data Store types installed on this machine
==============================================================
Relational store
Spatiotemporal big data store
Graph store
Object store
General Information of ArcGIS Data Store on machine.example.com
==============================================================
ArcGIS Data Store release....12.1.0.1234
Staging location............./arcgis/datastore/staging
Log location................./arcgis/datastore/logs
Free disk space..............174.00GB
Information for relational store ds_sthiu0_5T
==============================================================
Backup location................/net/nwshare/dsbackups
Backup schedule................{"schedule-starttime":"00:00:00","schedule-frequency":"Every 1 DAYS"}
Days backup retained...........31
Data store status..............Started
SSL enabled....................true
Threshold for READONLY mode....2048MB
Last failover..................20250130190334005
Registered machines............MACHINE1.EXAMPLE.COM, MACHINE4.EXAMPLE.COM
Maximum connections............150
Owning system URL..............https://gisserver_webadaptor.example.com/server
Portal for ArcGIS URL..........https://portal_webadaptor.example.com/portal
Number of connections..........8 connection(s) to managed database
Data store mode................READWRITE
Is point-in-time recovery enabled...No
Information for spatiotemporal big data store ds_qpko99Cl
==============================================================
Is cluster finalized................Yes
Max rebalance off time..............60 minutes
Automatic rebalance ................On
Threshold for READONLY mode.........1024MB
Backup location...................../net/dirshare2/sbds_bu
Backup schedule.....................{"schedule-starttime":"02:00:00","schedule-frequency":"Every 2 DAYS"}
Member machines.....................MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM
Coordinator candidate machines in spatiotemporal cluster..MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM
Current coordinator machine in cluster......MACHINE1.EXAMPLE.COM
Data machines in spatiotemporal cluster.....MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM
Registered machines.................MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM
Owning system URL...................https://gisserver_webadaptor.example.com/server
Portal for ArcGIS URL...............https://portal_webadaptor.example.com/portal
Data store mode.....................READWRITE
Information for graph store x2b7s0n
==============================================================
Deployment mode..............cluster
Backup location............../net/dirshare3/graphbu
Backup schedule..............{"schedule-starttime":"03:00:00","schedule-frequency":"Every 3 DAYS"}
Registered machines..........MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM
Owning system URL............https://gisserver_webadaptor.example.com/server
Portal for ArcGIS URL........https://portal_webadaptor.example.com/portal
Is cluster finalized.........true
Information for object store w1tiknx
==============================================================
Deployment mode...........cluster
Backup location.........../net/dirshare4/myfiles/ods_bu
Backup schedule...........{"schedule-starttime":"04:00:00","schedule-frequency":"Every 1 DAYS"}
Heap size in MB.............4208
Coordinator machines........MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM
Registered machines.........MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM, MACHINE4.EXAMPLE.COM, MACHINE5.EXAMPLE.COM
Owning system URL.........https://gisserver.example.com:6443/server/admin
Portal for ArcGIS URL.....https://portal_webadaptor.example.com/portal
describedatastore
ArcGIS Data Store types installed on this machine
==============================================================
Relational store
Spatiotemporal big data store
Graph store
Object store
General Information of ArcGIS Data Store on machine.example.com
==============================================================
ArcGIS Data Store release....12.1.0.1234
Staging location.............C:\arcgisdatastore\staging
Log location.................C:\arcgisdatastore\logs
Free disk space..............174.00GB
Information for relational store ds_sthiu0_5T
==============================================================
Backup location..............\\nwshare\dsbackups
Backup schedule..............{"schedule-starttime":"00:00:00","schedule-frequency":"Every 7 DAYS"}
Days backup retained.........31
Data store status............Started
SSL enabled..................true
Last failover................20250130190334005
Threshold for READONLY mode..2048MB
Registered machines..........MACHINE1.EXAMPLE.COM, MACHINE4.EXAMPLE.COM
Maximum connections..........150
Owning system URL............https://gisserver_webadaptor.example.com/server
Portal for ArcGIS URL........https://portal_webadaptor.example.com/portal
Number of connections........8 connection(s) to managed database
Data store mode..............READWRITE
Is point-in-time recovery enabled...No
Information for spatiotemporal data store ds_qpko99Cl
==============================================================
Is cluster finalized................Yes
Max rebalance off time..............60 minutes
Automatic rebalance ................On
Threshold for READONLY mode.........1024MB
Backup location.....................\\nwshare2\sbds_bu
Backup schedule.....................{"schedule-starttime":"02:00:00","schedule-frequency":"Every 2 DAYS"}
Member machines.....................MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM
Coordinator candidate machines in spatiotemporal cluster..MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM
Current coordinator machine in cluster......MACHINE1.EXAMPLE.COM
Data machines in spatiotemporal cluster.....MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM
Registered machines.................MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM
Owning system URL...................https://gisserver_webadaptor.example.com/server
Portal for ArcGIS URL...............https://portal_webadaptor.example.com/portal
Data store mode.....................READWRITE
Information for graph store x2b7s0n
==============================================================
Deployment mode.............cluster
Backup location.............\\nwshare3\graphbu
Backup schedule.............{"schedule-starttime":"03:00:00","schedule-frequency":"Every 3 DAYS"}
Registered machines.........MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM
Owning system URL...........https://gisserver_webadaptor.example.com/server
Portal for ArcGIS URL.......https://portal_webadaptor.example.com/portal
Is cluster finalized........true
Information for object store w1tiknx
==============================================================
Deployment mode.............cluster
Backup location.............\\nwshare4\myfiles\ods_bu
Backup schedule.............{"schedule-starttime":"04:00:00","schedule-frequency":"Every 2 DAYS"}
Heap size in MB.............4208
Coordinator machines........MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM
Registered machines.........MACHINE1.EXAMPLE.COM, MACHINE2.EXAMPLE.COM, MACHINE3.EXAMPLE.COM, MACHINE4.EXAMPLE.COM, MACHINE5.EXAMPLE.COM
Owning system URL...........https://gisserver.example.com:6443/server/admin
Portal for ArcGIS URL.......https://portal_webadaptor.example.com/portal
If you use a cloud-service object store and run the command on the relational store machine, the utility returns information about the relational store and the cloud object store. The following example shows an object store in an Amazon Web Services bucket:
./describedatastore.sh
ArcGIS Data Store types installed on this machine
==============================================================
Relational store
General Information of ArcGIS Data Store on machine.example.com
==============================================================
ArcGIS Data Store release....12.1.0.1234
Staging location............./arcgis/datastore/staging
Log location................./arcgis/datastore/logs
Free disk space..............174.00GB
Information for relational store ds_sthiu0_5T
==============================================================
Backup location................/net/nwshare/dsbackups
Backup schedule................{"schedule-starttime":"00:00:00","schedule-frequency":"Every 1 DAYS"}
Days backup retained...........31
Data store status..............Started
SSL enabled....................true
Threshold for READONLY mode....2048MB
Last failover..................20250130190334005
Registered machines............MACHINE1.EXAMPLE.COM, MACHINE4.EXAMPLE.COM
Maximum connections............150
Owning system URL..............https://gisserver_webadaptor.example.com/server
Portal for ArcGIS URL..........https://portal_webadaptor.example.com/portal
Number of connections..........8 connection(s) to managed database
Data store mode................READWRITE
Is point-in-time recovery enabled...No
Information for cloud object stores
====================================
Cloud object store name........my_object
Cloud object store provider....Amazon
Cloud object store bucket......object7
describedatastore
ArcGIS Data Store types installed on this machine
==============================================================
Relational store
General Information of ArcGIS Data Store on machine.example.com
==============================================================
ArcGIS Data Store release....12.1.0.1234
Staging location.............C:\arcgisdatastore\staging
Log location.................C:\arcgisdatastore\logs
Free disk space..............174.00GB
Information for relational store ds_sthiu0_5T
==============================================================
Backup location..............\\nwshare\dsbackups
Backup schedule..............{"schedule-starttime":"00:00:00","schedule-frequency":"Every 7 DAYS"}
Days backup retained.........31
Data store status............Started
SSL enabled..................true
Last failover................20250130190334005
Threshold for READONLY mode..2048MB
Registered machines..........MACHINE1.EXAMPLE.COM, MACHINE4.EXAMPLE.COM
Maximum connections..........150
Owning system URL............https://gisserver_webadaptor.example.com/server
Portal for ArcGIS URL........https://portal_webadaptor.example.com/portal
Number of connections........8 connection(s) to managed database
Data store mode..............READWRITE
Is point-in-time recovery enabled...No
Information for cloud object stores
====================================
Cloud object store name......my_object
Cloud object store provider..Amazon
Cloud object store bucket....object7