create-database

subtitle

Create opDb

version

0.9.102

Description

Create a operational database in a environment

Synopsis

  create-database
--environment-name <value>
--database-name <value>
[--auto-scaling-parameters <value>]
[--scale-type <value>]
[--storage-type <value>]
[--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
}

--scale-type (string)

Scale type. MICRO - Create a 2-node cluster (1 gateway and 1 worker) with high availability disabled. LIGHT - Create a multi-node cluster with a light master and gateway instance type. HEAVY - Create a multi-node cluster with heavy master and gateway instance type.

Possible values:

  • MICRO

  • LIGHT

  • HEAVY

--storage-type (string)

Storage type for clusters. CLOUD_WITH_EPHEMERAL - Cloud with ephemeral storage. CLOUD - Cloud storage without ephemeral storage. HDFS - HDFS storage.

Possible values:

  • CLOUD_WITH_EPHEMERAL

  • CLOUD

  • HDFS

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

Form Factors

public