The Ultipa Java 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 = new RequestConfig();
requestConfig.setGraph("miniCircle");
Response response = driver.gql("MATCH (n) RETURN n LIMIT 5", requestConfig);
List<Node> nodes = response.alias("n").asNodes();

System.out.println("ID of the first node: " + nodes.get(0).getID());
System.out.println("Name of the first node: " + nodes.get(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 = new RequestConfig();
requestConfig.setGraph("miniCircle");
Response response = driver.gql("MATCH ()-[e]->() RETURN e LIMIT 3", requestConfig);
List<Edge> edges = response.alias("e").asEdges();

for (Edge edge : edges) {
    System.out.println(edge.getValues());
}

{toUuid=108, uuid=1661, fromUuid=59, timestamp=Sun Oct 14 06:27:42 CST 2018}
{toUuid=15, uuid=31, fromUuid=59}
{toUuid=1012, uuid=1368, fromUuid=59, datetime=2019-03-23T17:09:12}

Path

A Path object includes the following attributes:

Methods on a Path object:

RequestConfig requestConfig = new RequestConfig();
requestConfig.setGraph("miniCircle");
Response response = driver.gql("MATCH p = ()-[]-()-[]-() RETURN p LIMIT 3", requestConfig);
Graph graph = response.alias("p").asGraph();

System.out.println("Nodes in each returned path:");
List<Path> paths = graph.getPaths();
for (Path path : paths) {
    System.out.println(path.getNodeUUIDs());
}

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 = new RequestConfig();
requestConfig.setGraph("miniCircle");
Response response = driver.gql("MATCH p = ()-[]-()-[]-() RETURN p LIMIT 3", requestConfig);
Graph graph = response.alias("p").asGraph();

System.out.println("Nodes in each returned path:");
List<Path> paths = graph.getPaths();
for (Path path : paths) {
    System.out.println(path.getNodeUUIDs());
}

System.out.println("----------");
System.out.println("Nodes in the graph formed by all returned paths:");
System.out.println(graph.getNodes().keySet());

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

GraphSet

A GraphSet object includes the following attributes:

Response response = driver.gql("SHOW GRAPH");
List<GraphSet> graphs = response.alias("_graph").asGraphSets();

for (GraphSet graph : graphs) {
    System.out.println(graph.getName());
}

DFS_EG
cyber
netflow

Schema

A Schema object includes the following attributes:

RequestConfig requestConfig = new RequestConfig();
requestConfig.setGraph("miniCircle");
Response response = driver.gql("SHOW NODE SCHEMA", requestConfig);
List<Schema> schemas = response.alias("_nodeSchema").asSchemas();

for (Schema schema : schemas) {
    System.out.println(schema.getName());
}

default
account
celebrity
country
movie

Property

A Property object includes the following attributes:

RequestConfig requestConfig = new RequestConfig();
requestConfig.setGraph("miniCircle");
Response response = driver.gql("SHOW NODE account PROPERTY", requestConfig);
List<Property> properties = response.alias("_nodeProperty").asProperties();

for (Property property : properties) {
    System.out.println(property.getName());
}

title
profile
age
name
logo

Attr

A Attr object includes the following attributes:

RequestConfig requestConfig = new RequestConfig();
requestConfig.setGraph("miniCircle");
Response response = driver.gql("MATCH (n:account) RETURN n.name LIMIT 3", requestConfig);
Attr attr = response.alias("n.name").asAttr();

System.out.println("name: " + attr.getName());
System.out.println("values: " + attr.getValues());
System.out.println("type: " + attr.getPropertyType());

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

Table

A Table object includes the following attributes:

Methods on a Table object:

RequestConfig requestConfig = new RequestConfig();
requestConfig.setGraph("miniCircle");
Response response = driver.gql("MATCH (n:account) RETURN table(n._id, n.name) LIMIT 3", requestConfig);
Table table = response.get(0).asTable();

System.out.println("Header:");
for (Header header : table.getHeaders()) {
    System.out.println(header.getPropertyName() + " - " + header.getPropertyType());
}

System.out.println("First Row:");
List<Value> rows = table.toKV();
if (!rows.isEmpty()) {
    System.out.println(rows.get(0));
}

Header:
n._id - STRING
n.name - STRING
First Row:
{n._id=ULTIPA800000000000003B, n.name=Velox}

HDCGraph

An HDCGraph object includes the following attributes:

RequestConfig requestConfig = new RequestConfig();
requestConfig.setGraph("miniCircle");
Response response = driver.uql("hdc.graph.show()", requestConfig);
List<HDCGraph> hdcGraphs = response.alias("_hdcGraphList").asHDCGraphs();

for (HDCGraph hdcGraph : hdcGraphs) {
    System.out.println(hdcGraph.getName() + " on " + hdcGraph.getHdcServerName());
}

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

Algo

An Algo object includes the following attributes:

Response response = driver.uql("show().hdc('hdc-server-1')");
List<Algo> algos = response.alias("_algoList").asAlgos();

for (Algo algo : algos) {
  System.out.println(algo.getName() + " supports writeback types: " + algo.getWriteSupportType());
}

fastRP supports writeback types: DB,FILE
struc2vec supports writeback types: DB,FILE

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