describe-dbc¶

Description¶

Describe a Database Catalog.

Synopsis¶

  describe-dbc
--cluster-id <value>
--dbc-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-id (string)

ID of the Database Catalog’s cluster.

--dbc-id (string)

ID of the Database Catalog.

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

dbc -> (object)

A Database Catalog.

crn -> (string)

The CRN of the Database Catalog.

id -> (string)

The ID of the Database Catalog.

name -> (string)

The name of the Database Catalog.

memorySize -> (string)

Metastore container memory size.

status -> (string)

Status of the Database Catalog. Possible values are: Creating, Created, Accepted, Starting, Running, Stopping, Stopped, Updating, PreUpdate, Upgrading, PreUpgrade, Restarting, Deleting, Waiting, Failed, Error.

statusChangedAt -> (datetime)

Timestamp of the last status change of the Database Catalog.

creator -> (object)

A CDP actor (user or machine user).

crn -> (string)

Actor CRN.

email -> (string)

Email address for users.

workloadUsername -> (string)

Username for users.

machineUsername -> (string)

Username for machine users.

creationDate -> (datetime)

Creation date of Database Catalog.

resourcePool -> (string)

The name of the Resource Pool the Database Catalog is in.

Form Factors: private

resources -> (map)

The actual resources used by the Database Catalog.

Form Factors: private

key -> (string)

value -> (object)

The resource requirements of a component.

Form Factors: private

cpu -> (float)

Overall CPU requirements.

memory -> (string)

Overall memory requirements.

breakdown -> (object)

Breakdown of the service memory requirements.

Form Factors: private

xms -> (string)

Java VM configuration for -Xms (initial and minimum heap size).

xmx -> (string)

Java VM configuration for -Xmx (maximum heap size).

xss -> (string)

Java VM configuration for -Xss (thread stack size).

maxDirectMemorySize -> (string)

Java VM configuration for -XX:MaxDirectMemorySize (limit for Direct Byte Buffers).

ephemeralStorage -> (string)

Temporary storage for CDW pods, used for storing configurations and temporary data needed during a process. The lifespan of ephemeral storage is tied to the pod.

localStorageSize -> (object)

Storage related information.

Form Factors: private

scratch -> (string)

Local disk space used for writing scratch data.

cache -> (string)

Local disk space used for writing cache data.

overhead -> (string)

Local disk space used for writing other temporary data, tools, etc.

Form Factors¶

public, private