diff --git a/docs-2.0/nebula-studio/about-studio/st-ug-limitations.md b/docs-2.0/nebula-studio/about-studio/st-ug-limitations.md index c5873c06c91..fbb18719609 100644 --- a/docs-2.0/nebula-studio/about-studio/st-ug-limitations.md +++ b/docs-2.0/nebula-studio/about-studio/st-ug-limitations.md @@ -22,16 +22,6 @@ Studio 目前仅支持 x86_64 架构。 ## 数据上传 - - Studio 上传数据仅支持上传无表头的 CSV 文件,但是,单个文件大小及保存时间不受限制,而且数据总量以本地存储容量为准。 ## 数据备份 @@ -44,7 +34,7 @@ Studio 上传数据仅支持上传无表头的 CSV 文件,但是,单个文 - `USE `:只能在 **Space** 下拉列表中选择图空间,不能运行这个语句选择图空间。 - **控制台** 上使用 nGQL 语句时,用户可以直接回车换行,不能使用换行符。 - ## 浏览器支持 diff --git a/docs-2.0/nebula-studio/about-studio/st-ug-release-note.md b/docs-2.0/nebula-studio/about-studio/st-ug-release-note.md index e9d0db38b75..36638d3c35f 100644 --- a/docs-2.0/nebula-studio/about-studio/st-ug-release-note.md +++ b/docs-2.0/nebula-studio/about-studio/st-ug-release-note.md @@ -3,7 +3,12 @@ ## v3.2.0() - 功能增强: - -- 修复: - -- 兼容: \ No newline at end of file + - 适配 Nebula 3.0.0,优化用户体验。 + - 新增 DEB 部署并启动 Studio。 + - 导入: + - 导入时需要输入密码确认,以增强安全性。 + - 控制台: + - 支持保存参数,用于参数化查询。 + +- 兼容: + - 移除 Node 环境,去除 Studio 对 Node.js 的依赖。 \ No newline at end of file diff --git a/docs-2.0/nebula-studio/about-studio/st-ug-terms.md b/docs-2.0/nebula-studio/about-studio/st-ug-terms.md index 57087b36716..b69eaa56ddf 100644 --- a/docs-2.0/nebula-studio/about-studio/st-ug-terms.md +++ b/docs-2.0/nebula-studio/about-studio/st-ug-terms.md @@ -6,6 +6,4 @@ - Nebula Graph:一款开源图数据库管理系统(Graph Database Management System),擅长处理千亿个点和万亿条边的超大规模数据集。详细信息,参考 [Nebula Graph 用户手册](../../README.md "点击前往 Nebula Graph 用户手册")。 - \ No newline at end of file +- Nebula Graph Cloud:一款支持 Azure 平台,在云上搭建 Nebula Graph 数据库的产品,支持一键部署 Nebula Graph,集成了可视化图数据库管理工具 Nebula Graph Studio、Nebula Dashboard、Nebula Explorer。详细信息,参考 [什么是 Nebula Graph Cloud](../../nebula-cloud/1.what-is-cloud.md)。 diff --git a/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md b/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md index 517be590e82..02fe8a7b8e5 100644 --- a/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md +++ b/docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md @@ -4,11 +4,12 @@ Nebula Graph Studio(简称 Studio)是一款可以通过 Web 访问的开源 ## 发行版本 -可以使用以下四种方式安装部署 Studio: +可以使用以下五种方式安装部署 Studio: - Docker 版本:用户可以使用 Docker 服务部署 Studio,并连接到 Nebula Graph 数据库。详细信息参考 [Docker 部署 Studio](../deploy-connect/st-ug-deploy.md)。 - RPM 版本:用户可以使用 RPM 服务部署 Studio,并连接到 Nebula Graph 数据库。详细信息参考 [RPM 部署 Studio](../deploy-connect/st-ug-deploy.md)。 - tar 包安装部署:用户可以使用 tar 包安装并部署 Studio,并连接到 Nebula Graph 数据库。详细信息参考 [tar 包部署 Studio](../deploy-connect/st-ug-deploy.md)。 +- DEB 包安装部署:用户可以使用 DEB 包安装并部署 Studio,并连接到 Nebula Graph 数据库。详细信息参考 [DEB 包部署 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)。 +对于云服务版 Studio,只有操作权限为 **ROOT** 和 **USER** 的 Nebula Graph Cloud 用户可以登录 Studio。详细信息参考 [配套的应用(Dashboard/Studio/Explorer)](../../nebula-cloud/5.solution/5.1.supporting-application.md)。 因为 Nebula Graph 默认不启用身份验证,所以,一般情况下用户可以使用 `root` 账号和任意密码登录 Studio。 diff --git a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md index 0e2f2b24aa3..0cb67f8b383 100644 --- a/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md +++ b/docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md @@ -3,7 +3,7 @@ Nebula Graph Studio( 以下简称 Studio )支持云端或本地部署。云服务版 Studio 只能在 Nebula Graph Cloud Service 上使用。当在 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 用户手册")。 --> -本文介绍如何在本地通过 Docker、RPM 和 tar 包部署 Studio。 +本文介绍如何在本地通过 Docker、RPM、DEB 和 tar 包部署 Studio。 !!! Note @@ -107,16 +107,13 @@ $ npm run start - Nebula Graph 服务已经部署并启动。详细信息,参考 [Nebula Graph 安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 Nebula Graph 安装部署")。 -- 使用的 Linux 上安装有版本为 v10.12.0 以上的 Node.js。 - - 确保在安装开始前,以下端口处于未被使用状态。 | 端口号 | 说明 | | ---- | ---- | | 7001 | Studio 提供的 web 服务 | - | 8080 | Nebula-http-gateway,Client 的 HTTP 服务 | -### 安装 +### 安装部署 1. 根据需要下载 tar 包,建议选择最新版本。 @@ -130,31 +127,18 @@ $ npm run start tar -xvf nebula-graph-studio-{{studio.release}}.x86_64.tar.gz ``` -### 部署 - -!!! Note - - 根目录 nebula-graph-studio 下一共有两个安装包:nebula-graph-studio 和 nebula-http-gateway。用户需要在同一台机器上分别部署并启动服务,才能完成 Studio 的部署。 - -1. 部署 nebula-http-gateway 并启动。 - - ```bash - $ cd nebula-http-gateway - $ nohup ./nebula-httpd & - ``` - -2. 部署 nebula-graph-studio 并启动。 +3. 部署 nebula-graph-studio 并启动。 ```bash $ cd nebula-graph-studio - $ npm run start + $ ./server ``` !!! caution - Studio {{studio.release}} 版本不需要依赖于 nebula-importer,故安装部署方式与 Studio v3.0.0 不同。 + Studio {{studio.release}} 版本不需要依赖于 nebula-importer 和 nebula-http-gateway,故安装部署方式与 Studio v3.1.0 不同。 -3. 启动成功后,在浏览器地址栏输入 `http://ip address:7001`。 +4. 启动成功后,在浏览器地址栏输入 `http://ip address:7001`。 如果在浏览器窗口中能看到以下登录界面,表示已经成功部署并启动 Studio。 @@ -164,9 +148,54 @@ $ npm run start 用户可以采用 `kill pid` 的方式来关停服务: ```bash -$ kill $(lsof -t -i :8080) # stop nebula-http-gateway -$ cd nebula-graph-studio -$ npm run stop # stop nebula-graph-studio +$ kill $(lsof -t -i :7001) # stop nebula-graph-studio +``` + +## DEB 部署 Studio + +### 前提条件 + +在通过 DEB 部署安装 Studio 之前,用户需要确认以下信息: + +- Nebula Graph 服务已经部署并启动。详细信息,参考 [Nebula Graph 安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 Nebula Graph 安装部署")。 + +- 使用的 Linux 发行版为 Ubuntu。 + +- 确保在安装开始前,以下端口处于未被使用状态。 + + | 端口号 | 说明 | + | ---- | ---- | + | 7001 | Studio 提供的 web 服务 | + + +### 安装 + +1. 根据需要选择并下载 DEB 包,建议选择最新版本。常用下载链接如下: + + | 安装包 | 检验和 | Nebula 版本 | + | ----- | ----- | ----- | + | [nebula-graph-studio-{{studio.release}}.x86_64.deb](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.deb) | [nebula-graph-studio-{{studio.release}}.x86_64.deb.sha256](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.deb.sha256) | {{ nebula.release }} | + +2. 使用`sudo dpkg -i `命令安装 DEB 包。 + + 例如,安装 Studio {{studio.release}} 版本需要运行以下命令: + + ```bash + $ sudo dpkg -i nebula-graph-studio-{{studio.release}}.x86_64.deb + ``` + +3. 启动成功后,在浏览器地址栏输入 `http://ip address:7001`。 + + 如果在浏览器窗口中能看到以下登录界面,表示已经成功部署并启动 Studio。 + + ![Nebula Graph Studio 登录界面](../figs/st-ug-001-1.png "Nebula Graph Studio 登录界面") + +### 卸载 + +用户可以使用以下的命令卸载 Studio。 + +```bash +$ sudo dpkg -r nebula-graph-studio-{{studio.release}}.x86_64 ``` ## Docker 部署 Studio @@ -182,7 +211,6 @@ $ npm run stop # stop nebula-graph-studio | 端口号 | 说明 | | ---- | ---- | | 7001 | Studio 提供的 web 服务 | - | 8080 | Nebula-http-gateway,Client 的 HTTP 服务 | - (可选)在中国大陆从 Docker Hub 拉取 Docker 镜像的速度可能比较慢,用户可以使用 `registry-mirrors` 参数配置加速镜像。例如,如果要使用 Docker 中国区官方镜像、网易镜像和中国科技大学的镜像,则按以下格式配置 `registry-mirrors` 参数: diff --git a/docs-2.0/nebula-studio/figs/chaxun.png b/docs-2.0/nebula-studio/figs/chaxun.png new file mode 100644 index 00000000000..f681e76640a Binary files /dev/null and b/docs-2.0/nebula-studio/figs/chaxun.png differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-001.png b/docs-2.0/nebula-studio/figs/st-ug-001.png deleted file mode 100644 index 56daeaf5237..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-001.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-003-1.png b/docs-2.0/nebula-studio/figs/st-ug-003-1.png deleted file mode 100644 index 95946d3f1eb..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-003-1.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-004.png b/docs-2.0/nebula-studio/figs/st-ug-004.png deleted file mode 100644 index 7dee381920e..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-004.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-005.png b/docs-2.0/nebula-studio/figs/st-ug-005.png deleted file mode 100644 index 001e5ae05ef..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-005.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-006.png b/docs-2.0/nebula-studio/figs/st-ug-006.png deleted file mode 100644 index ecde01f1feb..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-006.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-007.png b/docs-2.0/nebula-studio/figs/st-ug-007.png deleted file mode 100644 index 38ceb25ae13..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-007.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-009.png b/docs-2.0/nebula-studio/figs/st-ug-009.png deleted file mode 100644 index 6719096bbf9..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-009.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-010.png b/docs-2.0/nebula-studio/figs/st-ug-010.png deleted file mode 100644 index a2affa766b8..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-010.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-011.png b/docs-2.0/nebula-studio/figs/st-ug-011.png deleted file mode 100644 index be904991f8e..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-011.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-012.png b/docs-2.0/nebula-studio/figs/st-ug-012.png deleted file mode 100644 index 0c0ec767386..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-012.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-013.png b/docs-2.0/nebula-studio/figs/st-ug-013.png deleted file mode 100644 index c29af27bc09..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-013.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-015-1.png b/docs-2.0/nebula-studio/figs/st-ug-015-1.png deleted file mode 100644 index ff481c538bd..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-015-1.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-016-1.png b/docs-2.0/nebula-studio/figs/st-ug-016-1.png deleted file mode 100644 index aa42fa210e4..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-016-1.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-022-1.png b/docs-2.0/nebula-studio/figs/st-ug-022-1.png deleted file mode 100644 index 591dfe19ff9..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-022-1.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-022.png b/docs-2.0/nebula-studio/figs/st-ug-022.png deleted file mode 100644 index b33d1ff8b95..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-022.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-023-1.png b/docs-2.0/nebula-studio/figs/st-ug-023-1.png deleted file mode 100644 index b4a1009b463..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-023-1.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-040.png b/docs-2.0/nebula-studio/figs/st-ug-040.png deleted file mode 100644 index 2725e634064..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-040.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-041.png b/docs-2.0/nebula-studio/figs/st-ug-041.png deleted file mode 100644 index 2129ef844e2..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-041.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-042.png b/docs-2.0/nebula-studio/figs/st-ug-042.png deleted file mode 100644 index 45add9269da..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-042.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-043.png b/docs-2.0/nebula-studio/figs/st-ug-043.png deleted file mode 100644 index c11cf0757b5..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-043.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-044.png b/docs-2.0/nebula-studio/figs/st-ug-044.png deleted file mode 100644 index 4ff17fb07f6..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-044.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-045.png b/docs-2.0/nebula-studio/figs/st-ug-045.png deleted file mode 100644 index 1d74884cbd0..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-045.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-046.png b/docs-2.0/nebula-studio/figs/st-ug-046.png deleted file mode 100644 index 32f7e529105..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-046.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-055-1.png b/docs-2.0/nebula-studio/figs/st-ug-055-1.png deleted file mode 100644 index d3eb01b6fa9..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-055-1.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-055-2.png b/docs-2.0/nebula-studio/figs/st-ug-055-2.png new file mode 100644 index 00000000000..7b1fc795611 Binary files /dev/null and b/docs-2.0/nebula-studio/figs/st-ug-055-2.png differ diff --git a/docs-2.0/nebula-studio/figs/st-ug-055.png b/docs-2.0/nebula-studio/figs/st-ug-055.png deleted file mode 100644 index 546a19bc367..00000000000 Binary files a/docs-2.0/nebula-studio/figs/st-ug-055.png and /dev/null differ diff --git a/docs-2.0/nebula-studio/use-console/st-ug-console.md b/docs-2.0/nebula-studio/use-console/st-ug-console.md index 80dbfef672e..0c630d34ff0 100644 --- a/docs-2.0/nebula-studio/use-console/st-ug-console.md +++ b/docs-2.0/nebula-studio/use-console/st-ug-console.md @@ -2,7 +2,7 @@ Studio 的控制台界面如下图所示。 -![控制台界面截图](../figs/st-ug-055-1.png "控制台") +![控制台界面截图](../figs/st-ug-055-2.png "控制台") 下表列出了控制台界面上的各种功能。 @@ -10,11 +10,12 @@ Studio 的控制台界面如下图所示。 | :-- | :--| :-- | | 1 | 工具栏 | 点击 **控制台** 页签进入控制台页面。 | | 2 | 选择图空间 | 在 **当前图空间** 列表中选择一个图空间。
**说明**:Studio 不支持直接在输入框中运行 `USE ` 语句。 | -| 3 | 输入框 | 在输入框中输入 nGQL 语句后,点击 ![表示运行的图标](../figs/st-ug-008.png "运行按钮") 按钮运行语句。用户可以同时输入多个语句同时运行,语句之间以 `;` 分隔。 -| 4 | 清空输入框 | 点击 ![表示清空的图标](../figs/st-ug-056.png "清空按钮") 按钮,清空输入框中已经输入的内容。 | -| 5 | 历史清单 | 点击 ![表示语句记录的图标](../figs/st-ug-057.png "查看语句记录") 按钮,在语句运行记录列表里,点击其中一个语句,输入框中即自动输入该语句。列表里提供最近 15 次语句运行记录。 | -| 6 | 运行 | 在输入框中输入 nGQL 语句后,点击 ![表示运行的图标](../figs/st-ug-008.png "运行按钮") 按钮即开始运行语句。 | -| 7 | 语句运行状态 | 运行 nGQL 语句后,这里显示语句运行状态。如果语句运行成功,语句以绿色显示。如果语句运行失败,语句以红色显示。 | -| 8 | 结果窗口 | 显示语句运行结果。如果语句会返回结果,结果窗口会以表格形式呈现返回的结果。 | -| 9 | 导出 CSV 文件 | 运行 nGQL 语句返回结果后,点击 **导出 CSV 文件** 按钮即能将结果以 CSV 文件的形式导出。 | -| 10 | 图探索功能键 | 根据运行的 nGQL 语句,用户可以点击图探索功能键将返回的结果导入 **图探索** 进行可视化展现,例如[导入图探索](st-ug-open-in-explore.md)和[查看子图](st-ug-visualize-subgraph.md)。 | +| 3 | 自定义参数展示 | 点击 ![查询](../figs/chaxun.png)按钮可展开自定义参数,用于参数化查询,详情信息可见[管理参数](../../nebula-console.md)。| +| 4 | 输入框 | 在输入框中输入 nGQL 语句后,点击 ![表示运行的图标](../figs/st-ug-008.png "运行按钮") 按钮运行语句。用户可以同时输入多个语句同时运行,语句之间以 `;` 分隔。 +| 5 | 清空输入框 | 点击 ![表示清空的图标](../figs/st-ug-056.png "清空按钮") 按钮,清空输入框中已经输入的内容。 | +| 6 | 历史清单 | 点击 ![表示语句记录的图标](../figs/st-ug-057.png "查看语句记录") 按钮,在语句运行记录列表里,点击其中一个语句,输入框中即自动输入该语句。列表里提供最近 15 次语句运行记录。 | +| 7 | 运行 | 在输入框中输入 nGQL 语句后,点击 ![表示运行的图标](../figs/st-ug-008.png "运行按钮") 按钮即开始运行语句。 | +| 8 | 语句运行状态 | 运行 nGQL 语句后,这里显示语句运行状态。如果语句运行成功,语句以绿色显示。如果语句运行失败,语句以红色显示。 | +| 9 | 结果窗口 | 显示语句运行结果。如果语句会返回结果,结果窗口会以表格形式呈现返回的结果。 | +| 10 | 导出 CSV 文件 | 运行 nGQL 语句返回结果后,点击 **导出 CSV 文件** 按钮即能将结果以 CSV 文件的形式导出。 | +| 11 | 图探索功能键 | 根据运行的 nGQL 语句,用户可以点击图探索功能键将返回的结果导入 **图探索** 进行可视化展现,例如[导入图探索](st-ug-open-in-explore.md)和[查看子图](st-ug-visualize-subgraph.md)。 |