ALTER TENANT

説明

ALTER TENANT ステートメントは、ユーザーテナントのプロパティを変更するために使用されます。これには、ローカリティ、プライマリゾーン、リソースプールリスト、システム変数値などの変更が含まれます。

ユーザーテナントの名前を変更する必要がある場合は、ALTER TENANT ... RENAME ステートメントを使用できます。

ユーザーテナントをロックまたはアンロックする必要がある場合は、ALTER TENANT ... LOCK / UNLOCK ステートメントを使用できます。ALTER TENANT ... LOCK ステートメントを使用してロック操作を実行すると、システムはロックされたテナント上で新しい接続を作成することを許可しませんが、既存の接続には影響しません。

権限要件

テナントを変更できるのは、sys テナントの root ユーザー（root@sys）のみです。他のテナントではテナントの変更はサポートされていません。

構文

ALTER TENANT

ALTER TENANT tenant_name
    [SET] [tenant_option_list] [set_sys_var];

tenant_option_list:
    tenant_option [, tenant_option ...]

tenant_option:
      LOCALITY [=] 'locality_description'
    | PRIMARY_ZONE [=] zone
    | RESOURCE_POOL_LIST [=](pool_name [, pool_name...])
    | ENABLE_ARBITRATION_SERVICE [=] {True | False}
    | [DEFAULT] TABLEGROUP [=] {NULL | tablegroup_name}
    | ENABLE_EXTENDED_ROWID [=] {true | false}
    | COMMENT [=]'string'

set_sys_var:
    VARIABLES var_name {TO | =} var_value [,var_name {TO | =} var_value...]

ALTER TENANT ... RENAME

ALTER TENANT tenant_name RENAME GLOBAL_NAME TO new_tenant_name;

ALTER TENANT ... LOCK / UNLOCK

ALTER TENANT tenant_name LOCK | UNLOCK;

パラメータの説明

例

• テナント tenant1 のプライマリゾーンを zone2 に変更します。

  obclient [oceanbase]> ALTER TENANT tenant1 primary_zone='zone2';
  

• テナント tenant1 のプライマリゾーンを RANDOM に変更します。

  obclient [oceanbase]> ALTER TENANT tenant1 primary_zone = RANDOM;
  

  このテナントに zone1、zone2、zone3 の3つのゾーンがある場合、このステートメントは次のものと同じです。

  obclient [oceanbase]> ALTER TENANT tenant1 primary_zone = 'zon1,zone2,zone3';
  

• リソースプールの変更は通常、テナントのレプリカ数のアップグレードやダウングレードのシナリオで使用されます。また、リソースプールを変更する際には、一度に1つのリソースプールしか追加または削除できず、以下のステートメントを実行してテナントのリソースプール pool1 を直接 pool2 に置き換えることはできません。そうしないと、次のエラーが発生します。

  obclient [oceanbase]> ALTER TENANT tenant1 resource_pool_list=('pool2');
  

  エラーメッセージは次のとおりです：

  ERROR 1210 (HY000): Incorrect arguments to resource pool list
  

  テナントの利用可能なリソースを調整したい場合、例えばテナントの拡張が必要な場合は、リソースユニットの仕様を引き上げることができます。

  obclient [oceanbase]> ALTER RESOURCE UNIT unit1 MAX_CPU 15, MEMORY_SIZE '20G', MAX_IOPS 1280, MIN_CPU=10, MIN_IOPS=1024;
  

• テナント tenant1 のローカリティを変更し、レプリカ数を増やします。ここで、F はフル機能型レプリカを表し、B_4 は新規追加されたゾーン名を表します。

  現在のテナント tenant1 のローカリティが F@B_1,F@B_2,F@B_3 で、リソースプールが pool1 であり、その ZONE_LIST の範囲が 'B_1','B_2','B_3' であるとします。

  1. リソースユニット unit2 を作成します。

     obclient [oceanbase]> CREATE RESOURCE UNIT unit2, MAX_CPU=5, MIN_CPU=2.5, MEMORY_SIZE= '32G', MAX_IOPS=10000, MIN_IOPS=5000, LOG_DISK_SIZE=5301023539200;
     

  2. リソースプール pool2 を作成します。

     obclient [oceanbase]> CREATE RESOURCE POOL pool2 unit='unit2',unit_num=1,zone_list=('B_4');
     

  3. テナントにリソースプール pool2 を追加します。

     obclient [oceanbase]> ALTER TENANT tenant1 resource_pool_list=('pool1','pool2');
     

  4. テナントのローカリティを変更します。

     obclient [oceanbase]> ALTER TENANT tenant1 LOCALITY='F@B_1,F@B_2,F@B_3,F@B_4';
     

     増やすレプリカタイプがカラムストアレプリカの場合、テナントのローカリティを変更するステートメントは次のとおりです：

     obclient [oceanbase]> ALTER TENANT tenant1 LOCALITY = 'F@B_1,F@B_2,F@B_3,C@B_4';
     

     注意

     • テナントのローカリティを変更する際、カラムストアレプリカについては、レプリカの追加・削除のみサポートされており、レプリカタイプの変換はサポートされていません。つまり、カラムストアレプリカを増やす場合は、元のゾーンにレプリカが存在していないことが条件となります。また、カラムストアレプリカを減らす場合は、カラムストアレプリカが存在するゾーンをレプリカのないゾーンに変更するしかありません。
     • テナントにカラムストアレプリカを追加した後、カラムストアレプリカにアクセスするには、ODPを追加デプロイし、一連の設定を行って接続をカラムストアレプリカにルーティングする必要があります。カラムストアレプリカの詳細な使用方法については、カラムストアレプリカを参照してください。

• アービトレーションサービスがデプロイされているシナリオでは、tenant1 にアービトレーションサービスを有効にします。

  obclient [oceanbase]> ALTER TENANT tenant1 ENABLE_ARBITRATION_SERVICE=true;
  

• 通常のテナント tenant1 の名前を tenant101 に変更します。

  obclient [oceanbase]> ALTER TENANT tenant1 RENAME GLOBAL_NAME TO tenant101;
  

• テナント tenant1 をロックします。

  obclient [oceanbase]> ALTER TENANT tenant1 LOCK;