TuGraph Database Subscription
Dec 20, 2024
User Groups and Permissions" to enter the user
group management interface, as shown in the following picture:
Click "Create User Group" to enter the user group creation page, as shown
below:Enter User group Name and Introduction, select Service Domain, and Group
Administrator, and click Create and Submit for approval. After the administrator
approves the user group, the user group is created.
You can view the details of the work order in [Personal Center -> Work
Order Management], find the corresponding approver, and contact the
approver for approval.2.2.2.2. Apply to join a user group
Click "Personal Center -> User Groups and Permissions -> All User Groups"
to enter the list page of all user groups, as shown below:
Click "Apply to join" to enter the application page, as shown below:
Enter Reason for application and click Submit for Approval. After the
administrator completes the approval, join the user group. Approval is
shown as follows:Note: The management staff list is automatically approved; The
administrator must manually approve the orange work order for common users.
2.2.2.3. Group permission
TuGraph Platform breaks down permissions, including functional permissions and
data permissions. The functional permissions correspond to a functional module on
TuGraph Platform, and the data permissions are data assets. Currently, the data
assets of the platform include graph items, data files, my analysis, lists, graph
clusters, etc.
2.2.2.3.1. Functional authority
Function permissions correspond to a function module on TuGraph Platform.
Currently, each function module has two corresponding function packages, namely
"basic function package" and "advanced function package". The user group has all
the basic function packages by default, and users can perform corresponding
operations in the corresponding function module based on the existing function
packages.
The permissions for each subfeature pack are described as follows:
• [Data management] : View rights, data modification, editing, deletion and
other advanced rights
• [List management] : View permissions, list modification, editing, deletion and
other advanced permissions• [My analysis] : View rights, analysis assets to save, modify, edit, delete and
other advanced rights
• [Favorites] : Favorites, cancel favorites
• [Experimental exploration] : View permissions, map project creation, modify,
delete, import data and other advanced permissions
• [Service construction] : View permissions, chart project creation, modify,
delete, import data and other advanced permissions
• [Operation and Maintenance Management]: View permissions, modify, delete
cluster information, task information, monitoring information, emergency
operations and other advanced permissions.
• 【Authority management】:
Click "Personal Center -> User Groups and Permissions -> Group Permissions
Query -> Function Permissions" to enter the "Function Permissions" list
page, as shown below:
Click "Apply for function Permission" to enter the function permission
application page, and apply for permission for the user group associated
with the user.Select User Group, enter application Reason, and click Submit for approval.
After the administrator approves the application, you can obtain related
function permissions.
2.2.2.3.2. Data permission
Data rights are data assets. The current data assets of the platform include graph
items, data files, my analysis, lists, graph clusters, etc. Data rights are
limited by service domains. You can view data assets of a service domain only when
you join a user group of the corresponding service domain.
Click "Personal Center -> User Groups and Permissions -> Group Permissions Query
-> Data Permissions" to enter the "Data Permissions" list page, as shown below:
Click Apply for Data Permission to enter the data permission application
page, and apply for permission for the user group associated with the user.Select User Group, enter application Reason, and click Submit for Approval.
After the administrator approves the application, you can obtain the
relevant data permission.
3. Graph entry
Log in to TuGraph Platform and open the product welcome page, as shown
below:
Click "New image Project", as shown below:Fill in the map name, select the business domain, user group and other
relevant information, and click "OK" to complete the map project
construction. In the "My Projects" list, the new image project is
displayed, as shown in the following figure:
4. Create graph cluster
4.1. Create the MetaServer cluster
For details, see Cluster management.4.2. Create the TuGraph DB cluster
For details, see Cluster management.
5. Graph construction
Graph construction is the core function module of graph research and
development, which realizes the Schema change management of graph instances
through graph construction, including the functions of creating new vertexs
(edges), deleting vertexs (edges), creating or deleting indexes, creating
or deleting ttl, modifying type names and attribute names. Diagram
construction supports not only manually adding vertexs (edges), but also
importing schemas through favorites or importing model files according to
different business requirements.
5.1. Model definition
5.1.1. Create the vertex
Click "Picture Project -> Picture Construction" to enter the picture construction
page. You can build the picture model by "adding points" and "adding edges", as
shown in the following picture:o Add vertex
Enter vertex type name, node display name, field name, field alias, field type,
etc., and support vertex display color and icon configuration. After the vertex
information is configured, click "Save" and the schema information will save the
draft state.The vertex type name cannot contain library keywords, and can contain only
letters, digits, and underscores (_). The vertex type name must match [a-zA-Z][A-
ZA-Z0-9]*.
o Add Edge
Enter the edge type name, edge display name, field name, field alias, field type,
select the starting point and end point information, and support the edge display
color configuration. After the edge information is configured, click "Save" and
the schema information will save the draft state.(1) TuGraph supports the same type edge to select different starting points and
ending points;
(2) The edge type name cannot use library keywords, and the name can only use
letters, digits, and underscores (matching [a-zA-Z][A-ZA-Z0-9]*).
5.1.2. Configuring the index (optional)
Indexes are one of the most important ways to speed up query efficiency, and
TuGraph Platform supports visual index construction or deletion. After
constructing the vertexs (edges), you can configure the index information directly
in the "Property configuration" in the configuration information. Note: Indexes
can only be built on non-required fields.
5.1.3. Configuring TTL
If you need to set timeout clearing for a certain type of vertex (edge),
you can specify an attribute field of the vertex (edge) as TTL. The rules
are as follows: If the real time of the field + TTL (time window length) is
< the current time, the vertex (edge) is retained; otherwise, it is
deleted. Based on different service scenarios, services can configure TTL
on the field whose field type is long on the vertex (side).
Attention:(1) Both index and TTL cannot exist on a vertex (edge);
(2) TTL can be configured only on attributes of type long;
(3) Intelligence has a TTL on each vertex (edge).
5.2. Release schema
5.2.1. Release schema
After the Schema is constructed, click [Publish Schema] to send the Schema
change information to the diagram instance, as shown in the following
figure:After clicking [Release Schema], you need to select the content to be
released and select the environment to which it will take effect, as shown
in the figure below:On this page, you can check whether the schema changes are consistent with
your expectations. After confirming, you can click "Publish" to publish the
Schema changes to the graph instance.
Note: All Schema changes in modeling will only modify the draft Schema, and
changes to the development, grayscale, and production schemas can only be done by
publishing the model. For example, to add a point to a production Schema, do the
following:
a. Add this point in the draft first
b. Change the development schema by publishing the model [draft] -> [Development].c. Then change the grayscale schema by publishing the model [Development] ->
[Grayscale]
d. Finally, change the production schema by publishing the model [grayscale] ->
[Production]
5.3. Import data
5.3.1. Offline import
5.3.1.1. Mapping configuration
After the graph Schema is published, data import begins. Select the point/edge
(can be selected in the canvas, can also be selected in the left list), the
offline import data source selection and mapping configuration page will pop up,
as shown below:
Select the corresponding data table or upload the data table locally to
configure the data mapping. The local upload page is shown below:Select the correct column qualifier, column separator, encoding format,
etc. Click OK to complete the data file upload.
5.3.1.2. Import configuration
After the mapping configuration is complete, click "Next" to enter the
import configuration page, as shown in the following figure:Configure the import mode and import start date. The import mode can be One-time
Import or Periodic Import. Currently, Periodic Import has certain requirements on
data sources. If required, click Finish to generate an import task.
Advanced Parameter Settings mainly set the parameters related to the imported
data. The default values can be selected.
You can go to "Import Task List" to view the import configuration and
import record, as shown in the following figure:You can click Edit to edit the data import task, or select Import Now to execute
the import task.
You can click Import Records to view details about the failed data import task and
the execution of the task.
5.3.2. Real-time import
TuGraph Platform supports real-time data import configuration, as shown
below:5.3.2.1. Select data source
Select the corresponding data source. If no configuration is available,
click "Data Source Connection Configuration" to enter the data source
configuration page, as shown below:5.3.2.2. Configure data source mapping and import
parameters
Configure data source mapping and import parameters according to the
Description.
6. Graph query
Graph query is mainly for technical research and development personnel,
providing them with graph query, development and debugging functions, andcan be released to the production environment after successful debugging.
Figure query entry is shown in the following figure:
Click "Graph query" to enter the graph query page, as shown in the
following picture:
6.1. Statement execution
6.1.1. Statement query
Click the query name, the right side is divided into two modules: statement input
box, execution result/history display, as shown in the following figure
• execute:a. Directly click "Execute" : By default, all statements in the editor will be
executed;
b. Select certain lines of code in the editor to execute
• save:Save the statement content in the current editor to the currently
selected statement, and you can see the latest content when you enter
the next time.
If the execution is successful, there are four types of display results,
all of which support result download, respectively:
• Execution result
a. JSON View
i. Vertex-Edge list
c. Vertex-Edge view6.1.2. Insert data
In the development environment, support for statement insertion (not yet
available in other environments) can be achieved in two ways:
o Write insert statements in the editor and execute them
6.1.3. Generate template
Click the "Generate template" icon to create a query template, as shown
below:The template configuration page is shown in the following figure:
Set the template name and parameters, and click OK.
6.3. Query template
6.3.1. Import query template
You can import a query template in either of the following ways: 1) from
the favorites or 2) locally.7. Graph analysis
Click "Project -> Analysis" to enter the visualization analysis page, as
shown below:
The graph analysis module consists of 4 parts:
1.Global query: Some seed nodes are queried globally for analysis2.Canvas toolbar: Select a single node or batch analysis operations after
multiple nodes in the lasso ring
3.Analysis navigation bar: Batch analysis operation after multiple nodes in the
lasso ring
4.Node Right-click menu: Analyze operations for a single node
You can use the graph analysis module of TuGraph Platform for real-time
visual graph query, graph analysis, development debugging, graph feature
development, custom graph application, publishing and embedding.
o Real-time visual graph query and graph analysis
i. Real-time graph query: real-time query results are returned, and the
results are displayed graphically. Query mode support:
1. Configuration query: Query the node type, attribute type, and filter criteria
to find the graph data
2. Statement query: Write ISO_GQL statements to query graph data
3. Template query: Quick query based on a user-defined template
4. Path analysis: Queries the shortest path and all path between two nodes
5. Loop detection: Detects whether one or two nodes are in the loop and queries
the loop where the node resides
ii. A wide range of graph analysis capabilities: Global configuration query,
statement query, template query, path analysis, canvas toolbar,
appearance configuration, grouping, aggregation, common neighbors,
important nodes, pattern matching, custom suspicious labels, black
judgment (join the blacklist & whitelist), save analysis, my analysis
module, Style template, hyperlink jump configuration, configuration
management, publishing embed, large point inspection & deletion, etc.iii. Analysis results precipitation: Save the analysis results to the "My
analysis" module for subsequent verification, sharing, re-analysis, etc.
o Graph feature development
§ By writing ISO_GQL statement query, find out the feature data and verify
whether the feature results meet the expectations.
§ Configuration query: By querying the definition of configuration
information such as node type, attribute type, and filter condition,
find out the feature data and verify whether the feature results meet
the expectations.
§ Generate a template for services to use in the query template.
o One-click integration
§ It can be quickly integrated by business applications, and function
modules can be directly embedded into third-party business systems;
7.1. Global query
After some seed nodes are identified by global query, the graph can be
visualized and analyzed. There are five start modes: configuration query,
statement query, template query, path query, and loop query.
7.1.1. Configuration query
Support edge/point type screening (point/edge name), diffusion degree
configuration, edge direction (in degree, out degree, bidirectional),
point/edge attribute filtering (point/edge attribute judgment), return
result number limit, etc.7.1.2. Statement query
Support ISO-GQL query language for query analysis, as shown in the
following figure:In addition, you can directly publish query statements as templates.
7.1.3. Template query
Query based on the published template. Enter the corresponding template
parameters and click Search to execute the corresponding query statement.7.1.4. Path query
It supports query and analysis of the path between the start node and the
end node, including the shortest path and all paths, and supports depth
configuration, as shown in the following figure:7.1.5. Loop query
It can detect whether a specified node or two is in the loop and query the
loop, as shown in the following figure:7.2. Canvas Toolbar - Graph view7.3. Analyze navigation bar - Graph view
7.3.1. Find and Add
You can add nodes to the canvas for analysis through Search and Add on the
premise that the current canvas elements remain unchanged. As shown in the
picture below:
Supports basic configuration mode and advanced statement mode.
o Basic modelo Advanced mode (added via query language)7.3.2. appearance
Supports visual configuration point/edge display styles and styles, as
shown in the figure below:7.3.3. layout
Support a variety of layouts, as shown below:7.3.4. divide into groups
On the basis of grouping according to custom conditions, add circle and
square switching, aggregation by group, and restoration7.3.5. aggregation
Added Loop Aggregation, Cancel & Expand aggregation, and Aggregation panel
to display aggregated data details.
7.3.6. Diffuse
Custom relationship diffusion for selected single/multiple points. The
default one degree diffusion, can be spread to three degrees, support
custom diffusion degree configuration, side direction (in degree, out
degree, bidirectional), point/edge attribute filtering (point/edge
attribute judgment), custom return result number limit.7.3.7. Edge merging
Multiple edges with the same starting point, end point, and edge type are
aggregated into one.7.3.8. tag
You can add labels to nodes, as shown in the following figure:
It can support corresponding operations of labels, such as hiding,
deleting, displaying, etc., as shown in the following figure:7.3.9. analyze
Supports five analysis methods: node importance, path analysis, filter
analysis, common neighbor and pattern matching.
7.3.10. Preservation analysis
Analysis results precipitation: Save the analysis results to the "My
analysis" module for subsequent verification, sharing, re-analysis, etc.
7.3.11. publish
Click the "Publish" button, the analysis results are quickly integrated by
business applications, and the function modules can be directly published and
embedded into the third-party business system, as shown in the following figure:8. Operation and maintenance center
8.1. Cluster management
The Cluster Management module is used to create, modify, and disable clusters. In
this way, users can quickly maintain their service clusters in a white screen.
There are two types of clusters: TuGraph DB cluster and MetaServer cluster
o TuGraph DB cluster is used to store user instance data.
o The MetaServer cluster is used to store metadata about the TuGraph DB
cluster.
Note: A TuGraph DB cluster must be mounted to one MetaServer cluster. One
MetaServer cluster can be mounted to multiple TuGraph DB clusters.
8.1.1. TuGraph DB cluster
8.1.1.1. Create the TuGraph DB cluster
The TuGraph DB cluster is used to store user graph data.Click "Operation and Maintenance Center -> TuGraph DB Operation and Maintenance ->
Cluster Management ->GeaBase Cluster" to enter the TuGraph DB cluster management
page, as shown in the following picture:
Click the "Create Cluster" button in the upper right corner to enter the
TuGraph DB cluster creation page, as shown below:
Fill in the following information:
o Basic Information:§ Cluster name: TuGraph DB cluster name;
§ Whether to share cluster: TuGraph DB supports two modes: independent
cluster and shared cluster, and multi-graph is supported in shared
cluster mode.
§ Environment: Select the type of environment, such as online formal
environment, online gray environment, etc.
§ Number of fragments: The number of data fragments can be filled in
according to the actual data scale;
§ Owning MetaServer cluster: Select the MetaServer cluster to which the DB
cluster is mounted.
§ Whether to enable Hash ID: This function can improve query efficiency,
but will affect the intuitive display of data ids. It is disabled by
default.
§ Port number: Default 60000
o Copy information (TuGraph can create a maximum of five copies, and one must
be specified as the primary copy)
§ Region: Select the city where the copy is located;
§ Hosts: IP address of the host where the copy is located. One copy can be
deployed on multiple host nodes.
§ Set as the primary copy: Whether it is the primary copy;
o Associating a graph item (An independent cluster must be associated with a
graph item when it is created)
Click "Create and submit for approval". After the administrator approves the
TuGraph DB cluster, you will see the TuGraph DB cluster that you have created.
During the creation process, you can find the corresponding task in "Operation andMaintenance Center -> TuGraph DB Operation and Maintenance -> Task Management" to
view the details and progress.
8.1.1.2. TuGraph DB Cluster operation
8.1.1.2.1. replica operation
You can add replica, expand capacity, and delete replica, as shown in the
following figure:
o Management shard
Raft Leader, migration leader, and balance leader can be specified.o Add replica
Click "Add Replica" at the top right of the list to enter the replica add
configuration page, as shown below:Fill in the replica version, region, machine IP, whether the master replica
and other information, click "Add and submit for approval", after the
approval is completed, the platform will automatically add the replica.
8.1.1.2.2. Machine operation
The machine supports operations such as restart, stop, capacity expansion,
and copy deletion.
8.1.1.2.3. Global configuration
You can click Global Settings to view the configuration information of
global variables.
Click "Modify Configuration" to carry out the configuration item
information, as shown in the following picture:8.1.1.2.4. Periodic task configuration
Periodic Task Configuration Records the configuration of all periodic tasks
related to the TuGraph DB cluster.
User side: Users can create a point-to-point statistics task. For details about
how to create a point-to-edge statistics task, see section 3.5. Dot Edge
Statistics operation document.
Operations and maintenance (O&M) : The DBA can create default_compaction,
TTL_filter, and TS_filter
Click "Task Configuration" to enter the task configuration page, as shown below:
Click "Create Task" to enter the task creation and configuration page, as
shown below:Fill in the configuration information and click "Add and submit for approval".
After the approval is completed, the platform will automatically execute the task.
o TTL supports the following three types:
§ TTL_filter: Deletes the ttl tag expired data of an attribute
§ TS_filter: Deletes expired edge tag data
§ "default compaction" does not delete expired data, but compacts it
o Whether to ignore the primary copy:
§ No, Switch: If the current copy is the primary copy, the system switches
the primary copy to the nearest one in the Sectionable Primary Copy
§ Yes, do not switch: The switchover is performed on the primary copy,
which may cause service jitter
o Disk size threshold: The disk can be executed only when the used disk space
is less than 80%
o Duplicate configuration supports serial execution in multiple batches
§ Whether the only copy in the region is executed. If No is selected, if
there is only one copy in a region, this copy will not be executed.8.1.2. MetaServer cluster
Click "Operation and Maintenance Center ->TuGraph DB Operation and
Maintenance -> Cluster Management ->MetaServer Cluster" to enter the
MetaServer cluster management page, as shown in the following picture:
8.1.2.1. Create the MetaServer cluster
Click "Create Cluster" to enter the MetaServer cluster creation and
configuration page, as shown in the following picture:Enter the cluster name and machine IP address, select the owning environment,
operating system, and version number of the cluster, and click Create and Submit
for approval. After the administrator approves the MetaServer cluster, you can
create the Metaserver cluster.
You can choose O&M Center > TuGraph DB O&M > Task Management to find the
corresponding task and view the execution status of the task, as shown in the
following figure:8.1.2.2. View the MetaServer cluster
Click the cluster name in the above figure to enter the cluster details
page, as shown in the following picture:Basic Information displays the owning environment, version, creator, creation
time, and cluster ID of the MetaServer cluster.
Machine List displays information such as the IP address, role, and version of the
host where the MetaServer cluster resides, and operations related to the host.
Service List displays information about the TuGraph DB cluster mounted to the
MetaServer cluster.
8.1.2.3. MetaServer Cluster operation
For MetaServer clusters, the platform supports operations such as active
switchover, online upgrade, start, restart, online capacity expansion,
machine replacement, and stop.
8.3. User management
For details, see 2.2.1. User Management.">