このドキュメントでは、obshellのバックアップコマンド群について説明します。バックアップコマンド群は、バックアップ設定の設定やバックアップタスクの確認に使用できます。このコマンド群を使用するには、OceanBaseクラスタが初期化されている必要があります。コマンド内で-h / --helpオプションを設定することで、コマンドのヘルプ情報を表示できます。タスク実行時にエラーが発生した場合は、-v / --verboseオプションを設定して、コマンドの詳細な実行プロセスを確認することもできます。
obshell backup set-config
このコマンドを使用すると、すべてのテナントまたは指定したテナントに対してバックアップ関連のパラメータを設定できます。
${home_path}/bin/obshell backup set-config [flags]
# example
/home/admin/oceanbase/bin/obshell backup set-config -t tenant1 -d /path/to/backup/data -a /path/to/backup/archive
home_path はOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。
オプションの説明は以下の表を参照してください：
オプション名 |
必須 |
データ型 |
デフォルト値 |
説明 |
|---|---|---|---|---|
| -t/--tenant_name | いいえ | string | なし | バックアップ対象のテナント名を設定します。設定しない場合、クラスタ内のすべてのテナントに適用されます。 |
| -d/--data_backup_uri | いいえ | string | なし | テナントのデータバックアップ宛先を設定します。以前にバックアップ宛先が設定されている場合、このオプションを指定しないと、以前の設定が使用されます。以前にバックアップ宛先が設定されていない場合、このオプションを指定しないと、デフォルトで空になります。
説明このオプションは、 |
| -a/--archive_log_uri | いいえ | string | なし | テナントのログアーカイブ宛先を設定します。以前にログアーカイブ宛先が設定されている場合、このオプションを指定しないと、以前の設定が使用されます。以前にログアーカイブ宛先が設定されていない場合、このオプションを指定しないと、デフォルトで空になります。
説明このオプションは、 |
| -u/--backup_base_uri | いいえ | string | なし | すべてのテナントのバックアップ宛先を設定します。設定後、このパス配下に各テナントのデータバックアップパスとログアーカイブパスを一定のルールで結合したファイルが作成されます。
説明このオプションは、 |
| -c/--log_archive_concurrency | いいえ | int | なし | ログアーカイブのワーカースレッド総数を設定します。 |
| -b/--binding | いいえ | string | Optional | Optional(ユーザービジネス優先)とMandatory(アーカイブ優先)のみサポートしています。設定しない場合、デフォルトでOptionalモードになります。 |
| -i/--piece_switch_interval | いいえ | string | なし | piece切り替え周期を設定します。値の範囲は[1d, 7d]です。 |
| -l/--archive_lag_target | いいえ | string | なし | テナントログアーカイブの遅延時間を制御します。変更する場合は、ログアーカイブ宛先の設定が完了していることを確認してください。 |
| -D/--delete_policy | いいえ | string | default | クリーンアップポリシーを設定します。クリーンアップポリシーが設定されたテナントは、毎時間1回自動クリーンアップが実行されます。現在、defaultのみサポートされており、これは -d/--data_backup_uri と -a/--archive_log_uri の値のうちバックアップされたもののみを対象とする自動クリーンアップを意味します。 |
| -r/--delete_recovery_window | いいえ | string | なし | バックアップデータの復元可能な時間窓を設定します。設定時には時間単位を指定する必要があります。このオプションの使用については、バックアップ関連パラメータの紹介を参照してください。 |
| -s/--ha_low_thread_score | いいえ | int | なし | バックアップやバックアップクリーンアップなどの中低優先順位タスクの現在のワーカースレッド数を指定します。値の範囲は[0, 100]です。 |
| -y/--yes | いいえ | なし | なし | このオプションには値を指定する必要がなく、コマンドでの設定は二度目の確認をスキップすることを意味します。 |
obshell cluster backup
このコマンドを使用すると、クラスタ内のすべてのテナントに対してバックアップ関連のパラメータを設定し、バックアップを実行できます。コマンドの詳細な使用方法については、クラスタレベルバックアップの開始を参照してください。
${home_path}/bin/obshell cluster backup [flags]
# example
/home/admin/oceanbase/bin/obshell cluster backup -u /path/to/backup --backup_mode incremental --encryption MySecretPassword
home_path はOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。
オプションの説明は以下の表を参照してください：
オプション名 |
必須 |
データ型 |
デフォルト値 |
説明 |
|---|---|---|---|---|
| -u/--backup_base_uri | いいえ | string | なし | すべてのテナントのバックアップ宛先を設定します。設定後は、このパスに各テナントのデータバックアップパスとログアーカイブパスを一定のルールで結合したものが作成されます。以前にバックアップ宛先が設定されている場合、ここでこのオプションを構成しない場合は、以前に設定された構成が採用されます。以前にバックアップ宛先が設定されていない場合、ここでこのオプションを構成しない場合は、デフォルトで空になります。 |
| -m/--backup_mode | いいえ | string | full | データバックアップモード。取り得る値は full と incremental で、それぞれフルバックアップ (full) と増分バックアップ (incremental) を表します。 |
| -c/--log_archive_concurrency | いいえ | int | なし | ログアーカイブの総ワーカースレッド数を設定します。 |
| -b/--binding | いいえ | string | Optional | アーカイブとビジネスの優先モードを設定します。現在、Optional (ユーザービジネス優先) と Mandatory (アーカイブ優先) の設定をサポートしています。設定しない場合、デフォルトは Optional モードです。 |
| -i/--piece_switch_interval | いいえ | string | なし | piece の切り替え間隔を設定します。取り得る範囲は [1d, 7d] です。 |
| -e/--encryption | いいえ | string | なし | バックアップ後のバックアップセットにパスワードを設定します。このオプションを設定した場合、そのバックアップセットを使用して復元する際には、このパスワードを入力する必要があります。また、このパスワードは削除できません。 |
| -l/--archive_lag_target | いいえ | string | なし | テナントのログアーカイブの遅延時間を制御します。変更が必要な場合は、ログアーカイブ宛先の設定が完了していることを確認してください。 |
| -D/--delete_policy | いいえ | string | default | クリーンアップポリシーを設定します。クリーンアップポリシーが設定されたテナントは、毎時1回自動クリーンアップが実行されます。現在、default の設定のみをサポートしており、これは -u/--backup_base_uri の値に含まれるバックアップのみを自動クリーンアップすることを意味します。 |
| -r/--delete_recovery_window | いいえ | string | なし | バックアップデータの復元可能な時間窓を設定します。設定時には時間単位を指定する必要があります。このオプションの使用については、バックアップ関連パラメータの紹介を参照してください。 |
| -s/--ha_low_thread_score | いいえ | int | なし | バックアップ、バックアップクリーンアップなどの中低優先順位タスクの現在のワーカースレッド数を指定します。取り得る範囲は [0, 100] です。 |
| -P/--plus_archive | いいえ | なし | なし | データバックアップ処理中にアーカイブログも同時にバックアップするかどうかを制御します。値を指定する必要はありません。このオプションを追加すると、最終バックアップディレクトリにアーカイブログを含む完全なデータセットが生成されます。 |
| -y/--yes | いいえ | なし | なし | このオプションには値を指定する必要はありません。コマンドでの設定は、二度目の確認をスキップすることを意味します。 |
obshell tenant backup
このコマンドを使用すると、指定したテナントのバックアップ関連パラメータを設定してバックアップを実行できます。
${home_path}/bin/obshell tenant backup <tenant_name> [flags]
# example
/home/admin/oceanbase/bin/obshell tenant backup t1 -d /path/to/backup/data --backup_mode incremental --encryption MySecretPassword
home_path はOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name はバックアップ対象のテナント名を設定する必要があります。
コマンドのオプション説明は以下の通りです：
オプション名 |
必須 |
データ型 |
デフォルト値 |
説明 |
|---|---|---|---|---|
| -d/--data_backup_uri | いいえ | string | なし | テナントのデータバックアップ宛先を設定します。以前にバックアップ宛先が設定されている場合、このオプションを指定しない場合は、以前の設定が適用されます。以前にバックアップ宛先が設定されていない場合、このオプションを指定しない場合は、デフォルトで空になります。 |
| -a/--archive_log_uri | いいえ | string | なし | テナントのログアーカイブ宛先を設定します。以前にログアーカイブ宛先が設定されている場合、このオプションを指定しない場合は、以前の設定が適用されます。以前にログアーカイブ宛先が設定されていない場合、このオプションを指定しない場合は、デフォルトで空になります。 |
| -m/--backup_mode | いいえ | string | full | データバックアップモード。full と incremental の値を取り得ます。それぞれフルバックアップ (full) と増分バックアップ (incremental) を表します。 |
| -c/--log_archive_concurrency | いいえ | int | なし | ログアーカイブのワーカースレッドの総数。 |
| -b/--binding | いいえ | string | Optional | アーカイブとビジネスの優先モードを設定します。現在、Optional (ユーザービジネス優先) と Mandatory (アーカイブ優先) の設定をサポートしています。設定しない場合、デフォルトは Optional モードです。 |
| -i/--piece_switch_interval | いいえ | string | なし | piece の切り替え間隔を設定します。値の範囲は [1d, 7d] です。 |
| -e/--encryption | いいえ | string | なし | バックアップ後のバックアップセットにパスワードを設定します。このオプションを設定した場合、そのバックアップセットを使用して復元する際には、このパスワードを入力する必要があります。また、このパスワードは削除できません。 |
| -l/--archive_lag_target | いいえ | string | なし | テナントのログアーカイブの遅延時間を制御します。変更が必要な場合は、ログアーカイブ宛先の設定が完了していることを確認してください。 |
| -D/--delete_policy | いいえ | string | default | クリーンアップポリシーを設定します。クリーンアップポリシーが設定されたテナントは、毎時1回自動クリーンアップが実行されます。現在、default の設定のみをサポートしており、これは -d/--data_backup_uri と -a/--archive_log_uri の値のうち、バックアップされたもののみを対象とする自動クリーンアップを意味します。 |
| -r/--delete_recovery_window | いいえ | string | なし | バックアップデータの復元可能な時間窓を設定します。設定時には時間単位を指定する必要があります。このオプションの使用については、バックアップ関連パラメータの紹介を参照してください。 |
| -s/--ha_low_thread_score | いいえ | int | なし | バックアップ、バックアップクリーンアップなどの中低優先順位タスクの現在のワーカースレッド数を指定します。値の範囲は [0, 100] です。 |
| -P/--plus_archive | いいえ | なし | なし | データバックアップ処理中にアーカイブログも同時にバックアップするかどうかを制御します。値を指定する必要はありません。このオプションを追加すると、最終的にバックアップディレクトリにアーカイブログを含む完全なデータセットが生成されます。 |
| -y/--yes | いいえ | なし | なし | このオプションに値を指定する必要はありません。コマンドでの設定は、二度目の確認をスキップすることを意味します。 |
obshell backup show
このコマンドを使用すると、すべてのテナントまたは指定したテナントのバックアップタスクを表示できます。
${home_path}/bin/obshell backup show [flags]
# example
/home/admin/oceanbase/bin/obshell backup show -d
home_path はOceanBaseデータベースのインストールディレクトリです。obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。
オプション名 |
必須 |
データ型 |
デフォルト値 |
説明 |
|---|---|---|---|---|
| -t/--tenant_name | いいえ | string | なし | バックアップタスクを表示するテナント名を指定します。設定しない場合、クラスタ内のすべてのテナントのバックアップタスクが表示されます。 |
| -d/--show_detail | いいえ | なし | なし | バックアップタスクの詳細情報を表示するかどうかを制御します。値は不要です。 |