The Ultipa Python driver provides a set of data structures designed to facilitate seamless interaction with the graph database. All data structures support getter methods to retrieve an attribute and setter methods to set the value of an attribute.

Node

A Node object includes the following attributes:

requestConfig = RequestConfig(graph="miniCircle")
response = Conn.gql("MATCH (n) RETURN n LIMIT 5", requestConfig)
nodes = response.alias("n").asNodes()

print("ID of the first node:", nodes[0].getID())
print("Name of the first node:", nodes[0].get("name"))

ID of the first node: ULTIPA800000000000004B
Name of the first node: Claire89

Edge

An Edge object includes the following attributes:

requestConfig = RequestConfig(graph="miniCircle")
response = Conn.gql("MATCH ()-[e]->() RETURN e LIMIT 3", requestConfig)
edges = response.alias("e").asEdges()

for edge in edges:
    print(edge.getValues())

{'toUuid': 13, 'uuid': 110, 'fromUuid': 7}
{'toUuid': 1032, 'uuid': 1391, 'fromUuid': 7, 'timestamp': 1537331913, 'datetime': '2018-09-19 12:38:33'}
{'toUuid': 1005, 'uuid': 1390, 'fromUuid': 7, 'timestamp': 1544118960, 'datetime': '2018-12-07 01:56:00'}

Path

A Path object includes the following attributes:

Methods on a Path object:

requestConfig = RequestConfig(graph="miniCircle")
response = Conn.gql("MATCH p = ()-[]-()-[]-() RETURN p LIMIT 3", requestConfig)
graph = response.alias("p").asGraph()

print("Nodes in each returned path:")
paths = graph.paths
for path in paths:
  print(path.nodeUuids)

Nodes in each returned path:
[6196955286285058052, 7998395137233256457, 8214567919347040275]
[6196955286285058052, 7998395137233256457, 8214567919347040275]
[6196955286285058052, 7998395137233256457, 5764609722057490441]

Graph

A Graph object includes the following attributes:

Methods on a Graph object:

requestConfig = RequestConfig(graph="miniCircle")
response = Conn.gql("MATCH p = ()-[]-()-[]-() RETURN p LIMIT 3", requestConfig)
graph = response.alias("p").asGraph()

print("Nodes in each returned path:")
paths = graph.paths
for path in paths:
  print(path.nodeUuids)

print("----------")
print("Nodes in the graph formed by all returned paths:")
print(graph.nodes.keys())

Nodes in each returned path:
[6196955286285058052, 7998395137233256457, 8214567919347040275]
[6196955286285058052, 7998395137233256457, 8214567919347040275]
[6196955286285058052, 7998395137233256457, 5764609722057490441]
----------
Nodes in the graph formed by all returned paths:
dict_keys([6196955286285058052, 7998395137233256457, 8214567919347040275, 5764609722057490441])

GraphSet

A GraphSet object includes the following attributes:

response = Conn.gql("SHOW GRAPH")
graphs = response.alias("_graph").asGraphSets()
for graph in graphs:
    print(graph.name)

DFS_EG
cyber
netflow

Schema

A Schema object includes the following attributes:

requestConfig = RequestConfig(graph="miniCircle")
response = Conn.gql("SHOW NODE SCHEMA", requestConfig)
schemas = response.alias("_nodeSchema").asSchemas()
for schema in schemas:
    print(schema.name)

default
account
celebrity
country
movie

Property

A Property object includes the following attributes:

requestConfig = RequestConfig(graph="miniCircle")
response = Conn.gql("SHOW NODE account PROPERTY", requestConfig)
properties = response.alias("_nodeProperty").asProperties()
for property in properties:
    print(property.name)

title
profile
age
name
logo

Attr

A Attr object includes the following attributes:

requestConfig = RequestConfig(graph="miniCircle")
response = Conn.gql("MATCH (n:account) RETURN n.name LIMIT 3")
attr = response.alias("n.name").asAttr()
print("name:", attr.name)
print("values:", attr.values)
print("property type:", attr.propertyType.name)
print("result type:", attr.resultType.name)

name: n.name
values: ['Velox', 'K03', 'Lunatique']
property type: STRING
result type: RESULT_TYPE_ATTR

Table

A Table object includes the following attributes:

Methods on a Table object:

