Source: https://dev-docs.yueshu.com.cn/v5.3.2/utilities/ngql/
Documentation version: v5.3.2

# 什么是 ngql

ngql 是连接悦数图数据库开发版 Graph 服务的命令行工具，支持执行 GQL 语句和脚本、加载内置示例数据，以及调整查询结果的显示格式。

## 特性

- 交互模式和非交互模式：在提示符下输入并运行语句，或执行脚本文件中的语句。
- 自动补全：使用 Tab 键补全 GQL 语句。
- 历史记录：查看并重新运行已执行的语句。
- 结果格式：以不同格式显示查询结果。

## 在 Docker Compose 部署中进入 ngql

按[部署教程](https://dev-docs.yueshu.com.cn/v5.3.2/get-started/deploy/)启动悦数图数据库开发版后，在运行 Docker 的开发机终端进入`compose.yaml`所在目录，执行：

````
docker compose exec ngql ngql --host graph-cluster --port 9669 --user root

````

第一个`ngql`是 Compose 服务名，第二个是容器内的客户端命令。`graph-cluster:9669`是容器网络中的 Graph 服务地址，无需替换为开发机 IP。

出现`Password`提示后，输入悦数图数据库开发版当前的`root`密码；首次部署密码的设置和转义规则见[设置 root 密码](https://dev-docs.yueshu.com.cn/v5.3.2/get-started/deploy/#root-password)。连接成功后，可在提示符下输入 GQL 语句；输入`:q`退出客户端。

连接与查询的示例见[连接并完成首次查询](https://dev-docs.yueshu.com.cn/v5.3.2/get-started/first-query/#ngql)。

## 下载独立安装包

配套 Docker Compose 已包含`ngql`容器。需要在开发机或其他机器上直接运行客户端时，可下载独立安装包。

当前版本：5.3.1。按客户端所在机器的操作系统和 CPU 架构选择安装包。

 | 操作系统 | CPU 架构 | 安装包 | 校验文件
 | macOS | Apple 芯片（ARM64） | [下载](https://dev-docs.yueshu.com.cn/downloads/ngql/5.3.1/yueshu-graph-ngql-5.3.1-darwin-aarch64.tgz) | [SHA-256](https://dev-docs.yueshu.com.cn/downloads/ngql/5.3.1/yueshu-graph-ngql-5.3.1-darwin-aarch64.tgz.sha256sum.txt)
 | macOS | Intel（x86-64） | [下载](https://dev-docs.yueshu.com.cn/downloads/ngql/5.3.1/yueshu-graph-ngql-5.3.1-darwin-x86_64.tgz) | [SHA-256](https://dev-docs.yueshu.com.cn/downloads/ngql/5.3.1/yueshu-graph-ngql-5.3.1-darwin-x86_64.tgz.sha256sum.txt)
 | Linux | ARM64 | [下载](https://dev-docs.yueshu.com.cn/downloads/ngql/5.3.1/yueshu-graph-ngql-5.3.1-linux-aarch64.tgz) | [SHA-256](https://dev-docs.yueshu.com.cn/downloads/ngql/5.3.1/yueshu-graph-ngql-5.3.1-linux-aarch64.tgz.sha256sum.txt)
 | Linux | x86-64 | [下载](https://dev-docs.yueshu.com.cn/downloads/ngql/5.3.1/yueshu-graph-ngql-5.3.1-linux-x86_64.tgz) | [SHA-256](https://dev-docs.yueshu.com.cn/downloads/ngql/5.3.1/yueshu-graph-ngql-5.3.1-linux-x86_64.tgz.sha256sum.txt)
 | Windows | x86-64 | [下载](https://dev-docs.yueshu.com.cn/downloads/ngql/5.3.1/yueshu-graph-ngql-5.3.1-windows-x86_64.tgz) | [SHA-256](https://dev-docs.yueshu.com.cn/downloads/ngql/5.3.1/yueshu-graph-ngql-5.3.1-windows-x86_64.tgz.sha256sum.txt)

需要检查文件完整性时，见[校验安装包](https://dev-docs.yueshu.com.cn/v5.3.2/utilities/#verify-download)。

### 解压并连接

确认悦数图数据库开发版已按[部署教程](https://dev-docs.yueshu.com.cn/v5.3.2/get-started/deploy/)启动，再在安装包所在目录打开终端。运行下方命令前，将`<package-name>`替换为下载的文件名。

默认连接本机的`127.0.0.1:9669`。从其他机器连接时，将`127.0.0.1`改为运行 Docker 的开发机 IP；如已修改端口映射，使用修改后的开发机端口。

Linux / macOSWindows PowerShell

````
tar -xzf "<package-name>"
cd yueshu-graph-ngql/bin
./ngql --host 127.0.0.1 --port 9669 --user root

````

````
tar -xzf "<package-name>"
Set-Location yueshu-graph-ngql/bin
.\ngql.exe --host 127.0.0.1 --port 9669 --user root

````

出现`Password`提示后，输入当前的`root`密码。连接成功后，按[首次查询](https://dev-docs.yueshu.com.cn/v5.3.2/get-started/first-query/#load-ngql)加载示例数据并执行查询。

## 更多用法

- 交互命令、执行脚本和查询结果格式，见 [ngql 使用指南](https://dev-docs.yueshu.com.cn/v5.3.2/utilities/ngql/usage/)。
- GQL 语法与示例，见 [GQL 参考](https://dev-docs.yueshu.com.cn/v5.3.2/database-gql-reference/overview/)。