- 最新动态
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 如何使用图引擎服务
- 准备工作
- 权限管理
- 元数据操作
- 创建图
- 管理图
- 数据迁移
- 访问图和分析图
- 查看图任务
- 配置图操作权限
- 运维监控与告警
- 套餐包管理
-
算法参考
- 算法一览表
- PageRank算法
- PersonalRank算法
- k核算法(k-core)
- k跳算法(k-hop)
- 最短路径算法(Shortest Path)
- 全最短路算法(All Shortest Paths)
- 带一般过滤条件最短路径(Filtered Shortest Path)
- 单源最短路算法(SSSP)
- 点集最短路(Shortest Path of Vertex Sets)
- 关联路径算法(n-Paths)
- 紧密中心度算法(Closeness Centrality)
- 标签传播算法(Label Propagation)
- Louvain算法
- 关联预测算法(Link Prediction)
- Node2vec算法
- 实时推荐算法(Real-time Recommendation)
- 共同邻居算法(Common Neighbors)
- 连通分量算法(Connected Component)
- 度数关联度算法(Degree Correlation)
- 三角计数算法(Triangle Count)
- 聚类系数算法(Cluster Coefficient)
- 中介中心度算法(Betweenness Centrality)
- 边中介中心度(Edge-betweenness Centrality)
- OD中介中心度(OD-betweenness Centrality)
- 单点环路检测(Single Vertex Circles Detection)
- 点集共同邻居(Common Neighbors of Vertex Sets)
- 点集全最短路(All Shortest Paths of Vertex Sets)
- 带一般过滤条件环路检测(filtered circle detection)
- 子图匹配(Subgraph Matching)
- 带过滤全对最短路径(Filtered All Pairs Shortest Paths)
- 带过滤全最短路径(Filtered All Shortest Paths)
- TopicRank算法
- 带过滤的n_paths算法(filtered_n_paths)
- 时序路径分析(Temporal Paths)
- 开发指南
-
API参考
- 使用前必读
- API概览
- 如何调用API
- 管理面API(V2)
-
业务面API
-
内存版
- 点操作API
- 边操作API
- 元数据操作API
- 索引操作API
- Gremlin操作API
-
算法API
- 执行算法(1.0.0)
-
算法API参数参考
- 算法公共参数
- pagerank算法(1.0.0)
- personalrank算法(1.0.0)
- k核算法(kcore)(1.0.0)
- k跳算法(k_hop)(1.0.0)
- 共同邻居(common_neighbors)(1.0.0)
- 点集共同邻居(common_neighbors_of_vertex_sets)(2.2.13)
- 关联预测(link_prediction)(1.0.0)
- 最短路径(shortest_path)(2.1.5)
- 全最短路(all_shortest_paths)(1.0.12)
- 带一般过滤条件最短路径(filtered_shortest_path)(2.2.4)
- 单源最短路(sssp)(1.0.0)
- 点集最短路(shortest_path_of_vertex_sets)(2.1.5)
- 关联路径(n_paths)(1.1.2)
- 带过滤的n_paths算法(filtered_n_paths)(2.2.22)
- 带过滤全对最短路径(filtered_all_pairs_shortest_paths)(2.2.17)
- 点集全最短路(all_shortest_paths_of_vertex_sets)(2.2.15)
- 带过滤全最短路径(filtered_all_shortest_paths)(2.2.17)
- 连通分量(connected_component)(1.0.0)
- 标签传播(label_propagation)(2.1.8)
- louvain算法(louvain)(2.2.1)
- node2vec算法(node2vec)(1.0.5)
- 实时推荐(realtime_recommendation)(2.2.21)
- 度数关联度(degree_correlation)(1.0.0)
- 三角计数(triangle_count)(1.0.0)
- 聚类系数(cluster_coefficient)(1.0.0)
- 紧密中心度(closeness)(1.0.0)
- 中介中心度算法(betweenness)(2.2.4)
- 边中介中心度(edge_betweenness)(2.2.4)
- OD中介中心度(od_betweenness)(2.2.4)
- 单点环路检测(single_vertex_circles_detection)(2.2.4)
- 带一般过滤条件环路检测(filtered_circle_detection)(2.2.15)
- 子图匹配(subgraph_matching)(2.2.16)
- topicrank算法(topicrank)(2.2.20)
- 动态图分析API
- 路径API
- 图统计API
- 图操作API
- 子图操作API
- Job管理API
- 自定义操作API
- Cypher操作API(2.2.16)
- Filtered-query API(2.2.13)
- Filtered-query V2(2.3.6)
- DSL查询API(2.3.14)
- 通过导入文件更新点边的指定属性(2.2.13)
- 通过读取文件删除点边(2.2.15)
- 运维监控API
-
持久化版
- 持久化版规格说明
- 点操作API
- 边操作API
- 元数据操作API
- 索引操作API
- HyG图管理API
-
HyG算法API
- 执行算法
-
算法API参数参考
- 算法公共参数
- pagerank算法
- personalrank算法(personalrank)
- k核算法(kcore)
- k跳算法(k_hop)
- 点集共同邻居(common_neighbors_of_vertex_sets)
- 最短路径(shortest_path)
- 全最短路(all_shortest_paths)
- 全对最短路径(all_pairs_shortest_paths)
- 单源最短路算法(sssp)
- 点集最短路(shortest_path_of_vertex_sets)
- 点集全最短路(all_shortest_paths_of_vertex_sets)
- 连通分量(connected_component)
- 三角计数算法(triangle_count)
- 紧密中心度算法(closeness)
- 中介中心度算法(betweenness)
- 边中介中心度(edge_betweenness)
- OD中介中心度(od_betweenness)
- 单点环路检测(single_vertex_circles_detection)
- topicrank算法(topicrank)
- louvain算法(louvain)
- Bigclam算法(bigclam)
- Cesna算法(cesna)
- infomap算法(infomap)
- 标签传播算法(label_propagation)
- 子图匹配算法(subgraph matching)
- 关联预测算法(link_prediction)
- n_paths算法(n_paths)
- 聚类系数算法(cluster_coefficient)
- 算法结果TXT格式说明
- 执行DSL算法
- DSL语法说明
- HyG Job管理API
- 原生算法API
- 图统计API
- 图操作API
- Job管理API
- Cypher操作API
- 交互式事务API
-
内存版
- 应用示例
- 权限策略和授权项
- 云监控服务监控指标说明
- 历史API
- 附录
- 常见问题
- 视频帮助
-
更多文档
-
用户指南(阿布扎比区域)
- 图引擎服务简介
- 权限管理
- 图引擎服务入门
- 图引擎服务管理控制台介绍
- 图引擎编辑器介绍
-
算法参考
- 算法一览表
- PageRank算法
- PersonalRank算法
- k核算法(k-core)
- k跳算法(k-hop)
- 最短路径算法(Shortest Path)
- 全最短路算法(All Shortest Paths)
- 单源最短路算法(SSSP)
- 点集最短路(Shortest Path of Vertex Sets)
- 关联路径算法(n-Paths)
- 紧密中心度算法(Closeness Centrality)
- 标签传播算法(Label Propagation)
- Louvain算法
- 关联预测算法(Link Prediction)
- Node2vec算法
- 实时推荐算法(Real-time Recommendation)
- 共同邻居算法(Common Neighbors)
- 联通分量算法(Connected Component)
- 度数关联度算法(Degree Correlation)
- 三角计数算法(Triangle Count)
- 聚类系数算法(Cluster Coefficient)
- 点集共同邻居(Common Neighbors of Vertex Sets)
- 子图匹配(Subgraph Matching)
- 带过滤全对最短路径(Filtered All Pairs Shortest Paths)
- 带过滤全最短路径(Filtered All Shortest Paths)
- TopicRank算法
- 带过滤的n_paths算法(2.2.22)
- 图引擎服务监控指标说明
- 计费说明
-
API参考(阿布扎比区域)
- 使用前必读
- 如何调用API
- 管理面API
-
业务面API
- 点操作API
- 边操作API
- 元数据操作API
- 索引操作API
- Gremlin操作API
-
算法API
- 执行算法
-
算法API参数参考
- 算法公共参数
- pagerank算法
- personalrank算法
- k核算法(kcore)
- k跳算法(k_hop)
- 最短路径(shortest_path)
- 全最短路(all_shortest_paths)
- 带一般过滤条件最短路径(filtered_shortest_path)
- 单源最短路(sssp)
- 点集最短路(shortest_path_of_vertex_sets)
- 关联路径(n_paths)
- 紧密中心度(closeness)
- 标签传播(label_propagation)
- louvain算法
- 关联预测(link_prediction)
- node2vec算法
- 实时推荐(realtime_recommendation)
- 共同邻居(common_neighbors)
- 联通分量(connected_component)
- 度数关联度(degree_correlation)
- 三角计数(triangle_count)
- 聚类系数(cluster_coefficient)
- 点集共同邻居(common_neighbors_of_vertex_sets)
- 点集全最短路(all_shortest_paths_of_vertex_sets)
- 带一般过滤条件环路检测(filtered_circle_detection)(2.2.15)
- 子图匹配(subgraph_matching)
- 带过滤全对最短路径(Filtered All Pairs Shortest paths)
- 带过滤全最短路径(filtered_all_shortest_paths)
- topicrank算法
- 带过滤的n_paths算法(2.2.22)
- 路径API
- 图统计API
- 子图操作API
- Job管理API
- Filtered-query API
- 通过导入文件更新点边的指定属性
- 通过读取文件删除点边
- Cypher操作API
- 细粒度权限控制API
- 监控指标说明
- 附录
-
用户指南(吉隆坡区域)
- 如何使用图引擎服务
- 权限管理
- 导入元数据
- 创建图
- 管理图
- 访问图和分析图
- 查看图任务
- 配置图操作权限
-
算法参考
- 算法一览表
- PageRank算法
- PersonalRank算法
- k核算法(k-core)
- k跳算法(k-hop)
- 最短路径算法(Shortest Path)
- 全最短路算法(All Shortest Paths)
- 单源最短路算法(SSSP)
- 点集最短路(Shortest Path of Vertex Sets)
- 关联路径算法(n-Paths)
- 紧密中心度算法(Closeness Centrality)
- 标签传播算法(Label Propagation)
- Louvain算法
- 关联预测算法(Link Prediction)
- Node2vec算法
- 实时推荐算法(Real-time Recommendation)
- 共同邻居算法(Common Neighbors)
- 联通分量算法(Connected Component)
- 度数关联度算法(Degree Correlation)
- 三角计数算法(Triangle Count)
- 聚类系数算法(Cluster Coefficient)
- 点集共同邻居(Common Neighbors of Vertex Sets)
- 子图匹配(Subgraph Matching)
- 带过滤全对最短路径(Filtered All Pairs Shortest Paths)
- 带过滤全最短路径(Filtered All Shortest Paths)
- TopicRank算法
- 带过滤的n_paths算法(filtered_n_paths)
-
API参考(吉隆坡区域)
- 使用前必读
- 如何调用API
- 管理面API
-
业务面API
- 点操作API
- 边操作API
- 元数据操作API
- 索引操作API
- Gremlin操作API
-
算法API
- 执行算法
-
算法API参数参考
- 算法公共参数
- pagerank算法
- personalrank算法
- k核算法(kcore)
- k跳算法(k_hop)
- 最短路径(shortest_path)
- 全最短路(all_shortest_paths)
- 带一般过滤条件最短路径(filtered_shortest_path)
- 单源最短路(sssp)
- 点集最短路(shortest_path_of_vertex_sets)
- 关联路径(n_paths)
- 紧密中心度(closeness)
- 标签传播(label_propagation)
- louvain算法(louvain)
- 关联预测(link_prediction)
- node2vec算法(node2vec)
- 实时推荐(realtime_recommendation)
- 共同邻居(common_neighbors)
- 联通分量(connected_component)
- 度数关联度(degree_correlation)
- 三角计数(triangle_count)
- 聚类系数(cluster_coefficient)
- 点集共同邻居(common_neighbors_of_vertex_sets)
- 点集全最短路(all_shortest_paths_of_vertex_sets)
- 带一般过滤条件环路检测(filtered_circle_detection)(2.2.15)
- 子图匹配(subgraph_matching)(2.2.16)
- 带过滤全对最短路径(filtered_all_pairs_shortest_paths)(2.2.17)
- 带过滤全最短路径(filtered_all_shortest_paths)(2.2.17)
- topicrank算法(topicrank)(2.2.20)
- 带过滤的n_paths算法(filtered_n_paths)(2.2.22)
- 路径API
- 图统计API
- 子图操作API
- Job管理API
- Filtered-query API
- 通过导入文件更新点边的指定属性
- 通过读取文件删除点边
- Cypher操作API
- 细粒度权限控制API
- 监控指标说明
- 附录
-
用户指南(阿布扎比区域)
- 通用参考
链接复制成功!
执行事务Cypher
功能介绍
执行事务Cypher。
URI
参数 |
是否必选 |
类型 |
说明 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
graph_name |
是 |
String |
图名称。 |
commit |
是 |
String |
事务ID,通过创建事务接口获取。 |
请求参数
参数 |
是否必选 |
类型 |
说明 |
---|---|---|---|
statements |
是 |
List |
statements为一个语句组,包含一到多条语句。其中每个元素的格式如表 statements参数说明。 |
参数 |
是否必选 |
类型 |
说明 |
---|---|---|---|
statement |
是 |
String |
Cypher语句。 |
parameters |
是 |
Object |
Cypher语句参数,在进行参数化查询时使用,默认为空。 如需使用,请参考参数化查询。 |
resultDataContents |
否 |
String或List |
返回的结果样式,样式可设置一个或多个。可选参数有“row”,”graph”, “raw”(2.2.27版本新增)。 |
includeStats |
否 |
Boolean |
控制返回结果是否携带增删改统计信息的开关,若不设置此字段,默认为不携带。 |
runtime |
否 |
String |
执行器类型,可选值为“map”、“slotted” 、“block”,默认为“map”。slotted执行器自2.3.15版本开始支持,block执行器自2.4.1版本开始支持。 |
executionMode(2.2.23) |
否 |
String |
执行模式。同步执行模式填写“sync”,异步执行填写“async”,不写默认同步执行。异步模式下,获取查询结果参见查询Job状态。 |
limit(2.2.23) |
否 |
Int |
该字段仅在异步模式下生效,表示对异步结果的最大结果数限制,默认值为100000。 |
- 在语句前可以添加explain和profile前缀,用于显示查询计划: explain只显示查询计划,不执行语句;profile显示查询计划,并执行语句。
- runtime字段说明:与map执行器相比,slotted执行器在语句的计划生成阶段完成了更多的语句数据流分析,在大部分情况下执行速度更快,占用内存更少。
- 在异步模式(executionMode参数值为async)下,支持cypher查询结果以csv格式导出到文件(GES版本2.3.4及以上支持该功能),详情请参考导出job返回结果到文件(2.2.1)。目前支持下列对象的返回:
- 点边单值属性、点边id、分组计数结果等值类型。
- 对于对象类型,目前的版本暂不支持导出,csv中视作空值处理。
- Cypher事务(仅持久化版规格有效):
- 持久化版规格下Cypher支持事务,用户可以通过设置transactional为true来开启Cypher的事务功能,以保证单条Cypher语句的原子性。对于多条Cypher语句的事务暂不支持。事务的隔离级别为串行化(serializability)。
- 由于底层存储引擎存在5s的事务时间窗口限制,因此Cypher的事务不可超过5s。对于复杂的查询,比如说多跳,运行时间可能会超过5s,从而触发超时导致提交失败。
使用Cypher的dbms.killQuery过程可以终止Cypher事务(详见Cypher API-函数和过程), 并回滚这条Cypher请求造成的所有改动。
响应参数
参数 |
类型 |
说明 |
---|---|---|
results |
List |
一个List,每个元素是一条Cypher语句的返回结果。 |
errors |
List |
一个List,每个元素包含字符串形式的code和message信息。 |
参数 |
类型 |
说明 |
---|---|---|
columns |
List |
返回的字段名。 |
data |
List |
返回的数据值,每个元素代表一条记录。 |
stats |
Object |
返回的增删改统计信息。 |
plan |
Object |
如果cypher语句带explain或者profile前缀,则此字段输出查询计划,否则不显示该字段,正常执行查询。profile特性2.3.12版本开始支持。 |
jobId(2.3.10) |
String |
请求为异步执行模式下,该字段用于输出异步任务id。 |
jobType(2.3.10) |
Integer |
请求为异步执行模式下,该字段用于输出异步任务的类型。 |
参数 |
类型 |
说明 |
---|---|---|
row |
List |
表示具体一行的内容,每个元素对应该行的一个字段,仅当resultDataContents为空或者包含“row”类型时显示。 |
meta |
List |
表示该行每个字段的类型信息,仅当resultDataContents为空或者包含“row”类型时显示。 |
graph |
Object |
以“graph”样式返回该行信息,仅当resultDataContents包含“graph”类型时显示。 |
raw(2.2.27) |
List |
以“raw”样式返回该行信息,仅当resultDataContents包含“raw”类型时显示。 |
参数 |
类型 |
说明 |
---|---|---|
contains_updates |
Boolean |
表示本次查询是否有数据修改。 |
edges_created |
Integer |
创建的边数目。 |
edges_deleted |
Int |
删除的边数目。 |
labels_set |
Integer |
设置的label数目。 |
properties_set |
Integer |
设置的属性数目。 |
vertices_created |
Integer |
创建的点数目。 |
vertices_deleted |
Integer |
删除的点数目。 |
请求示例
执行Cypher查询,Cypher语句为match (n) return n limit 1,返回的结果样式是每个元素对应该行的一个字段。
POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/transaction/{commit} { "statements": [{ "statement": "match (n) return n limit 1", "parameters": {}, "resultDataContents": ["row"], "includeStats": false }] }
SERVER_URL:图的访问地址,取值请参考业务面API使用限制。
响应示例
状态码: 200
成功响应示例(同步任务)
Http Status Code: 200 { "results": [ { "columns": ["n"], "data": [ { "row": [ { "occupation": "artist", "gender": "F", "Zip-code": "98133", "userid": 0, "age": "25-34" } ], "meta": [ { "id": "46", "type": "node", "labels": [ "user" ] } ] } ], "stats": { "contains_updates": false, "edges_created": 0, "edges_deleted": 0, "labels_set": 0, "properties_set": 0, "vertices_created": 0, "vertices_deleted": 0 } } ], "errors": [] }
状态码: 200
成功响应示例(异步任务)
Http Status Code: 200 { "results": [ { "columns": [ "jobId", "jobType" ], "jobId": "b64a5846-e306-4f87-b0f1-d595ee2a9990", "jobType": 1, "data": [ { "row": [ "b64a5846-e306-4f87-b0f1-d595ee2a9990", 1 ], "meta": [ null, null ] } ] } ], "errors": [] }
状态码: 400
失败响应示例
Http Status Code: 400 { "results": [], "errors": [ { "code": "GES.8904", "message": "Label index in vertices is not found." } ] }
状态码
返回值 |
说明 |
---|---|
400 Bad Request |
请求错误。 |
401 Unauthorized |
鉴权失败。 |
403 Forbidden |
没有操作权限。 |
404 Not Found |
找不到资源。 |
500 Internal Server Error |
服务内部错误。 |
503 Service Unavailable |
服务不可用。 |
错误码
请参见错误码。