View the physical restore progress

During data restore, you can check the physical restore progress in views.

Procedure

1. Log in to the sys tenant of the cluster as the root user.

2. Execute the following statement to view the restore progress:

   obclient [oceanbase]> SELECT * FROM oceanbase.CDB_OB_RESTORE_PROGRESS\G
   

   A sample query result is as follows:

   *************************** 1. row ***************************
                      TENANT_ID: 1
                         JOB_ID: 1
            RESTORE_TENANT_NAME: mysql
              RESTORE_TENANT_ID: 1002
             BACKUP_TENANT_NAME: backup_tenant
               BACKUP_TENANT_ID: 1002
            BACKUP_CLUSTER_NAME: backup_cluster
                    BACKUP_DEST: file:///data/nfs/backup//archive,file:///data/nfs/backup/data
                 RESTORE_OPTION: pool_list=small_pool_2&primary_zone=z1
                    RESTORE_SCN: 1658285759724047000
            RESTORE_SCN_DISPLAY: 2022-06-1 02:55:59.724047
                         STATUS: WAIT_TENANT_RESTORE_FINISH
                START_TIMESTAMP: 2022-06-1 10:58:33.689560
                BACKUP_SET_LIST: file:///data/nfs/backup/data/backup_set_1_full
              BACKUP_PIECE_LIST: file:///data/nfs/backup/archive/piece_d1001r1p1,file:///data/nfs/backup/archive/piece_d1001r2p2
              	   TABLET_COUNT: NULL
   			FINISH_TABLET_COUNT: NULL
    		   RESTORE_PROGRESS: NULL
                    TOTAL_BYTES: NULL
            TOTAL_BYTES_DISPLAY: NULL
                   FINISH_BYTES: NULL
           FINISH_BYTES_DISPLAY: NULL
                    DESCRIPTION:
   *************************** 2. row ***************************
                      TENANT_ID: 1002
                         JOB_ID: 1
            RESTORE_TENANT_NAME: mysql
              RESTORE_TENANT_ID: 1002
             BACKUP_TENANT_NAME: backup_tenant
               BACKUP_TENANT_ID: 1002
            BACKUP_CLUSTER_NAME: backup_cluster
                    BACKUP_DEST: file:///data/nfs/backup//archive,file:///data/nfs/backup/data
                 RESTORE_OPTION: pool_list=small_pool_2&primary_zone=z1
                    RESTORE_SCN: 1658285759724047000
            RESTORE_SCN_DISPLAY: 2022-06-1 02:55:59.724047
                         STATUS: RESTORING
                START_TIMESTAMP: 2022-06-1 10:58:33.689560
                BACKUP_SET_LIST: file:///data/nfs/backup/data/backup_set_1_full
              BACKUP_PIECE_LIST: file:///data/nfs/backup/archive/piece_d1001r1p1,file:///data/nfs/backup/archive/piece_d1001r2p2
              	   TABLET_COUNT: 38708
   			FINISH_TABLET_COUNT: 35102
    		   RESTORE_PROGRESS: 66.97
                    TOTAL_BYTES: 313158553
            TOTAL_BYTES_DISPLAY: 298.65MB
                   FINISH_BYTES: 209715200
           FINISH_BYTES_DISPLAY: 200.00MB
                    DESCRIPTION:
   2 rows in set
   

   This view records the parameters you entered during restore, and other information such as the restore progress.

   After a restore job is performed for a user tenant, two records are generated: one for the sys tenant and the other for the restored user tenant. The job record for the sys tenant records the restore information about the restored tenant. The job record for the restored tenant records its restore progress.

   Pay attention to the STATUS column in the restore progress view. Here is a breakdown of the status values for the sys tenant and restored tenant:

   • For the sys tenant:

     • CREATE_TENANT: The sys tenant is creating the tenant to be restored. After the tenant is created, the status changes to WAIT_TENANT_RESTORE_FINISH. If the creation failed, the status changes to RESTORE_FAIL.

     • WAIT_TENANT_RESTORE_FINISH: The system is waiting for the restore of the tenant to complete. After the tenant is restored, the status changes to RESTORE_SUCCESS. If the restore fails, the status changes to RESTORE_FAIL.

     • RESTORE_SUCCESS: The tenant is restored.

     • RESTORE_FAIL: The restore of the tenant failed.

   • For the target tenant:

     • RESTORING: Data of the tenant is being restored. After the tenant is restored, the status changes to POST_CHECK. If the restore fails, the status changes to RESTORE_FAIL.

     • POST_CHECK: The system is checking the role of the tenant and restoring the tenant as a standby database. After the operation is completed, the status changes to UPGRADE. If the operation failed, the status changes to RESTORE_FAIL.

     • UPGRADE: The tenant is being upgraded. For restore across versions, an upgrade is performed for the tenant. After the operation is completed, the status changes to RESTORE_SUCCESS. If the operation failed, the status changes to RESTORE_FAIL.

     • RESTORE_SUCCESS: The restore succeeded.

     • RESTORE_FAIL: The restore failed.

   For more information about the CDB_OB_RESTORE_PROGRESS view, see Views related to physical restore.

   After the restore is completed, you can view the restore result. For more information, see Query the restore result.