requestConfig = RequestConfig(graph="miniCircle")
response = Conn.gql("MATCH (n:account) RETURN table(n._id, n.name) LIMIT 3")
table = response.get(0).asTable()
print("Header:")
print(table.headers)
print("First Row:")
print(table.toKV()[0])

Header:
[{'property_name': 'n._id', 'property_type': 'string'}, {'property_name': 'n.name', 'property_type': 'string'}]
First Row:
{'n._id': 'ULTIPA800000000000003B', 'n.name': 'Velox'}

HDCGraph

An HDCGraph object includes the following attributes:

requestConfig = RequestConfig(graph="miniCircle")
response = Conn.uql("hdc.graph.show()", requestConfig)
hdcGraphs = response.alias("_hdcGraphList").asHDCGraphs()
for hdcGraph in hdcGraphs:
    print(hdcGraph.name, "on", hdcGraph.hdcServerName)

miniCircle_hdc_graph on hdc-server-1
miniCircle_hdc_graph2 on hdc-server-2

Algo

An Algo object includes the following attributes:

response = Conn.uql("show().hdc('hdc-server-1')")
algos = response.alias("_algoList_from_hdc-server-1").asAlgos()
data = [[algo.name, algo.writeSupportType] for algo in algos if algo.type == "algo"]
headers = ["Name", "writeSupportType"]
print(tabulate.tabulate(data, headers=headers, tablefmt="grid"))

+-----------+--------------------+
| Name      | writeSupportType   |
+===========+====================+
| fastRP    | DB,FILE            |
+-----------+--------------------+
| struc2vec | DB,FILE            |
+-----------+--------------------+

Projection

A Projection object includes the following attributes:

requestConfig = RequestConfig(graph="miniCircle")
response = Conn.uql("show().projection()", requestConfig)
projections = response.alias("_projectionList").asProjections()
for projection in projections:
    print(projection.name)

miniCircle_projection_1

Index

An Index object includes the following attributes:

requestConfig = RequestConfig(graph="miniCircle")
response = Conn.gql("SHOW NODE INDEX", requestConfig)
indexList = response.alias("_nodeIndex").asIndexes()
for index in indexList:
    print(index.schema, "-", index.properties, "-", index.schema)

account - gender(6),year - account

Privilege

A Privilege object includes the following attributes:

response = Conn.uql("show().privilege()")
privileges = response.alias("_privilege").asPrivileges()

graphPrivileges = [privilege.name for privilege in privileges if privilege.level == PrivilegeLevel.Graphlevel]
print("Graph Privileges:", graphPrivileges)

systemPrivileges = [privilege.name for privilege in privileges if privilege.level == PrivilegeLevel.SystemLevel]
print("System Privileges:", systemPrivileges)

Graph Privileges: ['READ', 'INSERT', 'UPSERT', 'UPDATE', 'DELETE', 'CREATE_SCHEMA', 'DROP_SCHEMA', 'ALTER_SCHEMA', 'SHOW_SCHEMA', 'RELOAD_SCHEMA', 'CREATE_PROPERTY', 'DROP_PROPERTY', 'ALTER_PROPERTY', 'SHOW_PROPERTY', 'CREATE_FULLTEXT', 'DROP_FULLTEXT', 'SHOW_FULLTEXT', 'CREATE_INDEX', 'DROP_INDEX', 'SHOW_INDEX', 'LTE', 'UFE', 'CLEAR_JOB', 'STOP_JOB', 'SHOW_JOB', 'ALGO', 'CREATE_PROJECT', 'SHOW_PROJECT', 'DROP_PROJECT', 'CREATE_HDC_GRAPH', 'SHOW_HDC_GRAPH', 'DROP_HDC_GRAPH', 'COMPACT_HDC_GRAPH', 'SHOW_VECTOR_INDEX', 'CREATE_VECTOR_INDEX', 'DROP_VECTOR_INDEX', 'SHOW_CONSTRAINT', 'CREATE_CONSTRAINT', 'DROP_CONSTRAINT']
System Privileges: ['TRUNCATE', 'COMPACT', 'CREATE_GRAPH', 'SHOW_GRAPH', 'DROP_GRAPH', 'ALTER_GRAPH', 'TOP', 'KILL', 'STAT', 'SHOW_POLICY', 'CREATE_POLICY', 'DROP_POLICY', 'ALTER_POLICY', 'SHOW_USER', 'CREATE_USER', 'DROP_USER', 'ALTER_USER', 'SHOW_PRIVILEGE', 'SHOW_META', 'SHOW_SHARD', 'ADD_SHARD', 'DELETE_SHARD', 'REPLACE_SHARD', 'SHOW_HDC_SERVER', 'ADD_HDC_SERVER', 'DELETE_HDC_SERVER', 'LICENSE_UPDATE', 'LICENSE_DUMP', 'GRANT', 'REVOKE', 'SHOW_BACKUP', 'CREATE_BACKUP', 'SHOW_VECTOR_SERVER', 'ADD_VECTOR_SERVER', 'DELETE_VECTOR_SERVER']

