HugeGraph Python Client Quick Start

1# uv is optional, you can use pip directly
2uv pip install hugegraph-python # Note: may not the latest version, recommend to install from source
3# WIP: we will use 'hugegraph-python-client' as the package name soon

1git clone https://github.com/apache/incubator-hugegraph-ai.git
2cd incubator-hugegraph-ai/hugegraph-python-client
3
4# Normal install 
5uv pip install .
6
7# (Optional) install the devel version
8uv pip install -e .

 1from pyhugegraph.client import PyHugeClient
 2
 3# Initialize the client
 4# For HugeGraph API version ≥ v3: (Or enable graphspace function)  
 5# - The 'graphspace' parameter becomes relevant if graphspaces are enabled.(default name is 'DEFAULT')
 6# - Otherwise, the graphspace parameter is optional and can be ignored. 
 7client = PyHugeClient("127.0.0.1", "8080", user="admin", pwd="admin", graph="hugegraph", graphspace="DEFAULT")
 8
 9''''
10Note:
11Could refer to the official REST-API doc of your HugeGraph version for accurate details.
12If some API is not as expected, please submit a issue or contact us.
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# Init Graph
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# Define a property key
2client.schema().propertyKey('name').dataType('STRING').cardinality('SINGLE').create()

1# Define a vertex label
2client.schema().vertexLabel('person').properties('name', 'age').primaryKeys('name').create()

1# Define an edge label
2client.schema().edgeLabel('knows').sourceLabel('person').targetLabel('person').properties('since').create()

1# Define an index label
2client.schema().indexLabel('personByName').onV('person').by('name').secondary().create()

1# Create vertices
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# Create an edge
6client.graph().addEdge(v1, 'knows', v2).property('since', '2020').create()

1# Get a vertex by ID
2vertex = client.graph().getVertexById(v1.id)
3print(vertex)
4
5# Get an edge by ID
6edge = client.graph().getEdgeById(edge.id)
7print(edge)

1# Update a vertex
2client.graph().updateVertex(v1.id).property('age', 30).update()
3
4# Update an edge
5client.graph().updateEdge(edge.id).property('since', '2021').update()

1# Delete a vertex
2client.graph().deleteVertex(v1.id)
3
4# Delete an edge
5client.graph().deleteEdge(edge.id)

1# Execute a Gremlin query
2g = client.gremlin()
3res = g.exec("g.V().limit(5)")
4print(res)