list-coprocessors¶

Description¶

Lists coprocessors in a database.

Synopsis¶

  list-coprocessors
[--environment <value>]
[--database <value>]
[--table-name <value>]
[--command-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment (string)

The name or CRN of the environment.

--database (string)

The name or CRN of the database.

--table-name (string)

Fully qualified table name.

--command-id (integer)

The command ID for the requested coprocessor.

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

environment -> (string)

The name or CRN of the environment.

database -> (string)

The name or CRN of the database.

coprocessors -> (array)

The list of coprocessors.

item -> (object)

An instance of a coprocessor.

tableName -> (string)

Fully qualified table name.

coprocessorCanonicalName -> (string)

The coprocessor canonical name. It is unique per database.

coprocessorLocationUrl -> (string)

The coprocessor location URL.

coprocessorArgs -> (string)

The optional coprocessor arguments in comma-separated list.

status -> (string)

Coprocessor status type. ADD_NEW - When an add coprocessor request was just requested. ADD_IN_PROGRESS - When an add coprocessor request is in progress. ADD_FAILED - When an add coprocessor request has failed. ADD_SUCCESSFUL - Add coprocessor request has been completed successfully. REMOVE_NEW - When a remove coprocessor request was just requested. REMOVE_IN_PROGRESS - When a remove coprocessor is in progress. REMOVE_FAILED - When a remove coprocessor request has failed. REMOVE_SUCCESSFUL - Remove coprocessor request has been completed successfully.

commandId -> (integer)

The last committed command ID of the coprocessor.

statusReason -> (string)

The reason of the current status.

Form Factors¶

public