# HTAP系统函数
- gs_htap_imcv_info()
  描述：gs_htap_imcv_info函数用于显示当前数据库内IMCV表的基本信息，例如列存数据的加载情况、内存/磁盘空间占用等。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
   
  表1gs_htap_imcv_info参数说明 
  | 参数      | 参数                     | **类型**      | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  |:---|:---|:---|:---|
  | 输出参数      | rel_name               | name        | 表名。                                                                                                                                                                                                                                                                                                                                                                                                                                         |
  | 输出参数   | partition_name        | name         | 一级分区名，如果非一级分区，该字段为空。                                                                                                                                                                                                                                                                                                                                                                                                                      |
  | 输出参数 | subpartition_name      | name        | 二级分区名，如果非二级分区，该字段为空。                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | 输出参数    | schema_name             | name        | Schema名。                                                                                                                                                                                                                                                                                                                                                                                                                                  |
  | 输出参数    | user_name              | name      | 用户名。                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | 输出参数     | imcvnattr             | smallint   | 创建IMCV的列数量。                                                                                                                                                                                                                                                                                                                                                                                                                               |
  | 输出参数      | imcvkey               | int2vector | 创建IMCV的列编号的数组。例如：原表中第1、3、5列创建了IMCV，则该字段值为\[1 3 5\]。                                                                                                                                                                                                                                                                                                                                                                                        |
  | 输出参数    | priority                 | smallint     | 加载优先级，保留字段（目前优先级暂不生效）。 - '1'：PRIORITY_NONE无优先级。  - '2'：PRIORITY_LOW低优先级。  - '3'：PRIORITY_HIGH高优先级。   |
  | 输出参数   | rowgroup_num           | integer     | 预期的行组数（即完全加载后应有的行组数）。                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | 输出参数    | populated_rowgroup_num | integer    | 实际加载的行组数（完全加载后该值应等于rowgroup_num）。                                                                                                                                                                                                                                                                                                                                                                                                           |
  | 输出参数  | cu_num_in_mem          | integer   | 内存中的IMCU数量。                                                                                                                                                                                                                                                                                                                                                                                                                               |
  | 输出参数    | cu_mem_size            | bigint      | IMCU占用的内存大小，单位字节。                                                                                                                                                                                                                                                                                                                                                                                                                         |
  | 输出参数    | cu_num_in_disk          | integer     | 磁盘中的IMCU数量。                                                                                                                                                                                                                                                                                                                                                                                                                                |
  | 输出参数     | cu_disk_size            | bigint        | IMCU占用的磁盘大小，单位字节。                                                                                                                                                                                                                                                                                                                                                                                                                         |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_htap_imcv_info();
   rel_name | partition_name | subpartition_name | schema_name | user_name | imcvnattr | imcvkey | priority | rowgroup_num | populated_rowgroup_num | cu_num_in_mem | cu_mem_size | cu_num_in_disk | cu_disk_size 
  ----------+----------------+-------------------+-------------+-----------+-----------+---------+----------+--------------+------------------------+---------------+-------------+----------------+--------------
   test_fun |                |                   | public      | ***       |         1 | 1       |        1 |            1 |                      1 |             2 |        4016 |              0 |            0
  (1 row)
  ```
  

- gs_imcv_flush(relname text, partname text, parallelism integer, rebuild_mode integer)
  描述：对数据库中指定的IMCV表或者分区立即进行一次列存数据的加载或重建，并显示行组处理的结果。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
  
  - 该函数不允许在事务块内执行。
  
  - 在执行并行加载/重建时，每个worker都会额外占用内存、CPU和I/O（开启落盘）等资源，请根据实际硬件资源、系统负载谨慎控制加载或重建的并行度。
   
  表2gs_imcv_flush参数说明 
  | 参数类型   | 参数名            | 类型        | 描述                                                                                                                                                                                                                                                                                                                                                                                      |
  |:---|:---|:---|:---|
  | 输入参数   | relname       | text    | 表名。                                                                                                                                                                                                                                                                                                                                                                                    |
  | 输入参数 | partname     | text     | 分区名，查询分区表所有分区或非分区表时，该值可传入NULL或者''。可缺省，缺省时如果表包含分区，则处理所有分区。                                                                                                                                                                                                                                                                                                                             |
  | 输入参数 | parallelism    | integer  | 并行度。即加载/重建任务利用的bgworker数量。取值范围为1\~256。实际后台bgworker数量不足时，使用实际能够拉起的bgworker执行重建任务。可缺省，缺省时默认并行度为1，即无并行。                                                                                                                                                                                                                                                                                  |
  | 输入参数 | rebuild_mode | integer  | 重建模式。取值范围： - 0：表示非强制重建，仅当列存数据未同步到行存时会触发重建。  - 1：表示强制重建，即列存数据是否新鲜都会触发重建。   可缺省，缺省时代表非强制重建。 |
  | 输出参数    | total         | integer | 实际处理的行组数。                                                                                                                                                                                                                                                                                                                                                                               |
  | 输出参数  | success       | integer    | 成功处理的行组数。                                                                                                                                                                                                                                                                                                                                                                             |
  | 输出参数     | error            | integer     | 处理失败的行组数，例如因为内存不足，未实际发生加载或者重建操作。                                                                                                                                                                                                                                                                                                                                                        |
  | 输出参数    | skip            | integer | 跳过处理的行组数，例如列存数据不存在未同步的行存数据变更，未发生重建操作。                                                                                                                                                                                                                                                                                                                                                  |
     
  示例：
  ```
  --缺省partname、parallelism、rebuild_mode。
  gaussdb=# SELECT * FROM gs_imcv_flush('htap_flush_by_name_part1');
   total | success | error | skip 
  -------+---------+-------+------
   2     | 2       | 0     | 0
  (1 row)
  --缺省parallelism、rebuild_mode。
  gaussdb=# SELECT * FROM gs_imcv_flush('htap_flush_by_name_part1', 'htap_flush_by_name_part1_p1');
   total | success | error | skip 
  -------+---------+-------+------
   1     | 0       | 0     | 1
  (1 row)
  --缺省rebuild_mode。
  gaussdb=# SELECT * FROM gs_imcv_flush('htap_flush_by_name_part1', 'htap_flush_by_name_part1_p1',1);
   total | success | error | skip 
  -------+---------+-------+------
   1     | 0       | 0     | 1
  (1 row)
  gaussdb=# SELECT * FROM gs_imcv_flush('htap_flush_by_name_part1', 'htap_flush_by_name_part1_p1',1,1);
   total | success | error | skip 
  -------+---------+-------+------
   1     | 1       | 0     | 0
  (1 row)
  ```
  

- gs_imcv_flush(reloid oid, partoid oid, parallelism integer, rebuild_mode integer)
  描述：对数据库中指定的IMCV表或者分区立即进行一次加载或重建，并显示行组处理后的结果。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
  
  - 该函数不允许在事务块内执行。
  
  - 在执行并行加载/重建时，每个worker都会额外占用内存、CPU和I/O（开启落盘）等资源，请根据实际硬件资源、系统负载谨慎控制加载或重建的并行度。
   
  表3gs_imcv_flush参数说明 
  | 参数类型 | 参数名        | 类型      | 描述                                                                                                                                                                                                                                                                                                              |
  |:---|:---|:---|:---|
  | 输入参数 | reloid      | oid     | 表oid。                                                                                                                                                                                                                                                                                                           |
  | 输入参数    | partoid      | oid       | 分区oid，查询分区表所有分区或非分区表时，该值可传入0。                                                                                                                                                                                                                                                                                     |
  | 输入参数  | parallelism | integer   | 并行度。即加载/重建任务利用的bgworker数量。取值范围为1\~256。实际后台bgworker数量不足时，使用实际能够拉起的bgworker执行重建任务。                                                                                                                                                                                                                                |
  | 输入参数   | rebuild_mode | integer  | 重建模式。取值范围： - 0：表示非强制重建，仅当列存数据未同步到行存时会触发重建。  - 1：表示强制重建，即列存数据是否新鲜都会触发重建。   |
  | 输出参数 | total      | integer | 实际处理的行组数。                                                                                                                                                                                                                                                                                                       |
  | 输出参数 | success    | integer | 成功处理的行组数。                                                                                                                                                                                                                                                                                                          |
  | 输出参数    | error      | integer   | 处理失败的行组数，例如因为内存不足，未实际发生加载或者重建操作。                                                                                                                                                                                                                                                                                 |
  | 输出参数     | skip        | integer    | 跳过处理的行组数，例如列存数据不存在未同步的行存数据变更，未发生重建操作。                                                                                                                                                                                                                                                                         |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_imcv_flush(20834, 20838,1,1);
   total | success | error | skip 
  -------+---------+-------+------
   1     | 1       | 0     | 0
  (1 row)
  ```
  

