开启和使用向量化引擎

使用限制

• 仅PolarDB PostgreSQL版14.10.20.0及以上版本支持向量化引擎。

• 原表必须有主键，且必须将主键列加入到加速索引中。

• 目前只针对静态数据，创建加速索引后，新增的动态数据无法通过加速索引查询。

• 目前支持的一致性级别为最终一致性。

• 一张表只能创建一个加速索引，加速索引中可以包含多个列。

• 不支持自定义数据类型，即通过CREATE TYPE语句创建的数据类型无法使用加速索引。

• 不支持存储过程的加速。

• 当查询语句使用的内存超过polar_csi.memory_limit指定的内存容量时会失败。

开启方式

PolarDB PostgreSQL版向量化引擎是一个内部的功能模块，与PolarDB PostgreSQL版已有的所有功能完全融合，可以在现有的PolarDB PostgreSQL版集群中免费开启/关闭该功能，无需为该功能单独付费或额外购买新集群。

PolarDB PostgreSQL版向量化引擎作为插件（polar_csi）部署在数据库集群中，在使用之前需要在指定的数据库中创建插件。

具体步骤如下：

1. 通过psql命令连接到现有集群的数据库，使用时请将{}中的内容替换为集群的连接信息，查看连接信息请参考查看或申请连接地址。

   psql -h {host} -p {port} -U {user_name} {dbname}

2. 登录到数据库后，创建polar_csi插件。

   说明

   需要注意的是，polar_csi插件的作用域是database级别，如果需要在一个集群的多个database中使用向量化引擎能力，需要为每个database分别创建polar_csi插件。

   CREATE EXTENSION polar_csi;

3. 开启向量化引擎功能（创建polar_csi插件后默认为关闭状态）。

   SET polar_csi.enable_query = ON;

语法说明

• 创建/删除polar_csi插件：

  ------创建polar_csi插件
  CREATE EXTENSION polar_csi;
  
  ------删除polar_csi插件
  DROP EXTENSION polar_csi;

• 开启/关闭向量化引擎功能，生效范围为会话或数据库。

  SET polar_csi.enable_query = [on|off];
  SET polar_csi.enable_query to [on|off];

• 创建加速索引，与PostgreSQL现有的CREATE INDEX语法一致，下列语句中primary_key是原表的主键列。

  CREATE INDEX xxx ON xxx USING CSI(primary_key,c1,c2,c3);

• 查看加速索引创建速度。

  SELECT * FROM pg_stat_progress_create_index;

• 查看某张表是否存在加速索引，可以使用\d命令。下列示例中，source_table_csi即为表source_table的加速索引。

  

• 删除加速索引。

  DROP INDEX xxx;

• 重建加速索引。

  REINDEX INDEX xxx;

• 查看Query是否使用加速索引：explain结果出现CSI Executor关键词时即表示使用加速索引。

  EXPLAIN SELECT COUNT(*) FROM source_table;
    QUERY PLAN  
  --------------
   CSI Executor
  (1 row)

• 使用Hint方式开启/关闭，生效范围为SQL语句。

  说明

  需要依赖pg_hint_plan插件，创建对应插件请使用CREATE EXTENSION。

  /*+ SET (polar_csi.enable_query on/off) */ SELECT ....

配置参数

数据类型

• 完全支持的数据类型如下：

  类别	数据类型
  bool 型	BOOLEAN
  字符与二进制	CHAR、VARCHAR、BPCHAR、TEXT、BYTEA、ARRAY、NAME、INTERVAL
  时间型	DATE、TIME、TIMESTAMP、TIMESTAMP WITH ZONE
  数值型	SHORT、SMALLINT、INTEGER、BIGINT、DECIMAL（需要指定精度）、NUMERIC、SERIAL、UUID、ENUM、FLOAT4、FLOAT8

• 有限支持的数据类型如下：JSONB、JSON。