Statement Outline

前提条件

GaussDB(for MySQL)的内核版本大于等于2.0.42.230600，支持Statement Outline功能。

注意事项

1. Statement Outline默认关闭，如果您需要使用，请参见开启Statement Outline。
2. Statement Outline不开启情况下对性能没有影响，但是特性开启后在规则较多的情况下对性能会产生影响，会导致性能下降。

功能描述

Statement Outline支持MySQL8.0的Optimizer Hints和Index Hints场景：

开启Statement Outline

1. 登录管理控制台。
2. 单击管理控制台左上角的，选择区域和项目。
3. 在页面左上角单击，选择“数据库 > 云数据库 GaussDB(for MySQL)”。
4. 在“实例管理”页面，选择目标实例，单击实例名称，进入实例概览页面。
5. 在左侧导航栏选择“参数修改”。
6. 在搜索框中搜索参数“rds_opt_outline_enabled”，将对应的值改为“ON”。

   表1 参数说明

   参数名称	描述
   rds_opt_outline_enabled	Statement Outline功能开关。 ON：表示开启Statement Outline功能。 OFF：表示关闭Statement Outline功能。

7. 单击“保存”。

Statement Outline表介绍

GaussDB(for MySQL)内置了一个系统表（outline）保存Hint，系统启动时会自动创建该表，无需您手动创建。创建表的SQL语句如下：

CREATE TABLE `mysql`.`outline` (
  `Id` bigint(20) NOT NULL AUTO_INCREMENT,
  `Schema_name` varchar(64) COLLATE utf8_bin DEFAULT NULL,
  `Digest` varchar(64) COLLATE utf8_bin NOT NULL,
  `Digest_text` longtext COLLATE utf8_bin,
  `Type` enum('IGNORE INDEX','USE INDEX','FORCE INDEX','OPTIMIZER') CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL,
  `Scope` enum('','FOR JOIN','FOR ORDER BY','FOR GROUP BY') CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT '',
  `State` enum('N','Y') CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL DEFAULT 'Y',
  `Position` bigint(20) NOT NULL,
  `Hint` text COLLATE utf8_bin NOT NULL,
  PRIMARY KEY (`Id`)
) ENGINE=InnoDB
 DEFAULT CHARSET=utf8 COLLATE=utf8_bin STATS_PERSISTENT=0 COMMENT='Statement outline'

管理Statement Outline

为了便捷地管理Statement Outline，定义了六个本地存储规则。

• add_optimizer_outline

  增加Optimizer Hint。

  • 语法

    dbms_outln.add_optimizer_outline(<Schema_name>,<Digest>,<Query_block>,<Hint>,<Query>);

    

    Digest和Query（原始SQL语句）可以任选其一。如果填写Query，DBMS_OUTLN会计算Digest和Digest_text，建议直接设置Query。

  • 参数说明

    参数名称	是否必选	类型	含义
    Schema_name	是	VARCHAR	语句所属的数据库名称。 可设置为空/NULL, 设置为空/NULL后，语句不能匹配。
    Digest	否	VARCHAR	语句特征哈希值。 和 Query参数可以选择其一设置， 不设置的话需要设置为空字符串。
    Query_block	是	INT	Hint作用对象在语句中的位置。 取值范围： 大于等于1。
    Hint	是	VARCHAR	Hint名称。
    Query	否	VARCHAR	SQL语句。 和 Digest参数可以选择其一，不设置的话需要设置为空字符串''。 如果两个都设置的话，确认Digest和Query是匹配的，否则参数校验不通过，执行失败。

  • 示例

    

• add_index_outline

  增加Index Hint。

  • 语法

    dbms_outln.add_index_outline(<Schema_name>,<Digest>,<Position>,<Type>,<Hint>,<Scope>,<Query>);

    

    Digest和Query（原始SQL语句）可以任选其一。如果填写Query，DBMS_OUTLN会计算Digest和Digest_text，建议直接设置Query。

  • 参数说明

    参数名称	是否必选	类型	含义
    Schema_name	是	VARCHAR	语句所属的db name。 可设置为空/NULL, 设置为空后，语句不能匹配
    Digest	否	VARCHAR	语句特征哈希值。 和 Query可以选择其一， 不设置的话需要设置为''
    Position	是	INT	Hint作用对象在语句中的位置，Index Hint作用对象为table, 即为表在语句中的位置。 取值范围：大于等于1。
    Type	是	ENUM	Hint类型。取值如下： OPTIMIZER USE INDEX FORCE INDEX IGNORE INDEX
    Hint	是	VARCHAR	Hint名称，即索引名称集合，多个索引名之间用英文逗号分隔。
    Scope	是	ENUM	Hint作用域。取值如下： FOR GROUP BY FOR ORDER BY FOR JOIN 空字符串
    Query	否	VARCHAR	SQL语句。 和 Digest可以选择其一，不设置的话需要设置为''。 如果两个都设置的话，确认Digest和Query是匹配的，否则参数校验不通过，执行失败。

  • 示例

    call dbms_outln.add_index_outline('outline_db', '', 1, 'USE INDEX', 'ind_1', '',"select * from t1 where t1.col1 =1 and t1.col2 ='xpchild'");

• preview_outline

  查看匹配Statement Outline的情况，可用于手动验证。

  • 语法

    dbms_outln.preview_outline(<Schema_name>,<Query>);

  • 参数说明

    参数名称	是否必选	参数类型	含义
    Schema_name	是	VARCHAR	数据库名称。
    Query	是	VARCHAR	SQL语句。

  • 示例

    

• show_outline

  展示Statement Outline在内存中命中的情况。

  • 语法

    dbms_outln.show_outline();

  • 示例

    

    关于HIT和OVERFLOW的说明如下:

    1. HIT为Statement Outline命中的次数。
    2. OVERFLOW为Statement Outline没有找到Query block或相应的表的次数。
• del_outline

  删除内存和表中的某一条Statement Outline。

  • 语法

    dbms_outln.del_outline(<id>);

  • 参数说明

    参数名称	是否必选	类型	含义
    id	是	INT	outline规则的序号ID，为mysql.outline表中的id列的值。不能为空。

  • 示例

    

    说明：如果删除的规则不存在，系统会报相应的警告，您可以使用show warnings;查看警告内容。

• flush_outline

  如果您直接操作了表outline修改Statement Outline，您需要让Statement Outline重新生效。

  • 语法

    dbms_outln.flush_outline();

  • 示例

    update mysql.outline set Position = 1 where Id = 18;
    call dbms_outln.flush_outline();

功能验证

验证Statement Outline是否有效果，有如下方法：

• 通过preview_outline进行预览

  

• 直接使用EXPLAIN查看