This topic describes the utilities commands of OceanBase Shell (OBShell). You can use utilities commands to manage OBShell.
obshell utilities show
You can run this command to display the information of a specified task.
${home_path}/bin/obshell utilities show -i
# example
${home_path}/bin/obshell utilities show -i 11
The following table describes the options in the command.
| Option | Required | Data type | Default value | Description |
|---|---|---|---|---|
| -i, --ID | Yes | string | N/A | The ID of the task whose information you want to view. |
| -d, --detail | No | N/A | Specifies to display the details of the task. |
obshell utilities stop
You can run this command to stop an unfinished task.
${home_path}/bin/obshell utilities stop -i
# example
${home_path}/bin/obshell utilities stop -i 11
The following table describes the options in the command.
| Option | Required | Data type | Default value | Description |
|---|---|---|---|---|
| -i, --ID | Yes | string | None | The ID of the task to be stopped. |
obshell utilities rollback
You can run this command to roll back a failed task.
${home_path}/bin/obshell utilities rollback -i
# example
${home_path}/bin/obshell utilities rollback -i 11
The following table describes the options in the command.
| Option | Required | Data type | Default value | Description |
|---|---|---|---|---|
| -i, --ID | Yes | string | None | The ID of the task to be rolled back. |
obshell utilities rerun
You can run this command to retry a failed task.
${home_path}/bin/obshell utilities rerun -i
# example
${home_path}/bin/obshell utilities rerun -i 11
The following table describes the options in the command.
| Option | Required | Data type | Default value | Description |
|---|---|---|---|---|
| -i, --ID | Yes | string | None | The ID of the task to be retried. |
obshell utilities skip
You can run this command to skip a failed task.
${home_path}/bin/obshell utilities skip -i
# example
${home_path}/bin/obshell utilities skip -i 11
The following table describes the options in the command.
| Option | Required | Data type | Default value | Description |
|---|---|---|---|---|
| -i, --ID | Yes | string | None | The ID of the task to be skipped. |