describe-database

subtitle

Describe a opDb

version

0.9.50 (BETA)

Description

Details about the operational database

Synopsis

  describe-database
--environment-name <value>
--database-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options

--environment-name (string) The name of the environment.

--database-name (string) The name of the database.

--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

databaseDetails -> (object)

Details of the databases.

databaseName -> (string)

The name of the database.

environmentCrn -> (string)

environment crn

crn -> (string)

database crn

creationDate -> (datetime)

The creation time of the database in UTC

status -> (string)

status of the database

creatorCrn -> (string)

Crn of the creator

dbVersion -> (string)

Database version

hueEndpoint -> (string)

Hue endpoint

environmentName -> (string)

Environment name

storageLocation -> (string)

HBase cloud storage location

internalName -> (string)

Internal cluster name for this database

autoScalingConfig -> (object)

A config for 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.

Form Factors

public