CREATE TENANT

描述

CREATE TENANT 语句用于创建用户租户。OceanBase 数据库仅支持创建用户租户，系统租户为集群创建时系统自动创建；Meta 租户是 OceanBase 数据库内部自管理的租户，每创建一个用户租户会创建一个对应的 Meta 租户，其生命周期与用户租户保持一致。

通过 CREATE TENANT 语句创建的租户，默认其租户角色为 PRIMARY。

使用限制及注意事项

• OceanBase 数据库支持两种类型的租户，MySQL 兼容模式和 Oracle 兼容模式。创建租户时，需要指定合适的租户的类型。租户创建后，租户类型无法修改。

• 创建租户时需要为租户分配资源池，需要提前做好资源规划并创建好资源池，创建资源池的相关操作请参见 创建租户。

• 有关克隆租户使用限制的详细信息，请参见 克隆租户

权限要求

仅 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

参数说明

示例

• 创建一个名为 test_tenant 的 MySQL 兼容模式的租户，Primary Zone 为 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 '%';
  

• 创建一个名为 tenant1 的 Oracle 兼容模式的租户，Primary Zone 为 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。

相关文档

• 租户介绍

• 用户租户介绍

• 创建租户

• 克隆租户

• 取消租户克隆