CREATE TENANT

説明

CREATE TENANT ステートメントは、ユーザーテナントを作成するために使用されます。OceanBaseデータベースはユーザーテナントのみをサポートしており、システムテナントはクラスタ作成時にシステムが自動的に作成します。MetaテナントはOceanBaseデータベース内部で自己管理されるテナントであり、ユーザーテナントが作成されるたびに対応するMetaテナントも作成され、そのライフサイクルはユーザーテナントと同期します。

CREATE TENANT ステートメントで作成されるテナントは、デフォルトでテナントロールが PRIMARY に設定されます。

制限事項と注意点

• OceanBaseデータベースは、MySQL互換モードとOracle互換モードの2種類のテナントをサポートしています。テナントを作成する際には、適切なテナントタイプを指定する必要があります。テナント作成後、テナントタイプの変更はできません。

• テナント作成時には、テナントにリソースプールを割り当てる必要があります。そのため、事前にリソース計画を立て、リソースプールを作成しておく必要があります。リソースプールの作成に関する操作については、テナントの作成を参照してください。

• クローンテナントの使用制限の詳細については、クローンテナントを参照してください。

権限要件

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

構文

テナントを作成する構文は以下のとおりです：

CREATE TENANT { {[IF NOT EXISTS] tenant_name [tenant_option_list] [set_sys_var]} | {clone_tenant_clause} };

tenant_option_list:
    tenant_option [, tenant_option...]

tenant_option:
      LOCALITY [=] 'locality_description'
    | PRIMARY_ZONE [=] primary_zone_name
    | RESOURCE_POOL_LIST [=] (pool_name [, pool_name...])
    | ENABLE_ARBITRATION_SERVICE [=] {True | False}
    | {CHARACTER SET | CHARSET} [=] charset_name
    | COLLATE [=] collation_name
    | {READ ONLY | READ WRITE}
    | COMMENT [=] 'string'

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

clone_tenant_clause:
    new_tenant_name FROM source_tenant_name WITH
      RESOURCE_POOL [=] resource_pool_name,
      UNIT [=] unit_config

パラメータの説明

var_name

var_name の一般的な値は以下のとおりです：

• ob_compatibility_mode：テナントの互換モードを指定します（MySQLまたはOracleモードを選択可能）。この値は作成時にのみ指定できます。ob_compatibility_mode を指定しない場合、デフォルトの互換モードはMySQLとなります。
• ob_tcp_invited_nodes：テナントへの接続アローリストを指定します。つまり、どのクライアントIPアドレスがそのテナントに接続できるかを許可します。例では、% はすべてのクライアントからのログインを許可することを意味します。ob_tcp_invited_nodes の値を指定しない場合、デフォルトではテナントへの接続はローカルIPアドレスからのみ許可されます。
• lower_case_table_names：大文字と小文字を区別するかどうかを制御します。この値は CREATE TENANT ステートメントを使用してテナントを作成する際にのみ指定でき、MySQLモードでのみ有効です。テナント作成後はSQLステートメントで変更できません。
• ob_compatibility_control：MySQL互換動作における競合が発生した場合の動作を制御します。現在の値は MYSQL5.7 と MYSQL8.0 であり、それぞれMySQL 5.7とMySQL 8.0の動作を維持するかどうかを示します。MySQLモードのテナントを作成する際には、この変数を指定する必要があり、作成時にのみ指定可能です。テナント作成後の変更は許可されません。明示的に ob_compatibility_control を指定しない場合、デフォルトではMySQL 5.7との互換動作を維持します。

例

• test_tenant という名前のMySQL互換モードのテナントを作成します。プライマリゾーンは zone1;zone2,zone3、リソースプールは pool1、文字セットは utf8mb4 で、すべてのクライアントIPアドレスからデータベースへの接続を許可します。

  obclient [oceanbase]>  CREATE TENANT IF NOT EXISTS test_tenant PRIMARY_ZONE='zone1;zone2,zone3', RESOURCE_POOL_LIST=('pool1'), CHARSET='utf8mb4' SET ob_tcp_invited_nodes TO '%';
  