- gs_imcv_flush(reloid oid) 描述：对数据库中指定的IMCV表立即进行一次重建，并显示重建的结果。重建过程将刷新IMCV表，移除旧数据并同步当前表的非活跃数据。
  返回值类型：text
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
  
  - 该函数不允许在事务块内执行。
  
  - 建议使用[gs_imcv_flush(relname text, partname text, parallelism integer, rebuild_mode integer)]或[gs_imcv_flush(reloid oid, partoid oid, parallelism integer, rebuild_mode integer)]系统函数。
   
  表4gs_imcv_flush参数说明 
  | 参数类型 | 参数名  | 类型   | 描述                               |
  |:---|:---|:---|:---|
  | 输入参数 | reloid | oid | 行存表/分区oid。                       |
  | 输出参数  | output | text | 返回本次重建的结果。显示行组重建成功的数量以及跳过重建的数量。 |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_imcv_flush(16796);
                   gs_imcv_flush
  ------------------------------------------------
   2 row groups rebuilt successfully, 1 skipped.
  (1 row)
  ```
  

- gs_htap_tmu_data(relname text, partname text, rowgroup_id integer)
  描述：查看实时事务单元TMU中的活跃事务数据。当rowgroup_id为0时，返回表中所有活跃事务数据；当rowgroup_id\>0时，返回表中指定行组中的活跃事务数据。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
   
  表5gs_htap_tmu_data参数说明 
  | 参数类型  | 参数名              | 类型        | 描述                                          |
  |:---|:---|:---|:---|
  | 输入参数    | relname            | text     | 表名。如果查询跨Schema的表信息，支持传入'schema.relname'形式。 |
  | 输入参数  | partname            | text     | 分区名，查询分区表所有分区或非分区表时，该值可传入NULL或者''。           |
  | 输入参数  | rowgroup_id      | integer  | 行组唯一标识。                                  |
  | 输出参数    | rel_name           | name      | 表名。                                          |
  | 输出参数   | partition_name      | name     | 一级分区名，如果非一级分区，该字段为空。                     |
  | 输出参数   | subpartition_name | name    | 二级分区名，如果非二级分区，该字段为空。                      |
  | 输出参数    | schema_name        | name     | Schema名。                                    |
  | 输出参数     | rel_oid             | oid      | 表oid。                                      |
  | 输出参数    | rowgroup_id         | integer  | 行组唯一标识。                                      |
  | 输出参数  | page_id           | integer | 所查行组中页面id。                                  |
  | 输出参数 | flag              | smallint   | 0代表非脏页，1代表脏页。                                |
  | 输出参数    | xid                 | xid      | 操作该数据的事务id。                                  |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_htap_tmu_data('htap_flush_by_name_part1', 'htap_flush_by_name_part1_p1', 0);
           rel_name         |       partition_name        | subpartition_name | schema_name | rel_oid | rowgroup_id | page_id | flag |  xid   
  --------------------------+-----------------------------+-------------------+-------------+---------+-------------+---------+------+--------
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |   20838 |           1 |       0 |    1 | 264177
  (1 row)
  ```
  
