Note
This view is introduced since OceanBase Database V4.0.0.
Purpose
This view displays the basic information of tenants.
- When you query this view from the system tenant, information about all tenants, including system tenants, user tenants, and Meta tenants, is displayed. You can use the
TENANT_TYPEcolumn to distinguish between tenant types. - When you query this view from a user tenant, information about only the tenant is displayed.
Columns
Column |
Type |
Nullable? |
Description |
|---|---|---|---|
| TENANT_ID | bigint(20) | NO | Tenant ID. Valid values include:
|
| TENANT_NAME | varchar(128) | NO | Tenant name |
| TENANT_TYPE | varchar(4) | NO |
|
| CREATE_TIME | timestamp(6) | YES | Tenant creation time |
| MODIFY_TIME | timestamp(6) | YES | Information update time |
| PRIMARY_ZONE | varchar(128) | YES | Primary zone of the tenant |
| LOCALITY | varchar(4096) | NO | Information about the distribution of tenant replicas |
| PREVIOUS_LOCALITY | varchar(4096) | NO | Information about the previous locality:
|
| COMPATIBILITY_MODE | varchar(6) | NO |
|
| STATUS | varchar(64) | NO | Current status of the tenant:
|
| IN_RECYCLEBIN | varchar(3) | NO | Whether the tenant is in the recycle bin:
|
| LOCKED | varchar(3) | NO | Whether the tenant is locked:
ALTER TENANT xxx LOCK|UNLOCK statement. |
| TENANT_ROLE | varchar(100) | NO | Cluster role:
NoteIntroduced in V4.1.0. |
| SWITCHOVER_STATUS | varchar(100) | NO | Status of the SWITCHOVER operation:
NoteIntroduced in V4.1.0. |
| SWITCHOVER_EPOCH | bigint(20) | NO | Unique identifier of the SWITCHOVER/FAILOVER operation
NoteIntroduced in V4.1.0. |
| SYNC_SCN | bigint(20) unsigned | NO | The latest snapshot version synchronized by the tenant. For system tenants and Meta tenants, this column displays NULL.
NoteIntroduced in V4.1.0. |
| REPLAYABLE_SCN | bigint(20) unsigned | NO | The latest snapshot version that can be replayed by the tenant. For system tenants and Meta tenants, this column displays NULL.
NoteIntroduced in V4.1.0. |
| READABLE_SCN | bigint(20) unsigned | NO | The latest snapshot version that can be read by the tenant. For system tenants and Meta tenants, this column displays NULL.
NoteIntroduced in V4.1.0. |
| RECOVERY_UNTIL_SCN | bigint(20) unsigned | NO | The latest recovery point of the tenant. For system tenants and Meta tenants, this column displays NULL.
NoteIntroduced in V4.1.0. |
| LOG_MODE | varchar(100) | NO | Archival mode:
NoteIntroduced in V4.1.0. |
| ARBITRATION_SERVICE_STATUS | varchar(64) | NO | Status of the arbitration service of the tenant, which can take on the following values:
NoteIntroduced in V4.1.0. |
| UNIT_NUM | bigint(20) | NO | Number of units in the zone
NoteIntroduced in V4.2.0. |
| COMPATIBLE | varchar(65536) | NO | Compatibility version
NoteIntroduced in V4.2.0. |
| MAX_LS_ID | bigint(20) | NO | The largest log stream ID that the tenant has ever had. For system tenants and Meta tenants, this value is 1, and for user tenants, it is the actual size.
NoteIntroduced in V4.2.0. |
| RESTORE_DATA_MODE | varchar(128) | NO | Mode for restoring data to the tenant. Valid values include:
NoteIntroduced in V4.3.3. |
Sample query
A user tenant queries the basic information of the tenant.
obclient [oceanbase]> SELECT * FROM oceanbase.DBA_OB_TENANTS\G
The query result is as follows:
*************************** 1. row ***************************
TENANT_ID: 1002
TENANT_NAME: mysql001
TENANT_TYPE: USER
CREATE_TIME: 2024-08-08 10:28:21.355856
MODIFY_TIME: 2024-08-08 10:28:41.044814
PRIMARY_ZONE: zone1
LOCALITY: FULL{1}@zone1
PREVIOUS_LOCALITY: NULL
COMPATIBILITY_MODE: MYSQL
STATUS: NORMAL
IN_RECYCLEBIN: NO
LOCKED: NO
TENANT_ROLE: PRIMARY
SWITCHOVER_STATUS: NORMAL
SWITCHOVER_EPOCH: 0
SYNC_SCN: 1723170356638494000
REPLAYABLE_SCN: 1723170356638494000
READABLE_SCN: 1723170356137986004
RECOVERY_UNTIL_SCN: 4611686018427387903
LOG_MODE: NOARCHIVELOG
ARBITRATION_SERVICE_STATUS: DISABLED
UNIT_NUM: 1
COMPATIBLE: 4.3.2.1
MAX_LS_ID: 1001
RESTORE_DATA_MODE: NORMAL
1 row in set