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

准备工作

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

使用指南

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

1. 打开终端工具

打开终端程序，导航至ultipa_cli所在文件夹。

2. 连接嬴图数据库

运行ultipa_cli，连接到嬴图数据库。

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

在与嬴图数据库建立连接时，ultipa_cli支持使用以下标志：

3. 指定工作图集

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

use alimama

4. 执行查询

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

5. 执行文件

ultipa_cli可以执行包含多个独立UQL或GQL查询的文件。其中，每个查询以分号（;）结束，按照顺序依次执行。

使用run命令执行文件并指定文件路径。在执行文件时，ultipa_cli会根据文件名中包含的“UQL”或“GQL”关键词（大小写不敏感，优先匹配“UQL”）自动切换至对应的UQL或GQL模式。若没有识别到任何关键词，将使用当前模式。

以下文件包含的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查询：

// 查询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);

run D:\Queries\queries_gql.txt

6. 安装算法

在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命令需使用\\来指定文件路径，且路径中不能出现空格。

7. 卸载算法

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

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

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

版本检查

使用-version或--version标志检查ultipa_cli的版本。

UQL执行历史

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