图引擎服务 GES-新建索引:请求参数

时间：2025-01-03 16:00:02

图引擎服务 GES 索引操作API

表2 Body参数说明
参数	是否必选	类型	说明
indexName	是	String	索引名称。只能包含字母,数字,-和_。不能包含其他字符。索引名称的长度需在63字符以内。说明：
indexType	是	String	索引的类型，区分大小写。 “GlobalCompositeVertexIndex”为全局的Composite类型的点索引。 “GlobalCompositeEdgeIndex”为全局的Composite类型的边索引。 “CompositeVertexIndex”为局部的Composite类型的点索引。 “CompositeEdgeIndex”为局部的Composite类型的边索引。 “FullTextIndex”为全文索引。
hasLabel	否	Boolean	是否有label，默认为false。 true false
indexLabel	否	List	Label列表，仅在indexType为CompositeVertexIndex或CompositeEdgeIndex时有效，而且为必填项，用来指定在哪些label上建立索引。
indexProperty	否（若hasLabel为false或null，则该项为必选）	List	索引的属性列表。可以创建索引的属性类型有： integer、 float、 double、 long、 enum、 string、 date。
strLength	否	Integer	String类型的属性在编码索引时会按照一固定长度来截断，strLength用于指定此截断长度。未指定时默认值为40字节，用户可指定范围为[1, 256]。通常用户不需要手动指定此参数，即使有些属性超过此长度，索引编码时被截断。一般也不会有明显的性能劣化。除非绝大多数属性均超过默认长度，可以考虑适当增大strLength，但是会带来索引修改的性能下降。

如果属性类型为string，属性长度建议不要超过40个字节，超出的部分会被截断。
Cypher查询可以借助hasLabel为True的索引来加速。
- indexProperty为空时，建立的索引为label索引，可以加速label过滤。
- indexProperty不为空时，建立的索引为属性索引，可以加速对应的属性过滤。