Types Mapping Ultipa and C#

Mapping Methods

The Alias() method of the Response class returns a DataItem, which embeds the query result. You should use the As<Type>() method of DataItem to cast the result to the appropriate driver type.

C#
var res = await ultipa.Uql("find().nodes() as n return n{*} limit 5");
var nodeList = res.Alias("n").AsNodes();
Console.WriteLine(JsonConvert.SerializeObject(nodeList));

The result n coming from the database contains five nodes, each of the NODE type. The AsNodes() method converts them as a list of Node objects.

Type mapping methods available on DataItem:

Driver Types

Node

A Node object has the following fields:

C#
var res = await ultipa.Uql("find().nodes() as n return n{*} limit 5", requestConfig);
var nodeList = res.Alias("n")?.AsNodes();
Console.WriteLine("ID of the 1st node: " + JsonConvert.SerializeObject(nodeList[0].Id));
Console.WriteLine(
    "Name of the 1st node: "
        + JsonConvert.SerializeObject(nodeList[0].Values.GetValueOrDefault("name"))
);

Output
ID of the 1st node: ULTIPA8000000000000001
Name of the 1st node: Titanic

Edge

An Edge object has the following fields:

C#
var res = await ultipa.Uql("find().edges() as e return e{*} limit 5", requestConfig);
var edgeList = res.Alias("e")?.AsEdges();
Console.WriteLine(
    "Value of the 1st edge: " + JsonConvert.SerializeObject(edgeList[0].Values)
);

Output
Value of the 1st edge: {"datetime":"2019-01-06T02:56:00Z","timestamp":"2019-01-05T18:57:57Z","targetPost":0}

Path

A Path object has the following fields:

C#
var res = await ultipa.Uql(
    "n().e()[:2].n() as paths return paths{*} limit 5",
    requestConfig
);
var pathList = res.Alias("paths")?.AsPaths();
Console.WriteLine(
    "Length of the 1st path: " + JsonConvert.SerializeObject(pathList[0].Edges.Count)
);
Console.WriteLine(
    "Edge list of the 1st path: " + JsonConvert.SerializeObject(pathList[0].Edges)
);
Console.WriteLine(
    "Information of the 2nd node in the 1st path: "
        + JsonConvert.SerializeObject(pathList[0].Nodes[1])
);

Output
Length of the 1st path: 2
Edge list of the 1st path: [{"Uuid":7,"FromUuid":27,"ToUuid":1,"Id":"","FromId":"ULTIPA800000000000001B","ToId":"ULTIPA8000000000000001","Schema":"follow","Values":{}},{"Uuid":99,"FromUuid":33,"ToUuid":27,"Id":"","FromId":"ULTIPA8000000000000021","ToId":"ULTIPA800000000000001B","Schema":"follow","Values":{}}]
Information of the 2nd node in the 1st path: {"Uuid":27,"Id":"ULTIPA800000000000001B","Schema":"account","Values":{"year":1988,"industry":"Transportation","name":"Sam123","stringList":[null],"int32List":[null],"float":3.72,"double":3.719999313354492}}

Graph

A Graph object has the following fields:

C#
var res = await ultipa.Uql(
    "n(as n1).re(as e).n(as n2).limit(3) with toGraph(collect(n1), collect(n2), collect(e)) as graph return graph",
    requestConfig
);
var graphList = res.Alias("graph")?.AsGraph();
var nodeList = graphList.Nodes;
var edgeList = graphList.Edges;
Console.WriteLine("Node IDs: ");
foreach (var node in nodeList)
{
    Console.WriteLine(node.Id);
}
Console.WriteLine("Edge UUIDs: ");
foreach (var edge in edgeList)
{
    Console.WriteLine(edge.Uuid);
}

Output
Node IDs:
ULTIPA8000000000000017
ULTIPA8000000000000001
ULTIPA8000000000000061
ULTIPA800000000000001B
Edge UUIDs:
1576
43
29

GraphSet

A GraphSet object has the following fields:

C#
var res = await ultipa.Uql("show().graph()");
var graphSetList = res.Alias("_graph")?.AsGraphSets();
foreach (var graph in graphSetList)
{
    if (graph.Status.Equals("UNMOUNTED"))
    {
        Console.WriteLine(graph.Name);
    }
}

Output
DFS_EG
cyber
cyber2

Schema

A Schema object has the following fields:

C#
var res = await ultipa.Uql("show().node_schema()", requestConfig);
var schemaList = res.Alias("_nodeSchema")?.AsSchemas();
foreach (var schema in schemaList)
{
    Console.WriteLine(schema.Name + " has " + schema.Total + " nodes");
}

Output
default has 0 nodes
user has 1092511 nodes
ad has 846811 nodes

Property

A Property object has the following fields:

C#
var res = await ultipa.Uql("show().node_property(@account)", requestConfig);
var propertyList = res.Alias("_nodeProperty")?.AsProperties();
foreach (var property in propertyList)
{
    if (property.Lte.Equals(true))
    {
        Console.WriteLine("LTE-ed property name: " + property.Name);
    }
}

Output
LTE-ed property name: year

Algo

An Algo object has the following fields:

C#
var res = await ultipa.Uql("show().algo()", requestConfig);
var algoList = res.Alias("_algoList")?.AsAlgos();
Console.WriteLine(JsonConvert.SerializeObject(algoList[0]));