- gs_htap_tmu_data(rel_oid oid, rowgroup_id integer) 描述：查看实时事务单元TMU中的活跃事务数据。当rowgroup_id为0时，返回表中所有活跃事务数据；当rowgroup_id\>0时，返回表中指定行组中的活跃事务数据。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
  
  - 建议使用[gs_htap_tmu_data(relname text, partname text, rowgroup_id integer)]系统函数。
   
  表6gs_htap_tmu_data参数说明 
  | 参数类型     | 参数名         | 类型       | 描述              |
  |:---|:---|:---|:---|
  | 输入参数    | rel_oid      | oid     | 行存表/分区oid。    |
  | 输入参数  | rowgroup_id | integer | 行组唯一标识。       |
  | 输出参数    | rel_oid     | oid      | 行存表oid信息。       |
  | 输出参数    | rowgroup_id | integer | 行组唯一标识。       |
  | 输出参数 | page_id    | integer | 所查行组中页面id。    |
  | 输出参数    | flag         | smallint  | 0代表非脏页，1代表脏页。 |
  | 输出参数   | xid          | xid     | 操作该数据的事务id。 |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_htap_tmu_data(16723, 0);
   rel_oid | rowgroup_id | page_id | flag | xid
  ---------+-------------+---------+------+-----
     16723 |           1 |       0 |    1 | 4278 
     16723 |           1 |       1 |    1 | 4283 
     16723 |           1 |       2 |    1 | 4289 
     16723 |           1 |       3 |    1 | 4291 
  (4 rows)
  ```
  
- gs_htap_tmu_chunk_meta(relname text, partname text, rowgroup_id integer)
  描述：查看实时事务单元TMU元数据信息。当rowgroup_id为0时，返回所有行组中的实时事务单元TMU数据信息；当rowgroup_id\>0时，返回表中指定行组中的实时事务单元TMU数据信息；当rowgroup_id为-1时，统计所有行组中的实时事务单元TMU数据后以单条返回。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
   
  表7gs_htap_tmu_chunk_meta参数说明 
  | 参数类型    | 参数名               | 类型             | 描述                                         |
  |:---|:---|:---|:---|
  | 输入参数   | relname            | text            | 表名。如果查询跨Schema的表信息，支持传入'schema.relname'形式。 |
  | 输入参数    | partname          | text            | 分区名，查询分区表所有分区或非分区表时，该值可传入NULL或者''。       |
  | 输入参数  | rowgroup_id      | integer          | 行组唯一标识。                                   |
  | 输出参数  | rel_name          | name            | 表名。                                       |
  | 输出参数    | partition_name    | name            | 一级分区名，如果非一级分区，该字段为空。                       |
  | 输出参数   | subpartition_name | name             | 二级分区名，如果非二级分区，该字段为空。                      |
  | 输出参数   | schema_name        | name             | Schema名。                                 |
  | 输出参数   | rel_oid            | oid             | 表oid。                                     |
  | 输出参数  | rowgroup_id      | integer        | 行组唯一标识。                                     |
  | 输出参数 | page_count         | bigint unsigned  | 所查行组中页面数量。                                  |
  | 输出参数  | dirty_page_count | bigint unsigned | 所查行组中脏页面数量。                              |
  | 输出参数   | clean_page_count  | bigint unsigned  | 所查行组中非脏页面数量。                                |
  | 输出参数  | dirty_ratio       | real            | 所查行组中脏页占全部页面数量比例。                          |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_htap_tmu_chunk_meta('htap_flush_by_name_part1', 'htap_flush_by_name_part1_p1', 0);
           rel_name         |       partition_name        | subpartition_name | schema_name | rel_oid | rowgroup_id | page_count | dirty_page_count | clean_page_count | dirty_ratio 
  --------------------------+-----------------------------+-------------------+-------------+---------+-------------+------------+------------------+------------------+-------------
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |   20838 |           1 | 1          | 1                | 0                |           1
  (1 row)
  ```
  
