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

Fix some problem in Studio #1583

Merged
merged 1 commit into from
Mar 21, 2022
Merged
Show file tree
Hide file tree
Changes from all 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
15 changes: 0 additions & 15 deletions docs-2.0/nebula-studio/about-studio/st-ug-check-updates.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs-2.0/nebula-studio/about-studio/st-ug-release-note.md
Original file line number Diff line number Diff line change
@@ -1,20 +1 @@
# Studio 版本更新说明

## v3.2.1(2022.02.17)

- 修复:
- 移除 rpm 包安装前对 node 环境的检查。
- 修复导出 csv 文件时的解析问题

## v3.2.0(2022.02.15)

- 功能增强:
- 适配 Nebula 3.0.0,优化用户体验。
- 新增 DEB 部署并启动 Studio。
- 导入:
- 导入时需要输入密码确认,以增强安全性。
- 控制台:
- 支持保存参数,用于参数化查询。

- 兼容:
- 移除 Node 环境,去除 Studio 对 Node.js 的依赖。
24 changes: 21 additions & 3 deletions docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Nebula Studio(简称 Studio)是一款可以通过 Web 访问的开源图数

## 发行版本

可以使用以下五种方式安装部署 Studio:
可以使用以下方式安装部署 Studio:

- 用户可以使用 Docker 服务、RPM 服务、tar 包和 DEB 包安装部署 Studio,并连接到 Nebula Graph 数据库。详细信息参考 [部署 Studio](../deploy-connect/st-ug-deploy.md)。
- 使用 Helm 安装部署:在 Kubernetes 集群里使用 Helm 安装并部署 Studio,并连接到 Nebula Graph 数据库。详细信息参考[使用 Helm 部署 Nebula Graph Studio](../deploy-connect/st-ug-deploy-by-helm.md)。
Expand All @@ -13,14 +13,16 @@ Nebula Studio(简称 Studio)是一款可以通过 Web 访问的开源图数
- 云服务版本:用户可以在 Nebula Graph Cloud Service 上创建 Nebula Graph 数据库实例,并一键直连云服务版 Studio。详细信息参考 [Nebula Graph Cloud Service 用户手册](https://cloud-docs.nebula-graph.com.cn/cn/posts/manage-instances/dbaas-ug-connect-nebulastudio/ "点击前往 Nebula Graph Cloud Service 用户手册")。
-->

五种部署方式功能基本相同,在使用 Studio 时可能会受到限制。详细信息,参考[使用限制](st-ug-limitations.md)。
几种部署方式功能基本相同,在使用 Studio 时可能会受到限制。详细信息,参考[使用限制](st-ug-limitations.md)。

## 产品功能

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

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

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

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

## 适用场景
Expand All @@ -38,4 +40,20 @@ Studio 可以方便管理管理 Nebula Graph 图数据,具备以下功能:

因为 Nebula Graph 默认不启用身份验证,所以,一般情况下用户可以使用 `root` 账号和任意密码登录 Studio。

当 Nebula Graph 启用了身份验证后,用户只能使用指定的账号和密码登录 Studio。关于 Nebula Graph 的身份验证功能,参考 [Nebula Graph 用户手册](../../7.data-security/1.authentication/1.authentication.md "点击前往 Nebula Graph 官网")。
当 Nebula Graph 启用了身份验证后,用户只能使用指定的账号和密码登录 Studio。关于 Nebula Graph 的身份验证功能,参考 [Nebula Graph 用户手册](../../7.data-security/1.authentication/1.authentication.md "点击前往 Nebula Graph 官网")。

## 版本更新

Studio 处于持续开发状态中。用户可以通过 [Studio 发布版本更新](../about-studio/st-ug-release-note.md)查看最新发布的功能。

<!--

## 云服务版 Studio

对于云服务版 Studio,以 Nebula Graph Cloud Service 上实际部署的版本为准,用户不能自行更新 Studio 版本。当前公测环境里的 Studio 版本为 v{{ studio.base111b }}。

-->

成功连接 Studio 后,用户可以在页面右上角点击版本号,再点击 **新发布**,前往查看 Studio 的版本更新记录。

![在页面右上角点击头像,并在弹出菜单里点击“新发布”](../figs/st-ug-014-1.png)
15 changes: 15 additions & 0 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,18 @@
- 如果已拥有 GOD 或者 ADMIN 权限的账号登录,可以使用 [**控制台**](../quick-start/st-ug-create-schema.md)或者 [**Schema**](../manage-schema/st-ug-crud-space.md) 页面管理 Schema。
- 如果已拥有 GOD、ADMIN、DBA 或者 USER 权限的账号登录,可以[批量导入数据](../quick-start/st-ug-import-data.md)或者在 **控制台** 页面上运行 nGQL 语句插入数据。
- 如果已拥有 GOD、ADMIN、DBA、USER 或者 GUEST 权限的账号登录,可以在 **控制台** 页面上运行 nGQL 语句读取数据。

!!! note

账号权限参见 [内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。

### 清除连接
<!--
使用云服务版 Studio 时,用户不能清除连接。
-->

如果需要重新连接 Nebula Graph 数据库,可以清除当前连接后再重新配置数据库。

当 Studio 还连接在某个 Nebula Graph 数据库时,在工具栏中,选择 **设置** > **清除连接**。之后,如果浏览器上显示 **配置数据库** 页面,表示 Studio 已经成功断开了与 Nebula Graph 数据库的连接。

![reset](../figs/st-ug-005.png)

This file was deleted.

Binary file removed docs-2.0/nebula-studio/figs/st-ug-005-1.png
Binary file not shown.
Binary file added docs-2.0/nebula-studio/figs/st-ug-005.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-012-1.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-013-1.png
Binary file not shown.
Binary file added docs-2.0/nebula-studio/figs/st-ug-014-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-014.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-020.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-024.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-025.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-026.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-027.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-028.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-029.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-030.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-031.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-032.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-033.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-034.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-035.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-036.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-038.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-039.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-040-1.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-041-1.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-042-1.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-043-1.png
Diff not rendered.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-044-1.png
Diff not rendered.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-045-1.png
Diff not rendered.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-046-1.png
Diff not rendered.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-046.png
Diff not rendered.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-047.png
Diff not rendered.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-048.png
Diff not rendered.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-054.png
Diff not rendered.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-058-1.png
Diff not rendered.
2 changes: 1 addition & 1 deletion docs-2.0/nebula-studio/manage-schema/st-ug-crud-space.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Studio v{{ studio.release }} 及以后版本。请更新版本,详细操作参

- Studio 已经连接到 Nebula Graph 数据库。
- 当前登录的账号拥有创建或删除图空间的权限,即:
- 如果 Nebula Graph 未开启身份验证,用户以默认用户名 `user` 账号和默认密码 `password` 登录
- 如果 Nebula Graph 未开启身份验证,用户以默认用户名 `user` 账号和任意密码登录
- 如果 Nebula Graph 已开启身份验证,用户以 `root` 账号及其密码登录。

## 创建图空间
Expand Down
5 changes: 4 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 @@ -19,7 +19,7 @@
在导入数据之前,用户需要先上传文件后再创建导入任务。
### 上传文件

按照以下步骤倒入数据
按照以下步骤导入数据

1. 在顶部导航栏里,点击 **导入** 页签。
2. 在 **上传文件** 页面,点击 **上传文件** 按钮,并选择需要的 CSV 文件。本示例中,选择 `edge_serve.csv`、`edge_follow.csv`、`vertex_player.csv` 和 `vertex_team.csv` 文件。
Expand Down Expand Up @@ -51,9 +51,12 @@
- 在 **edge 1** 页签下,点击右方的![down](../figs/down.png)图标,在显示的属性列表中,选择 Edge Type。
- 根据 Edge type 的属性,从 `edge_follow.csv` 文件中选择相应的数据列。其中,**srcId** 和 **dstId** 分别表示边的起点与终点,所选择的数据及处理方式必须与相应的 VID 保持一致。本示例中,**srcId** 对应的是表示起点球员的 VID,**dstId** 对应的是表示终点球员的 VID。rank 为选填项,可以忽略。
![导入任务](../figs/st-ug-009.png)

4. 完成设置后,点击 **导入** 按钮。

5. 用户输入 Nebula 账号的密码后方可导入数据。
![输入密码](../figs/st-ug-010.png)

6. 导入数据后可以在 **导入数据** 页签内查看日志、下载日志、下载配置文件、删除任务等操作。
![导入成功](../figs/st-ug-004.png)

Expand Down
4 changes: 1 addition & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -390,17 +390,15 @@ nav:
- 认识 Nebula Graph Studio:
- 什么是 Nebula Graph Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md
- 使用限制: nebula-studio/about-studio/st-ug-limitations.md
- 版本更新: nebula-studio/about-studio/st-ug-check-updates.md
- 安装与登录:
- 部署 Studio: nebula-studio/deploy-connect/st-ug-deploy.md
- 使用 Helm 部署 Studio: nebula-studio/deploy-connect/st-ug-deploy-by-helm.md
- 连接数据库: nebula-studio/deploy-connect/st-ug-connect.md
- 清除连接: nebula-studio/deploy-connect/st-ug-reset-connection.md
- 快速开始:
- 规划 Schema: nebula-studio/quick-start/st-ug-plan-schema.md
- 创建 Schema: nebula-studio/quick-start/st-ug-create-schema.md
- 导入数据: nebula-studio/quick-start/st-ug-import-data.md
- 控制台界面: nebula-studio/use-console/st-ug-console.md
- 控制台界面: nebula-studio/quick-start/st-ug-console.md
- 管理Schema:
- 操作图空间: nebula-studio/manage-schema/st-ug-crud-space.md
- 操作 Tag: nebula-studio/manage-schema/st-ug-crud-tag.md
Expand Down