云数据库 GAUSSDB-CREATE GLOBAL INDEX:参数说明
下载云数据库 GAUSSDB用户手册完整版
参数说明
- UNIQUE
创建唯一性索引，每次添加数据时检测表中是否有重复值。如果插入或更新的值会引起重复的记录时，将报错。
- CONCURRENTLY
以不阻塞DML的方式创建索引（加ShareUpdateExclusiveLock锁）。创建索引时，一般会阻塞其他语句对该索引所依赖表的访问。指定此关键字，可以实现创建过程中不阻塞DML。
- 普通CREATE GLOBAL INDEX命令可以在事务内执行，但是CREATE GLOBAL INDEX CONCURRENTLY不可以在事务内执行。
- 内置了stream加速创建优化，该优化受enable_stream_operator参数控制。当该参数开启时，在线创建会以stream的方式进行，创建性能提升。
- 索引在线创建过程中可能会发生构建失败。构建失败的可能情形包括用户指令终止在线创建命令、修改该索引的定义、修改基表定义且影响了该索引的定义等。索引在线构建失败时有报错提示，同时留下一个“不可用”的索引。这个索引会被查询忽略，但它仍消耗IUD开销。因此推荐的恢复方法是通过DROP INDEX IF EXISTS语法删除该索引并尝试再次在线创建索引，或通过REINDEX/REBUILD语法重建索引。
- schema_name
模式的名称。
取值范围：已存在模式名。
- index_name
要创建的索引名，不能包含模式名，索引的模式与表相同。
取值范围：字符串，要符合标识符命名规范。
- table_name
需要为其创建索引的表的名称，可以用模式修饰。
取值范围：已存在的表名。
- USING method
指定创建索引的方法。
取值范围：ubtree，提供多版本B-tree索引，索引页面上包含事务信息。
- column_name
表中需要创建索引的列的名称（字段名）。
如果索引方式支持多字段索引，可以声明多个字段，对于非分区基表最多可以声明28个字段，对于分区基表最多可以声明27个字段。
- column_name ( length )
支持前缀键，详见：column_name ( length )。
前缀索引作为一种表达式索引，在GSI中的约束与表达式键一致。
- expression
创建一个基于该表的一个或多个字段的表达式索引，通常必须写在圆括号中。如果表达式有函数调用的形式，圆括号可以省略。表达式索引可用于获取对基本数据的某种变形的快速访问。比如，一个在upper(col)上的函数索引将允许WHERE upper(col) = 'JIM'子句使用索引。在创建表达式索引时，如果表达式中包含IS NULL子句，则这种索引是无效的。此时，建议用户尝试创建一个部分索引。
- COLLATE collation
COLLATE子句指定列的排序规则（该列必须是可排列的数据类型）。如果没有指定，则使用默认的排序规则。排序规则可以使用“select * from pg_collation”命令从pg_collation系统表中查询，默认的排序规则为查询结果中以default开始的行。
- opclass
操作符类的名称。对于索引的每一列可以指定一个操作符类，操作符类标识了索引那一列的使用的操作符。
- ASC
指定按升序排序 （默认）。
- DESC
指定按降序排序。
- NULLS FIRST
指定空值在排序中排在非空值之前，当指定DESC排序时，本选项为默认的。
- NULLS LAST
指定空值在排序中排在非空值之后，未指定DESC排序时，本选项为默认的。
- CONTAINING
全局二级索引可以包含索引键以外的基表属性。
- CONTAINING (column_name [, ...])
全局二级索引包含的索引键以外的基表属性。
- DISTRIBUTE BY
指定全局二级索引分布键，其分布键需要与基表不同，且只能使用哈希分布方式。
- DISTRIBUTE BY hash(column_name [,...])
全局二级索引分布键。
需要被包含在索引键中。
- WITH ( {storage_parameter = value} [, ... ] )
指定GSI的存储参数。
取值范围：- FILLFACTOR
一个索引的填充因子（fillfactor）是一个介于10和100之间的百分数。
取值范围：10~100
- STORAGE_TYPE
指定GSI的存储类型。
取值范围：USTORE
- INDEXSPLIT
取值范围：DEFAULT、INSERTPT
- enable_tde
指定该索引为加密索引。数据库会自动将加密索引中的数据先加密再存储。使用该参数前，请确保已通过GUC参数enable_tde开启透明加密功能，并通过GUC参数tde_key_info设置访问密钥服务的信息，以及基表也设置了enable_tde属性。在《特性指南》中“透明 数据加密 ”章节可获取该参数的详细使用方法。本参数仅支持btree，ubtree索引，不支持hash等其他索引。
取值范围：on/off。设置enable_tde=on时，key_type、tde_cmk_id、dek_cipher参数由数据库自动生成。
默认值：off
- encrypt_algo
取值范围：字符串，有效值为：AES_128_CTR，SM4_CTR。
默认值：不设置enable_tde选项时默认为空；设置enable_tde选项设置时，默认为AES_128_CTR。
- dek_cipher
数据密钥的密文。用户为索引设置enable_tde参数后，索引会自动复制基表的dek_cipher参数，该参数不支持主动设置或更改。
取值范围：字符串
默认值：空
- key_type
主密钥的类型。用户为表设置enable_tde参数后，索引会自动复制基表的key_type参数，该参数不支持主动设置或更改。
默认值：空
- cmk_id
主密钥的ID。用户为表设置enable_tde参数后，索引会自动复制基表的cmk_id参数，该参数不支持主动设置或更改。
取值范围：字符串
默认值：空
- FILLFACTOR
- TABLESPACE tablespace_name
指定索引的表空间，如果没有声明则使用默认的表空间。
取值范围：已存在的表空间名。
- VISIBLE
设置索引状态为可见，此选项为默认的。
- VISIBLE仅支持在ORA模式数据库下（即sql_compatibility = 'ORA'）设置，在其他数据库兼容模式下不支持。
- 当disable_keyword_options参数设置为“visible”时，此关键字不支持使用。
- 升级未提交阶段，不支持使用此关键字。
- INVISIBLE
设置索引状态为不可见。
- INVISIBLE仅支持在ORA模式数据库下（即sql_compatibility = 'ORA'）设置，在其他数据库兼容模式下不支持。
- 当disable_keyword_options参数设置为“invisible”时，此关键字不支持使用。
- 升级未提交阶段，不支持使用此关键字。
- WHERE predicate
创建一个部分索引。部分索引是一个只包含表的一部分记录的索引，通常是该表中比其他部分数据更有用的部分。例如，有一个表，表里包含已记账和未记账的定单，未记账的定单只占表的一小部分而且这部分是最常用的，此时就可以通过只在未记账部分创建一个索引来改善性能。另外一个可能的用途是使用带有UNIQUE的WHERE强制一个表的某个子集的唯一性。
取值范围：predicate表达式只能引用表的字段，它可以使用所有字段，而不仅是被索引的字段。目前，子查询和聚集表达式不能出现在WHERE子句里。不建议使用int等数值类型作为predicate，因为int等数值类型可以隐式转换为BOOLEAN值（非0值隐式转换为true，0转换为false），可能导致非预期的结果。