• tenant_c という名前のMySQL互換モードのテナントを作成します。ローカリティは F@zone1,F@zone2,C@zone3、プライマリゾーンは zone1;zone2,zone3、リソースプールは pool1 で、すべてのクライアントIPアドレスからデータベースへの接続を許可します。

  注意

  カラムストアレプリカを含むテナントを作成した後、カラムストアレプリカにアクセスするには、追加でODPをデプロイし、一連の設定を行って接続をカラムストアレプリカにルーティングする必要があります。カラムストアレプリカの詳細な使用方法については、カラムストアレプリカを参照してください。

  obclient [oceanbase]> CREATE TENANT tenant_c LOCALITY = 'F@zone1,F@zone2,C@zone3', primary_zone='zone1;zone2,zone3', RESOURCE_POOL_LIST=('pool1') SET ob_tcp_invited_nodes = '%';
  

• tenant1 という名前のOracle互換モードのテナントを作成します。プライマリゾーンは zone1、リソースプールは pool1 で、すべてのクライアントIPアドレスからデータベースへの接続を許可します。

  obclient [oceanbase]>  CREATE TENANT tenant1 PRIMARY_ZONE='zone1', RESOURCE_POOL_LIST=('pool1') SET ob_compatibility_mode='oracle',  ob_tcp_invited_nodes='%';
  

• 新しいクローンテナントの名前を clone_mysql001、スタンバイテナントを mysql001 とします。ここで、新しいテナントのリソースプール名を clone_mysql001_resource_pool、リソースユニットを unit001 と指定します。

  注意

  テナントクローン機能はログアーカイブに依存しており、ソーステナントでログアーカイブを有効にして初めてそのテナントのクローンを実行できます。また、テナントクローンステートメントの実行中は、ソーステナントのログアーカイブを無効にすることはできません。ログアーカイブの詳細については、ログアーカイブの概要を参照してください。

  CREATE TENANT clone_mysql001 FROM mysql001
        WITH
        RESOURCE_POOL = clone_mysql001_resource_pool,
        UNIT = unit001;
  

  システムテナントでテナントクローンステートメントを実行すると、対応するクローンタスクが生成されます。DBA_OB_CLONE_PROGRESSおよびDBA_OB_CLONE_HISTORYビューを使用して、クローンタスクの実行状態を確認できます。

  例：

  obclient [(none)]> SELECT * FROM oceanbase.DBA_OB_CLONE_HISTORY WHERE CLONE_TENANT_NAME = 'clone_mysql001'\G
  

  実行結果は次のとおりです：

  *************************** 1. row ***************************
          CLONE_JOB_ID: 1706248530701634201
              TRACE_ID: YB42AC1E87C9-00060F1AD6DF0264-0-0
      SOURCE_TENANT_ID: 1002
    SOURCE_TENANT_NAME: mysql001
      CLONE_TENANT_ID: 1012
    CLONE_TENANT_NAME: clone_mysql001
    TENANT_SNAPSHOT_ID: 1706248530759745885
  TENANT_SNAPSHOT_NAME: _inner_snapshot$1706248530759740679
      RESOURCE_POOL_ID: 1006
    RESOURCE_POOL_NAME: clone_mysql001_resource_pool
      UNIT_CONFIG_NAME: unit001
          RESTORE_SCN: 1706248531829799503
                STATUS: CLONE_SYS_SUCCESS
        CLONE_JOB_TYPE: FORK
      CLONE_START_TIME: 2024-01-26 13:55:30.705699
  CLONE_FINISHED_TIME: 2024-01-26 13:56:00.141434
              RET_CODE: 0
        ERROR_MESSAGE: NULL
  1 row in set
  

ビューのフィールドの詳細については、DBA_OB_CLONE_PROGRESSおよびDBA_OB_CLONE_HISTORYを参照してください。

関連ドキュメント

• テナントの紹介

• ユーザーテナントの紹介

• テナントの作成

• テナントのクローン

• テナントクローンのキャンセル