update-database¶

Description¶

Update an operational database in an environment

Synopsis¶

  update-database
--environment-name <value>
--database-name <value>
[--auto-scaling-parameters <value>]
[--num-desired-strong-meta-servers <value>]
[--remove-strong-meta-servers | --no-remove-strong-meta-servers]
[--num-desired-restworker-nodes <value>]
[--remove-restworker-nodes | --no-remove-restworker-nodes]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-name (string)

environment name

--database-name (string)

database name

--auto-scaling-parameters (object)

A Parameters to configure AutoScaling

targetedValueForMetric -> (integer)

The target value of the metric a user expect to maintain for the cluster

maxWorkersForDatabase -> (integer)

Maximum number of worker nodes as per this metrics can be scaled up to.

maxWorkersPerBatch -> (integer)

Maximum number of worker nodes as per this metrics can be scaled up to in one batch.

minWorkersForDatabase -> (integer)

Minimum number of worker nodes as per this metrics can be scaled down to.

evaluationPeriod -> (integer)

Period of metrics(in seconds) needs to be considered.

minimumBlockCacheGb -> (integer)

The amount of block cache, in Gigabytes, which the database should have.

Shorthand Syntax:

targetedValueForMetric=integer,maxWorkersForDatabase=integer,maxWorkersPerBatch=integer,minWorkersForDatabase=integer,evaluationPeriod=integer,minimumBlockCacheGb=integer

JSON Syntax:

{
  "targetedValueForMetric": integer,
  "maxWorkersForDatabase": integer,
  "maxWorkersPerBatch": integer,
  "minWorkersForDatabase": integer,
  "evaluationPeriod": integer,
  "minimumBlockCacheGb": integer
}

--num-desired-strong-meta-servers (integer)

The desired number of strong meta servers for this database. A positive, non-zero number is required. Use remove-strong-meta-servers to remove strong meta servers entirely. Requires the COD_STRONG_META_SERVERS entitlement.

--remove-strong-meta-servers | --no-remove-strong-meta-servers (boolean)

Removes any strong meta servers provisioned for this database. Requires the COD_STRONG_META_SERVERS entitlement.

--num-desired-restworker-nodes (integer)

Sets the desired number of REST Worker nodes for the database. A positive, non-zero number is required. Requires the COD_RESTWORKERS entitlement.

--remove-restworker-nodes | --no-remove-restworker-nodes (boolean)

Removes any REST Worker nodes provisioned for this database. Requires the COD_RESTWORKERS entitlement.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

status -> (string)

Status of whether the update was successful or not.

Form Factors¶

public