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 has 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 has 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 has 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 has 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 has the following attributes:

response = Conn.uql("show().graph()")
graphs = response.alias("_graph").asGraphSets()
for graph in graphs:
    print(graph.name)

DFS_EG
cyber
netflow

Schema

A Schema object has the following attributes:

response = Conn.uql("show().node_schema()")
schemas = response.alias("_nodeSchema").asSchemas()
for schema in schemas:
    print(schema.name, "has", schema.total, "nodes")

default has 0 nodes
member has 7 nodes
organization has 19 nodes

Property

A Property object has the following attributes:

requestConfig = RequestConfig(graph="miniCircle")
response = Conn.uql("show().node_property(@account)", requestConfig)
properties = response.alias("_nodeProperty").asProperties()
for property in properties:
    print(property.name)

title
profile
age
name
logo

Table

A Table object has 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'}

Algo

An Algo object has the following attributes:

response = Conn.uql("show().algo()")
algos = response.alias("_algoList").asAlgos()
print(algos[0])

{'name': 'celf', 'description': 'celf', 'version': '1.0.0', 'result_opt': '25', 'parameters': {'seedSetSize': 'size_t,optional,1 as default', 'monteCarloSimulations': 'size_t,optional, 1000 as default', 'propagationProbability': 'float,optional, 0.1 as default'}, 'write_to_db_parameters': {}, 'write_to_file_parameters': {'filename': 'set file name'}}

Exta

An exta is a custom algorithm developed by users.

An Exta object has the following attributes:

response = Conn.uql("show().exta()")
extas = response.alias("_extaList").asExtas()
print(extas[0].name)

page_rank

Index

An Index object has the following attributes:

response = Conn.uql("show().index()")
indexList = response.alias("_nodeIndex").asIndexes()

for index in indexList:
    print(index.schema, index.properties, index.size)

account name 0
movie name 2526

response = Conn.uql("show().fulltext()")
indexList = response.alias("_edgeFulltext").asIndexes()

for index in indexList:
    print(index.schema, index.properties, index.schema)

contentFull content review

Privilege

A Privilege object has the following attributes:

response = Conn.uql("show().privilege()")
privilege = response.alias("_privilege").asPrivilege()
print(privilege.systemPrivileges)

["TRUNCATE","COMPACT","CREATE_GRAPH","SHOW_GRAPH","DROP_GRAPH","ALTER_GRAPH","MOUNT_GRAPH","UNMOUNT_GRAPH","TOP","KILL","STAT","SHOW_POLICY","CREATE_POLICY","DROP_POLICY","ALTER_POLICY","SHOW_USER","CREATE_USER","DROP_USER","ALTER_USER","GRANT","REVOKE","SHOW_PRIVILEGE"]

Policy

A Policy object has the following attributes:

response = Conn.uql("show().policy()")
policyList = response.alias("_policy").asPolicies()

for policy in policyList:
    print(policy.name)

manager
operator

User

A User object has the following attributes:

response = Conn.uql("show().user('Tester')")
user = response.alias("_user").asUsers()

print(user.toJSON())

{"create": 1721974206, "graphPrivileges": "{}", "policies": "[]", "propertyPrivileges": "{\"node\":{\"read\":[],\"write\":[[\"miniCircle\",\"account\",\"name\"]],\"deny\":[]},\"edge\":{\"read\":[],\"write\":[],\"deny\":[]}}", "systemPrivileges": "[]", "username": "Tester"}

Stats

A Stats object has the following attributes:

response = Conn.uql("stats()")
stats = response.get(0).asStats()
print("CPU usage (%):", stats.cpuUsage)
print("Memory usage:", stats.memUsage)

CPU usage (%): 5.415697
Memory usage: 9292.265625

Process

A Process object has the following attributes:

requestConfig = RequestConfig(graphName="amz")

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

a_2_569_2
a_3_367_1

Task

A Task object has the following attributes:

requestConfig = RequestConfig(graphName="miniCircle")

response = Conn.uql("show().task()", requestConfig)
tasks = response.alias("_task").asTasks()
print(tasks[0].task_info)
print(tasks[0].param)
print(tasks[0].result)

{'task_id': 77954, 'server_id': 2, 'algo_name': 'louvain', 'start_time': 1728543848, 'writing_start_time': 1728543848, 'end_time': 1728543848, 'time_cost': 0, 'TASK_STATUS': 3, 'return_type': <ultipa.types.types_response.Return_Type object at 0x0000025E53C0F940>}
{"phase1_loop_num":"20","min_modularity_increase":"0.001"}
{'community_count': '10', 'modularity': '0.535017', 'result_files': 'communityID,ids,num'}

Attr

A Attr object has the following attributes:

response = Conn.uql("find().nodes({@ad}) as n return n.brand limit 5")
attr = response.alias("n.brand").asAttr()
print(attr.values)

[14655, 14655, 14655, 14655, 434760]