嬴图CLI（ultipa_cli）是一款跨平台（Windows/Mac/Linux）命令行界面工具，专为嬴图数据库设计，用来执行GQL和UQL查询语句。

准备工作

• 命令行工具：
  • Linux或MacOS：Bash，Zsh，TCSH
  • Windows：PowerShell
• 点击此处下载嬴图CLI。无需安装。

使用指南

以下步骤均在Windows系统上PowerShell中演示。

1. 连接嬴图数据库

打开终端程序，导航至ultipa_cli所在文件夹。运行ultipa_cli，连接到嬴图数据库：

./ultipa_cli.exe -h <host_addr> -u <username> -p <password>

查看所有标志，开始使用ultipa_cli并连接至嬴图数据库。成功登录后将进入交互式会话，可以使用各种命令（详请参阅所有命令）与数据库交互并进行操作。

2. 指定图集

使用命令use指定当前工作图集。以图集alimama为例。

use alimama

3. 执行查询

ultipa_cli支持UQL模式和GQL模式。默认使用UQL模式。

UQL查询

执行UQL查询：

find().nodes({@nodx.cateID == "1089685"}) as n return n{*} limit 5

UQL和GQL模式切换

可使用uql和gql命令切换至UQL模式或GQL模式。

gql

GQL查询

执行GQL查询：

MATCH (n:nodx {cateID: "1089685"}) RETURN n LIMIT 5

4. 执行文件

可使用run命令在交互式会话中执行文件，也可使用-e/--exec标志直接执行文件。两种方法均需指定文件路径。

关于文件：

• 文件需包含一或多个UQL或GQL查询。每个查询以分号（;）结束，按照顺序依次执行。
• 文件可以包含use <graphName>命令，用于指定当前图集。
• 执行文件时，ultipa_cli会根据文件名自动检测查询模式。若文件名包含关键字UQL或GQL（大小写不敏感，优先匹配UQL），将切换至相应的模式。如果未识别到此类关键字，将使用当前模式或默认模式。

在交互式会话中执行文件

以下文件包含的UQL查询可以在当前图集创建schema和属性，并插入点和边：

create().node_schema("Student").node_schema("Course").edge_schema("Take");
create().node_property(@Student,"name").node_property(@Course,"name").edge_property(@Take, "year", int32);
insert().into(@Student).nodes([{_id:"s1", name:"Alex"}, {_id:"s2", name:"Susan"}]);
insert().into(@Course).nodes([{_id:"c1", name:"Art"}, {_id:"c2", name:"Literature"}]);
insert().into(@Take).edges([{_from:"s1", _to:"c1"}, {_from:"s2", _to:"c1"}, {_from:"s2", _to:"c2"}]);

在交互式会话中执行该文件：

run D:\Queries\graphCreation.uql

直接执行文件

以下文件包含两条GQL查询：

use miniCircle;
// 查询1
MATCH (n:account WHERE n.year = 1990) RETURN n.name LIMIT 10;
// 查询2
MATCH (m:movie)-[]-(c:country)
WHERE m.rating > 8
RETURN count(DISTINCT c);

直接执行该文件：

./ultipa_cli.exe -h <host_addr> -u <username> -p <password> -e D:\Queries\queries_gql.txt

5. 安装算法

在ultipa_cli中使用install algo命令可在数据库的一个HDC服务器上安装HDC算法。

install algo命令需使用以下标志：

install algo -a D:\\algo\\libplugin_fastRP.so -i D:\\algo\\fastRP.yml -hdc hdc-server-1

在Windows设备上，install algo命令需使用\\来指定文件路径，且路径中不能出现空格。

6. 卸载算法

在ultipa_cli使用uninstall algo命令可从数据库的一个HDC服务器上卸载HDC算法。

uninstall algo命令需使用以下标志：

uninstall algo -n fastRP -hdc hdc-server-1

所有标志

ultipa_cli支持以下标志：

所有命令

进入交互式会话后，ultipa_cli支持以下命令：

UQL执行历史

首次成功连接至嬴图数据库后，系统会在ultipa_cli所在目录下自动生成.ultipa_cli_history文件，用于记录ultipa_cli中执行的所有命令。只要该文件存在，新执行的命令都将增加至文件末尾，方便用户追踪执行的历史命令，用于后续参考和再次执行。