Policy

A Policy object includes the following attributes:

A PropertyPrivilegeElement object includes the following attributes:

response = Conn.uql("show().policy('Tester')")
policy = response.alias("_policy").asPolicies()
print("Graph Privileges:", policy.graphPrivileges)
print("System Privileges:", policy.systemPrivileges)
print("Property Privileges:")
print("- Node (Read):", policy.propertyPrivileges.node.read)
print("- Node (Write):", policy.propertyPrivileges.node.write)
print("- Node (Deny):", policy.propertyPrivileges.node.deny)
print("- Edge (Read):", policy.propertyPrivileges.edge.read)
print("- Edge (Write):", policy.propertyPrivileges.edge.write)
print("- Edge (Deny):", policy.propertyPrivileges.edge.deny)
print("Policies:", policy.policies)

Graph Privileges: {'amz': ['ALGO', 'INSERT', 'DELETE', 'UPSERT'], 'StoryGraph': ['UPDATE', 'READ']}
System Privileges: ['TRUNCATE', 'KILL', 'TOP']
Property Privileges:
- Node (Read): [['*', '*', '*']]
- Node (Write): []
- Node (Deny): []
- Edge (Read): []
- Edge (Write): [['amz', '*', '*'], ['alimama', '*', '*']]
- Edge (Deny): [['miniCircle', 'review', 'value, timestamp']]
Policies: ['sales', 'manager']

User

A User object includes the following attributes:

A PropertyPrivilegeElement object includes the following attributes:

response = Conn.uql("show().user('johndoe')")
user = response.alias("_user").asUsers()
print("Created Time:", user.createdTime)
print("Graph Privileges:", user.graphPrivileges)
print("System Privileges:", user.systemPrivileges)
print("Property Privileges:")
print("- Node (Read):", user.propertyPrivileges.node.read)
print("- Node (Write):", user.propertyPrivileges.node.write)
print("- Node (Deny):", user.propertyPrivileges.node.deny)
print("- Edge (Read):", user.propertyPrivileges.edge.read)
print("- Edge (Write):", user.propertyPrivileges.edge.write)
print("- Edge (Deny):", user.propertyPrivileges.edge.deny)
print("Policies:", user.policies)

Created Time: 2025-04-02 11:08:38
Graph Privileges: {'amz': ['ALGO', 'INSERT', 'DELETE', 'UPSERT'], 'StoryGraph': ['UPDATE', 'READ']}
System Privileges: ['TRUNCATE', 'KILL', 'TOP']
Property Privileges:
- Node (Read): [['*', '*', '*']]
- Node (Write): []
- Node (Deny): []
- Edge (Read): []
- Edge (Write): [['amz', '*', '*'], ['alimama', '*', '*']]
- Edge (Deny): [['miniCircle', 'review', 'value, timestamp']]
Policies: ['sales', 'manager']

Process

A Process object includes the following attributes:

response = Conn.uql("top()")
processes = response.alias("_top").asProcesses()
for process in processes:
    print(process.processId)

1049435

Job

A Job object includes the following attributes:

requestConfig = RequestConfig(graph="miniCircle")
response = Conn.gql("SHOW JOB", requestConfig)
jobs = response.alias("_job").asJobs()
for job in jobs:
    if job.status == "FAILED":
        print(job.id, "-", job.errMsg, "-", job.type)

51 - Fulltext name already exists. - CREATE_FULLTEXT
42 - Fulltext name already exists. - CREATE_FULLTEXT
26 - [engine] uuids should be unsigned integer - HDC_ALGO
26_1 -  - HDC_ALGO
17 - [engine] all failed, because some nodes do not exist in db - HDC_ALGO
17_1 -  - HDC_ALGO