このドキュメントでは、obshellのリストアコマンドグループについて説明します。リストアコマンドグループは、テナントのリストアタスクをキャンセルしたり、リストアタスクを確認したりするために使用できます。このコマンドグループを使用するには、OceanBaseクラスタが初期化されている必要があります。コマンド内で-h / --helpオプションを設定すると、コマンドのヘルプ情報を表示できます。タスク実行時にエラーが発生した場合は、-v / --verboseオプションを設定して、コマンドの詳細な実行プロセスを確認できます。
obshell tenant restore
このコマンドを使用すると、バックアップファイルを指定したテナントに復元できます。
${home_path}/bin/obshell tenant restore <tenant_name> [flags]
# example
/home/admin/oceanbase/bin/obshell tenant restore mytenant --timestamp "2021-01-01T00:00:00.000+08:00" -z "zone1,zone2,zone3" -d '/path/to/backup/data' -a '/path/to/backup/clog' -u unit1
home_path はOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は復元対象のテナント名です。
コマンドのオプションの説明は以下のとおりです：
オプション名 |
必須 |
データ型 |
デフォルト値 |
説明 |
|---|---|---|---|---|
| -d/--data_backup_uri | はい | string | なし | ソーステナントのデータバックアップパス。 |
| -z/--zone | いいえ | string | なし | テナントのゾーン配置。指定しない場合、クラスタ内のすべてのゾーンをデフォルトで使用します。 |
| --unit_num | いいえ | int | 1 | テナントがターゲットゾーン上に持つユニット数。値はターゲットゾーンのノード数より小さくする必要があります。 |
| -u/--unit | いいえ | string | なし | テナントリソースプールが使用するリソース仕様。
説明
|
| --replica_type | いいえ | string | FULL | テナントがターゲットゾーン上に持つレプリカタイプ。FULL（フル機能レプリカ）または READONLY（読み取り専用レプリカ）に設定できます。
説明
|
| -p/--primary_zone | いいえ | string | RANDOM | テナントのプライマリゾーン。読み書きサービスを提供するゾーンの優先順位を指定します。例えば、primary_zone ='zone1;zone2,zone3' は、当該テナントの読み書きサービスを優先的に zone1 が提供し、zone1 が zone2、zone3 よりも優先順位が高く、zone2 と zone3 は同じ優先順位であることを意味します。 |
| -T/--timestamp | いいえ | string | なし | 指定したタイムスタンプまで復元します。形式は "2006-01-02T15:04:05.000Z07:00" のようにする必要があります。 |
| -S/--scn | いいえ | int | なし | 指定したSCNまで復元します。 |
| -a/--archive_log_uri | いいえ | string | ${data_backup_uri} | ソーステナントのログアーカイブパス。設定されていない場合、-d/--data_backup_uri の値と同じになります。 |
| -s/--ha_high_thread_score | いいえ | int | なし | 高可用性・高優先順位スレッドの現在のワーカースレッド数を設定します。値の範囲は [0,100] です。 |
| -c/--concurrency | いいえ | int | なし | データ復元の並列度を指定します。指定しない場合、デフォルトでそのテナントに割り当てられた MAX_CPU 数と等しくなります。 |
| -D/--decryption | いいえ | string | なし | バックアップの復元パスワードを設定します。データバックアップ時にパスワードが追加された場合にのみ、バックアップの復元パスワードを設定する必要があります。 |
| -k/--kms_encrypt_info | いいえ | string | なし | 暗号化情報を設定します。暗号化されていない場合、または復元時に元のキーマネジメントサービスにアクセスできる場合は、設定不要です。 |
| -y/--yes | いいえ | なし | なし | このオプションには値を指定する必要がなく、コマンドでの設定は二度目の確認をスキップすることを意味します。 |
obshell restore cancel
このコマンドを使用すると、特定のテナントの復元タスクをキャンセルできます。
${home_path}/bin/obshell restore cancel <tenant_name> [-y]
# example
/home/admin/oceanbase/bin/obshell restore cancel tenant1
home_path はOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は、復元タスクのキャンセル対象となるテナント名です。
-y/--yes を使用して、確認ダイアログの表示を省略するかどうかを指定できます。このオプションに値を指定する必要はありません。
obshell restore show
このコマンドを使用すると、指定したテナントの復元タスクを表示できます。
${home_path}/bin/obshell restore show <tenant_name> [-d]
# example
/home/admin/oceanbase/bin/obshell restore show tenant1
home_path はOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は、復元タスクを表示する対象となるテナント名です。
-d/--show_detail を使用して、復元タスクの詳細情報を表示するかどうかを指定できます。このオプションに値を指定する必要はありません。