- gs_htap_tmu_chunk_meta(rel_oid oid, rowgroup_id integer) 描述：查看实时事务单元TMU元数据信息。当rowgroup_id为0时，返回所有行组中的实时事务单元TMU数据信息；当rowgroup_id\>0时，返回表中指定行组中的实时事务单元TMU数据信息。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
  
  - 建议使用[gs_htap_tmu_chunk_meta(relname text, partname text, rowgroup_id integer)]系统函数。
   
  表8gs_htap_tmu_chunk_meta参数说明 
  | 参数类型  | 参数名                | 类型        | 描述                 |
  |:---|:---|:---|:---|
  | 输入参数   | rel_oid         | oid     | 行存表/分区oid。        |
  | 输入参数  | rowgroup_id        | integer  | 行组唯一标识。            |
  | 输出参数     | rel_oid           | oid    | 行存表oid信息。        |
  | 输出参数  | rowgroup_id       | integer | 行组唯一标识。          |
  | 输出参数   | page_count         | integer | 所查行组中页面数量。         |
  | 输出参数 | dirty_page_count  | integer  | 所查行组中脏页面数量。        |
  | 输出参数  | clean_page_count | integer | 所查行组中非脏页面数量。       |
  | 输出参数  | dirty_ratio     | cstring | 所查行组中脏页占全部页面数量比例。 |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_htap_tmu_chunk_meta(16723, 0);
   rel_oid | rowgroup_id | page_count | dirty_page_count | clean_page_count | dirty_ratio 
  ---------+-------------+------------+------------------+------------------+-------------
     16723 |           1 |          4 |                4 |                0 | 100.00%
  (1 row)
  ```
  
- gs_imcv_bgworker_status() 描述：显示执行IMCV表重建的bgworker的状态信息。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
   
  表9gs_imcv_bgworker_status参数说明 
  | 参数类型  | 参数名             | 类型                       | 描述                                                                                                                                                                                             |
  |:---|:---|:---|:---|
  | 输出参数   | worker_pid     | bigint                  | 线程号。                                                                                                                                                                                           |
  | 输出参数 | database_id   | oid                      | 数据库id。                                                                                                                                                                                          |
  | 输出参数  | relation_id     | oid                      | 正在处理的IMCV表的oid。                                                                                                                                                                                |
  | 输出参数 | rowgroup_id    | integer                 | 行组唯一标识。                                                                                                                                                                                           |
  | 输出参数   | worker_status | cstring                  | 表示init（初始化）、running（进行中）、ready（空闲）三种线程工作状态。                                                                                                                                                   |
  | 输出参数  | worker_type     | cstring                 | 任务类型，包含background_invalid_worker（无任务在执行）、background_unknown_worker（未知任务）、background_rowgroup_rebuild_worker（重建行组）、background_async_populate_worker（异步加载）、background_cache_worker（缓存区任务）五种任务类型。 |
  | 输出参数  | start_time    | timestamp with time zone | 线程启动的时间戳。                                                                                                                                                                                    |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_imcv_bgworker_status();
   worker_pid | database_id | relation_id | rowgroup_id | worker_status |        worker_type        | start_time 
  ------------+-------------+-------------+-------------+---------------+---------------------------+------------
            0 |           0 |           0 |           0 | init          | background_invalid_worker | 
  (1 row)
  ```
  

- gs_htap_scan_hit_status(relname text, partname text)
  描述：用于查询表粒度的IMCU命中率信息。当relname与partname均为null或空时，返回当前数据库下所有IMCV表的命中率信息；其他情况返回指定表或指定分区的命中率信息。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
   
  表10gs_htap_scan_hit_status参数说明 
  | 参数类型   | 参数                    | 类型             | 描述                                          |
  |:---|:---|:---|:---|
  | 输入参数  | relname             | text          | 表名。如果查询跨Schema的表信息，支持传入'schema.relname'形式。 |
  | 输入参数   | partname            | text           | 分区名，查询分区表所有分区或非分区表时，该值可传入NULL或者''。           |
  | 输出参数  | rel_name              | name             | 表名。                                        |
  | 输出参数  | partition_name          | name            | 分区名。                                      |
  | 输出参数 | subpartition_name     | name             | 二级分区名。                                       |
  | 输出参数  | schema_name           | name             | Schema名。                                    |
  | 输出参数  | column_number       | integer          | 列序号。                                          |
  | 输出参数  | column_name          | name           | 列名。                                          |
  | 输出参数  | imcu_in_cache_cnt      | bigint unsigned  | 该列存放于缓存区的IMCU数。                           |
  | 输出参数   | imcu_total_cnt         | bigint unsigned  | 该列总的IMCU数。                                   |
  | 输出参数   | imcu_ave_scan_cnt     | bigint unsigned | 该列平均每个IMCU的使用次数。                            |
  | 输出参数 | imcu_total_scan_cnt  | bigint unsigned | 该列IMCU总的使用次数。                              |
  | 输出参数   | imcu_ave_hit_cnt     | bigint unsigned  | 该列平均每个IMCU的缓存命中数。                             |
  | 输出参数 | imcu_total_hit_cnt   | bigint unsigned   | 该列IMCU总的缓存命中数。                              |
  | 输出参数   | total_hit_percentage | real           | 该列IMCU总的缓存命中率。                             |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_htap_scan_hit_status('htap_flush_by_name_part1', 'htap_flush_by_name_part1_p1');
           rel_name         |       partition_name        | subpartition_name | schema_name | column_number | column_name | imcu_in_cache_cnt | imcu_total_cnt | imcu_ave_scan_cnt | imcu_total_scan_cnt | imcu_ave_hit_cnt | imcu_total_hit_cnt | tot
  al_hit_percentage 
  --------------------------+-----------------------------+-------------------+-------------+---------------+-------------+-------------------+----------------+-------------------+---------------------+------------------+--------------------+----
  ------------------
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |             0 | ctid        | 1                 | 1              | 0                 | 0                   | 0                | 0                  |    
                  0
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |             1 | c1          | 1                 | 1              | 0                 | 0                   | 0                | 0                  |    
                  0
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |             2 | c2          | 1                 | 1              | 0                 | 0                   | 0                | 0                  |    
                  0
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |             3 | c3          | 1                 | 1              | 0                 | 0                   | 0                | 0                  |    
                  0
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |             4 | c4          | 1                 | 1              | 0                 | 0                   | 0                | 0                  |    
                  0
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |             5 | c5          | 1                 | 1              | 0                 | 0                   | 0                | 0                  |    
                  0
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |             6 | c6          | 1                 | 1              | 0                 | 0                   | 0                | 0                  |    
                  0
  (7 rows)
  ```
  
- gs_htap_scan_hit_status(reloid oid) 描述：用于查询表粒度的IMCU命中率信息。当reloid为0时，返回当前数据库下所有IMCV表的命中率信息；当reloid非0时，返回指定表中的命中率信息。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
  
  - 建议使用[gs_htap_scan_hit_status(relname text, partname text)]函数。
   
  表11gs_htap_scan_hit_status参数列表 
  | 参数类型   | 参数                 | 类型                 | 描述                  |
  |:---|:---|:---|:---|
  | 输入参数    | rel_oid              | oid             | 行存表/分区oid。         |
  | 输出参数 | rel_oid              | oid              | 表的oid。              |
  | 输出参数 | column_number        | integer           | 列序号。               |
  | 输出参数    | imcu_in_cache_cnt   | bigint unsigned  | 该列存放于缓存区的IMCU数。    |
  | 输出参数  | imcu_total_cnt      | bigint unsigned  | 该列总的IMCU数。          |
  | 输出参数  | imcu_ave_scan_cnt      | bigint unsigned | 该列平均每个IMCU的使用次数。     |
  | 输出参数    | imcu_total_scan_cnt | bigint unsigned  | 该列IMCU总的使用次数。       |
  | 输出参数  | imcu_ave_hit_cnt   | bigint unsigned  | 该列平均每个IMCU的缓存命中数。 |
  | 输出参数    | imcu_total_hit_cnt   | bigint unsigned   | 该列IMCU总的缓存命中数。     |
  | 输出参数  | total_hit_percentage  | real            | 该列IMCU总的缓存命中率。     |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_htap_scan_hit_status(38389);
   rel_oid | column_number | imcu_in_cache_cnt | imcu_total_cnt | imcu_ave_scan_cnt | imcu_total_scan_cnt | imcu_ave_hit_cnt | imcu_total_hit_cnt | total_hit_percentage 
  ---------+---------------+-------------------+----------------+-------------------+---------------------+------------------+--------------------+----------------------
     38389 |             0 | 1                 | 1              | 0                 | 0                   | 0                | 0                  |                    0
     38389 |             1 | 0                 | 0              | 0                 | 0                   | 0                | 0                  |                    0
     38389 |             2 | 0                 | 0              | 0                 | 0                   | 0                | 0                  |                    0
     38389 |             3 | 0                 | 0              | 0                 | 0                   | 0                | 0                  |                    0
     38389 |             4 | 0                 | 0              | 0                 | 0                   | 0                | 0                  |                    0
  (5 rows)
  ```
  
