Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release studio 3.9.0 #2451

Merged
merged 16 commits into from
Feb 1, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 5 additions & 33 deletions docs-2.0-zh/20.appendix/release-notes/studio-release-note.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,11 @@
# NebulaGraph Studio 更新说明


## v3.8.0
## v3.9.0

- 功能
- 支持使用 MySQL 数据库作为后端存储。
- 支持[使用 AI 导入数据](../../nebula-studio/quick-start/st-ug-import-data.md)。
- 支持[使用 AI 查询语句助手](../../nebula-studio/quick-start/st-ug-console.md)生成 nGQL 语句。

- 增强
- 支持自定义 WebSocket 的读写参数。
- 易用性
- 支持在导入任务列表根据图空间名称筛选任务。
- 兼容性
- 由于数据库表结构变更,需要在配置文件内将`DB.AutoMigrate`设置为`true`,系统会自动对已有历史数据进行升级适配。

如果是自己手动创建的库表,请手动修改这些表:`task_infos`、`task_effects`、`sketches`、`schema_snapshots`、`favorites`、`files`、`datasources`。

示例如下:

```mysql
ALTER TABLE `task_infos` ADD COLUMN `b_id` CHAR(32) NOT NULL DEFAULT '';
UPDATE TABLE `task_infos` SET `b_id` = `id`;
CREATE UNIQUE INDEX `idx_task_infos_id` ON `task_infos`(`b_id`);

ALTER TABLE `task_effects` ADD COLUMN `b_id` CHAR(32) NOT NULL DEFAULT '';
UPDATE TABLE `task_effects` SET `b_id` = `id`;
CREATE UNIQUE INDEX `idx_task_effects_id` ON `task_effects`(`b_id`);
...
```

## v3.7.0

- 增强

- 支持导入 SFTP、Amazon S3 的数据文件。
- 导入页面支持配置更多导入参数,如并发数、重试次数等。
- 支持重跑任务。
- 支持任务保存为草稿。
- 支持在 ARM 架构的 Docker 容器内运行 Studio。
- 优化[控制台功能](../../nebula-studio/quick-start/st-ug-console.md),包括自动补全 Tag/Edge type、快速选择历史语句、快速查看 Schema 等。
- 优化[执行计划](../../nebula-studio/quick-start/st-ug-console.md)展示样式。
48 changes: 37 additions & 11 deletions docs-2.0-zh/nebula-studio/quick-start/st-ug-console.md
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,50 @@

本文介绍 Studio 的控制台界面。

![控制台界面截图](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-015-cn.png)
## 入口

在顶部导航栏里,单击**控制台**。

## 页面介绍

<img src="https://docs-cdn.nebula-graph.com.cn/figures/std_console_240131_cn.png" width="1200" alt="控制台界面截屏">

下表列出了控制台界面上的各种功能。

