索引推荐

openGauss的索引推荐的功能，共包含三个子功能：单query索引推荐、虚拟索引和workload级别索引推荐。

单query索引推荐

单query索引推荐功能支持用户在数据库中直接进行操作，本功能基于查询语句的语义信息和数据库的统计信息，对用户输入的单条查询语句生成推荐的索引。本功能仅支持单条SELECT类型的语句，不支持其他类型的SQL语句。本功能依赖函数gs_index_advise实现。

表 1 单query索引推荐功能的接口

函数名

参数

功能

gs_index_advise

SQL语句字符串

针对单条查询语句生成推荐索引。

使用上述函数，获取针对该query生成的推荐索引，推荐结果由索引的表名和列名组成。使用方法如下：

  1. openGauss=# select "table", "column" from gs_index_advise('SELECT c_discount from bmsql_customer where c_w_id = 10');
  2.      table      |  column  
  3. ----------------+----------
  4.  bmsql_customer | (c_w_id)
  5. (1 row)

上述结果表明，应当在表bmsql_customer的c_w_id列上创建索引。创建索引的命令如下：

  1. CREATE INDEX idx on bmsql_customer(c_w_id);

某些SQL语句，也可能被推荐创建联合索引，例如：

  1. openGauss=# select "table", "column" from gs_index_advise('select name, age, sex from t1 where age >= 18 and age < 35 and sex = ''f'';');
  2.  table | column
  3. -------+------------
  4.  t1    | (age, sex)
  5. (1 row)

则上述语句表明应该在表t1上创建一个联合索引 (age, sex)。创建索引的命令如下：

  1. CREATE INDEX idx1 on t1(age, sex);

虚拟索引

虚拟索引功能支持用户在数据库中直接进行操作，本功能将模拟真实索引的建立，避免真实索引创建所需的时间和空间开销，用户基于虚拟索引，可通过优化器评估该索引对指定查询语句的代价影响。虚拟索引涉及的函数接口和GUC参数，请参见表2、表3。

表 2 虚拟索引功能的接口

函数名

参数

功能

hypopg_create_index

创建索引语句的字符串

创建虚拟索引。

hypopg_display_index

无

显示所有创建的虚拟索引信息。

hypopg_drop_index

索引的oid

删除指定的虚拟索引。

hypopg_reset_index

无

清除所有虚拟索引。

hypopg_estimate_size

索引的oid

估计指定索引创建所需的空间大小。

表 3 虚拟索引功能的GUC参数

参数名

功能

默认值

enable_hypo_index

是否开启虚拟索引功能

off

使用方法如下：

  1. 使用函数hypopg_create_index创建虚拟索引。

    1. openGauss=> select * from hypopg_create_index('create index on bmsql_customer(c_w_id)');
    2.  indexrelid |              indexname              
    3. ------------+-------------------------------------
    4.      329726 | <329726>btree_bmsql_customer_c_w_id
    5. (1 row)

  2. 开启GUC参数enable_hypo_index，该参数控制数据库的优化器进行EXPLAIN时是否考虑创建的虚拟索引。通过对特定的查询语句执行explain，用户可根据优化器给出的执行计划评估该索引是否能够提升该查询语句的执行效率。例如：

    开启GUC参数前，执行EXPLAIN + 查询语句：

    1. openGauss=> explain SELECT c_discount from bmsql_customer where c_w_id = 10;
    2.                               QUERY PLAN                              
    3. ----------------------------------------------------------------------
    4.  Seq Scan on bmsql_customer  (cost=0.00..52963.06 rows=31224 width=4)
    5.    Filter: (c_w_id = 10)
    6. (2 rows)

    开启GUC参数：

    1. openGauss=> set enable_hypo_index = on;
    2. SET

    开启GUC参数后，执行EXPLAIN + 查询语句：

    1. openGauss=> explain SELECT c_discount from bmsql_customer where c_w_id = 10;
    2.                                                     QUERY PLAN                                                    
    3. ------------------------------------------------------------------------------------------------------------------
    4.  [Bypass]
    5.  Index Scan using <329726>btree_bmsql_customer_c_w_id on bmsql_customer  (cost=0.00..39678.69 rows=31224 width=4)
    6.    Index Cond: (c_w_id = 10)
    7. (3 rows)

    通过对比两个执行计划可以观察到，该索引预计会降低指定查询语句的执行代价，用户可考虑创建对应的真实索引。

  3. （可选）使用函数hypopg_display_index展示所有创建过的虚拟索引。例如：

    1. openGauss=> select * from hypopg_display_index();
    2.                  indexname                  | indexrelid |     table      |      column      
    3. --------------------------------------------+------------+----------------+------------------
    4.  <329726>btree_bmsql_customer_c_w_id        |     329726 | bmsql_customer | (c_w_id)
    5.  <329729>btree_bmsql_customer_c_d_id_c_w_id |     329729 | bmsql_customer | (c_d_id, c_w_id)
    6. (2 rows)

  4. （可选）使用函数hypopg_estimate_size估计虚拟索引创建所需的空间大小（单位：字节）。例如：

    1. openGauss=> select * from hypopg_estimate_size(329730);
    2.  hypopg_estimate_size 
    3. ----------------------
    4.              15687680
    5. (1 row)

  5. 删除虚拟索引。

    使用函数hypopg_drop_index删除指定oid的虚拟索引。例如：

    1. openGauss=> select * from hypopg_drop_index(329726);
    2.  hypopg_drop_index 
    3. -------------------
    4.  t
    5. (1 row)

    使用函数hypopg_reset_index一次性清除所有创建的虚拟索引。例如：

    1. openGauss=> select * from hypopg_reset_index();
    2.  hypopg_reset_index 
    3. --------------------
    5. (1 row)

