Skip to content

Commit

Permalink
fixed format (#139)
Browse files Browse the repository at this point in the history
  • Loading branch information
oldLady344 committed Dec 31, 2020
1 parent 8d9610b commit dfa275a
Show file tree
Hide file tree
Showing 13 changed files with 147 additions and 36 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
- [English Document](https://docs.nebula-graph.io/)
- 客户端 (TODO)
- [Nebula Graph Cloud Service](https://cloud-docs.nebula-graph.com.cn/cn/posts/toc/dbaas-ug-toc/)
- [Nebula Graph Studio](https://github.com/vesoft-inc/nebula-docs-cn/tree/master/nebula-studio)
- [Nebula Graph Studio](https://docs.nebula-graph.com.cn/nebula-studio/about-studio/st-ug-what-is-graph-studio/)

## 贡献文档

Expand Down
2 changes: 1 addition & 1 deletion docs/nebula-studio/about-studio/st-ug-limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Nebula Graph 版本支持

目前 Studio 仅支持 Nebula Graph v1.1.0 及以下版本,不支持 Nebula Graph v2.0.0-alpha
目前 Studio v1.x 仅支持 Nebula Graph v1.x,不支持 Nebula Graph v2.x

## 系统架构

Expand Down
1 change: 1 addition & 0 deletions docs/nebula-studio/deploy-connect/st-ug-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
- 如果已启用身份验证,同时又创建了不同的用户并分配了角色,不同角色的用户使用自己的账号和密码登录。

![Nebula Graph Studio 的登录页面](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-002.png "配置数据库")

2. 完成设置后,点击 **连接** 按钮。
如果您能看到如下图所示的界面,表示您已经成功连接到 Nebula Graph 数据库。

Expand Down
14 changes: 14 additions & 0 deletions docs/nebula-studio/manage-schema/st-ug-crud-edge-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,23 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版
在 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`
Expand All @@ -44,25 +50,33 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版
按以下步骤使用 **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 "删除") 图标。

## 后续操作
Expand Down
14 changes: 13 additions & 1 deletion docs/nebula-studio/manage-schema/st-ug-crud-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,13 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版
按以下步骤使用 **Schema** 创建索引:

1. 在工具栏中,点击 **Schema** 页签。

2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。

3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称切换图空间。

4. 点击 **索引** 页签,再点击 **创建** 按钮。

5.**创建** 页面上,完成以下设置:

a. **索引类型**:确认或修改索引类型,即 **标签** 或者 **边类型**。本示例中选择 **边类型**
Expand All @@ -34,27 +38,35 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版

d. **索引属性**:点击 **添加**,在 **选择关联的属性** 列表里选择需要索引的属性,并点击 **确定** 按钮。如果需要关联多个属性,重复这一步操作。您可以按界面提示重排索引属性的顺序。本示例中选择 `label``actionId`
> **说明**:索引属性的顺序会影响 `LOOKUP` 语句的查询结果。详细信息,参考 [《nGQL 用户手册》](https://docs.nebula-graph.com.cn/manual-CN/2.query-language/4.statement-syntax/2.data-query-and-manipulation-statements/lookup-syntax/#faq "点击前往 Nebula Graph 网站")
6. 完成设置后,在 **对应的 nGQL**面板,您能看到与上述配置等价的 nGQL 语句。
![为边类型 action 创建索引](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-023.png "创建索引")

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

## 查看索引

按以下步骤使用 **Schema** 查看索引:

1. 在工具栏中,点击 **Schema** 页签。

2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。

3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称切换图空间。

4. 点击 **索引** 页签,在列表左上方,选择需要查看的索引类型。

5. 在列表中,找到需要查看的索引,点击索引所在行。界面上即列出索引相关的所有属性。

## 删除索引

按以下步骤使用 **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 "删除") 图标。
10 changes: 7 additions & 3 deletions docs/nebula-studio/manage-schema/st-ug-crud-space.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版
按以下步骤使用 **Schema** 创建图空间:

1. 在工具栏里,点击 **Schema** 页签。

2. 在图空间列表上方,点击 **+ 创建** 按钮。

3.**创建** 页面,完成以下配置:

a. **名称**:指定图空间名称,本示例中设置为 `mooc_actions`。不可与已有的图空间名称重复。名称命名规则,参考[《nGQL 用户手册》](https://docs.nebula-graph.com.cn/manual-CN/2.query-language/3.language-structure/schema-object-names/ "点击前往 Nebula Graph 网站")
Expand All @@ -29,9 +31,9 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版

**对应的nGQL语句** 面板上,您能看到上述设置对应的 nGQL 语句。如下所示:

```ngql
CREATE SPACE mooc_actions (partition_num = 10, replica_factor = 1, charset = utf8, collate = utf8_bin)
```
```ngql
CREATE SPACE mooc_actions (partition_num = 10, replica_factor = 1, charset = utf8, collate = utf8_bin)
```

4. 配置确认无误后,点击 **创建** 按钮。
如果页面回到 **图空间列表**,而且列表中显示刚创建的图空间信息,表示图空间创建成功。
Expand All @@ -43,9 +45,11 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版
按以下步骤使用 **Schema** 删除图空间:

1. 在工具栏里,点击 **Schema** 页签。

2. 在图空间列表里,找到需要删除的图空间,并在 **操作** 列中,点击 ![表示删除的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-017.png "删除") 图标。

![在图空间列表中删除指定的图空间](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-016.png "删除图空间")

3. 在弹出对话框中,确认信息,并点击 **确认** 按钮。
删除成功后,页面回到 **图空间列表**

Expand Down
13 changes: 13 additions & 0 deletions docs/nebula-studio/manage-schema/st-ug-crud-tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,13 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版
按以下步骤使用 **Schema** 创建标签:

1. 在工具栏中,点击 **Schema** 页签。

2.**图空间列表** 中,找到图空间,点击图空间名称或者在 **操作** 列中点击 ![表示设置的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-018.png "设置") 图标。

3.**当前图空间** 里确认图空间名称。您也可以通过选择图空间名称切换图空间。

4. 点击 **标签** 页签,并点击 **创建** 按钮。

5.**创建** 页面上,完成以下设置:

a. **名称**:按提示信息输入合规的标签名称。本示例中,输入 `course`
Expand All @@ -34,6 +38,7 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版
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 语句。

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

Expand All @@ -42,25 +47,33 @@ Studio v1.2.0-beta 及以后版本。请更新版本,详细操作参考 [版
按以下步骤使用 **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** 面板上,修改 `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 "删除") 图标。

## 后续操作
Expand Down
31 changes: 24 additions & 7 deletions docs/nebula-studio/quick-start/st-ug-create-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,11 @@
在 Studio 上创建 Schema 之前,您需要确认以下信息:

- Studio 已经连接到 Nebula Graph 数据库。

- 您的账号拥有 GOD、ADMIN 或 DBA 权限。详细信息,参考 [Nebula Graph 内置角色](https://docs.nebula-graph.com.cn/manual-CN/3.build-develop-and-administration/4.account-management-statements/built-in-roles/)

- 您已经规划好了 Schema 的要素。

- 已经创建了图空间。
> **说明**:本示例假设已经创建了图空间。如果您的账号拥有 GOD 权限,也可以在 **控制台****Schema** 上创建一个图空间。
Expand All @@ -20,32 +23,46 @@
按以下步骤使用 **Schema** 创建 Schema:

1. 创建标签。详细信息,参考 [操作标签](../manage-schema/st-ug-crud-tag.md)

2. 创建边类型。详细信息,参考 [操作边类型](../manage-schema/st-ug-crud-edge-type.md)

## 使用控制台创建 Schema

按以下步骤使用 **控制台** 创建 Schema:

1. 在工具栏里,点击 **控制台** 页签。

2.**当前Space** 中选择一个图空间。在本示例中,选择 **mooc_actions**

![在 当前Space 中选择一个图空间](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-007.png "选择图空间")

3. 在命令行中,依次输入以下语句,并点击 ![表示运行的图标](https://docs-cdn.nebula-graph.com.cn/nebula-studio-docs/st-ug-008.png "Run 图标") 图标。

```nGQL
CREATE TAG user (userId int); -- 创建标签 user,带有 1 个属性
CREATE TAG course (courseId int, courseName string); -- 创建标签 course,带有两个属性
CREATE EDGE action (actionId int, duration double, label bool, feature0 double, feature1 double, feature2 double, feature3 double); -- 创建边类型,带有 7 个属性
```
-- 创建标签 user,带有 1 个属性
CREATE TAG user (userId int);
-- 创建标签 course,带有两个属性
CREATE TAG course (courseId int, courseName string);
-- 创建边类型,带有 7 个属性
CREATE EDGE action (actionId int, duration double, label bool, feature0 double,
feature1 double, feature2 double, feature3 double);
```

至此,您已经完成了 Schema 创建。您可以运行以下语句查看标签与边类型的定义是否正确、完整。

```nGQL
SHOW TAGS; -- 列出当前图空间中所有标签
SHOW EDGES; -- 列出当前图空间中所有边类型
-- 列出当前图空间中所有标签
SHOW TAGS;
-- 列出当前图空间中所有边类型
SHOW EDGES;
-- 查看每种标签和边类型的结构是否正确
DESCRIBE TAG user;
DESCRIBE TAG course;
DESCRIBE EDGE action; -- 查看每种标签和边类型的结构是否正确
DESCRIBE EDGE action;
```

## 后续操作
Expand Down
Loading

0 comments on commit dfa275a

Please sign in to comment.