Skip to content

Commit

Permalink
update studio (#1624)
Browse files Browse the repository at this point in the history
* [WIP]update studio

* update

* Update docs-2.0/nebula-studio/quick-start/st-ug-import-data.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* Update docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* Update docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>
  • Loading branch information
foesa-yang and abby-cyber authored Apr 2, 2022
1 parent 104c703 commit 307724c
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs-2.0/20.appendix/write-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
有多种方式可以写入 Nebula Graph {{ nebula.release }}:

- 使用[命令行 -f 的方式](../2.quick-start/3.connect-to-nebula-graph.md)导入:可以导入少量准备好的 nGQL 文件,适合少量手工测试数据准备;
- 使用 [studio 导入](../nebula-studio/quick-start/st-ug-import-data.md):可以用过浏览器导入本机多个 csv 文件,单个文件不超过 100 MB,格式有限制;
- 使用 [studio 导入](../nebula-studio/quick-start/st-ug-import-data.md):可以用过浏览器导入本机多个 csv 文件,格式有限制;
- 使用 [importer 导入](../nebula-importer/use-importer.md):导入单机多个 csv 文件,大小没有限制,格式灵活;数据量十亿级以内;
- 使用 [Exchange 导入](../nebula-exchange/about-exchange/ex-ug-what-is-exchange.md):从 Neo4j, Hive, MySQL 等多种源分布式导入,需要有 Spark 集群;数据量十亿级以上
- 使用 [Spark-connector](../nebula-spark-connector.md)/[Flink-connector](../nebula-flink-connector.md) 导入:有相应组件 (Spark/Flink),撰写少量代码;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ Nebula Studio(简称 Studio)是一款可以通过 Web 访问的开源图数

Studio 可以方便管理管理 Nebula Graph 图数据,具备以下功能:

- 使用 **Schema** 管理功能,用户可以使用图形界面完成图空间、Tag(标签)、Edge Type(边类型)、索引的创建,查看图空间的统计数据,快速上手 Nebula Graph。
- 使用 **Schema** 管理功能,用户可以使用图形界面完成图空间、Tag(标签)、Edge Type(边类型)、索引的创建,查看图空间的统计数据,快速上手 Nebula Graph。

- 使用 **导入** 功能,通过简单的配置,用户即能批量导入点和边数据,并能实时查看数据导入日志。
- 使用**导入**功能,通过简单的配置,用户即能批量导入点和边数据,并能实时查看数据导入日志。

- 使用 **控制台** 功能,用户可以使用 nGQL 语句创建 Schema,并对数据执行增删改查操作。
- 使用**控制台**功能,用户可以使用 nGQL 语句创建 Schema,并对数据执行增删改查操作。

## 适用场景

Expand Down
9 changes: 8 additions & 1 deletion docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ Nebula Graph Studio( 以下简称 Studio )支持云端或本地部署。云
当屏幕返回以下信息时,表示 PRM 版 Studio 已经成功启动。

```bash
Created symlink from /etc/systemd/system/multi-user.target.wants/nebula-graph-studio.service to /usr/lib/systemd/system/nebula-graph-studio.service.
Start installing Nebula Studio now...
Nebula Studio has been installed.
Nebula Studio started automatically.
```

3. 启动成功后,在浏览器地址栏输入 `http://ip address:7001`
Expand All @@ -65,6 +67,11 @@ Nebula Graph Studio( 以下简称 Studio )支持云端或本地部署。云
$ sudo rpm -e nebula-graph-studio-{{studio.release}}.x86_64
```

当屏幕返回以下信息时,表示 PRM 版 Studio 已经卸载。
```bash
Nebula Studio removed, bye~
```

### 异常处理

如果在安装过程中自动启动失败或是需要手动启动或停止服务,请使用以下命令
Expand Down
6 changes: 3 additions & 3 deletions docs-2.0/nebula-studio/quick-start/st-ug-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Studio 的控制台界面如下图所示。

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

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

Expand All @@ -18,8 +18,8 @@ Studio 的控制台界面如下图所示。
| 8 | 输入框 | 在输入框中输入 nGQL 语句后,点击 ![play](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-play.png) 按钮运行语句。用户可以同时输入多个语句同时运行,语句之间以 `;` 分隔。 |
| 9 | 语句运行状态 | 运行 nGQL 语句后,这里显示语句运行状态。如果语句运行成功,语句以绿色显示。如果语句运行失败,语句以红色显示。 |
| 10 | 收藏 | 点击![save](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-save.png) 按钮,将语句存入收藏夹中,已收藏的语句该按钮以黄色展示。|
| 11 | 导出 CSV 文件 | 运行 nGQL 语句返回结果后,点击 ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) 按钮即能将结果以 CSV 文件的形式导出。 |
| 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 语句返回的结果. |
| 13 | 关闭执行结果 | 点击 ![close](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-close.png)按钮,关闭此条 nGQL 语句返回的结果。 |
| 14 | 表格窗口 | 显示语句运行结果。如果语句会返回结果,窗口会以表格形式呈现返回的结果。 |
| 15 | 可视化窗口 | 显示语句运行结果。如果语句会返回完整的点边结果,窗口会以可视化形式呈现返回的结果。 |
| 15 | 可视化窗口 | 显示语句运行结果。如果语句会返回完整的点边结果,窗口会以可视化形式呈现返回的结果。点击右方 ![expand](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-back.png)按钮,展开数据概览面板。 |
8 changes: 7 additions & 1 deletion docs-2.0/nebula-studio/quick-start/st-ug-import-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
## 操作步骤

在导入数据之前,用户需要先上传文件后再创建导入任务。

### 上传文件

按照以下步骤导入数据:
Expand All @@ -26,7 +27,7 @@

!!! Note

一次可以选择多个 CSV 文件,本文使用的 CSV 文件可以在[规划 Schema ](st-ug-plan-schema.md) 中下载。
一次可以选择多个 CSV 文件,本文使用的 CSV 文件可以在[规划 Schema](st-ug-plan-schema.md) 中下载。

3. 上传结束后,可以在文件列表的 **操作** 列,点击 ![detail](https://docs-cdn.nebula-graph.com.cn/figures/detail.png) 图标预览文件内容,或点击 ![delete](https://docs-cdn.nebula-graph.com.cn/figures/alert-delete.png) 图标删除上传的文件。

Expand All @@ -39,6 +40,11 @@
1. 在顶部导航栏里,点击 **导入** 页签。
2. 在标签页内点击 **导入数据** 按钮。
3.**导入数据** 页面,点击 **导入模版** 直接通过配置文件导入数据或点击 **+ 创建导入任务** 按钮,完成以下任务:

!!! caution

Studio 通过**导入模板**导入数据与 [Nebula Importer](../../nebula-importer/use-importer.md) 大致相同,但是**导入模板**中配置文件的所有文件路径仅保留文件名。并且请确保在导入 YAML 文件之前上传所有 CSV 数据文件。

- 选择图空间。
- 填写任务名称。
- (可选)填写批处理量。
Expand Down

0 comments on commit 307724c

Please sign in to comment.