describe-database¶

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

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

gatewayNodesCount -> (integer)

Number of gateway nodes for the database.

restworkerNodesCount -> (integer)

Number of REST Worker nodes for the database.

Form Factors¶

public