add-coprocessor¶
- subtitle
Add a coprocessor for a specific table
- version
0.9.128
Description¶
Adds a coprocessor for a specific table.
Synopsis¶
add-coprocessor
--table-name <value>
--coprocessor-canonical-name <value>
[--coprocessor-location-url <value>]
[--coprocessor-args <value>]
[--environment <value>]
[--database <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]
Options¶
--table-name
(string)
Fully qualified table name.
--coprocessor-canonical-name
(string)
The coprocessor canonical name. It is unique per database.
--coprocessor-location-url
(string)
The coprocessor location URL. This URL could be an object store path, or it could be an HDFS path if it’s a built-in coprocessor.
--coprocessor-args
(string)
The optional coprocessor arguments in comma-separated list.
--environment
(string)
The name or CRN of the environment.
--database
(string)
The name or CRN 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¶
environment -> (string)
The name or CRN of the environment.
database -> (string)
The name or CRN of the database.
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.
creationTime -> (integer)
When the coprocessor request was submitted.
commandId -> (integer)
The command ID of the submitted request.
statusReason -> (string)
Reason for the response if any.
Form Factors¶
public