# DBE_COMPRESSION
#### 接口介绍
根据输入的参数，评估指定数据对象的采样压缩率或者获取指定行数据的压缩类型。
表1DBE_COMPRESSION 
| 接口名称                  | 描述                    |
|:---|:---|
| GET_COMPRESSION_RATIO | 根据输入参数评估指定数据对象的采样压缩率。 |
| GET_COMPRESSION_TYPE  | 根据输入参数获取指定行数据的压缩类型。   |
   
![](https://support.huaweicloud.com/distributed-devg-v8-gaussdb/public_sys-resources/caution_3.0-zh-cn.png)
GET_COMPRESSION_TYPE接口只支持分布式数据库中数据节点（DN），其他节点暂不支持。
- DBE_COMPRESSION.GET_COMPRESSION_RATIO 根据输入参数评估指定数据对象的采样压缩率，原型为：
  ```
  DBE_COMPRESSION.GET_COMPRESSION_RATIO(
  SCRATCHTBSNAME IN VARCHAR2,
  OWNNAME        IN VARCHAR2,
  OBJNAME        IN VARCHAR2,
  SUBOBJNAME     IN VARCHAR2,
  COMPTYPE       IN NUMBER,
  BLKCNT_CMP     OUT INTEGER,
  BLKCNT_UNCMP   OUT INTEGER,
  ROW_CMP        OUT INTEGER,
  ROW_UNCMP      OUT INTEGER,
  CMP_RATIO      OUT NUMBER,
  COMPTYPE_STR   OUT VARCHAR2,
  SAMPLE_RATIO   IN NUMBER DEFAULT 20,
  OBJTYPE        IN INTEGER DEFAULT 1);
  ```
  表2DBE_COMPRESSION.GET_COMPRESSION_RATIO接口参数说明 
  | 参数             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                              |
  |:---|:---|
  | SCRATCHTBSNAME | 数据对象所属表空间。                                                                                                                                                                                                                                                                                                                                                                                                                      |
  | OWNNAME        | 数据对象所有者（所属模式）。                                                                                                                                                                                                                                                                                                                                                                                                                  |
  | OBJNAME        | 数据对象名称。                                                                                                                                                                                                                                                                                                                                                                                                                         |
  | SUBOBJNAME     | 数据子对象名称。                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | COMPTYPE       | 压缩类型，支持： - 1：未压缩  - 2：高级压缩。   |
  | BLKCNT_CMP     | 样本被压缩后占用的块数。                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | BLKCNT_UNCMP   | 样本未压缩占用的块数。                                                                                                                                                                                                                                                                                                                                                                                                                     |
  | ROW_CMP        | 样本被压缩后单个块内可容纳的行数。                                                                                                                                                                                                                                                                                                                                                                                                               |
  | ROW_UNCMP      | 样本未被压缩时单个数据块可容纳的行数。                                                                                                                                                                                                                                                                                                                                                                                                             |
  | CMP_RATIO      | 压缩比，blkcnt_uncmp除以blkcnt_cmp。                                                                                                                                                                                                                                                                                                                                                                                                   |
  | COMPTYPE_STR   | 描述压缩类型的字符串。                                                                                                                                                                                                                                                                                                                                                                                                                     |
  | SAMPLE_RATIO   | 采样比例，输入为0-100的整数或浮点数，对应为百分之N的采样比例。默认为20，即对20%的行数进行采样。                                                                                                                                                                                                                                                                                                                                                                           |
  | OBJTYPE        | 对象类型，支持： - 1：表对象。                                                                                                                                                                       |
     
  

- DBE_COMPRESSION.GET_COMPRESSION_TYPE 根据输入参数获取指定行数据的压缩类型，该接口属于运维类接口，不做可见性判断，即传入的ctid为已删除的行时，该接口依然会返回当前行在页面上最新的状态，原型为：
  ```
  DBE_COMPRESSION.GET_COMPRESSION_TYPE(
  OWNNAME    IN VARCHAR2,
  TABNAME    IN VARCHAR2,
  CTID       IN TEXT,
  SUBOBJNAME IN VARCHAR2 DEFAULT NULL,
  BUCKETID   IN pg_catalog.int2 DEFAULT NULL)
  ```
  表3DBE_COMPRESSION.GET_COMPRESSION_TYPE接口参数说明 
  | 参数         | 描述                                    |
  |:---|:---|
  | OWNNAME    | 数据对象所有者（所属模式）。                        |
  | TABNAME    | 数据对象名称。                               |
  | CTID       | 目标行ctid。                              |
  | SUBOBJNAME | 数据子对象名称。                              |
  | BUCKETID   | 目标行的tablebucketid，仅用于bucket表，默认为NULL。 |