configuredatastore

This utility is used with all ArcGIS Data Store types.

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

Additional uses for the configuredatastore utility are as follows:

Upgrade a data store after updating the ArcGIS Data Store software on all machines in the data store.
Designate the role of a machine in a spatiotemporal big data store.
Change the deployment mode of an existing single instance graph store or object store.

Syntax

configuredatastore <ArcGIS Server host name> <ArcGIS Server administrator> <ArcGIS Server administrator password> <data store content directory> [--stores {relational | spatiotemporal | graph | object}] [--mode {singleInstance | cluster}] [--roles {coord | data}]


Option	Description
`<ArcGIS Server host name>`	This is the GIS Server site that is used or will be used as the ArcGIS Enterprise hosting server. Provide one of the following: The fully qualified domain name of one of the machines in the hosting server site in the format `gisserver.example.com` The URL of the hosting server site in the format `https://gisserver.example.com:6443` Note: Even if the GIS Server site uses a web adaptor or load balancer, you must provide the URL in the format shown above. The IP address of one of the machines in the hosting server site
`<ArcGIS Server administrator>`	Provide the username for a built-in (not organization-specific) user who has administrator privileges in the hosting GIS Server site.
`<ArcGIS Server administrator password>`	Provide the password for the account used above.
`<data store content directory>`	The data store content directory is the location on the local machine where data store files will be created. Note: This option is required the first time you run the configuredatastore utility on a machine to create a data store. Once the data store content directory is designated, this option is ignored if you run the configuredatastore utility on the same machine to create additional types of data stores or to upgrade data stores.
`--stores`	This option indicates the type of ArcGIS Data Store to configure. Valid values are as follows: `relational` `spatiotemporal` `graph` `object` If you do not specify the `--stores` option, the `relational` value is assumed.
`--mode`	This optional option applies to the graph store and object store when you create the data store. You can also use this option to change the mode of an existing graph or object store. Valid values are `singleInstance` or `cluster`. If you do not specify a mode, the object store and graph store are created in single instance mode.
`--roles`	This optional option applies to multiple machine spatiotemporal big data stores only. Supported values are `coord`, `data`, or `coord,data`. Spatiotemporal big data store machines can be created in either role or both roles. To deploy a machine in both roles, separate the two roles with a comma; for example, specify `--roles coord,data` when you run the configuredatastore utility to create a spatiotemporal big data store on a machine. For a description of each role—coordinator and data—see Add machines to a data store. You can also run the configuredatastore utility with the `--roles` option to change the role of an existing spatiotemporal big data store machine. Note: Do not include the `--roles` option when you run the configuredatastore utility to complete the upgrade of a spatiotemporal big data store. The `--roles` option is applied on a per machine basis, whereas upgrades affect the entire spatiotemporal big data store.

Configuring a specific type of data store

You specify the type of data store to create using the --stores option, as indicated above. Use the following links for a description of each type of data store:

To configure more than one data store type on the same machine, separate the types with a comma (no spaces). For example, to configure both a relational store and graph store on the same machine, specify --stores relational,graph.

Caution:

Data stores configured on the same machine compete for memory and other resources, negatively affecting performance and possibly causing the data stores to stop working. This is especially true for spatiotemporal big data stores, graph stores, and object stores; do not configure a spatiotemporal big data store, graph store, or object store on the same machine as another data store or other ArcGIS component.

If you script the creation of multiple machines in a spatiotemporal big data store, graph store, or object store, the first machine must be manually configured with the GIS Server site before you can script the creation of additional machines in the cluster. Include wait times in your script to be sure the additional machines are not added at the same time.

Each data store type has a default mode in which it is created. You can specify a different mode when you create a graph store or object store.

See Create a data store for instructions.

Configuring data stores after updating ArcGIS Data Store installations

As part of upgrading ArcGIS Data Store, you must reconfigure the existing data store machines. After you install a new version of ArcGIS Data Store over the existing ArcGIS Data Store on every data store machine, you can run the configuredatastore utility to finish upgrading that particular data store type. Where and how many times you run the configuredatastore utility to upgrade varies depending on the type of data store.

