changedbproperties

This ArcGIS Data Store utility is used with the relational, object, and spatiotemporal big data store.

The changedbproperties utility allows you to alter various properties depending on the type of data store you run it against.

Syntax

changedbproperties --store {relational | spatiotemporal | object} [configuration options]

You must provide the --store option and at least one configuration option. The following are supported configuration options, their descriptions, and the data store type with which each option can be used:


Configuration option	Description	Supported data store type
`--disk-threshold-readonly`	This option controls when a relational store will be placed in read-only mode to avoid loss of data due to insufficient disk space. Specify sizes in MB. The default disk space value is 1024 MB.	Relational store only
`--max-connections`	Use this parameter to specify the maximum number of connections allowed to a relational store. The relational store accepts up to 150 connections by default. Use the `--max-connections` property to change the number of connections allowed. Take into consideration that ArcGIS Data Store internal processes can take up to five connections. Also consider how many concurrent connections the 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. The number you specify cannot be less than 10. When you change the maximum number of connections allowed, the number is changed on both the primary and standby data store machines.	Relational store only
`--pitr`	This option indicates whether ArcGIS Data Store creates incremental backups of the relational store, thereby allowing you to recover the relational store to a point in time. Possible arguments for this option are `enable` or `disable`.	Relational store only The default setting is `--pitr disable`. Caution: Point-in-time recovery is dependent on the presence of full, automatic backups. Do not disable automatic backups if you set the `--pitr` option to `enable`. You must set the `--pitr` option to `enable` if you will use the webgisdr utility—which is installed with Portal for ArcGIS—to create incremental backups of your ArcGIS Enterprise deployment.
`--enablessl`	This option controls use of the Transport Layer Security (TLS) protocol for communication between the relational store and the hosting server. Supported arguments for the `--enablessl` parameter are as follows: `true`—This is the default setting. The Transport Layer Security protocol will be used when communicating between the relational store and hosting server when you specify `--store relational`. `false`—Specify `false` and `--store relational` to use HTTP communication between the hosting server and relational store.	Relational store only
`--heap-size`	Use this parameter to change the amount of heap memory (in MB) used by a spatiotemporal big data store or object store. By default, a spatiotemporal big data store uses 50% of the total RAM or 70% of the available RAM when it starts—whichever value is smaller. You can change the heap size to an amount between 512 MB and 32,000 MB, but ensure the amount you specify does not exceed the amount of RAM available on the machine. If the spatiotemporal big data store contains multiple machines, run the changedbproperties utility on each machine to increase the heap size. The amount of heap memory used by the object store by default depends on the amount of RAM available on the machine. In most cases, the object store uses 50% of the total RAM or 70% of the available RAM; whichever value is smaller. On machines with more than 20 GB of RAM, the object store uses 40% of the RAM when it starts, but only if the amount of available RAM is between 40% and 70% of total RAM. You can change the heap size for the object store to a value between 1024 MB (minimum) and 124,000 MB (maximum). However, be aware of the following: If the amount of available RAM on the machine is between 16 GB and 32 GB, the minimum viable heap size for the object store is 6 GB. Ensure that the amount you specify for the heap size does not exceed the amount of RAM available on the machine. If the object store contains multiple machines, all machines in the cluster will be updated and the object store will restart on all the machines in the cluster.	Spatiotemporal big data store and object store only
`--rebalance`	By default, this option is set to `true`, which means the spatiotemporal big data store distributes data to other machines if any one machine is unavailable. If you need to perform maintenance on one spatiotemporal big data store machine, such as upgrading it, you can temporarily shut off rebalancing by specifying `--rebalance false`. The rebalance option will be suspended for the number of minutes set for the `--max-rebalance-off` parameter.	Spatiotemporal big data store only
`--max-rebalance-off`	This option is used in combination with the `--rebalance` option to indicate how long rebalancing will remain suspended. By default, `--max-rebalance-off` is set to 60 minutes. That means if you temporarily shut off rebalancing, it will start again after 60 minutes. If you need more or less time than that to perform the maintenance task for which you suspended rebalancing, change the time setting for `--max-rebalance-off`.	Spatiotemporal big data store only
`--prompt`	When you run this utility, you are prompted to confirm the action you specified. If you automate the use of this utility, specify `--prompt no`; otherwise, the script will not proceed until you answer the prompt.	All data stores supported by this utility

Examples

The following sections include examples of using the options available with the changedbproperties utility.

Change the read-only threshold for the relational store

By default, the relational store is placed in read-only mode when free disk space drops to 1,024 MB. In the following example, there are other apps writing to the machine, so the administrator configures the relational store to be placed in read-only mode sooner: when free disk space on the machine drops to 4,000 MB:

./changedbproperties.sh --store relational --disk-threshold-readonly 4000

changedbproperties --store relational --disk-threshold-readonly 4000

You are changing the following database properties:
         ...disk space threshold to change relational store into READONLY mode to 4000MB)

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

Change the number of connections allowed to the relational store

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

./changedbproperties.sh --store relational --max-connections 100

changedbproperties --store relational --max-connections 100

You are changing the following database properties:
         ...max number of connections to 100 (on all relational 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

Enable point-in-time recovery for the relational store

By default, point-in-time recovery is disabled. In this example, point-in-time recovery is enabled for the relational store:

./changedbproperties.sh --store relational --pitr enable

changedbproperties --store relational --pitr enable

You are changing the following database properties:
         ...enable point-in-time recovery for relational store

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

Disable SSL

By default, the relational store communicates with the hosting server over HTTPS. In this example, the --enablessl parameter is used to configure the relational store to communicate with the hosting server over HTTP.

./changedbproperties.sh --store relational --enablessl false

changedbproperties --store relational --enablessl false

You are changing the following database properties:
         ...disable ssl for relational store

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

Change the heap size for the spatiotemporal big data store or object store

You can change the amount of RAM that the spatiotemporal big data store or object store uses when it starts. Heap size values are in MB.

Caution:

Decreasing the heap size could prevent the data store from starting. If you increase the heap size, do not specify a number that exceeds the amount of RAM available on the machine.

In this example, the heap size is set to 1,600 MB on a spatiotemporal big data store machine.

./changedbproperties.sh --store spatiotemporal --heap-size 1600

changedbproperties --store spatiotemporal --heap-size 1600

You are changing the following database properties:
         ...heap size for spatiotemporal store to 1600MB (on current machine)

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

In this example, the heap size is set to 2,400 MB on an object store machine.

./changedbproperties.sh --store object --heap-size 2400

changedbproperties --store object --heap-size 2400

You are changing the following database properties:
         ...heap size to 2400MB for the object store installed on this machine

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

Pause rebalancing for the spatiotemporal big data store

In this example, the administrator needs to perform a brief maintenance procedure on one machine in a spatiotemporal big data store and does not want the data store to rebalance. To do this, the --rebalance and --max-rebalance-off options are used to suspend rebalancing for 30 minutes. After 30 minutes, the spatiotemporal big data store will automatically change rebalance to true.

Because this must happen periodically, the administrator keeps the following statement in a script and sets the prompt option to no.

./changedbproperties.sh --store spatiotemporal --rebalance false --prompt no

./changedbproperties.sh --store spatiotemporal --max-rebalance-off 30 --prompt no

changedbproperties --store spatiotemporal --rebalance false --prompt no

changedbproperties --store spatiotemporal --max-rebalance-off 30 --prompt no