Output
{"Name":"bipartite","Param":"{\"name\":\"bipartite\",\"description\":\"bipartite check\",\"version\":\"1.0.1\",\"parameters\":{},\"result_opt\":\"56\"}","Detail":"base:\r\n  category: Connectivity & Compactness\r\n   name: Bipartite\r\n    desc: Judge if the current graph is bipartite.\r\n}

Exta

NOTE

An exta is a custom algorithm developed by users.

An Exta object has the following fields:

C#
var res = await ultipa.Uql("show().exta()");
var extaList = res.Alias("_extaList")?.AsExtas();
Console.WriteLine(JsonConvert.SerializeObject("Exta name: " + extaList[0].Name));

Output
"Exta name: page_rank"

Index

An Index object has the following fields:

C#
var res = await ultipa.Uql("show().index()", requestConfig);
var indexList = res.Alias("_nodeIndex")?.AsIndexes();
foreach (var index in indexList)
{
    Console.WriteLine("Schema name: " + index.Schema);
    Console.WriteLine("Properties: " + index.Properties);
    Console.WriteLine("Size: " + index.size);
}

Output
Schema name: account
Properties: name
Size: 0
Schema name: movie
Properties: name
Size: 2526

C#
var res = await ultipa.Uql("show().fulltext()", requestConfig);
var fulltextList = res.Alias("_edgeFulltext")?.AsIndexes();
foreach (var item in fulltextList)
{
    Console.WriteLine("Fulltext name: " + item.Name);
    Console.WriteLine("Schema name: " + item.Schema);
    Console.WriteLine("Properties: " + item.Properties);
}

Output
Fulltext name: nameFull
Schema name: review
Properties: content

Privilege

A Privilege object has the following fields:

C#
var res = await ultipa.Uql("show().privilege()");
var privilegeList = res.Alias("_privilege")?.AsPrivileges();

var systemPrivilegeList = new List\<string>();
foreach (var item in privilegeList)
{
    if (item.Level == PrivilegeType.SystemLevel)
    {
        systemPrivilegeList.Add(item.Name);
    }
}
Console.WriteLine("System privileges include: ");
Console.WriteLine(JsonConvert.SerializeObject(systemPrivilegeList));

Output
System privileges include:
["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 fields:

C#
var res = await ultipa.Uql("show().policy()");
var policyList = res.Alias("_policy")?.AsPolicies();
foreach (var item in policyList)
{
    Console.WriteLine("Policy name: " + item.Name);
}

Output
Policy name: operator
Policy name: manager

User

A User object has the following fields:

C#
var res = await ultipa.Uql("show().user('Tester')");
var userList = res.Alias("_user")?.AsUsers();
Console.WriteLine("Username: " + userList[0].Username);
Console.WriteLine("Created at: " + userList[0].CreatedTime);
Console.WriteLine(
    "Graph privileges: " + JsonConvert.SerializeObject(userList[0].GraphPrivileges)
);
Console.WriteLine(
    "System privileges: " + JsonConvert.SerializeObject(userList[0].SystemPrivileges)
);
Console.WriteLine(
    "Property privileges: " + JsonConvert.SerializeObject(userList[0].PropertyPrivileges)
);

Output
Username: Tester
Created at: 7/26/2024 6:10:06 AM
Graph privileges: {"Ad_Click":["FIND_EDGE","FIND_NODE"],"DFS_EG":["UPDATE","INSERT"]}
System privileges: ["MOUNT_GRAPH"]
Property privileges: {"node":{"read":[["*","*","*"]],"write":[["*","*","*"],["miniCircle","account","name"]],"deny":[]},"edge":{"read":[["*","*","*"]],"write":[["*","*","*"]],"deny":[]}}

Stats

A DatabaseStats object has the following fields:

C#
var res = await ultipa.Uql("stats()");
var statsList = res.Alias("_statistic")?.AsStats();
Console.WriteLine("CPU usage: " + statsList.CpuUsage);
Console.WriteLine("Memory usage: " + statsList.MemUsage);

Output
CPU usage: 12.204036
Memory usage: 11348.136719

Process

A Process object has the following fields:

C#
var res = await ultipa.Uql("top()");
var processList = res.Alias("_top")?.AsProcesses();
Console.WriteLine("Process ID: " + processList[0].Id);

Output
Process ID: a_7_14568_1

Task

A UltipaTask object has the following fields:

C#
var res = await ultipa.Uql("show().task()", requestConfig);
var taskList = res.Alias("_task")?.AsTasks();
Console.WriteLine("Algo Name: " + taskList[0].Info.AlgoName);
Console.WriteLine("Parameters: " + taskList[0].Param);
Console.WriteLine("Result: " + taskList[0].result);

Output
Algo Name: louvain
Parameters: {"phase1_loop_num":"20","min_modularity_increase":"0.001"}
Result: {
  "community_count": "10",
  "modularity": "0.535017",
  "result_files": "communityID,ids,num"
}

Table

A Table object has the following fields:

Methods on a Table object:

C#
var res = await ultipa.Uql(
    "find().nodes() as n return table(n._id, n._uuid) as myTable limit 5"
);
var myTab = res.Alias("myTable")?.AsTable();
Console.WriteLine("2nd row in table: " + JsonConvert.SerializeObject(myTab.ToKv()[1]));

Output
2nd row in table: {"n._id":"ULTIPA8000000000000002","n._uuid":0}

Attr

An Attr object has the following fields:

C#
var res = await ultipa.Uql(
    "find().nodes({@ad}) as n return n.brand limit 5",
    requestConfig
);
var myAttr = res.Alias("n.brand")?.AsAttr();
Console.WriteLine(JsonConvert.SerializeObject(myAttr));

Output
[14655,14655,14655,14655,434760]