Configuration cannot proceed until you install the new version of ArcGIS Data Store on all machines in the ArcGIS Enterprise deployment.

See Upgrade ArcGIS Data Store for more information and instructions.

Changing the object store mode

To change the object store mode from single instance to cluster mode, run the configuredatastore utility to add at least two machines to the object store, and set the --mode option to cluster when you add them. This will reset the mode for the entire object store to cluster mode.

Note:

You must have a default backup location configured for the object store before you can change the mode from single instance to cluster. The machines you add to the object store must have access to this location.
You cannot change the object store mode from cluster to single instance.

Changing the graph store mode

If the graph store contains one machine, it is running in single instance mode. If it contains three machines, it is running in cluster mode.

To change the graph store mode from single instance to cluster mode, run the configuredatastore utility with the --mode option set to cluster.

Note:

You can use the --mode option to specify the graph store mode when you create it or when you upgrade a single instance graph store. You can also run the configuredatastore utility to change the mode of an existing graph store from single instance to cluster mode.
You must have a default backup location configured for the graph store before you can change the mode from single instance to cluster. The machines you add to the graph store must have access to this location.
You cannot change the graph store mode from cluster to single instance.

Changing the spatiotemporal big data store machine role

Every spatiotemporal big data store cluster must have a machine in the coordinator role that acts as the current coordinator of all the other machines in the cluster. The first machine you create in a spatiotemporal big data store must include the coordinator role, and this first machine is the current, active coordinator. To ensure that the cluster continues to work even when the current coordinator machine fails, the cluster must have at least two other machines that have the coordinator role assigned to them.

A spatiotemporal big data store cluster must also have at least one machine in the data role.

Roles are assigned to the machines when you add them to the cluster, as described in Add machines to a data store. Machines that are eligible to be a coordinator can be changed to store data only. Machines that are currently only in the data role can have the coordinator role added to them.

Supported role changes are as follows:

Specify --roles data to change a coordinator to a data machine. This is possible if there are other coordinator-eligible machines in the cluster. You can change a coordinator machine to a data role if there are at least three other coordinator-eligible machines in the cluster.
Specify --roles data to remove the coordinator role from a machine that was deployed with both roles. This leaves the machine in the data role. You can remove the coordinator role from the machine if there are at least three other coordinator-eligible machines in the cluster.
Specify --roles coord,data to add the coordinator role to a machine that was initially deployed to fill only the data role. A maximum of five machines can include the coordinator role. If there are already five coordinator machines in the cluster, you cannot add the coordinator role to a data machine in the cluster.

Tip:

Before you change a machine's role, run the describedatastore utility on one of the machines to identify what role is assigned to each machine in the spatiotemporal big data store cluster.

Examples

In this example, a data store for hosted feature layer data (relational store) is created. The name of one of the machines in the GIS Server site that will use the data store is gisserver.example.com:6443, the site administrator username and password are admin and Iph33l$ik, respectively, and the content directory for the data store is /dstore/data.

./configuredatastore.sh gisserver.example.com admin Iph33l$ik /dstore/data --stores relational --prompt no

In this example, a data store for hosted feature layer data (relational store) is created. The name of one of the machines in the GIS Server site that will use the data store is gisserver.example.com, the site administrator username and password are admin and Iph33l$ik, respectively, and the content directory for the data store is C:\datastore\data\.

configuredatastore gisserver.example.com admin Iph33l$ik c:\datastore\data\ --stores relational --prompt no

In the following example, a machine is added to an existing object store (single instance):

./configuredatastore.sh gisserver.example.com admin Iph33l$ik dsstore/cache3 --stores object --mode cluster --prompt no

configuredatastore gisserver.example.com admin Iph33l$ik c:\datastore\cache3\ --stores object --mode cluster --prompt no

In the next example, one of the data-only machines in a spatiotemporal big data store cluster has the coordinator role added to it, making it eligible to act as the coordinator if the current coordinator machine fails.

./configuredatastore.sh gisserver.example.com admin Iph33l$ik dsstore/cache3 --stores spatiotemporal --roles coord,data --prompt no

configuredatastore gisserver.example.com admin Iph33l$ik c:\datastore\cache3\ --stores spatiotemporal --roles coord,data --prompt no