HugeGraph Python 客户端快速入门

1# uv 是可选的，您可以直接使用 pip
2uv pip install hugegraph-python # 注意：可能不是最新版本，建议从源码安装
3# WIP：我们很快会将 'hugegraph-python-client' 作为包名

1git clone https://github.com/apache/incubator-hugegraph-ai.git
2cd incubator-hugegraph-ai/hugegraph-python-client
3
4# 普通安装
5uv pip install .
6
7# (可选) 安装开发版本
8uv pip install -e .

 1from pyhugegraph.client import PyHugeClient
 2
 3# 初始化客户端
 4# 对于 HugeGraph API 版本 ≥ v3：（或启用 graphspace 功能）
 5# - 如果启用了 graphspace，则 'graphspace' 参数变得相关（默认名称为 'DEFAULT'）
 6# - 否则，graphspace 参数是可选的，可以忽略。
 7client = PyHugeClient("127.0.0.1", "8080", user="admin", pwd="admin", graph="hugegraph", graphspace="DEFAULT")
 8
 9""""
10注意：
11可以参考您 HugeGraph 版本的官方 REST-API 文档以获取准确的详细信息。
12如果某些 API 与预期不符，请提交 issue 或联系我们。
13"""
14schema = client.schema()
15schema.propertyKey("name").asText().ifNotExist().create()
16schema.propertyKey("birthDate").asText().ifNotExist().create()
17schema.vertexLabel("Person").properties("name", "birthDate").usePrimaryKeyId().primaryKeys("name").ifNotExist().create()
18schema.vertexLabel("Movie").properties("name").usePrimaryKeyId().primaryKeys("name").ifNotExist().create()
19schema.edgeLabel("ActedIn").sourceLabel("Person").targetLabel("Movie").ifNotExist().create()
20
21print(schema.getVertexLabels())
22print(schema.getEdgeLabels())
23print(schema.getRelations())
24
25# 初始化图
26g = client.graph()
27v_al_pacino = g.addVertex("Person", {"name": "Al Pacino", "birthDate": "1940-04-25"})
28v_robert = g.addVertex("Person", {"name": "Robert De Niro", "birthDate": "1943-08-17"})
29v_godfather = g.addVertex("Movie", {"name": "The Godfather"})
30v_godfather2 = g.addVertex("Movie", {"name": "The Godfather Part II"})
31v_godfather3 = g.addVertex("Movie", {"name": "The Godfather Coda The Death of Michael Corleone"})
32
33g.addEdge("ActedIn", v_al_pacino.id, v_godfather.id, {})
34g.addEdge("ActedIn", v_al_pacino.id, v_godfather2.id, {})
35g.addEdge("ActedIn", v_al_pacino.id, v_godfather3.id, {})
36g.addEdge("ActedIn", v_robert.id, v_godfather2.id, {})
37
38res = g.getVertexById(v_al_pacino.id).label
39print(res)
40g.close()

1# 定义属性键
2client.schema().propertyKey('name').dataType('STRING').cardinality('SINGLE').create()

1# 定义顶点标签
2client.schema().vertexLabel('person').properties('name', 'age').primaryKeys('name').create()

1# 定义边标签
2client.schema().edgeLabel('knows').sourceLabel('person').targetLabel('person').properties('since').create()

1# 定义索引标签
2client.schema().indexLabel('personByName').onV('person').by('name').secondary().create()

1# 创建顶点
2v1 = client.graph().addVertex('person').property('name', 'John').property('age', 29).create()
3v2 = client.graph().addVertex('person').property('name', 'Jane').property('age', 25).create()
4
5# 创建边
6client.graph().addEdge(v1, 'knows', v2).property('since', '2020').create()

1# 通过 ID 获取顶点
2vertex = client.graph().getVertexById(v1.id)
3print(vertex)
4
5# 通过 ID 获取边
6edge = client.graph().getEdgeById(edge.id) # 假设 edge 对象已定义并有 id 属性
7print(edge)

1# 更新顶点
2client.graph().updateVertex(v1.id).property('age', 30).update()
3
4# 更新边
5client.graph().updateEdge(edge.id).property('since', '2021').update() # 假设 edge 对象已定义并有 id 属性

1# 删除顶点
2client.graph().deleteVertex(v1.id)
3
4# 删除边
5client.graph().deleteEdge(edge.id) # 假设 edge 对象已定义并有 id 属性

1# 执行 Gremlin 查询
2g = client.gremlin()
3res = g.exec("g.V().limit(5)")
4print(res)