| 编号 | 功能 | 说明 |
| :-- | :--| :-- |
| 1 | 工具栏 | 点击 **控制台** 页签进入控制台页面。 |
| 2 | 选择图空间 | 在 **当前图空间** 列表中选择一个图空间。 <br/> **说明**:Studio 不支持直接在输入框中运行 `USE <space_name>` 语句。 |
| 3 | 收藏夹 | 点击![save](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-save.png) 按钮,展开收藏夹,点击其中一个语句,输入框中即自动输入该语句。 |
| 4 | 历史清单 | 点击 ![history](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-history.png) 按钮,在语句运行记录列表里,点击其中一个语句,输入框中即自动输入该语句。列表里提供最近 15 次语句运行记录。 |
| 1 | 查看 Schema | 展示图空间的 Schema。 |
| 2 | 选择图空间 | 选择执行 nGQL 的图空间。不支持在控制台执行`USE <space_name>`语句切换图空间。 |
| 3 | 收藏夹 | 点击![save](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-save.png) 按钮,展开收藏夹,点击其中一个语句,该语句会自动输入到输入框中。 |
| 4 | 历史清单 | 点击 ![history](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-history.png) 按钮,在语句运行记录列表里,点击其中一个语句,输入框中即自动输入该语句。列表里提供最近 15 次语句运行记录。</br>在输入框中输入`/`可以快速选择历史查询语句。 |
| 5 | 清空输入框 | 点击 ![clear](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-clear.png) 按钮,清空输入框中已经输入的内容。 |
| 6 | 运行 | 在输入框中输入 nGQL 语句后,点击 ![play](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-play.png) 按钮即开始运行语句。 |
| 7 | 自定义参数展示 | 点击 ![查询](https://docs-cdn.nebula-graph.com.cn/figures/down.png)按钮可展开自定义参数,用于参数化查询,详情信息可见[管理参数](../../nebula-console.md)。|
| 8 | 输入框 | 在输入框中输入 nGQL 语句后,点击 ![play](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-play.png) 按钮运行语句。用户可以同时输入多个语句同时运行,语句之间以 `;` 分隔。支持用`//`添加注释。 |
| 7 | 输入框 | 输入 nGQL 语句的区域。语句会根据 Schema 或字符串展示不同颜色。</br>支持代码补全,可以根据 Schema 快速输入 Tag 或者 Edge type。</br>可以同时输入多个语句按顺序执行,语句之间以`;`分隔。可以用`//`添加注释。</br>支持对选中的语句单击右键,然后执行剪切、复制、运行等操作。 |
| 8 | 自定义参数展示 | 点击 ![查询](https://docs-cdn.nebula-graph.com.cn/figures/down.png)按钮可展开查看自定义参数,用于参数化查询。详情信息可见[管理参数](../../nebula-console.md)。|
| 9 | 语句运行状态 | 运行 nGQL 语句后,这里显示语句运行状态。如果语句运行成功,语句以绿色显示。如果语句运行失败,语句以红色显示。 |
| 10 | 添加到收藏夹 | 点击![save](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-save.png) 按钮,将语句存入收藏夹中,已收藏的语句该按钮以黄色展示。|
| 11 | 导出 CSV 文件或 PNG 格式图片 | 运行 nGQL 语句返回结果后,返回结果为表格形式时,点击 ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) 按钮即能将结果以 CSV 文件的形式导出。切换到可视化窗口,点击 ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) 按钮即能将结果以 CSV 文件或 PNG 图片的形式导出。 |
| 12 | 展开/隐藏执行结果 | 点击 ![up](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-up.png) 按钮,隐藏此条 nGQL 语句返回的结果或点击 ![down](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-down.png)按钮,展开此条 nGQL 语句返回的结果. |
| 11 | 导出 CSV 文件或 PNG 格式图片 | 运行 nGQL 语句返回结果后,返回结果为表格形式时,点击 ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) 按钮即能将结果以 CSV 文件的形式导出。</br>切换到可视化窗口,点击 ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) 按钮即能将结果以 CSV 文件或 PNG 图片的形式导出。 |
| 12 | 展开/隐藏执行结果 | 点击 ![up](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-up.png) 按钮,隐藏此条 nGQL 语句返回的结果 |
| 13 | 关闭执行结果 | 点击 ![close](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-close.png)按钮,关闭此条 nGQL 语句返回的结果。 |
| 14 | 表格窗口 | 显示语句运行结果。如果语句会返回结果,窗口会以表格形式呈现返回的结果。 |
| 15 | 可视化窗口 | 显示语句运行结果。如果语句会返回完整的点边结果,窗口会以可视化形式呈现返回的结果。点击右方 ![expand](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-back.png)按钮,展开数据概览面板。 |
| 14 | 表格窗口 | 在表格中显示语句的运行结果。 |
| 15 | 执行计划窗口 | 显示执行计划。如果执行的是`EXPLAIN`或`PROFILE`语句,窗口会以可视化形式呈现执行计划。如何理解执行计划请参见下文说明。 |
| 16 | 可视化窗口 | 显示语句运行结果。如果结果包含完整的点边信息,窗口会以可视化形式呈现返回的结果。点击右方 ![expand](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-back.png)按钮,展开数据概览面板。 |
| 17 | AI 查询语句助手 | 用户可以和助手聊天,将自然语言转换为 nGQL 查询语句,并支持一键复制 nGQL 语句到输入框中。使用前需要在[系统设置](../system-settings.md)里设置和启用该功能。</br>注意:和助手交互时,会将当前图空间的 Schema 信息发送给大规模语言模型,请注意信息安全。|

## 执行计划说明

Studio 可以展示语句的执行计划,界面说明如下。

<img src="https://docs-cdn.nebula-graph.com.cn/figures/ec_expl_excutionPlan_231226_cn.png" width="1000" alt="执行计划截屏">

|序号|说明|
|:---|:---|
|1 |`EXPLAIN`或`PROFILE`语句。|
|2 |执行计划涉及的算子并根据执行耗时排序。耗时前三的算子分别标记为为红色、橘红色和黄色。单击算子可以直接选中执行流程中的对应算子并展示算子信息。|
|3 |算子执行流程。每个算子都会显示该算子的入参、出参和耗时。</br>`Select`、`Loop`、`PassThrough`和`Start`算子有独立配色。</br>箭头展示数据流向和行数,行数越多,箭头越粗。</br>单击算子会在右侧展示算子的详细信息。|
|4 |算子详细信息。分为`Profiling data`和`Operator info`两部分。</br>`Profiling data`展示算子的性能数据,包括接收到的数据行数、执行耗时、总耗时等。</br>`Operator info`展示算子的具体操作信息。|
|5 |放大或缩小界面,还可以倒序显式算子执行流程。|
|6 |语句耗时。|
|7 |全屏展示或取消全屏。|

