Skip to content

Commit

Permalink
Move studio docs (cn) (vesoft-inc#103)
Browse files Browse the repository at this point in the history
* Initial commit

* Merge request for docker (#1)

* feat: first version init

* mod: docs

* fix: docs (#3)

* feat: update docs && web image (vesoft-inc#4)

* nebula graph studio user guide (vesoft-inc#5)

* user-guide

* details about host ip

* feat: add nginx import file download (vesoft-inc#6)

* docs: update (vesoft-inc#7)

* feat: release web image to 0.0.7 (vesoft-inc#8)

* mod: change relative image always use latest (vesoft-inc#9)

* docs: update (vesoft-inc#10)

* docs: fix (vesoft-inc#11)

* Update README.md (vesoft-inc#12)

* mod: changelog (vesoft-inc#13)

* en version and cn minor updates (vesoft-inc#15)

* Update README.md (vesoft-inc#14)

* [doc] links updated (vesoft-inc#16)

* en version and cn minor updates

* links updated

* minor update

* [doc]add readme (vesoft-inc#17)

* add readme

* address comments

* address comments

* fix typo (vesoft-inc#18)

* fix changelog links (vesoft-inc#20)

* [doc] minor updates (vesoft-inc#19)

* minor updates

* notes added

* minor updates

* [doc] figures added  (vesoft-inc#24)

* figures added

* minor updates

* updated

* nGQL

* docs: update changelog (vesoft-inc#31)

* docs: update changelog (vesoft-inc#34)

* mod: upload to server (vesoft-inc#42)

* mod: upload to server

* mod: http client max size

* fix: file download

* docs: fix

* mod: docker image name

Co-authored-by: NicolaCage <37568394+NicolaCage@users.noreply.github.com>

* mod: CHANGELOG (vesoft-inc#64)

* docs: update changelog (vesoft-inc#66)

* docs: release 1.0.4-beta (vesoft-inc#68)

* update-doc (vesoft-inc#96)

* update-changelog (vesoft-inc#97)

* update-changelog

* update

* docs: add 1.0.5-beta changelog (vesoft-inc#98)

* docs: add 1.0.5-beta changelog

* docs: fix typo

* docs: fix typo (vesoft-inc#99)

* Release V1.0.6-beta (vesoft-inc#102)

* docs: add 1.0.5-beta changelog

* docs: fix typo

* docs: release v1.0.6-beta

* update-doc (vesoft-inc#105)

* add-example (vesoft-inc#106)

* add-video-link (vesoft-inc#110)

* docs: update release (vesoft-inc#111)

* chore: release 1.0.8-beta (vesoft-inc#116)

* show-edge-doc (vesoft-inc#119)

* chore: release 1.0.9-beta (vesoft-inc#132)

* update USE (vesoft-inc#136)

* docs: release 1.0.10-beta (vesoft-inc#142)

* docs: release 1.0.10-beta

* mod: doc review

* docs: release 1.1.0-beta (vesoft-inc#143)

* docs: release 1.1.0-beta

* docs: update

* docs: changelog update (vesoft-inc#144)

* docs: changelog update

* docs: update

* New user guide (vesoft-inc#148)

* added new files for user guide

* deleted doc

* updated on whitewum's comments

* corrected links

* updated what-is-studio

* updated docs

* updated

* corrected links

* updated plan-schema

* updated

* removed uuid

* fixed links and corrected description (vesoft-inc#150)

* fixed image links (vesoft-inc#151)

* fixed image links

* fixed format

* added schema management (vesoft-inc#152)

* fix conflict

* modified st-ug-crud-index.md

* updated

* fixed

* updated toc.md

* fixed format errors

* fixed punctuation errors

* docs: changelog update (vesoft-inc#155)

* fixed typo (vesoft-inc#154)

* Update readme (vesoft-inc#157)

* updated readme.md and re-organized folder

* updated

* added schema management (english) (vesoft-inc#159)

* added manage schema (english)

* updated toc.md

* removed company name from docs (vesoft-inc#160)

* Update limitations (vesoft-inc#161)

* updated limitations

* updated limitations

* updated limitations

* added a link to studio video (vesoft-inc#162)

* added a link to studio video

* updated

* added video link for the English README.md

* docs: update  version (vesoft-inc#163)

* docs: update  version

* mod: changelog update

* mod: code review

* mod: max size of upload files update (vesoft-inc#164)

* added open-in-explorer & updated toc (vesoft-inc#165)

* added open-in-explorer & updated toc

* updated

* updated

* Add version info && update limitations (vesoft-inc#166)

* added version info into operation docs and fixed errors

* updated

* added version info into operation docs and fixed errors

* updated

* updated

* added view subgraph (vesoft-inc#169)

* add English quick start && polish some docs of chinese version (vesoft-inc#167)

* added manage schema (english)

* added english quick start && polished the chinese version

* updated toc

* updated

* fixed comments

* Add version info && update limitations (vesoft-inc#166)

* added version info into operation docs and fixed errors

* updated

* added version info into operation docs and fixed errors

* updated

* updated

* fixed comments

* added view subgraph (vesoft-inc#169)

* added manage schema (english)

* added english quick start && polished the chinese version

* updated toc

* updated

* fixed comments

* fixed comments

* open in explore (english) (vesoft-inc#168)

* added Open-in-Explore (en)

* updated

* rename

* added Open-in-Explore (en)

* updated

* rename

* edited toc

* updated version

* fixed typo

* fixed comments

* updated UI description

* fixed comments

* move studio docs (cn)

Co-authored-by: dutor <440396+dutor@users.noreply.github.com>
Co-authored-by: Jerry <8124783+nianiaJR@users.noreply.github.com>
Co-authored-by: wilsonyou <40747875+wilsonyou@users.noreply.github.com>
Co-authored-by: min.wu <50101159+whitewum@users.noreply.github.com>
Co-authored-by: Amber Zhang <42762957+Amber1990Zhang@users.noreply.github.com>
Co-authored-by: NicolaCage <37568394+NicolaCage@users.noreply.github.com>
Co-authored-by: hetao <hetao.daily@gmail.com>
Co-authored-by: He Nut <18328704+hetao92@users.noreply.github.com>
  • Loading branch information
9 people committed Nov 16, 2020
1 parent de24928 commit 4e29e16
Show file tree
Hide file tree
Showing 68 changed files with 784 additions and 3 deletions.
3 changes: 0 additions & 3 deletions .gitignore

This file was deleted.

14 changes: 14 additions & 0 deletions nebula-studio/about-studio/st-ug-check-updates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# 版本更新

Studio 处于持续开发状态中。为保证您在本地或 Nebula Graph Cloud Service 上能使用 Studio 最新的功能:

- Nebula Graph Cloud Service 上始终部署最新版本的 Studio。
- 本地部署时,建议您每次都运行以下命令启动 Studio:

```bash
docker-compose pull && docker-compose up
```

您可以通过 [Studio 的版本更新记录](https://github.com/vesoft-inc/nebula-web-docker/blob/master/docs/CHANGELOG-zh.md "点击前往 GitHub") 查看最新发布的功能。如果您已经在 Studio 页面上,您可以在页面右上角点击版本号,再点击 **新发布**,前往上述 Studio 的版本更新记录。

![在页面右上角点击版本号,并在弹出菜单里点击“新发布”](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-014.png "查看 Studio 版本更新记录")
14 changes: 14 additions & 0 deletions nebula-studio/about-studio/st-ug-faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# 常见问题

**为什么我无法使用某个功能?**

如果发现您无法使用某个功能,建议您按以下步骤排除问题:

1. 确认 Nebula Graph 是最新版本。如果您使用 Docker Compose 部署 Nebula Graph 数据库,建议您运行 `docker-compose pull && docker-compose up -d` 拉取最新的 Docker 镜像,并启动容器。
2. 确认 Studio 是最新版本。具体操作,参考 [版本更新](st-ug-check-updates.md)
3. 搜索 [论坛](https://discuss.nebula-graph.com.cn/) 或 GitHub 的 [nebula](https://github.com/vesoft-inc/nebula)[nebula-web-docker](https://github.com/vesoft-inc/nebula-web-docker/issues) 项目,确认是否已经有类似的问题。
4. 如果上述操作均未解决您的问题,欢迎您在论坛上提交问题。

**Studio 支持 Nebula Graph V2.0 pre 吗?**

不支持。目前 Studio 仅支持 Nebula Graph V1.1.0 及以下版本。
36 changes: 36 additions & 0 deletions nebula-studio/about-studio/st-ug-limitations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# 使用限制

本文描述了您在使用 Studio 时可能会受到的限制。

## Nebula Graph 版本支持

目前 Studio 仅支持 Nebula Graph V1.1.0 及以下版本,不支持 Nebula Graph V2.0 pre-release。

## 数据上传

如果您在 Nebula Graph Cloud Service 上使用 Studio,上传数据会有以下限制:

- 目前仅支持上传没有表头行的 CSV 文件。
- 单个文件不得超过 100 MB。
- 单个实例上传文件总量不得超过 1 GB。
- 单个文件仅能保存 1 天。

如果您在本地使用 Studio,上传数据会有以下限制:

- 目前仅支持上传没有表头行的 CSV 文件。
- 单个文件大小及保存时间不受限制,数据总量以本地存储容量为准。

## 数据备份

目前仅支持在 **控制台** 上以 CSV 格式导出查询结果,不支持其他数据备份方式。

## nGQL 支持

除以下内容外,您可以在 Studio 的 **控制台** 上执行所有 nGQL 语句语法:

- `USE <space_name>`:您只能在 **Space** 下拉列表中选择图空间,不能运行这个语句选择图空间。
- **控制台** 上使用 nGQL 语句时,您可以直接回车换行,不能使用换行符。

## 浏览器支持

建议您使用 Chrome 访问 Studio。
9 changes: 9 additions & 0 deletions nebula-studio/about-studio/st-ug-terms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 名词解释

本文提供了您在使用 Studio 时可能需要知道的名词解释。

- Nebula Graph Studio:在本手册中简称为 Studio,是一款可以通过 Web 访问的图数据库可视化工具,搭配 Nebula Graph DBMS 使用,为您提供构图、数据导入、编写 nGQL 查询、图探索等一站式服务。

- Nebula Graph:一款开源图数据库管理系统(Graph Database Management System),擅长处理千亿个点和万亿条边的超大规模数据集。详细信息,参考 [Nebula Graph 用户手册](https://docs.nebula-graph.com.cn/ "点击前往 Nebula Graph 用户手册")

- Nebula Graph Cloud Service:Nebula Graph 图数据库的云服务平台(Database-as-a-Service,DBaaS),按需付费,支持一键部署 Nebula Graph,集成了 Nebula Graph Studio,并内置资源监控工具。详细信息,参考 [Nebula Graph Cloud Service 用户手册](https://cloud-docs.nebula-graph.com.cn/cn/posts/toc/dbaas-ug-toc/ "点击前往 Nebula Graph Cloud Service 用户手册")
37 changes: 37 additions & 0 deletions nebula-studio/about-studio/st-ug-what-is-graph-studio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 什么是 Nebula Graph Studio

Nebula Graph Studio(简称 Studio)是一款可以通过 Web 访问的图数据库可视化工具,搭配 Nebula Graph DBMS 使用,为您提供构图、数据导入、编写 nGQL 查询、图探索等一站式服务。即使没有图数据库操作经验,您也可以快速成为图专家。

## 发行版本

Studio 目前有两个发行版本:

- 本地版本:您可以在本地部署 Studio,并连接到部署在本地的 Nebula Graph 数据库。详细信息,参考 [安装部署 Studio](../install-configure/st-ug-install.md)
- 云服务版本:您可以在 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 用户手册")

两个发行版本功能基本相同。但是,因为部署方式不同,会有不同的使用限制。详细信息,参考 [使用限制](st-ug-limitations.md)

## 产品功能

Studio 提供以下功能:

- 灵活的部署方式,满足您的不同需求。您可以在本地部署 Studio 连接 Nebula Graph 数据库,或者在 Nebula Graph Cloud Service 上一键直连云端 Nebula Graph 数据库实例。
- GUI 设计,方便您管理 Nebula Graph 图数据:
- 借助 **Schema** 管理功能,您可以使用图形界面完成 Schema(模式)创建,使您能快速上手 Nebula Graph 数据库。
- 借助 **控制台** 功能,您可以使用 nGQL 语句创建 Schema,并对数据执行增删改查操作。
- 借助 **导入** 功能,通过简单的配置,您即能完成批量点和边数据导入,并能实时查看数据导入日志。
- 图探索,支持可视化展示图数据,使您更容易发现数据之间的关联性,提高数据分析和解读的效率。

## 适用场景

如果您有以下任一需求,都可以使用 Studio:

- 您有一份数据集,想进行可视化图探索或者数据分析。您可以使用 Docker Compose 或者得 Nebula Graph Cloud Service 部署 Nebula Graph 数据库,再使用 Studio 完成可视化操作。
- 您已经安装部署了 Nebula Graph 数据库,并且已经导入数据集,想使用 GUI 工具执行 nGQL 语句查询、可视化图探索或者数据分析。
- 您刚开始学习 nGQL(Nebula Graph Query Language),但是不习惯用命令行工具,更希望使用 GUI 工具查看语句输出的结果。

## 身份验证

Nebula Graph 默认不启动身份验证,此时,您可以使用默认账号和密码(`user``password`)登录 Studio。如果 Nebula Graph 启用了身份验证,您只能使用指定的账号和密码登录 Studio。

关于 Nebula Graph 的身份验证功能,参考[《Nebula Graph 用户手册》](https://docs.nebula-graph.com.cn/manual-CN/3.build-develop-and-administration/4.account-management-statements/authentication/ "点击前往 Nebula Graph 用户手册")
Binary file added nebula-studio/figs/st-ug-001.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 added nebula-studio/figs/st-ug-002.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 added nebula-studio/figs/st-ug-003.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 added nebula-studio/figs/st-ug-004.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 added 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 added nebula-studio/figs/st-ug-006.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 added nebula-studio/figs/st-ug-007.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 added nebula-studio/figs/st-ug-008.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 added nebula-studio/figs/st-ug-009.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 added nebula-studio/figs/st-ug-010.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 added nebula-studio/figs/st-ug-011.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 added nebula-studio/figs/st-ug-012.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 added nebula-studio/figs/st-ug-013.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 added nebula-studio/figs/st-ug-014.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 added nebula-studio/figs/st-ug-015.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 added nebula-studio/figs/st-ug-016.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 added nebula-studio/figs/st-ug-017.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 added nebula-studio/figs/st-ug-018.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 added nebula-studio/figs/st-ug-019.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 added nebula-studio/figs/st-ug-020.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 added nebula-studio/figs/st-ug-021.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 added nebula-studio/figs/st-ug-022.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 added nebula-studio/figs/st-ug-023.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 added nebula-studio/figs/st-ug-024.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 added nebula-studio/figs/st-ug-025.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 added nebula-studio/figs/st-ug-026.png
Binary file added nebula-studio/figs/st-ug-027.png
Binary file added nebula-studio/figs/st-ug-028.png
Binary file added nebula-studio/figs/st-ug-029.png
Binary file added nebula-studio/figs/st-ug-030.png
Binary file added nebula-studio/figs/st-ug-031.png
Binary file added nebula-studio/figs/st-ug-032.png
Binary file added nebula-studio/figs/st-ug-033.png
Binary file added nebula-studio/figs/st-ug-034.png
Binary file added nebula-studio/figs/st-ug-035.png
Binary file added nebula-studio/figs/st-ug-036.png
Binary file added nebula-studio/figs/st-ug-038.png
Binary file added nebula-studio/figs/st-ug-039.png
Binary file added nebula-studio/figs/st-ug-040.png
Binary file added nebula-studio/figs/st-ug-041.png
Binary file added nebula-studio/figs/st-ug-042.png
Binary file added nebula-studio/figs/st-ug-043.png
Binary file added nebula-studio/figs/st-ug-044.png
Binary file added nebula-studio/figs/st-ug-045.png
Binary file added nebula-studio/figs/st-ug-046.png
Binary file added nebula-studio/figs/st-ug-047.png
Binary file added nebula-studio/figs/st-ug-048.png
42 changes: 42 additions & 0 deletions nebula-studio/install-configure/st-ug-connect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# 连接数据库

安装并启动 Studio 后,您需要连接 Nebula Graph 数据库。本文主要描述如何在本地连接 Nebula Graph 数据库。

使用云服务时,参考[《Nebula Graph Cloud Service 用户手册》](https://cloud-docs.nebula-graph.com.cn/cn/posts/manage-instances/dbaas-ug-connect-nebulastudio/ "点击进入 Nebula Graph Cloud Service 用户手册")

## 前提条件

在连接数据库前,您需要确认以下信息:

- 部署了 Nebula Graph 查询引擎的服务器 IP 地址以及服务所用端口。

- Nebula Graph 数据库登录账号信息,包括用户名和密码。
> **说明**:如果在部署 Nebula Graph 时已经启用了身份验证,并且已经创建了不同角色的用户,您只能使用被分配到的账号和密码登录数据库。如果未启用身份验证,您可以使用默认用户名(`user`)和默认密码(`password`)登录数据库。关于启用身份验证,参考 [Nebula Graph 用户手册](https://docs.nebula-graph.com.cn/ "点击进入 Nebula Graph 用户手册")
## 操作步骤

按以下步骤连接 Nebula Graph 数据库:

1. 在 Studio 的 **配置数据库** 页面上,输入以下信息:
- **Host**:填写 Nebula Graph 查询引擎的服务器 IP 地址及端口。格式为 `IP地址:3699`
> **说明**:如果 Nebula Graph 数据库与 Studio 部署在同一台服务器上,您必须在 **Host** 字段填写这台服务器的真实 IPv4 地址。
- **用户名****密码**:根据 Nebula Graph 的身份验证设置填写登录账号和密码。
- 如果未启用身份验证,可以填写默认用户名 `user` 和默认密码 `password`
- 如果已启用身份验证,但是未创建账号信息,您只能以 GOD 角色登录,必须填写 `root` 及对应的密码 `nebula`
- 如果已启用身份验证,同时又创建了不同的用户并分配了角色,不同角色的用户使用自己的账号和密码登录。

![显示 Nebula Graph Studio 界面,表示连接成功](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-002.png "Nebula Graph Studio 连接成功")
2. 完成设置后,点击 **连接** 按钮。
如果您能看到如下图所示界面,表示您已经成功连接到 Nebula Graph 数据库。

![显示 Nebula Graph Studio 界面,表示连接成功](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-003.png "Nebula Graph Studio 连接成功")

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

## 后续操作

成功连接 Nebula Graph 数据库后,根据账号的权限,您可以选择执行以下操作:

- 如果您以拥有 GOD 或者 ADMIN 权限的账号登录,可以使用 **控制台** [创建 Schema](../quick-start/st-ug-create-schema.md) 或者 [使用 Schema 管理](../use-studio/manage-schema/st-ug-crud-space.md)
- 如果您以拥有 GOD、ADMIN、DBA 或者 USER 权限的账号登录,可以 [导入数据](../quick-start/st-ug-import-data.md) 或者使用 **控制台** 写入数据。
- 如果您以拥有 GOD、ADMIN、DBA、USER 或者 GUEST 权限的账号登录,可以使用 **控制台** 完成查询操作或者使用 **图探索** 完成图探索或数据分析。
56 changes: 56 additions & 0 deletions nebula-studio/install-configure/st-ug-install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# 安装 Studio

Studio 支持本地访问和云服务访问。本文主要描述如何在本地安装 Studio。

使用云服务访问时,您不需要安装 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 之前,您需要确认以下信息:

- Nebula Graph 服务已经部署并启动。详细信息,参考[《Nebula Graph 用户手册》](https://docs.nebula-graph.io/manual-EN/3.build-develop-and-administration/2.install/1.install-with-rpm-deb/ "点击前往 Nebula Graph 用户手册")
> **说明**:您可以使用多种方式部署并启动 Nebula Graph 服务。如果您刚开始使用 Nebula Graph,建议您使用 Docker Compose 部署 Nebula Graph。详细信息,参考 [使用 Docker Compose 部署 Nebula Graph](https://github.com/vesoft-inc/nebula-docker-compose/blob/master/README_zh-CN.md "点击前往 GitHub 网站")
>
- 在即将运行 Studio 的机器上安装并启动 Docker Compose。详细信息,参考 [Docker Compose 文档](https://docs.docker.com/compose/install/ "点击即进入 Docker 文档中心")

## 操作步骤

按以下步骤安装并运行 Studio:

1. 下载 Studio 安装包。

```bash
git clone https://github.com/vesoft-inc/nebula-web-docker
```

2. 切换到 `nebula-web-docker` 路径。

```bash
cd path/to/nebula-web-docker
```

3. 安装并启动 Studio。

```bash
docker-compose pull && docker-compose up
```

当屏幕返回以下信息时,表示 Studio 已经成功启动。

```bash
Creating docker_importer_1 ... done
Creating docker_client_1 ... done
Creating docker_web_1 ... done
Creating docker_nginx_1 ... done
```

4. 启动成功后,在浏览器地址栏输入 `http://localhost:7001`

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

![Nebula Graph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-001.png "Nebula Graph Studio 登录界面")

## 后续操作

进入 Studio 登录界面后,您需要连接 Nebula Graph 数据库。详细信息,参考 [连接数据库](st-ug-connect.md)
5 changes: 5 additions & 0 deletions nebula-studio/install-configure/st-ug-reset-connection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# 断开连接

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

在 Studio 连接到某个 Nebula Graph 数据库时,在工具栏中,选择 **设置** > **清除连接**。之后,如果浏览器上显示 **配置数据库** 页面,表示 Studio 已经成功断开了与 Nebula Graph 数据库的连接。
70 changes: 70 additions & 0 deletions nebula-studio/manage-schema/st-ug-crud-edge-type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# 操作边类型

在 Nebula Graph 数据库中创建图空间后,您可能需要创建边类型。您可以选择使用 **控制台** 或者 **Schema** 操作边类型。本文仅说明如何使用 **Schema** 操作边类型。

## 支持版本

Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版本更新](../about-studio/st-ug-check-updates.md)

## 前提条件

在 Studio 上操作边类型之前,您必须确认以下信息:

- Studio 已经连接到 Nebula Graph 数据库。
- 图空间已经创建。
- 您当前登录的账号拥有 GOD、ADMIN 或者 DBA 的权限。

## 创建边类型

按以下步骤使用 **Schema** 创建边类型:

1. 在工具栏中,点击 **Schema** 页签。
2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。
3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称切换图空间。
4. 点击 **边类型** 页签,并点击 **创建** 按钮。
5.**创建** 页面上,完成以下设置:

a. **名称**:按提示信息输入合规的边类型名称。本示例中,输入 `action`

b. (可选)如果边类型需要属性,在 **定义属性**面板的左上角,点击勾选框,并在展开的列表中,完成以下操作:
- 输入属性名称、数据类型和默认值。
- 如果一个边类型有多个属性,可以点击 **添加属性** 按钮,并定义属性。
- 如果要删除某个属性,在该属性所在行,点击 ![表示删除的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-020.png "删除") 图标。

c. (可选)边类型未设置索引时,您可以设置 TTL:在 **设置TTL**面板的左上角,点击勾选框,并在展开的列表中设置 `TTL_COL``TTL_DURATION` 参数信息。关于这两个参数的详细信息,参考 [TTL 配置](https://docs.nebula-graph.com.cn/manual-CN/2.query-language/4.statement-syntax/1.data-definition-statements/TTL/ "点击前往 Nebula Graph 网站")

6. 完成设置后,在 **对应的nGQL语句** 面板上,您能看到与上述配置等价的 nGQL 语句。
![定义边类型 action 的属性](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-022.png "定义边类型")

7. 确认无误后,点击 **+ 创建** 按钮。
如果边类型创建成功,**定义属性**面板会显示这个边类型的属性列表。

## 修改边类型

按以下步骤使用 **Schema** 修改边类型:

1. 在工具栏中,点击 **Schema** 页签。
2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。
3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称完成图空间切换。
4. 点击 **边类型** 页签,找到需要修改的边类型,并在 **操作** 列中,点击 ![表示修改的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-021.png "修改") 图标。
5.**编辑** 页面,您可以选择以下操作:
- 如果要修改属性:在 **定义属性** 面板上,找到需要修改的属性,在右侧点击 **编辑**,再修改属性的数据类型或者默认值。修改完成后,点击 **确认****取消**
- 如果要删除属性:在 **定义属性** 面板上,找到需要删除的属性,在右侧点击 **删除**,经确认后,删除属性。
- 如果要添加属性:在 **定义属性** 面板上,点击 **添加属性** 按钮,添加属性信息。
- 如果要修改 TTL:在 **设置TTL** 面板上,修改或 `TTL_COL``TTL_DURATION` 设置。
- 如果要删除所有已经配置的 TTL:在 **设置TTL** 面板的左上角,点击勾选框,取消选择。
- 如果要设置 TTL:在 **设置TTL** 面板的左上角,点击勾选框,开始设置 TTL。
6. 完成设置后,在 **对应的nGQL语句** 面板上,您能看到修改后的 nGQL 语句。

## 删除边类型

按以下步骤使用 **Schema** 删除边类型:

1. 在工具栏中,点击 **Schema** 页签。
2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。
3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称切换图空间。
4. 点击 **边类型** 页签,找到需要修改的边类型,并在 **操作** 列中,点击 ![表示删除的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png "删除") 图标。

## 后续操作

边类型创建成功后,您可以在 **控制台** 上逐条插入边数据,或者使用 **导入** 功能批量插入边数据。
Loading

0 comments on commit 4e29e16

Please sign in to comment.