このドキュメントでは、obshellのテナントコマンドグループについて説明します。テナントコマンドグループは、テナントの作成および管理に使用されます。このコマンドグループを使用するには、OceanBaseクラスタが初期化済みである必要があります。コマンド内で-h / --helpオプションを設定すると、コマンドのヘルプ情報を表示できます。タスク実行時にエラーが発生した場合は、-v / --verboseオプションを設定して、コマンドの詳細な実行プロセスを確認することもできます。
obshell tenant create
このコマンドを使用すると、業務用テナントを作成できます。
${home_path}/bin/obshell tenant create <tenant_name> [-z] [-u] [--unit_num] [--replica_type] [--primary_zone] [--charset] [--collation] [--info] [--read_only]
[--parameters] [--variables] [--whitelist] [--scenario] [--root_password]
# example
# テナントt1を作成し、クラスタの各ゾーンにFULLレプリカを配置します。使用するリソースプールの仕様はs1です。
/home/admin/oceanbase/bin/obshell tenant create t1 -u s1
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は作成するテナントの名前です。
オプションの説明は以下の表を参照してください：
| オプション名 | 必須 | データ型 | デフォルト値 | 説明 |
|---|---|---|---|---|
| -z/--zone | いいえ | string | なし | テナントのゾーン分布。指定されていない場合は、デフォルトでクラスタ内のすべてのゾーンになります。 |
| -u/--unit | いいえ | string | なし | テナントリソースプールが使用するリソース仕様。
説明
|
| --unit_num | いいえ | int | 1 | ターゲットゾーン上のテナントのユニット数。その値はターゲットゾーンのノード数より小さくなければなりません。 |
| --replica_type | いいえ | string | FULL | ターゲットゾーン上のテナントのレプリカタイプ。値として FULL (フル機能型レプリカ) または READONLY (読み取り専用型レプリカ) を指定できます。
説明
|
| --primary_zone | いいえ | string | RANDOM | テナントのプライマリゾーン。テナントが読み書きサービスを提供するゾーンの優先順位を指定します。例えば、primary_zone ='zone1;zone2,zone3' は、そのテナントが読み書きサービスを優先的に zone1 から提供し、zone1 は zone2、zone3 よりも優先順位が高く、zone2 と zone3 は同じ優先順位であることを意味します。 |
| --scenario | いいえ | string | なし | テナントのワークロードタイプを指定します。オプション値は以下のとおりです：
説明このオプションを使用してテナントのワークロードタイプを設定できるのは、OceanBaseクラスタがV4.3.0以降のバージョンの場合に限ります。 |
| --variables | いいえ | string | なし | テナントのシステム変数を指定します。形式は max_connections=1000,ob_query_time=1000000 です。 |
| --parameters | いいえ | string | なし | テナントの構成パラメータを指定します。形式は backup_data_file_size=2G,arbitration_timeout=10s です。 |
| --whitelist | いいえ | string | なし | テナントのアクセスアローリストを指定します。 |
| --root_password | いいえ | string | なし | テナントのrootユーザーのパスワードを指定します。 |
| --import_script | いいえ | bool | false | タイムゾーンデータとGISメタデータをシステムテナントにインポートするかどうかを制御します。値を渡す必要はありません。 |
| --read_only | いいえ | なし | なし | テナントが読み取り可能かどうかを指定します。 |
| --charset | いいえ | string | なし | テナントが使用する文字セットを指定します。 |
| --collate | いいえ | string | なし | テナントが使用する照合順序を指定します。 |
| --info | いいえ | string | なし | テナントの情報を指定します。 |
obshell tenant drop
このコマンドを使用すると、指定されたテナントを削除できます。
${home_path}/bin/obshell tenant drop <tenant_name> [--recycle] [-y]
# example
/home/admin/oceanbase/bin/obshell tenant drop t1
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は削除対象のテナント名です。
コマンドのオプションの説明は以下のとおりです：
| オプション名 | 必須 | データ型 | デフォルト値 | 説明 |
|---|---|---|---|---|
| --recycle | いいえ | なし | なし | 値を指定する必要はありません。このオプションが指定されている場合、削除されたテナントはごみ箱に移動されます。 |
| -y/--yes | いいえ | なし | なし | 2回目の確認をキャンセルするかどうかを制御します。値を指定する必要はありません。 |
obshell tenant modify
このコマンドを使用すると、テナントのプライマリゾーンやホワイトリストなどのプロパティを変更できます。
${home_path}/bin/obshell tenant modify <tenant_name> [--primary_zone] [--whitelist] [--password] [--old_password] [--new_password]
# example
/home/admin/oceanbase/bin/obshell tenant modify t1 --primary_zone RANDOM --whitelist '%'
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は変更対象のテナント名です。
コマンドのオプションの説明は以下のとおりです：
| オプション名 | 必須 | データ型 | デフォルト値 | 説明 |
|---|---|---|---|---|
| --primary_zone | いいえ | string | なし | テナントのPrimary Zoneを指定します。これは、テナントが読み書きサービスを提供するZoneの優先順位を示します。例えば、primary_zone ='zone1;zone2,zone3' と指定すると、このテナントに対して読み書きサービスは zone1 から優先的に提供され、zone1 は zone2、zone3 よりも優先順位が高く、zone2 と zone3 は同じ優先順位です。 |
| --whitelist | いいえ | string | なし | テナントのアクセス許可リストを指定します。 |
| --password | いいえ | なし | なし | rootユーザーのパスワードを対話形式で変更するかどうかを指定します。値を渡す必要はありません。
説明このオプションは |
| --old_password | いいえ | string | なし | rootの現在のパスワードを設定します。rootユーザーのパスワードを変更する際に設定します。 |
| --new_password | いいえ | string | なし | rootユーザーの新しいパスワードを設定します。パスワードを変更する際に設定します。 |
obshell tenant lock
このコマンドを使用すると、テナントがロックされ、ロックされたテナントにはユーザーがアクセスできなくなります。
${home_path}/bin/obshell tenant lock <tenant_name>
# example
/home/admin/oceanbase/bin/obshell tenant lock t1
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name はロック対象のテナント名です。
obshell tenant unlock
このコマンドを使用して、テナントのロックを解除します。
${home_path}/bin/obshell tenant unlock <tenant_name>
# example
/home/admin/oceanbase/bin/obshell tenant unlock t1
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されます。tenant_name はロックを解除する対象のテナント名です。
obshellテナントの名前変更
このコマンドを使用して、テナントの名前を変更できます。
${home_path}/bin/obshell tenant rename <tenant_name> <new_name>
# example
/home/admin/oceanbase/bin/obshell tenant rename t1 t2
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は名前を変更する対象のテナント名、new_name はテナントの新しい名前です。
obshell tenant replica
このコマンドグループを使用して、テナントのレプリカを管理できます。
obshell tenant replica add
このコマンドグループを使用すると、テナントレプリカを一括で追加できます。
${home_path}/bin/obshell tenant replica add <tenant_name> -z [-u] [--replica_type]
# example
/home/admin/oceanbase/bin/obshell tenant replica add t1 -z zone4,zone5 -u s1
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は、レプリカを追加するテナント名です。
コマンドのオプションの説明は以下のとおりです：
| オプション名 | 必須 | データ型 | デフォルト値 | 説明 |
|---|---|---|---|---|
| -z/--zone | はい | string | なし | 新規追加するレプリカが配置されるゾーンを指定します。複数のゾーンを指定する場合は、英字のカンマ（,）で区切ります。 |
| -u/--unit | いいえ | string | なし | テナントリソースプールで使用するリソース仕様。
説明
|
| --replica_type | いいえ | string | なし | ターゲットゾーン上のテナントのレプリカタイプ。FULL（フル機能型レプリカ）または READONLY（読み取り専用型レプリカ）に設定できます。
説明
|
obshell tenant replica delete
このコマンドを使用すると、テナントレプリカを一括で削除できます。
${home_path}/bin/obshell tenant replica delete <tenant_name> -z
# example
/home/admin/oceanbase/bin/obshell tenant replica delete t1 -z zone3
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は、レプリカを削除するテナント名です。
-z / --zone を使用して、削除されるレプリカが配置されるゾーンを指定できます。このオプションは必須であり、複数のゾーンを指定する場合は、英字のカンマ（,）で区切ります。
obshell tenant replica modify
このコマンドを使用すると、複数のレプリカのプロパティを一括で変更できます。
${home_path}/bin/obshell tenant replica modify <tenant_name> [-z] [-u] [--unit_num] [--replica_type]
# example
/home/admin/oceanbase/bin/obshell tenant replica modify t1 --unit s2 --unit_num 2
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は、レプリカのプロパティを変更するテナント名です。
コマンドのオプションの説明は以下のとおりです：
| オプション名 | 必須 | データ型 | デフォルト値 | 説明 |
|---|---|---|---|---|
| -z/--zone | いいえ | string | なし | 変更対象のレプリカが配置されるゾーンを指定します。複数のゾーンを指定する場合は、英字のカンマ（,）で区切ります。指定されていない場合、デフォルトですべてのゾーン上のレプリカが変更されます。 |
| -u/--unit | いいえ | string | なし | テナントリソースプールで使用するリソース仕様。
説明
|
| --unit_num | いいえ | string | なし | ターゲットゾーン上のテナントのユニット数。その値はターゲットゾーンのノード数より小さくする必要があります。 |
| --replica_type | いいえ | string | なし | ターゲットゾーン上のテナントのレプリカタイプ。FULL（フル機能型レプリカ）または READONLY（読み取り専用型レプリカ）に設定できます。
説明
|
obshellテナントパラメータ
このコマンドグループを使用して、テナントの構成パラメータを管理できます。
obshell tenant parameter set
このコマンドを使用して、テナントの構成パラメータを設定できます。
${home_path}/bin/obshell tenant parameter set <tenant_name> <name=value>
# example
/home/admin/oceanbase/bin/obshell tenant parameter set t1 cpu_quota_concurrency=10,_rowsets_enabled=true
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は設定対象のテナント名です。構成パラメータは <name=value> の形式で設定し、複数のパラメータを設定する場合は、英字のカンマ（,）で区切ります。
例では、t1 は構成パラメータを設定するテナント名であり、cpu_quota_concurrency=10,_rowsets_enabled=true は t1 に設定される構成パラメータです。
obshell tenant parameter show
このコマンドを使用して、テナントの構成パラメータを照会できます。あいまいクエリもサポートされています。
${home_path}/bin/obshell tenant parameter show <tenant_name> <parameter>
# example
/home/admin/oceanbase/bin/obshell tenant parameter show t1 cpu_quota_concurrency
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は構成パラメータを照会するテナント名を設定します。parameter は照会する構成パラメータ名を設定します。あいまいクエリがサポートされています。
obshellテナント変数
このコマンドグループを使用して、テナントのシステム変数を管理できます。
obshell tenant variable set
このコマンドを使用して、テナント全体のシステム変数を設定できます。
${home_path}/bin/obshell tenant variable set <tenant_name> <name=value>
# example
/home/admin/oceanbase/bin/obshell tenant variable set t1 max_connections=10000,recyclebin=true
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は、システム変数を設定するテナント名として設定する必要があります。システム変数は <name=value> の形式で設定します。複数のシステム変数を設定する場合は、英字のカンマ（,）で区切ります。
obshell tenant variable show
このコマンドを使用して、テナントのシステム変数を照会できます。あいまいクエリもサポートされています。
${home_path}/bin/obshell tenant variable show <tenant_name> <variable>
# example
/home/admin/oceanbase/bin/obshell tenant variable show t1 max_connections
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は、システム変数を照会するテナント名として設定する必要があります。variable は、照会するシステム変数として設定し、あいまいクエリをサポートします。
obshell tenant show
このコマンドを使用して、テナント情報を照会できます。
${home_path}/bin/obshell tenant show [tenant_name] [-d]
# example
/home/admin/oceanbase/bin/obshell tenant show t1
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。tenant_name は照会対象のテナント名を設定する必要があります。tenant_name が指定されない場合、クラスタ内のすべてのテナント情報が表示されます。
-d / --show_detail を使用して、テナントの詳細情報を表示するかどうかを設定できます。このオプションに値を渡す必要はありません。
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 | いいえ | なし | なし | -y/--yes の設定は再確認をキャンセルすることを意味し、値の指定は不要です。 |
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 | いいえ | なし | なし | -y/--yes を設定すると、確認が不要になり、値を渡す必要はありません。 |
obshell tenant archivelog
このコマンドを使用すると、指定されたテナントのログアーカイブを開くことができます。
${home_path}/bin/obshell tenant archivelog <tenant-name> [flags]
# example
/home/admin/oceanbase/bin/obshell tenant archivelog t1
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。t1 はログアーカイブを開く対象のテナント名です。
-y / --yes を設定することで、確認ダイアログを省略するかどうかを制御できます。このオプションに値を指定する必要はなく、設定するだけで確認ダイアログが省略されます。
obshell tenant noarchivelog
このコマンドを使用すると、指定されたテナントのログアーカイブが無効になります。
${home_path}/bin/obshell tenant noarchivelog <tenant-name> [flags]
# example
/home/admin/oceanbase/bin/obshell tenant noarchivelog t1
home_path はOceanBaseデータベースのインストールディレクトリであり、obshellはデフォルトでOceanBaseデータベースのインストールディレクトリ内の bin ディレクトリに配置されています。t1 はログアーカイブを無効にする対象のテナント名です。
-y / --yes を設定することで、確認ダイアログの表示を無効にできます。このオプションに値を指定する必要はなく、設定するだけで確認ダイアログの表示が無効になります。