- gs_imcu_meta(rel_name text, partname text)
  描述：用于显示当前数据库下指定rel_name的IMCV表下的IMCU元信息。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
   
  表12gs_imcu_meta参数说明 
  | 参数类型   | 参数                  | 类型                  | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
  |:---|:---|:---|:---|
  | 输入参数   | relname           | text             | IMCV表名。如果查询跨Schema的表信息，支持传入'schema.relname'形式。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
  | 输入参数 | partname            | text            | IMCV分区名，查询分区表所有分区或非分区表时，该值可传入NULL或者''。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | 输出参数   | rel_name            | name             | IMCV表名。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | 输出参数     | partition_name       | name             | IMCV一级分区名。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
  | 输出参数    | subpartition_name  | name             | IMCV二级分区名。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
  | 输出参数    | schema_name         | name               | Schema名。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | 输出参数   | rowgroup_id        | integer            | IMCU所在行组id。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | 输出参数 | row_count            | integer           | IMCU行数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
  | 输出参数    | imcu_size           | integer           | IMCU大小，单位字节。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  | 输出参数  | imcu_data_size     | integer         | IMCU数据大小（不包含IMCU元信息），单位字节。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | 输出参数   | compressed_data_size | integer          | IMCU数据压缩后的大小。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
  | 输出参数    | compressed_ratio   | real              | IMCU数据的压缩比。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | 输出参数    | compressed_type       | text               | IMCU的压缩算法： - none：无IMCU数据，无法压缩。  - uncompressed：未进行压缩。  - delta_plus_rle：IMCU数据采用delta_plus_rle压缩算法进行压缩。  - lz4_compressed：IMCU数据采用lz4压缩算法进行压缩。  - dict_compressed：IMCU数据采用dict压缩算法进行压缩。   |
  | 输出参数   | imcu_mode            | integer           | IMCU加载列数据特征： - 1：普通。  - 2：全部为空。  - 3：相同值。  - 4：无最大最小值。  - 8：有空行。  - 16：无求和值。                        |
  | 输出参数    | magic             | integer           | 生成IMCU数据时的事务xid值，用于校验IMCU数据是否有效。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
  | 输出参数    | attnum               | smallint           | IMCU加载列对应的attnum。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
  | 输出参数    | scan_cnt            | bigint unsigned | 扫描IMCU的总次数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  | 输出参数   | hit_cnt             | bigint unsigned   | 命中内存态IMCU的次数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
  | 输出参数    | data_location       | smallint          | 标记IMCU位于内存中、位于磁盘中或处于escape状态。 - 0：内存。  - 1：磁盘。  - 2：escape状态，因内存不足，仅创建元数据，查询这部分数据时会回行存读取。                                                                                                                                                                                                                                                                                                                                                     |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_imcu_meta('htap_flush_by_name_part1', 'htap_flush_by_name_part1_p1');
           rel_name         |       partition_name        | subpartition_name | schema_name | rowgroup_id | row_count | imcu_size | imcu_data_size | compressed_data_size | compressed_ratio | compressed_type | imcu_mode | magic | attnum | scan_cnt
   | hit_cnt | data_location 
  --------------------------+-----------------------------+-------------------+-------------+-------------+-----------+-----------+----------------+----------------------+------------------+-----------------+-----------+-------+--------+---------
  -+---------+---------------
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |           1 |         2 |      4024 |             24 |                   24 |                1 | uncompressed    |         1 |     0 |      0 | 0       
   | 0       |             0
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |           1 |         2 |      4016 |             16 |                   16 |                1 | uncompressed    |         1 |     0 |      1 | 0       
   | 0       |             0
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |           1 |         2 |      4016 |             16 |                   16 |                1 | uncompressed    |         1 |     0 |      2 | 0       
   | 0       |             0
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |           1 |         2 |      4060 |             48 |                   48 |                1 | uncompressed    |         0 |     0 |      3 | 0       
   | 0       |             0
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |           1 |         2 |         0 |              0 |                    0 |                0 | none            |         3 |     0 |      4 | 0       
   | 0       |             0
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |           1 |         2 |      4036 |             24 |                   24 |                1 | uncompressed    |         0 |     0 |      5 | 0       
   | 0       |             0
   htap_flush_by_name_part1 | htap_flush_by_name_part1_p1 |                   | public      |           1 |         2 |      4060 |             48 |                   48 |                1 | uncompressed    |         0 |     0 |      6 | 0       
   | 0       |             0
  (7 rows)
  ```
  备注：该示例每一行代表一个IMCU（其中attnum为0的列为CTID列）。
  
- gs_imcu_meta(rel_name) 描述：gs_imcu_meta用于显示指定rel_name的IMCV表下的IMCU元信息。该函数仅支持查询当前数据库和当前Schema下的表。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
  
  - 建议使用[gs_imcu_meta(rel_name text, partname text)]系统函数。
   
  表13gs_imcu_meta参数列表 
  | 参数类型    | 参数              | 类型              | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  |:---|:---|:---|:---|
  | 输入参数    | relname          | text            | IMCV表名。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  | 输出参数  | reloid            | oid               | 表id。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
  | 输出参数   | relname              | text              | 表名。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | 输出参数   | imcu_xmin        | xid              | 预留，暂不使用。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  | 输出参数    | imcu_id            | integer            | IMCU id。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  | 输出参数  | row_count        | integer            | IMCU行数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | 输出参数   | imcu_size         | integer          | IMCU大小，单位字节。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
  | 输出参数    | imcu_mode         | integer          | IMCU加载列数据特征： - 1：普通。  - 2：全部为空。  - 3：相同值。  - 4：无最大最小值。  - 8：有空行。  - 16：无求和值。                      |
  | 输出参数   | imcu_pointer      | bigint          | 预留，暂不使用。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | 输出参数  | magic             | integer          | 生成IMCU数据时的事务xid值，用于校验IMCU数据是否有效。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
  | 输出参数 | attnum             | smallint           | IMCU加载列对应的attnum。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  | 输出参数    | compressed_size   | integer         | IMCU压缩后的大小。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
  | 输出参数    | compressed_ratio | real            | IMCU的压缩比。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
  | 输出参数  | compressed_type   | text             | IMCU的压缩算法： - none：无IMCU数据，无法压缩。  - uncompressed：未进行压缩。  - delta_plus_rle：IMCU数据采用delta_plus_rle压缩算法进行压缩。  - lz4_compressed：IMCU数据采用lz4压缩算法进行压缩。  - dict_compressed：IMCU数据采用dict压缩算法进行压缩。   |
  | 输出参数  | scan_cnt        | bigint unsigned | 扫描IMCU的总次数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
  | 输出参数 | hit_cnt          | bigint unsigned | 命中内存态IMCU的次数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
  | 输出参数    | data_location      | smallint         | 标记IMCU位于内存中、位于磁盘中或处于escape状态。 - 0：内存。  - 1：磁盘。  - 2：escape状态，因内存不足，仅创建元数据，查询这部分数据时会回行存读取。                                                                                                                                                                                                                                                                                                                                               |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_imcu_meta('lineitem') limit 5;
   reloid | relname  | imcu_xmin | imcu_id | row_count | imcu_size | imcu_mode | imcu_pointer |   magic   | attnum | compressed_size | compressed_ratio | compressed_type | scan_cnt | hit_cnt | data_location 
  --------+----------+-----------+---------+-----------+-----------+-----------+--------------+-----------+--------+-----------------+------------------+-----------------+----------+---------+--------------
   441887 | lineitem |         0 |       1 |    366353 |   2930832 |         1 |            0 | 221434760 |      0 |         1472277 |          1.99068 | lz4_compressed  | 1        | 1       |            0
   441887 | lineitem |         0 |       2 |    366320 |   2930568 |         1 |            0 | 221434760 |      0 |         1472215 |          1.99058 | lz4_compressed  | 1        | 1       |            0
   441887 | lineitem |         0 |       3 |    366479 |   2931840 |         1 |            0 | 221434760 |      0 |         1472885 |          1.99054 | lz4_compressed  | 1        | 1       |            0
   441887 | lineitem |         0 |       4 |    366282 |   2930264 |         1 |            0 | 221434760 |      0 |         1472131 |          1.99049 | lz4_compressed  | 1        | 1       |            0
   441887 | lineitem |         0 |       5 |    366364 |   2930920 |         1 |            0 | 221434760 |      0 |         1472384 |          1.99059 | lz4_compressed  | 1        | 1       |            0
  (5 rows)
  ```
  备注：该示例每一行代表一个IMCU（其中attnum为0的列为CTID列）。
  

