Change Password

Input error
Input error
Input error
Submit
v2.x

Web CLI and Query Result Visualization

The Web-CLI can be accessed by clicking the Query module from the sidebar.

Ultipa Manager provides shortcuts to a couple of common uQL commands. Clicking the widgets of these shortcuts will copy a sample of the respective uQL into the CLI; users can easily modify the uQL and query against the current graphset based on their needs.


For instance click 'Find Nodes' widget to query for nodes; the shortcuts collapse into an icon at the lower right corner of the page, and the query results are displayed in a tab below the CLI:


The shortcuts can be expanded at any time by clicking the icon:


Web-CLI Operations

Ultipa Web-CLI executes uQL one at a time; linefeed character is prohibited; below keyboard operations are supported:

Key Description
Up Arrow Swith to previous uQL
Down Arrow Swith to next uQL
Enter Execute current uQL

Historical uQLs can be listed by clicking the icon at the right end of the CLI. The records are listed in time descending order, clicking any record will copy the uQL to the CLI:


Result Tab Operations

Each execution of uQL will generate a result tab, users can retrieve a recent uQL command and its query result by switching to the respective tab.


The uQL of each tab is right below the tab name, clicking the uQL will copy the uQL command to the CLI.

The query results are displayed below the uQL in both List View and Graph View.

List View

The list view shows the query result in a traditional table-like view. Varying with the query commands, the list view displays nodes, edges and paths.

Node List

Check the list view of 'Find Node' command. The nodes in the list can be edited or deleted:


Edge list

Check the list view of 'Find Edge' command. The edges in the list can be edited or deleted; use the Node Selector, an advanced tool for editing the From Node and the To Node of the edge:


For example, click the icon to the right of To Node and popup the Node Selector:


The Node Selector searches for nodes by two means:

  • the fulltext index
  • the filter in uQL find().nodes(<filter>)

When using fulltext index to select node, switch to 'Index' on the Node Selector and make sure there are fulltext indexes created for node properties in advanced:


Note: use fulltext index as precisely as possible, maximum 10 nodes will be shown.

When using uQL filter to select node, switch to 'UQL' on the Node Selector; revise the node filter and hit Enter on keyboard:


Note: set node filter properly since maximum 10 nodes will be shown.

Path List

Check the list view of 'A-B Path Finding' command. The nodes and edges that line up alternatively in each path can be edited or deleted in the similar way as instroduced above. Click a node or edge in a path to evoke the operation menu:


In this example, the nodes in the paths are labeled using their values of property 'name', while the edges are labeled using their values of property '_id'. The edge label can be adjusted for better intuitiveness. Go to Setting - Display to reset edge label:


Shown in the above screenshot, the edge label is set to be property 'name'; however in this example there is no such an edge property called 'name', hence the Ultipa Manager uses '_id' as edge label in the list view of paths.

Modify the setting and use property 'type' as edge label, and check the list view of paths:


Other Information

Some commands may have results other than the above mentioned lists, such as 'the number of all possible neighbors' of a K-Hop command, and the aggregation result of an aggregation operation. Refer to uQL Handbook v3.1 for details of these return values.

Graph View

The graph view visualizes the query result using a sub-graph which is more intuitive than list or table. Besides editing, deleting and setting labels of nodes and edges, the graph view of query result facilitates users with a lot more operations against meta-data, such as setting style, adjusting layout, combining search result and creating meta-data for the current graphset.

Graph view is provided in both 2D and 3D mode.

2D Graph

Revise the 'Find Node' command into find().nodes({type:"country"}).limit(10).select(*) and run the 2D graphic view:


Ultipa Manager supports secondary search for nodes on the 2D view of query result; this can be done via Secondary Search Box in two ways:

  • search for one node by node property '_id'
  • fulltext search for multiple nodes by node property 'name'

Note: the method of fulltext search by node 'name' does NOT require a fulltext index of node property 'name' to be created; it only requires the graphset to have a node property called 'name' with data type 'string'.

Example 1: Search for node with id = 10001.


Example 2: Search for node with name contains 'china'.


Meta-data Style

Check the graph view of 'A-B Path Finding' command:


The meta-data in the graph view are displayed with label, shape and color. The toolbar on the right contains utilities for adjusting the style of these meta-data:

Icon Description
Enter full screen mode, press 'ESC' to cancel
Switch to 3D view
Open data processor panel
Open meta-data style setting panel
Open meta-data style setting panel

In the above screenshot the edges are using _id as label; change the edge label to property 'type' following below steps:

  • click icon    in the toolbar, there shows two styles in the list, 'default' and 'forum';
  • click    at the right end of 'default', which is the style currently being used;
  • in the popup panel switch to 'Edge', the default rule of edge style is selected and highlighted in blue color, with details shown on the right side;
  • in the detail choose 'type' for 'Display':

Confirm the changes and check the edge label on the graph view:


Users can add or delete rules for meta-data style, and modify the color, shape, size/width, and label display for each rule. Describe a node style panel for example:


A properly designed meta-data style helps highlight the imformation that users want to emphasize of a sub-graph . Switch to style 'forum' in the style list, which empahsizes the relationship 'follow' and the start/end node of paths:


To delete meta-data style from the style list, go to Setting - Graph Styles:


Node Operations

Operations on nodes in the 2D view includes:

Operation Description
hover Show the info bar on the bottom of the result tab, containing property values of current node
drag Move current node and lock it
left-click Lock current node, lock info bar, popup menu
right-click Popup menu

Note:

  • if a node is not locked, it moves when other nodes in the sub-graph move, and it will NOT move with other nodes if it is 'locked';
  • the info bar, if not locked, will hide when the hover ends;
  • see below descriptions for left/right-click menus.

A screenshot of left-click menu of node in 2D view:


Options in the left-click menu:

Option Description
Spread Searches against the current graphset for 1-step paths that start from current node, and draws these paths in the sub-graph
Edit Edit current node's property value; this will update the current graphset
Delete Delete current node from the current graphset

Note: editing and deleting node in the 2D view are similar to that in the list view.

A screenshot of right-click menu of node in 2D view:


Options in the right-click menu:

Option Description
Hide Hide current node and all of its edges from the sub-graph
Lock Lock node to its current position
Unlock Unlock node from its current position
New Edge Create an edge between current node and a designated node in the sub-graph; this will update the current graphset
Search More Searches against the current graphset for paths that start from current node, and draws these paths in the sub-graph

Note: a hidden node and its edges will not be drawn again in the same result tab, such as after executing 'Spread' or 'Search More' even though they do contribute to the searching in those operations.

See an example of 'Spread' operation:

Revise the 'Find Node' command into find().nodes({name:"Italy"}).limit(10).select(*) and run the 2D view, spread the node via left-click menu:


There are three paths drawn. The maximum number of paths (or results) to draw can be modified. Go to Setting - Query and revise the value of 'Limit' to 5:


Spread the node again and two more paths are drawn:


See an example of 'Search More' operation:

Execute command find().nodes({name:"Italy"}).limit(10).select(*) again, and go to 'Search More - AB Path' setting panel; select the end node, and set depth and limit as below:


These settings are to search for a 3-step path from node 'Italy' to node 'Léon' and draw the path on the sub-graph. Submit the settings and check the result:


See another example of 'Search More' operation:

Execute command find().nodes({name:"Italy"}).limit(10).select(*) again, and go to 'Search More - Auto-spread' setting panel; set depth and limit as below:


These settings are to search for paths from node 'Italy' to other nodes within 3 steps, and draw maximum 10 paths on the sub-graph. Submit the settings and check the result:


See an example of 'New Edge' operation:


Edge Operations

Operations on edges in the 2D view includes:

Operation Description
hover Show the info bar on the bottom of the result tab, containing property values of current edge
left-click Lock info bar, popup menu

A screenshot of left-click menu of edge in 2D view:


Options in the left-click menu:

Option Description
Edit Edit current edge's property value; this will update the current graphset
Delete Delete current edge from the current graphset

Note: editing and deleting edge in the 2D view are similar to that in the list view.

Blank Area Operations

Operations on the blank area of the 2D view includes:

Operation Description
drag Move sub-graph
wheel up/down Zoom sub-graph in/out
left-click Clear any node selection, unlcok info bar
right-click Popup menu

A screenshot of right-click menu of blank area in 2D view:


Options in the right-click menu:

Option Description
New Node Create a node in the sub-graph; this will update the current graphset
Search More Searches against the current graphset for nodes or paths, and draws these nodes/paths in the sub-graph
Lock All Lock all nodes in the sub-graph to their current positions
Unlock All Unlock all nodes in the sub-graph from their current positions
Collapse Edges If between two nodes there are multiple edges in the same direction, collapse them into a representative edge
Expand Edges Expand all representative edges

See an example of 'Search More' operation:

On any 2D view, go to 'Search More' setting panel and enter a uQL that searches for nodes or paths:


Submit and check the result:


See an example of 'Collapse/Expand Edges' operation:


3D Graph

3D graphic view demonstrates the complex query result in 3D space. Run command t().n().e({type:"follow"})[:5].n().limit(1000).select(*) and switch to 3D graphic view:


The 3D view supports most of the operations of the 2D view, except for a few operations that are not applicable, such as right-click menu, info bar, etc.

Meta-data Style

In the 3D view, meta-data style settings in the toolbar are valid only for the meta-data color and meta-data display (label). Node shape is overwritten with dot, edge color is gray and edge width is 1.

Node Operations

Operations on nodes in the 3D view includes:

Operation Description
hover Show the node label
drag Move current node
left-click Popup menu

Note: meta-data in the 3D view will never be locked.

A screenshot of left-click menu of node in 3D view:


Options in the above menu are same with those in a 2D view.

Edge Operations

Operations on edges in the 3D view includes:

Operation Description
hover Show the edge label

Blank Area Operations

Operations on the blank area of the 3D view includes:

Operation Description
left-drag Rotate sub-graph
right-drag Rotate user view
wheel up/down Zoom sub-graph in/out
left-click Clear any node selection