このドキュメントでは、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 | クリーンアップポリシーを設定します。クリーンアップポリシーが設定されたテナントでは、毎時間自動クリーンアップがトリガーされます。現在、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クラスタバックアップ
このコマンドを使用すると、クラスタ内のすべてのテナントに対してバックアップ関連の構成パラメータを設定し、バックアップを実行できます。コマンドの詳細な使用方法については、クラスタレベルのバックアップの開始を参照してください。
${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 | クリーンアップポリシーを設定します。クリーンアップポリシーが設定されたテナントでは、毎時間自動クリーンアップがトリガーされます。現在、default に設定することのみがサポートされており、これは -u/--backup_base_uri 値のバックアップのみを自動クリーンアップすることを意味します。 |
| -r/--delete_recovery_window | いいえ | string | なし | バックアップデータの復旧可能な時間窓を制御します。設定時には時間単位を指定する必要があります。このオプションの使用については、バックアップ関連パラメータの紹介を参照してください。 |
| -s/--ha_low_thread_score | いいえ | int | なし | バックアップ、バックアップクリーンアップなどの中低優先度タスクの現在のワーカースレッド数を指定します。値の範囲は[0, 100]です。 |
| -P/--plus_archive | いいえ | なし | なし | データバックアップ処理中にアーカイブログも同時にバックアップするかどうかを制御します。値を渡す必要はありません。このオプションを追加すると、最終バックアップディレクトリにアーカイブログを含む完全なデータセットが生成されます。 |
| -y/--yes | いいえ | なし | なし | このオプションに値を渡す必要はありません。コマンドでの設定は、二度目の確認をスキップすることを意味します。 |
obshellテナントバックアップ
このコマンドを使用すると、指定されたテナントに対してバックアップ関連の構成パラメータを設定し、バックアップを実行できます。
${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 の2種類で、それぞれフルバックアップ（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 | クリーンアップポリシーを設定します。クリーンアップポリシーが設定されたテナントでは、毎時間自動クリーンアップが実行されます。現在、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 | いいえ | なし | なし | バックアップタスクの詳細情報を表示するかどうかを制御します。値を指定する必要はありません。 |