已合并
fix ustore doc problem #8885
xudabiao2024创建于 21 天前
fix ustore doc problem #8885
已合并
共 11 个文件变更+38-5
| @@ -36,7 +36,12 @@ This parameter is a USERSET parameter. Set it based on instructions provided in | |||
| 36 | 36 | ||
| 37 | This parameter is a USERSET parameter. Set it based on instructions provided in [Table 1](../database_administration_guide/reset_parameters.md#en-us_topic_0283137176_en-us_topic_0237121562_en-us_topic_0059777490_t91a6f212010f4503b24d7943aed6d846). | 37 | This parameter is a USERSET parameter. Set it based on instructions provided in [Table 1](../database_administration_guide/reset_parameters.md#en-us_topic_0283137176_en-us_topic_0237121562_en-us_topic_0059777490_t91a6f212010f4503b24d7943aed6d846). |
| 38 | 38 | ||
| 39 | -You can set **enable\_ustore\_partial\_seqscan** \(copy selective columns only during sequential scanning in the ustore table\), **enable\_candidate\_buf\_usage\_count** \(whether dirty pages are evicted and added to the use count weight\), and **ustats\_tracker\_naptime** \(time for reloading the statistics file\). **umax\_search\_length\_for\_prune** \(number of blocks to be pruned before table extension\) and **ustore\_unit\_test** \(starting the UStore white box test\). The setting method is ustore\_att ='**enable\_ustore\_partial\_seqscan**=on'. | 39 | +You can set **enable\_ustore\_partial\_seqscan** \(copy selective columns only during sequential scanning in the ustore table\), **enable\_candidate\_buf\_usage\_count** \(whether dirty pages are evicted and added to the use count weight\), **ustats\_tracker\_naptime** \(time for reloading the statistics file\), **umax\_search\_length\_for\_prune** \(number of blocks to be pruned before table extension\), **ustore\_verify\_level** \(verification level\) and **ustore\_verify\_module** \(modules to be verified\). The setting method is ustore\_attr='**enable\_ustore\_partial\_seqscan**=true'. |
| 40 | + | ||
| 41 | +>[!NOTE] | ||
| 42 | +>- Boolean subkeys \(such as **enable\_ustore\_partial\_seqscan** and **enable\_candidate\_buf\_usage\_count**\) accept only true or false, not on/off. This is different from common Boolean GUC parameters. For example, SET ustore_attr = 'enable_ustore_partial_seqscan=true' succeeds, while SET ustore_attr = 'enable_ustore_partial_seqscan=on' reports an invalid parameter value error. | ||
| 43 | +>- The subkey **ustore\_unit\_test** \(starting the UStore white box test\) is for R&D debugging only and is not supported in release versions. | ||
| 44 | +>- When **gs_guc** is used to set **ustore\_attr**, if a subkey name or value is invalid, gs_guc may still report Success and write the invalid configuration into the postgresql.conf configuration file. If the configuration takes effect in reload mode, the invalid configuration may be silently ignored. If it takes effect in restart mode, the database instance may fail to start. Ensure that both the subkey name and value are valid before setting this parameter using gs_guc. | ||
| 40 | 45 | ||
| 41 | **Value range**: a string | 46 | **Value range**: a string |
| 42 | 47 | ||
| @@ -167,6 +167,8 @@ SELECT [/*+ plan_hint */] [ ALL | DISTINCT [ ON ( expression [, ...] ) ] ] | |||
| 167 | 167 | ||
| 168 | The optional **REPEATABLE** clause specifies the number of seeds used to generate random numbers in the sampling method. The seed value can be any non-null constant value. If the table was not changed during the query, the two queries having the same seed and *argument* values will select the same sampling in this table. However, different seed values usually generate different samples. If **REPEATABLE** is not specified, a new random sample will be selected for each query based on the seed generated by the system. | 168 | The optional **REPEATABLE** clause specifies the number of seeds used to generate random numbers in the sampling method. The seed value can be any non-null constant value. If the table was not changed during the query, the two queries having the same seed and *argument* values will select the same sampling in this table. However, different seed values usually generate different samples. If **REPEATABLE** is not specified, a new random sample will be selected for each query based on the seed generated by the system. |
| 169 | 169 | ||
| 170 | + TABLESAMPLE is not supported on Ustore partitioned tables (including scans on a partition specified using the PARTITION (partition_name) clause). An error "Ustore not support table sampling yet" is reported in this case. TABLESAMPLE is supported on regular (non-partitioned) Ustore tables. | ||
| 171 | + | ||
| 170 | - TIMECAPSULE \{ TIMESTAMP | CSN \} expression | 172 | - TIMECAPSULE \{ TIMESTAMP | CSN \} expression |
| 171 | 173 | ||
| 172 | Queries the table data of a specified CSN or at a specified time point. | 174 | Queries the table data of a specified CSN or at a specified time point. |
| @@ -318,6 +318,8 @@ Ustore 支持标准的 2PC 事务。 | |||
| 318 | - 不支持 MOT 外表。 | 318 | - 不支持 MOT 外表。 |
| 319 | - 不支持 OIDS。 | 319 | - 不支持 OIDS。 |
| 320 | - 不支持 CLUSTER。 | 320 | - 不支持 CLUSTER。 |
| 321 | +- 不支持查询系统列cmin和cmax。 | ||
| 322 | +- 分区表不支持TABLESAMPLE采样。 | ||
| 321 | 323 | ||
| 322 | ## 依赖关系<a name="section45787398"></a> | 324 | ## 依赖关系<a name="section45787398"></a> |
| 323 | 325 | ||
| @@ -36,7 +36,12 @@ | |||
| 36 | 36 | ||
| 37 | 该参数属于USERSET类型，请参考[表1](../database_administration_guide/reset_parameters.md#zh-cn_topic_0283137176_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。 | 37 | 该参数属于USERSET类型，请参考[表1](../database_administration_guide/reset_parameters.md#zh-cn_topic_0283137176_zh-cn_topic_0237121562_zh-cn_topic_0059777490_t91a6f212010f4503b24d7943aed6d846)中对应设置方法进行设置。 |
| 38 | 38 | ||
| 39 | -可以设置包括enable\_ustore\_partial\_seqscan（仅在ustore表中顺序扫描时复制选择性列），enable\_candidate\_buf\_usage\_count（是否脏页淘汰加入使用次数权重），ustats\_tracker\_naptime（重新加载统计文件所用的时间），umax\_search\_length\_for\_prune（扩展表前要修剪的块数），ustore\_unit\_test（开启Ustore白盒测试），设置方法为 ustore\_att='需要设置的参数'，例如需要设置enable\_ustore\_partial\_seqscan时，ustore\_attr='enable\_ustore\_partial\_seqscan=on'。 | 39 | +可以设置包括enable\_ustore\_partial\_seqscan（仅在ustore表中顺序扫描时复制选择性列），enable\_candidate\_buf\_usage\_count（是否脏页淘汰加入使用次数权重），ustats\_tracker\_naptime（重新加载统计文件所用的时间），umax\_search\_length\_for\_prune（扩展表前要修剪的块数），ustore\_verify\_level（控制校验的级别），ustore\_verify\_module（控制校验的模块），设置方法为 ustore\_attr='需要设置的参数'，例如需要设置enable\_ustore\_partial\_seqscan时，ustore\_attr='enable\_ustore\_partial\_seqscan=true'。 |
| 40 | + | ||
| 41 | +>[!NOTE]说明 | ||
| 42 | +>- 布尔类型的子键（如enable\_ustore\_partial\_seqscan、enable\_candidate\_buf\_usage\_count）取值仅为true或false，不支持on/off，与普通布尔类型GUC参数的取值习惯不同。例如，SET ustore_attr = 'enable_ustore_partial_seqscan=true'可以设置成功，而SET ustore_attr = 'enable_ustore_partial_seqscan=on'会报参数值非法错误。 | ||
| 43 | +>- 子键ustore\_unit\_test（开启Ustore白盒测试）仅供研发调试使用，发布版本不支持设置该子键。 | ||
| 44 | +>- 使用gs_guc设置ustore\_attr时，如果子键名称或取值非法，gs_guc可能仍提示Success并将非法配置写入postgresql.conf配置文件：以reload方式生效时，该非法配置可能被静默忽略；以restart方式生效时，可能导致数据库实例无法启动。请确认子键名称和取值均合法后，再通过gs_guc设置该参数。 | ||
| 40 | 45 | ||
| 41 | **取值范围**： 字符串 | 46 | **取值范围**： 字符串 |
| 42 | 47 | ||
| @@ -290,6 +290,8 @@ SELECT [/*+ plan_hint */] [ ALL | DISTINCT [ ON ( expression [, ...] ) ] ] | |||
| 290 | 290 | ||
| 291 | _table\_name_ 可以是普通表，分区表，普通视图，物化视图和键保留（key-preserved）的连接视图；普通视图指在单表上查询创建的视图；键保留的连接视图指对键保留表进行连接操作后创建的视图，但不支持对包含超过一个非键保留表的连接视图进行数据采样。 | 291 | _table\_name_ 可以是普通表，分区表，普通视图，物化视图和键保留（key-preserved）的连接视图；普通视图指在单表上查询创建的视图；键保留的连接视图指对键保留表进行连接操作后创建的视图，但不支持对包含超过一个非键保留表的连接视图进行数据采样。 |
| 292 | 292 | ||
| 293 | + 对Ustore存储引擎的分区表，不支持使用TABLESAMPLE子句进行数据采样（包括通过PARTITION (partition_name)子句指定分区扫描的场景），执行时会报错"Ustore not support table sampling yet"；Ustore普通表（非分区表）支持TABLESAMPLE采样。 | ||
| 294 | + | ||
| 293 | - TIMECAPSULE \{ TIMESTAMP | CSN \} expression | 295 | - TIMECAPSULE \{ TIMESTAMP | CSN \} expression |
| 294 | 296 | ||
| 295 | 查询指定CSN点或者指定时间点表的内容。 | 297 | 查询指定CSN点或者指定时间点表的内容。 |
| @@ -22,7 +22,8 @@ None. | |||
| 22 | 22 | ||
| 23 | ## Constraints<a name="section13355203802911"></a> | 23 | ## Constraints<a name="section13355203802911"></a> |
| 24 | 24 | ||
| 25 | -None. | 25 | +- The system columns cmin and cmax cannot be queried. |
| 26 | +- TABLESAMPLE is not supported on partitioned tables. | ||
| 26 | 27 | ||
| 27 | ## Dependencies<a name="section101449415302"></a> | 28 | ## Dependencies<a name="section101449415302"></a> |
| 28 | 29 | ||
| @@ -56,7 +56,12 @@ This parameter is a USERSET parameter. Set it based on instructions provided in | |||
| 56 | 56 | ||
| 57 | This parameter is a USERSET parameter. Set it based on instructions provided in [Table 1](../database_administration_guide/reset_parameters.md#en-us_topic_0283137176_en-us_topic_0237121562_en-us_topic_0059777490_t91a6f212010f4503b24d7943aed6d846). | 57 | This parameter is a USERSET parameter. Set it based on instructions provided in [Table 1](../database_administration_guide/reset_parameters.md#en-us_topic_0283137176_en-us_topic_0237121562_en-us_topic_0059777490_t91a6f212010f4503b24d7943aed6d846). |
| 58 | 58 | ||
| 59 | -You can set **enable\_ustore\_partial\_seqscan** \(copy selective columns only during sequential scanning in the ustore table\), **enable\_candidate\_buf\_usage\_count** \(whether dirty pages are evicted and added to the use count weight\), and **ustats\_tracker\_naptime** \(time for reloading the statistics file\). **umax\_search\_length\_for\_prune** \(number of blocks to be pruned before table extension\) and **ustore\_unit\_test** \(starting the UStore white box test\). The setting method is ustore\_att ='**enable\_ustore\_partial\_seqscan**=on'. | 59 | +You can set **enable\_ustore\_partial\_seqscan** \(copy selective columns only during sequential scanning in the ustore table\), **enable\_candidate\_buf\_usage\_count** \(whether dirty pages are evicted and added to the use count weight\), **ustats\_tracker\_naptime** \(time for reloading the statistics file\), **umax\_search\_length\_for\_prune** \(number of blocks to be pruned before table extension\), **ustore\_verify\_level** \(verification level\) and **ustore\_verify\_module** \(modules to be verified\). The setting method is ustore\_attr='**enable\_ustore\_partial\_seqscan**=true'. |
| 60 | + | ||
| 61 | +>[!NOTE] | ||
| 62 | +>- Boolean subkeys \(such as **enable\_ustore\_partial\_seqscan** and **enable\_candidate\_buf\_usage\_count**\) accept only true or false, not on/off. This is different from common Boolean GUC parameters. For example, SET ustore_attr = 'enable_ustore_partial_seqscan=true' succeeds, while SET ustore_attr = 'enable_ustore_partial_seqscan=on' reports an invalid parameter value error. | ||
| 63 | +>- The subkey **ustore\_unit\_test** \(starting the UStore white box test\) is for R&D debugging only and is not supported in release versions. | ||
| 64 | +>- When **gs_guc** is used to set **ustore\_attr**, if a subkey name or value is invalid, gs_guc may still report Success and write the invalid configuration into the postgresql.conf configuration file. If the configuration takes effect in reload mode, the invalid configuration may be silently ignored. If it takes effect in restart mode, the database instance may fail to start. Ensure that both the subkey name and value are valid before setting this parameter using gs_guc. | ||
| 60 | 65 | ||
| 61 | **Value range**: a string | 66 | **Value range**: a string |
| 62 | 67 | ||
| @@ -166,6 +166,8 @@ SELECT [/*+ plan_hint */] [ ALL | DISTINCT [ ON ( expression [, ...] ) ] ] | |||
| 166 | 166 | ||
| 167 | The optional **REPEATABLE** clause specifies the number of seeds used to generate random numbers in the sampling method. The seed value can be any non-null constant value. If the table was not changed during the query, the two queries having the same seed and *argument* values will select the same sampling in this table. However, different seed values usually generate different samples. If **REPEATABLE** is not specified, a new random sample will be selected for each query based on the seed generated by the system. | 167 | The optional **REPEATABLE** clause specifies the number of seeds used to generate random numbers in the sampling method. The seed value can be any non-null constant value. If the table was not changed during the query, the two queries having the same seed and *argument* values will select the same sampling in this table. However, different seed values usually generate different samples. If **REPEATABLE** is not specified, a new random sample will be selected for each query based on the seed generated by the system. |
| 168 | 168 | ||
| 169 | + TABLESAMPLE is not supported on Ustore partitioned tables (including scans on a partition specified using the PARTITION (partition_name) clause). An error "Ustore not support table sampling yet" is reported in this case. TABLESAMPLE is supported on regular (non-partitioned) Ustore tables. | ||
| 170 | + | ||
| 169 | - TIMECAPSULE \{ TIMESTAMP | CSN \} expression | 171 | - TIMECAPSULE \{ TIMESTAMP | CSN \} expression |
| 170 | 172 | ||
| 171 | Queries the table data of a specified CSN or at a specified time point. | 173 | Queries the table data of a specified CSN or at a specified time point. |
| @@ -326,6 +326,8 @@ Ustore 支持标准的 2PC 事务。 | |||
| 326 | - 不支持 MOT 外表。 | 326 | - 不支持 MOT 外表。 |
| 327 | - 不支持 OIDS。 | 327 | - 不支持 OIDS。 |
| 328 | - 不支持 CLUSTER。 | 328 | - 不支持 CLUSTER。 |
| 329 | +- 不支持查询系统列cmin和cmax。 | ||
| 330 | +- 分区表不支持TABLESAMPLE采样。 | ||
| 329 | 331 | ||
| 330 | ## 依赖关系<a name="section45787398"></a> | 332 | ## 依赖关系<a name="section45787398"></a> |
| 331 | 333 | ||
| @@ -57,7 +57,12 @@ | |||
| 57 | 57 | ||
| 58 | **参数说明**： Ustore测试参数。 | 58 | **参数说明**： Ustore测试参数。 |
| 59 | 59 | ||
| 60 | -该参数属于USERSET类型，可以设置enable\_ustore\_partial\_seqscan（仅在ustore表中顺序扫描时复制选择性列）、enable\_candidate\_buf\_usage\_count（是否脏页淘汰加入使用次数权重）、ustats\_tracker\_naptime（重新加载统计文件所用的时间）、umax\_search\_length\_for\_prune（扩展表前要修剪的块数）、ustore\_unit\_test（开启Ustore白盒测试）等参数。设置方法为 ustore\_attr='需要设置的参数'，例如需要设置enable\_ustore\_partial\_seqscan时，ustore\_attr='enable\_ustore\_partial\_seqscan=on'。 | 60 | +该参数属于USERSET类型，可以设置enable\_ustore\_partial\_seqscan（仅在ustore表中顺序扫描时复制选择性列）、enable\_candidate\_buf\_usage\_count（是否脏页淘汰加入使用次数权重）、ustats\_tracker\_naptime（重新加载统计文件所用的时间）、umax\_search\_length\_for\_prune（扩展表前要修剪的块数）、ustore\_verify\_level（控制校验的级别）、ustore\_verify\_module（控制校验的模块）等参数。设置方法为 ustore\_attr='需要设置的参数'，例如需要设置enable\_ustore\_partial\_seqscan时，ustore\_attr='enable\_ustore\_partial\_seqscan=true'。 |
| 61 | + | ||
| 62 | +>[!NOTE]说明 | ||
| 63 | +>- 布尔类型的子键（如enable\_ustore\_partial\_seqscan、enable\_candidate\_buf\_usage\_count）取值仅为true或false，不支持on/off，与普通布尔类型GUC参数的取值习惯不同。例如，SET ustore_attr = 'enable_ustore_partial_seqscan=true'可以设置成功，而SET ustore_attr = 'enable_ustore_partial_seqscan=on'会报参数值非法错误。 | ||
| 64 | +>- 子键ustore\_unit\_test（开启Ustore白盒测试）仅供研发调试使用，发布版本不支持设置该子键。 | ||
| 65 | +>- 使用gs_guc设置ustore\_attr时，如果子键名称或取值非法，gs_guc可能仍提示Success并将非法配置写入postgresql.conf配置文件：以reload方式生效时，该非法配置可能被静默忽略；以restart方式生效时，可能导致数据库实例无法启动。请确认子键名称和取值均合法后，再通过gs_guc设置该参数。 | ||
| 61 | 66 | ||
| 62 | **取值范围**： 字符串 | 67 | **取值范围**： 字符串 |
| 63 | 68 | ||
| @@ -291,6 +291,8 @@ SELECT [/*+ plan_hint */] [ ALL | DISTINCT [ ON ( expression [, ...] ) ] ] | |||
| 291 | 291 | ||
| 292 | _table\_name_ 可以是普通表，分区表，普通视图，物化视图和键保留（key-preserved）的连接视图；普通视图指在单表上查询创建的视图；键保留的连接视图指对键保留表进行连接操作后创建的视图，但不支持对包含超过一个非键保留表的连接视图进行数据采样。 | 292 | _table\_name_ 可以是普通表，分区表，普通视图，物化视图和键保留（key-preserved）的连接视图；普通视图指在单表上查询创建的视图；键保留的连接视图指对键保留表进行连接操作后创建的视图，但不支持对包含超过一个非键保留表的连接视图进行数据采样。 |
| 293 | 293 | ||
| 294 | + 对Ustore存储引擎的分区表，不支持使用TABLESAMPLE子句进行数据采样（包括通过PARTITION (partition_name)子句指定分区扫描的场景），执行时会报错"Ustore not support table sampling yet"；Ustore普通表（非分区表）支持TABLESAMPLE采样。 | ||
| 295 | + | ||
| 294 | - TIMECAPSULE \{ TIMESTAMP | CSN \} expression | 296 | - TIMECAPSULE \{ TIMESTAMP | CSN \} expression |
| 295 | 297 | ||
| 296 | 查询指定CSN点或者指定时间点表的内容。 | 298 | 查询指定CSN点或者指定时间点表的内容。 |