- gs_imcv_status() 描述：gs_imcv_status函数用于显示当前所有IMCV表的状态信息。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
  
  - 建议使用[gs_htap_imcv_info()]系统函数。
   
  表14gs_imcv_status参数列表 
  | 参数     | 参数                   | **类型**      | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                               |
  |:---|:---|:---|:---|
  | 输出参数      | reloid              | oid           | 表id。                                                                                                                                                                                                                                                                                                                                                                                                                                  |
  | 输出参数    | relname              | name        | 表名。                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  | 输出参数   | dboid                | oid         | 数据库id。                                                                                                                                                                                                                                                                                                                                                                                                                                 |
  | 输出参数   | dbname               | name        | 数据库名。                                                                                                                                                                                                                                                                                                                                                                                                                                |
  | 输出参数 | schemaname          | name          | Schema的名字。                                                                                                                                                                                                                                                                                                                                                                                                                              |
  | 输出参数   | username               | name        | IMCV表的owner。                                                                                                                                                                                                                                                                                                                                                                                                                          |
  | 输出参数    | parentoid           | oid          | 父表id。如果是分区，则表示父表id，否则显示0。                                                                                                                                                                                                                                                                                                                                                                                                            |
  | 输出参数    | imcvispart            | bool         | IMCV是否是分区表。                                                                                                                                                                                                                                                                                                                                                                                                                          |
  | 输出参数    | imcvstatus           | char        | IMCV表状态。 正常情况下应为'F'。当IMCV表异常（例如使用逃生接口gs_htap_data_maintenance卸载过该表）或不可用（备机模式下主机的IMCV表）状态下，该值为'E'。                                                                                                                                                                                                                                                                                       |
  | 输出参数   | imcvnattr             | smallint   | 加载列数量。                                                                                                                                                                                                                                                                                                                                                                                                                                |
  | 输出参数    | imcvkey               | int2vector | 加载的列数组。                                                                                                                                                                                                                                                                                                                                                                                                                             |
  | 输出参数   | priority             | smallint      | 加载优先级，保留字段（目前优先级暂不生效）。 - '1'：PRIORITY_NONE无优先级。  - '2'：PRIORITY_LOW低优先级。  - '3'：PRIORITY_HIGH高优先级。   |
  | 输出参数   | childoids            | oidvector    | 如果是分区表，记录该表的子分区的id列表。如果不是，则为空。                                                                                                                                                                                                                                                                                                                                                                                                       |
  | 输出参数   | rowgroup_num        | integer        | 预期的行组数（即完全加载后应有的行组数）。仅在imcvstatus为'F'时该项数值有意义。                                                                                                                                                                                                                                                                                                                                                                                        |
  | 输出参数    | cu_num_in_mem      | integer      | 内存中的IMCU数量。仅在imcvstatus为'F'时该项数值有意义。                                                                                                                                                                                                                                                                                                                                                                                                 |
  | 输出参数     | cu_mem_size         | bigint      | IMCU占用的内存大小，单位字节。仅在imcvstatus为'F'时该项数值有意义。                                                                                                                                                                                                                                                                                                                                                                                           |
  | 输出参数     | cu_num_in_disk      | integer       | 磁盘中的IMCU数量。仅在imcvstatus为'F'时该项数值有意义。                                                                                                                                                                                                                                                                                                                                                                                                   |
  | 输出参数  | cu_disk_size         | bigint      | IMCU占用的磁盘大小，单位字节。仅在imcvstatus为'F'时该项数值有意义。                                                                                                                                                                                                                                                                                                                                                                                            |
  | 输出参数    | populated_rowgroup_num | integer       | 实际加载的行组数（完全加载后该值应等于rowgroup_num）。仅在imcvstatus为'F'时该项数值有意义。                                                                                                                                                                                                                                                                                                                                                                           |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_imcv_status WHERE relname='htap_test';
   reloid |  relname  | dboid | dbname | schemaname | username | parentoid | imcvispart | imcvstatus | imcvnattr |  imcvkey  | priority | childoi
  ds | rowgroup_num | cu_num_in_mem | cu_mem_size | cu_num_in_disk | cu_disk_size | populated_rowgroup_num 
  --------+-----------+-------+--------+------------+----------+-----------+------------+------------+-----------+-----------+----------+--------
  ---+--------------+---------------+-------------+----------------+--------------+------------------------
    16512 | htap_test | 16417 | htapdb | public     | ***      |         0 | f          | F          |         5 | 1 2 3 4 5 |        1 |        
     |            0 |             0 |           0 |              0 |            0 |                      0
  (1 row)
  ```
  

- gs_htap_file_status(db_name text)
  描述：查看HTAP列存IMCU落盘文件的使用信息。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
   
  表15gs_htap_file_status参数列表 
  | 参数类型   | 参数               | **类型** | **描述**                     |
  |:---|:---|:---|:---|
  | 输入参数   | db_name            | text      | 数据库名字，输入为''或NULL时表示查询所有数据库。 |
  | 输出参数    | db_oid              | oid    | 数据库id。                       |
  | 输出参数     | file_name       | text  | 数据文件名。                       |
  | 输出参数 | file_id          | integer  | 数据文件标识，当前版本返回值只有2。            |
  | 输出参数   | extent_size        | integer  | 数据文件的扩展大小。                 |
  | 输出参数    | allocated_blocks | bigint | 数据文件已分配给IMCU使用的页面数。         |
  | 输出参数    | total_blocks    | bigint  | 数据文件在磁盘上的总物理页面数。             |
  | 输出参数    | high_water_mark  | bigint  | 数据文件使用页数的高水位线。              |
  | 输出参数     | utilization      | real    | 使用的block数占总block数的百分比。        |
  | 输出参数  | ext               | text     | 扩展字段，当前版本为NULL。             |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_htap_file_status('postgres');
   db_oid |        file_name         | file_id | extent_size | allocated_blocks | total_blocks | high_water_mark | utilization | ext 
  --------+--------------------------+---------+-------------+------------------+--------------+-----------------+-------------+-----
    13329 | global/imcu/13329/2_imcu |       2 |           4 |                0 |            0 |               0 |           1 | 
  (1 row)
  ```
  
