Skip to content

Commit

Permalink
update studio 3.6.0 (#2528)
Browse files Browse the repository at this point in the history
* update studio 3.6.0

* Update docs-2.0/nebula-studio/manage-schema/st-ug-view-schema.md

---------

Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com>
  • Loading branch information
cooper-lzy and randomJoe211 authored Jan 30, 2023
1 parent 6ab7925 commit 48ad1a7
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs-2.0/nebula-explorer/deploy-connect/ex-ug-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ OAuth 部分的配置说明如下。

!!! Note

- 即使 NebulaGraph 数据库与 Explorer 部署在同一台机器上,用户也必须在 **Host** 字段填写这台机器的本机 IP 地址,而不是 `127.0.0.1` 或者 `localhost`。
- 即使 NebulaGraph 数据库与 Explorer 部署在同一台机器上,用户也必须填写这台机器的本机 IP 地址,而不是 `127.0.0.1` 或者 `localhost`。
- 在新的标签页连接另一个 NebulaGraph 数据库时,会覆盖旧标签页的会话。如果需要同时登录多个 NebulaGraph 数据库,可以用不同的浏览器或者无痕模式。

- **Port**:Graphd 服务的端口。默认为`9669`
Expand Down
41 changes: 23 additions & 18 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,34 +15,41 @@

- NebulaGraph 数据库登录账号信息,包括用户名和密码。

!!! Note

如果 NebulaGraph 已经启用了身份验证,并且已经创建了不同角色的用户,用户只能使用被分配到的账号和密码登录数据库。如果未启用身份验证,用户可以使用 `root` 用户名和任意密码登录数据库。关于启用身份验证,参考 [NebulaGraph 用户手册](../../README.md "点击进入 NebulaGraph 用户手册")。

## 操作步骤

按以下步骤连接 NebulaGraph 数据库:

1. 在 Studio 的 **配置数据库** 页面上,输入以下信息:
1. 在浏览器地址栏输入 `http://<ip_address>:7001`

在浏览器窗口中看到以下登录界面表示已经成功部署并启动了 Studio。

![NebulaGraph Studio 的登录页面](https://docs-cdn.nebula-graph.com.cn/figures/studio_login_230130_cn.png "配置数据库")

2. 在 Studio 的 **配置数据库** 页面上,输入以下信息:

- **Host**:填写 NebulaGraph 的 Graph 服务本机 IP 地址及端口。格式为`ip:port`。默认端口为`9669`
- **Graphd IP 地址**:填写 NebulaGraph 的 Graph 服务本机 IP 地址。例如`192.168.10.100`

!!! Note

即使 NebulaGraph 数据库与 Studio 部署在同一台机器上,用户也必须在 **Host** 字段填写这台机器的本机 IP 地址,而不是 `127.0.0.1` 或者 `localhost`。
- 即使 NebulaGraph 数据库与 Studio 部署在同一台机器上,用户也必须填写这台机器的本机 IP 地址,而不是 `127.0.0.1` 或者 `localhost`。
- 在新的标签页连接另一个 NebulaGraph 数据库时,会覆盖旧标签页的会话。如果需要同时登录多个 NebulaGraph 数据库,可以用不同的浏览器或者无痕模式。

- **用户名****密码**:根据 NebulaGraph 的身份验证设置填写登录账号和密码。
- 如果未启用身份验证,可以填写默认用户名 `root` 和任意密码。
- 如果已启用身份验证,但是未创建账号信息,用户只能以 GOD 角色登录,必须填写 `root` 及对应的密码 `nebula`
- 如果已启用身份验证,同时又创建了不同的用户并分配了角色,不同角色的用户使用自己的账号和密码登录。
- **Port**:Graphd 服务的端口。默认为`9669`

![NebulaGraph Studio 的登录页面](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-cn.png "配置数据库")
- **用户名****密码**:根据 NebulaGraph 的身份验证设置填写登录账号和密码。
- 如果未启用身份验证,可以填写默认用户名 `root` 和任意密码。
- 如果已启用身份验证,但是未创建账号信息,用户只能以 GOD 角色登录,必须填写 `root` 及对应的密码 `nebula`
- 如果已启用身份验证,同时又创建了不同的用户并分配了角色,不同角色的用户使用自己的账号和密码登录。

2. 完成设置后,点击 **连接** 按钮。
3. 完成设置后,点击 **连接** 按钮。

首次登录会显示欢迎页,根据使用流程展示相关功能,并且支持自动下载并导入测试数据集。
!!! note

一次连接会话持续 30 分钟。如果超过 30 分钟没有操作,会话即断开,用户需要重新登录数据库。
一次连接会话持续 30 分钟。如果超过 30 分钟没有操作,会话即断开,用户需要重新登录数据库。

首次登录会显示欢迎页,根据使用流程展示相关功能,并且支持自动下载并导入测试数据集。

想要再次访问欢迎页,单击 ![help](https://docs-cdn.nebula-graph.com.cn/figures/navbar-help.png)

## 后续操作

Expand All @@ -65,6 +72,4 @@

如果需要重新连接 NebulaGraph 数据库,可以登出后重新配置数据库。

在页面右上角单击用户头像,单击 **登出**,如果浏览器上显示 **配置数据库** 页面,表示 Studio 已经成功断开了与 NebulaGraph 数据库的连接。

![reset](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-cn.png)
在页面右上角单击用户头像,单击 **登出**
10 changes: 5 additions & 5 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ NebulaGraph Studio( 以下简称 Studio )支持云端或本地部署。云

如果在浏览器窗口中能看到以下登录界面,表示已经成功部署并启动 Studio。

![NebulaGraph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-cn.png "NebulaGraph Studio 登录界面")
![NebulaGraph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/studio_login_230130_cn.png "NebulaGraph Studio 登录界面")

### 卸载

Expand Down Expand Up @@ -137,7 +137,7 @@ $ systemctl restart nebula-graph-studio.service

如果在浏览器窗口中能看到以下登录界面,表示已经成功部署并启动 Studio。

![NebulaGraph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-cn.png "NebulaGraph Studio 登录界面")
![NebulaGraph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/studio_login_230130_cn.png "NebulaGraph Studio 登录界面")

### 卸载

Expand Down Expand Up @@ -186,7 +186,7 @@ $ sudo dpkg -r nebula-graph-studio

如果在浏览器窗口中能看到以下登录界面,表示已经成功部署并启动 Studio。

![NebulaGraph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-cn.png "NebulaGraph Studio 登录界面")
![NebulaGraph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/studio_login_230130_cn.png "NebulaGraph Studio 登录界面")
### 停止服务

用户可以采用 `kill <pid>` 的方式来关停服务:
Expand Down Expand Up @@ -271,7 +271,7 @@ $ kill $(lsof -t -i :7001) # stop nebula-graph-studio

如果在浏览器窗口中能看到以下登录界面,表示已经成功部署并启动 Studio。

![NebulaGraph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-cn.png "NebulaGraph Studio 登录界面")
![NebulaGraph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/studio_login_230130_cn.png "NebulaGraph Studio 登录界面")

## Helm 部署 Studio

Expand Down Expand Up @@ -323,7 +323,7 @@ $ kill $(lsof -t -i :7001) # stop nebula-graph-studio
4. 启动成功后,在浏览器地址栏输入`http://<node_address>:30070`
如果在浏览器窗口中能看到以下登录界面,表示已经成功部署并启动 Studio。

![NebulaGraph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-cn.png "NebulaGraph Studio 登录界面")
![NebulaGraph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/studio_login_230130_cn.png "NebulaGraph Studio 登录界面")

### 卸载

Expand Down
19 changes: 19 additions & 0 deletions docs-2.0/nebula-studio/manage-schema/st-ug-view-schema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 查看 Schema

用户可以在 Studio 上可视化地查看 Schema。

## 操作步骤

1. 在顶部导航栏里,点击 **Schema** 页签。

2.**图空间列表**中,找到图空间,单击图空间名称或者在**操作**列中单击 **Schema**

3. 单击**查看 Schema** 页签,单击**获取 Schema**

## 其他操作

**图空间列表**中,找到图空间,在**操作**列可以执行如下操作:

- 查看 Schema DDL:显示该图空间的 Schema 创建语句,包括图空间、Tag、Edge type 和索引。
- 克隆图空间:克隆该图空间的 Schema 到新的图空间。
- 删除图空间:删除该图空间,包括 Schema 和所有点边数据。
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@ plugins:
- spark-connector/*
- 4.deployment-and-installation/5.zone.md
- 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md
- nebula-dashboard-ent/4.cluster-operator/cluster-information/job-management.md
# 仅发布包含企业版功能的文档版本时,注释以下页面
# begin
# - 3.ngql-guide/6.functions-and-expressions/17.ES-function.md
Expand Down Expand Up @@ -568,6 +567,7 @@ nav:
- 操作 Tag: nebula-studio/manage-schema/st-ug-crud-tag.md
- 操作 Edge type: nebula-studio/manage-schema/st-ug-crud-edge-type.md
- 操作索引: 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/troubleshooting/st-ug-config-server-errors.md
Expand Down

0 comments on commit 48ad1a7

Please sign in to comment.