新建索引
功能介绍
根据给定的indexName,IndexType等信息创建索引。目前支持索引:复合索引。
- 复合索引有全局点索引(GlobalCompositeVertexIndex)和全局边索引(GlobalCompositeEdgeIndex)。复合索引可在label和property上创建索引,使用索引查询可以加快速度。
索引特性对比
特性 |
模糊查询 |
速度 |
灵活度 |
支持谓语 |
---|---|---|---|---|
复合索引 |
不支持 |
快速 |
仅限于固定组合属性键 |
不支持 |
URI
- URI 格式
POST /ges/v1.0/{project_id}/graphs/{graph_name}/indices
- 参数说明
表1 URI参数说明 参数
是否必选
类型
说明
project_id
是
String
项目编号,用于资源隔离。请参考获取项目ID。
graph_name
是
String
图名称。
请求
- 请求样例(复合索引)
POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/indices { "indexName":"ageIndex", "indexType": "GlobalCompositeVertexIndex", "hasLabel": "true", "indexProperty": ["age"] }
- Body参数说明
表2 Body参数说明 参数
是否必选
类型
说明
indexName
是
String
索引名称。只能包含字母,数字,-和_。不能包含其他字符。索引名称的长度需在63字符以内。
indexType
是
String
索引的类型。区分大小写。“GlobalCompositeVertexIndex”为全局的Composite类型的点索引。
indexProperty
否(若hasLabel为false或null,则该项为必选)
String
索引的属性列表。
可以创建索引的属性类型有: integer、 float、 double、 long、 enum、 char array、 string、 date。
- Body参数说明
响应
- 要素说明
表3 要素说明 参数
是否必选
类型
说明
errorMessage
否
String
系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。
errorCode
否
String
系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。
job_id
否
String
执行该异步任务的jobId。
说明:- 可以查询jobId查看任务执行状态、获取返回结果,详情参考Job管理API。
jobType
否
String
执行该异步任务的jobType。
result
否
String
成功时result值为success。
- 请求成功样例
Http Status Code: 200 { "jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232", "jobType": 8 }
- 请求失败样例
Http Status Code: 400 { "errorMessage": "graph [demo] is not found", "errorCode": "GES.8603" }