- gs_htap_file_status(db_oid oid) 描述：查看HTAP列存IMCU落盘文件的使用信息。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
  
  - 推荐使用[gs_htap_file_status(db_name text)]。
   
  表16gs_htap_file_status参数列表 
  | 参数类型  | 参数                | **类型** | **描述**                  |
  |:---|:---|:---|:---|
  | 输入参数  | db_oid             | oid      | 数据库id，输入0表示查询所有数据库。  |
  | 输出参数  | db_oid             | oid       | 数据库id。                   |
  | 输出参数    | file_name          | text      | 数据文件名。                 |
  | 输出参数     | file_id          | integer  | 数据文件标识，当前版本返回值只有2。     |
  | 输出参数   | extent_size      | integer | 数据文件的扩展大小。              |
  | 输出参数  | allocated_blocks | bigint | 数据文件已分配给IMCU使用的页面数。    |
  | 输出参数    | total_blocks      | bigint    | 数据文件在磁盘上的总物理页面数。     |
  | 输出参数   | high_water_mark  | bigint   | 数据文件使用页数的高水位线。          |
  | 输出参数   | utilization         | real    | 使用的block数占总block数的百分比。 |
  | 输出参数 | ext                | text    | 扩展字段，当前版本为NULL。         |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_htap_file_status(13146);
   db_oid |        file_name         | file_id | extent_size | allocated_blocks | total_blocks | high_water_mark | utilization | ext 
  --------+--------------------------+---------+-------------+------------------+--------------+-----------------+-------------+-----
    13146 | global/imcu/13146/2_imcu |       2 |           8 |            91936 |        98304 |           91936 |     .935221 | 
  (1 row)
  ```
  

- gs_htap_data_maintenance(rel_oid oid, type integer) 描述：列存数据的维护接口，提供两项能力（1）卸载列存数据（清理内存和磁盘空间）；（2）所有列存数据落盘的逃生手段。
  返回值类型：text
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  该接口会直接卸载IMCV保护行存TP业务，会导致已经使用IMCV Scan的业务报错，使用前需充分确认影响。仅供因配置或其他原因导致IMCV内存等资源使用过量，集群又无法停机时，紧急逃生使用。
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/note_3.0-zh-cn.png)
  - 仅参数enable_htap=on时可用。
  
  - 仅系统管理员或者运维管理人员才有权限执行此函数。
  
  - 该函数不允许在事务内执行。
  
  - 该接口仅作为清理数据/落盘数据的逃生手段，请谨慎使用。
   
  表17gs_htap_data_maintenance参数列表 
  | 参数类型 | 参数       | **类型** | **描述**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
  |:---|:---|:---|:---|
  | 输入参数  | rel_oid | oid    | 行存表oid，0表示处理当前数据库下所有表。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  | 输入参数  | type       | integer | 处理类型，取值范围为0、1、2 - 0：表示卸载对应表的所有IMCV数据，包括内存和落盘数据文件，仅保留元数据，gs_imcv系统表还存在信息，通过gs_imcv_status视图查询状态为'E'；入参rel_oid为0时，卸载所有表IMCV数据后，落盘文件会被清理，磁盘空间也会释放。使用该接口卸载IMCV后，IMCV状态为'E'，此时无法使用HTAP相关功能，需要重新创建IMCV或执行VACUUM FULL将基表与对应分区的IMCV状态转为'F' 。  - 1：该参数已废弃。    - 2：表示将对应表的IMCV数据全部落盘。   |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_htap_data_maintenance(16824,0);
   gs_htap_data_maintenance 
  --------------------------
   Maintenance finish.
  (1 row)
  gaussdb=# SELECT * FROM gs_htap_data_maintenance(16824,2);
   gs_htap_data_maintenance 
  --------------------------
   Maintenance finish.
  (1 row)
  ```
  