关于算子和优化规则的介绍以及如何调优,可以参考论坛[执行计划详解与调优](https://discuss.nebula-graph.com.cn/t/topic/12010)。
27 changes: 26 additions & 1 deletion docs-2.0-zh/nebula-studio/quick-start/st-ug-import-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Studio 支持界面化地将 CSV 格式数据导入至 {{nebula.name}} 中。

导入数据之前,需要确认以下信息:

- {{nebula.name}} 里已经创建 Schema。
- {{nebula.name}} 里已经创建 Schema。

- CSV 文件符合 Schema 要求。

Expand All @@ -16,8 +16,14 @@ Studio 支持界面化地将 CSV 格式数据导入至 {{nebula.name}} 中。

在顶部导航栏里,单击 ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) 图标。

## 操作步骤

导入数据主要分为 2 个部分,新建数据源和创建导入任务,接下来将详细介绍。

!!! note

导入任务还支持 AI 导入,该功能为 Beta 功能,使用前需要在[系统设置](../system-settings.md)里设置和启用该功能。

### 新建数据源

在页面右上角单击**新建数据源**,设置数据来源及其相关设置。当前支持 3 种类型的数据源。
Expand Down Expand Up @@ -62,6 +68,25 @@ Studio 支持界面化地将 CSV 格式数据导入至 {{nebula.name}} 中。

导入任务创建后,可以在**导入数据**页签内查看导入任务的进度,支持根据图空间筛选任务、编辑任务、查看日志、下载日志、重新导入、下载配置文件、删除任务等操作。

### AI 导入

!!! note

导入任务执行完成后,请手动检查数据是否正常导入,推荐结合导入页面的任务日志进行查看,排查超时、触发隐私政策、服务中断、编码等问题。

1. 在页面左上角单击**AI 导入**,完成如下设置:

- **文件**:选择需要进行 AI 导入的文件。当前仅支持本地单个文件或本地目录。每次只能选择一个本地文件或目录。文件需要为纯文本文件。
- **导入图空间**:待导入数据的图空间。图空间的 Schema 需要提前创建好。
- **导出 NGQL 文件路径**:导出 ngql 文件的路径,通常无需修改。
- **附加提示**:可以附加其他提示来指导数据导入。提示的精度直接影响导入结果的准确性。

你可以在配置文件中查看和 AI 导入相关的`LLM`参数。

2. 完成设置后,单击**下一步**,确认待导入的文件和使用的 AI URL,然后单击**开始**。

导入任务创建后,可以在**导入数据**页签内查看导入任务的进度,支持查看日志、下载日志、重新导入、删除任务等操作。

## 后续操作

完成数据导入后,用户可以进入[控制台](st-ug-console.md)页面。
21 changes: 21 additions & 0 deletions docs-2.0-zh/nebula-studio/system-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# 全局设置

本文介绍 Studio 的全局设置,包含语言切换和 Beta 功能。

- 语言:支持切换中文和英文。

- Beta 功能:Beta 功能开关。Beta 功能目前包括[查看 Schema](manage-schema/st-ug-view-schema.md)、[文本转查询](quick-start/st-ug-console.md)和 [AI 导入](quick-start/st-ug-import-data.md)。

文本转查询和 AI 导入需要设置人工智能相关的配置。详细设置参见下文。

## 文本转查询和 AI 导入

文本转查询和 AI 导入是基于大规模语言模型(LLM)实现的人工智能,需要配置以下参数才能正常使用。

|参数|说明|
|:---------|:--|
|**API type** | API 接口类型。支持`OpenAI`和`Aliyun`。 |
|**URL** | API URL。请按照对应接口类型填写正确的 URL 格式。例如`https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/chat/completions?api-version={api-version}`。 |
|**key** | 用于验证 API 的 key。使用在线大语言模型时必填,使用离线大语言模型时根据实际设置选填。 |
|**model** | 大语言模型版本。使用在线大语言模型时必填,使用离线大语言模型时根据实际设置选填。 |
|**文本最大长度**| 接收或生成一段文本的最大长度限制。单位:字节。 |
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ extra:
base111b: 1.1.1-beta
base220: 2.2.1
base300: 3.0.0
release: 3.8.0
release: 3.9.0
tag: v3.9.0
exchange:
release: 3.7.0
Expand Down Expand Up @@ -583,6 +583,7 @@ nav:
- Manage indexes: nebula-studio/manage-schema/st-ug-crud-index.md
- View schema: nebula-studio/manage-schema/st-ug-view-schema.md
- Schema drafting: nebula-studio/quick-start/draft.md
- Global settings: nebula-studio/system-settings.md
- Troubleshooting:
- Database connection error: nebula-studio/troubleshooting/st-ug-config-server-errors.md
- Unable to access Studio: nebula-studio/troubleshooting/st-ug-connection-errors.md
Expand Down Expand Up @@ -940,6 +941,7 @@ nav:
- 操作索引: nebula-studio/manage-schema/st-ug-crud-index.md
- 查看 Schema: nebula-studio/manage-schema/st-ug-view-schema.md
- Schema 草图: nebula-studio/quick-start/draft.md
- 全局设置: nebula-studio/system-settings.md
- 故障排查:
- 连接数据库错误: nebula-studio/troubleshooting/st-ug-config-server-errors.md
- 无法访问 Studio: nebula-studio/troubleshooting/st-ug-connection-errors.md
Expand Down