workload级别索引推荐

对于workload级别的索引推荐，用户可通过运行数据库外的脚本使用此功能，本功能将包含有多条DML语句的workload作为输入，最终生成一批可对整体workload的执行表现进行优化的索引。

  1. 准备好包含有多条DML语句的文件作为输入的workload，文件中每条语句占据一行。用户可从数据库的离线日志中获得历史的业务语句。

  2. 运行python脚本index_advisor_workload.py，命令如下：

    1. python index_advisor_workload.py [p PORT] [d DATABASE] [f FILE] [--h HOST] [-U USERNAME] [-W PASSWORD][--schema SCHEMA]
    2. [--max_index_num MAX_INDEX_NUM][--max_index_storage MAX_INDEX_STORAGE] [--multi_iter_mode] [--multi_node]  [--json] [--driver] [--show_detail]

    其中的输入参数依次为：

    • PORT：连接数据库的端口号。
    • DATABASE：连接数据库的名字。
    • FILE：包含workload语句的文件路径。
    • HOST：（可选）连接数据库的主机号。
    • USERNAME：（可选）连接数据库的用户名。
    • PASSWORD：（可选）连接数据库用户的密码。
    • SCHEMA：模式名称。
    • MAX_INDEX_NUM：（可选）最大的索引推荐数目。
    • MAX_INDEX_STORAGE：（可选）最大的索引集合空间大小。
    • multi_node：（可选）指定当前是否为分布式数据库实例。
    • multi_iter_mode：（可选）算法模式，可通过是否设置该参数来切换算法。
    • json：（可选）指定workload语句的文件路径格式为SQL归一化后的json，默认格式每条SQL占一行。
    • driver：（可选）指定是否使用python驱动器连接数据库，默认gsql连接。
    • show_detail：（可选）是否显示当前推荐索引集合的详细优化信息。

    例如：

    1. python index_advisor_workload.py 6001 postgres tpcc_log.txt --schema public --max_index_num 10 --multi_iter_mode

    推荐结果为一批索引，以多个创建索引语句的格式显示在屏幕上，结果示例。

    1. create index ind0 on public.bmsql_stock(s_i_id,s_w_id);
    2. create index ind1 on public.bmsql_customer(c_w_id,c_id,c_d_id);
    3. create index ind2 on public.bmsql_order_line(ol_w_id,ol_o_id,ol_d_id);
    4. create index ind3 on public.bmsql_item(i_id);
    5. create index ind4 on public.bmsql_oorder(o_w_id,o_id,o_d_id);
    6. create index ind5 on public.bmsql_new_order(no_w_id,no_d_id,no_o_id);
    7. create index ind6 on public.bmsql_customer(c_w_id,c_d_id,c_last,c_first);
    8. create index ind7 on public.bmsql_new_order(no_w_id);
    9. create index ind8 on public.bmsql_oorder(o_w_id,o_c_id,o_d_id);
    10. create index ind9 on public.bmsql_district(d_w_id);