Overview

An Ultipa Graph instance allows for the existence of multiple graphsets. Each graphset includes the definition of the graph structure (schemas and properties), metadata (nodes and edges), various indexes, processes, tasks, and so on. Sometimes, the terms "graphset" and "graph" are used interchangeably.

A graphset named default is automatically created during the creation of an Ultipa Graph instance. This default graphset is initially empty and can be freely utilized. However, the default graphset is not allowed to be altered (name and description), dropped, or unmounted.

In a cluster environment, the unmount, mount, and truncate UQLs will be sent to the leader node for execution.

Show Graph

// Show all graphsets in the instance (via listGraph API)
show().graph()

// Show all graphsets in the instance (via listGraph API)
show().graph("")

// Show the graphset named Sample in the instance
show().graph("Sample")

Example result:

The status of a graphset can be mounted, unmounted or mounting. Large graphsets may take some time to finish mounting, during which the status is mounting.

A mounted graphset displays the total number of nodes and edges within it. An unmounted graphset displays 0 for both totalNodes and totalEdges. During unmounting, the graphset displays the number of nodes and edges that are currently mounted.

Create Graph

// Create a graphset named social, and provide description
create().graph("social", "Campus social graph")

// Create a graphset named social
create().graph("social")

// Create multiple graphsets at one time
create()
  .graph("social")
  .graph("transaction", "Bank Card Transaction")

Naming Conventions

Here are the naming conventions for graphsets:

• Contains 2 to 64 characters.
• Must start with letters.
• Allowed characters include letters (A-Z, a-z), underscore (_), and numbers (0-9).

You cannot have two graphsets with the same name.

Create Multiple Graphsets

Example: Create three graphsets at the same time, with one of the names (default) duplicated with an existing graphset.

create().graph("newGraph_1").graph("default").graph("newGraph_2")

Result: The creation of the graphset newGraph_1, which was specified before the duplicated graphset, succeeds. However, the one (newGraph_2) specified after the duplicated graphset fails, with the error message Duplicated db name! returned.

Use TRY

Example: Create three graphsets at the same time, with one of the names (default) duplicated with an existing graphset.

TRY create().graph("newGraph_1").graph("default").graph("newGraph_2")

Result: The creation of the graphset newGraph_1, which was specified before the duplicated graphset, succeeds. However, the one (newGraph_2) specified after the duplicated graphset fails. The error message is shielded by the TRY prefix, while returning the message SUCCEED.

Alter Graph

// Alter name and description of the graphset currently named "miniCircle"
alter().graph("miniCircle").set({name: "movieCommunity", description: "Unix Movie Platform"})

// Remove description of the graphset named "movieCommunity"
alter().graph("movieCommunity").set({description: ""})

// Rename the graphset named "movieCommunity"
alter().graph("movieCommunity").set({name: "movComm"})

Unmount Graph

You may unmount temporarily unused graphsets (except the default graphset) to save instance memories. For example, the LTE-ed properties will be unloaded from the memory.

When a graph is unmounted, it’s not allowed to modify or read the schemas, properties, data and so on within the graph. Unmounted graph can only be mounted, altered or dropped.

// Unmount a graphset named "LDCC" from the instance memory
unmount().graph("LDCC")

Mount Graph

Newly created graphsets are mounted by default. You may need to manually re-mount any unmounted graphsets.

When a graphset is remounted, its previously LTE-ed properties will be reloaded into memory, and the indexes and full-text indexes will also be automatically recreated as before.

// Mount a graphset named "LDCC" back to the instance memory
mount().graph("LDCC")

Drop Graph

Dropping a graphset means to delete the entire graphset. The default graphset cannot be dropped.

// Drop the graphset named "test0831"
drop().graph("test0831")

// Drop multiple graphsets at one time
drop().graph("test0831").graph("test0925")

Truncate Graph

Truncating a graphset only deletes the specified data within the graph, while the graphset itself and its structure (schemas & properties) are retained.

// Truncate all nodes and edges in the graphset named "PowerGrid"
truncate().graph("PowerGrid")

// Truncate all @bus nodes in the graphset named "PowerGrid"
truncate().graph("PowerGrid").nodes(@bus)
                                     
// Truncate all @connectsTo edges in the graphset named "PowerGrid"
truncate().graph("PowerGrid").edges(@connectsTo)

// Truncate all nodes in the graphset named "PowerGrid"
truncate().graph("PowerGrid").nodes("*")

// Truncate all edges in the graphset named "PowerGrid"
truncate().graph("PowerGrid").edges("*")

Compact Graph

Compacting a graphset clears invalid and redundant data from the graph on the server disk but does not make any changes to other valid data.

// Compact the graphset named "PowerGrid"
compact().graph("PowerGrid")

Operations related to data manipulation can generate redundant data, such as old records retained after an update or delete operation. It's suggested to regularly compact graphsets to improve query efficiency.