- gs_imcu_size_estimation(relname text, partname text, colnum_name_array text\[\]) 描述：该函数返回该表指定分区指定列创建IMCV列存数据预估的内存使用值。
  返回值类型：record
  ![](https://support.huaweicloud.com/centralized-ref-v10-gaussdb/public_sys-resources/notice_3.0-zh-cn.png)
  - 必须是系统管理员或运维管理员才有权限执行此函数。
  
  - 不支持备机执行。
  
  - 该函数约束与HTAP DDL保持一致，相关报错信息与实际执行DDL报错信息一致。
   
  表18gs_imcu_size_estimation参数说明 
  | 参数类型 | 参数名             | 类型              | 描述                                       |
  |:---|:---|:---|:---|
  | 输入参数 | relname            | text              | 表名。如果查询跨Schema的表信息，支持传入'schema.relname'形式。 |
  | 输入参数   | partname         | text           | 分区名，查询分区表所有分区或非分区表时，该值可传入NULL或者''。         |
  | 输入参数  | colnum_name_array | text\[\]        | 列名数组。                                      |
  | 输出参数 | node_name         | name            | 节点名。                                        |
  | 输出参数   | estimated_size | bigint unsigned | 预估内存使用值，单位字节。                             |
     
  示例：
  ```
  gaussdb=# SELECT * FROM gs_imcu_size_estimation('test_estimate', '', ARRAY['id']);
   node_name | estimated_size 
  -----------+----------------
   datanode1 | 20016
  (1 row)
  ```
  
 
