Driver Data Classes

The Ultipa Java driver provides a set of data classes designed to facilitate seamless interaction with the graph database. All data classes 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:

Java
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"));

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

Edge

An Edge object includes the following attributes:

Java
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());
}

Output
{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:

Java
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());
}

Output
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:

Java
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());

Output
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:

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

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

Output
DFS_EG
cyber
netflow

Schema

A Schema object includes the following attributes:

Java
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());
}

Output
default
account
celebrity
country
movie

Property

A Property object includes the following attributes:

Java
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());
}

Output
title
profile
age
name
logo

Attr

A Attr object includes the following attributes:

Java
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());

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

Table

A Table object includes the following attributes:

Methods on a Table object:

Java
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));
}

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

HDCGraph

An HDCGraph object includes the following attributes:

Java
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());
}

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

Algo

An Algo object includes the following attributes:

Java
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());
}

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

Projection

A Projection object includes the following attributes:

Java
RequestConfig requestConfig = new RequestConfig();
requestConfig.setGraph("miniCircle");
Response response = driver.uql("show().projection()", requestConfig);
List<Projection> projections = response.alias("_projectionList").asProjections();

for (Projection projection : projections) {
    System.out.println(projection.getName());
}

Output
miniCircle_projection_1

Index

An Index object includes the following attributes:

Java
RequestConfig requestConfig = new RequestConfig();
requestConfig.setGraph("miniCircle");
Response response = driver.gql("SHOW NODE INDEX", requestConfig);
List<Index> indexList = response.alias("_nodeIndex").asIndexes();

for (Index index : indexList) {
    System.out.println(index.getSchema() + " - " + index.getProperties());
}

Output
account - gender(6),year

Privilege

A Privilege object includes the following attributes:

Java
Response response = driver.uql("show().privilege()");
List<Privilege> privileges = response.alias("_privilege").asPrivileges();

String graphPrivilegeNames = privileges.stream()
		.filter(p -> p.getLevel() == PrivilegeLevel.GRAPH_LEVEL)
		.map(Privilege::getName)
		.collect(Collectors.joining(", "));
System.out.println("Graph privileges: " + graphPrivilegeNames);

String systemPrivilegeNames = privileges.stream()
		.filter(p -> p.getLevel() == PrivilegeLevel.SYSTEM_LEVEL)
		.map(Privilege::getName)
		.collect(Collectors.joining(", "));
System.out.println("System privileges: " + systemPrivilegeNames);

Output
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:

Java
Response response = driver.uql("show().policy('Tester')");
List<Policy> policy = response.alias("_policy").asPolicies();
System.out.println("Graph privileges: " + policy.get(0).getGraphPrivileges());
System.out.println("System privileges: " + policy.get(0).getSystemPrivileges());
System.out.println("Property privileges:");
System.out.println("- Node (Read): " + policy.get(0).getPropertyPrivileges().getNode().getRead());
System.out.println("- Node (Write): " + policy.get(0).getPropertyPrivileges().getNode().getWrite());
System.out.println("- Node (Deny): " + policy.get(0).getPropertyPrivileges().getNode().getDeny());
System.out.println("- Edge (Read): " + policy.get(0).getPropertyPrivileges().getEdge().getRead());
System.out.println("- Edge (Write): " + policy.get(0).getPropertyPrivileges().getEdge().getWrite());
System.out.println("- Edge (Deny): " + policy.get(0).getPropertyPrivileges().getEdge().getDeny());
System.out.println("Policies: " + policy.get(0).getPolicies());

Output
Graph privileges: {amz=[ALGO, DROP_FULLTEXT, 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: [manager, sales]

User

A User object includes the following attributes:

A PropertyPrivilegeElement object includes the following attributes:

Java
Response response = driver.uql("show().user('johndoe')");
List<User> user = response.alias("_user").asUsers();
System.out.println("Created Time: " + user.get(0).getCreatedTime());
System.out.println("Graph privileges: " + user.get(0).getGraphPrivileges());
System.out.println("System privileges: " + user.get(0).getSystemPrivileges());
System.out.println("Property privileges:");
System.out.println("- Node (Read): " + user.get(0).getPropertyPrivileges().getNode().getRead());
System.out.println("- Node (Write): " + user.get(0).getPropertyPrivileges().getNode().getWrite());
System.out.println("- Node (Deny): " + user.get(0).getPropertyPrivileges().getNode().getDeny());
System.out.println("- Edge (Read): " + user.get(0).getPropertyPrivileges().getEdge().getRead());
System.out.println("- Edge (Write): " + user.get(0).getPropertyPrivileges().getEdge().getWrite());
System.out.println("- Edge (Deny): " + user.get(0).getPropertyPrivileges().getEdge().getDeny());
System.out.println("Policies: " + user.get(0).getPolicies());

Output
Created Time: Wed Apr 02 11:08:38 CST 2025
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): []
Policies: [sales, manager]

Process

A Process object includes the following attributes:

Java
Response response = driver.uql("top()");
List<Process> processes = response.alias("_top").asProcesses();

for (Process process : processes) {
    System.out.println(process.getProcessId());
}

Output
1049435

Job

A Job object includes the following attributes:

Java
RequestConfig requestConfig = new RequestConfig();
requestConfig.setGraph("miniCircle");
Response response = driver.gql("SHOW JOB", requestConfig);
List<Job> jobs = response.alias("_job").asJobs();

for (Job job : jobs) {
    if ("FAILED".equals(job.getStatus())) {
        System.out.println(job.getId() + " - " + job.getErrMsg() + " - " + job.getType());
    }
}

Output
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