Skip to content

Commit

Permalink
explorer removes dependence on studio (#2311)
Browse files Browse the repository at this point in the history
  • Loading branch information
cooper-lzy authored Nov 11, 2022
1 parent d940ffe commit 8d3fc93
Show file tree
Hide file tree
Showing 4 changed files with 149 additions and 10 deletions.
78 changes: 75 additions & 3 deletions docs-2.0/nebula-explorer/db-management/10.create-schema.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,79 @@
# Schema 管理

Explorer 支持界面化或者通过控制台命令方式管理 Schema。
Explorer 支持界面化方式管理 Schema。

在 Explorer 页面的右上方,单击![Schema_page](https://docs-cdn.nebula-graph.com.cn/figures/studio-nav-schema.png)进入 Schema 创建页面。
!!! Note

Explorer 的 Schema 功能同 Studio。详情参见[创建 Schema](../../nebula-studio/quick-start/st-ug-create-schema.md)
- 用户可以使用 Schema 草图功能图形化设计 Schema。详情参见 [Schema 草图](draft.md)。
- 用户可以在控制直接执行 nGQL 命令管理 Schema。

## 前提条件

- 账号拥有 GOD、ADMIN 或 DBA 权限。详情参见 [NebulaGraph 内置角色](../../7.data-security/1.authentication/3.role-list.md)

- 已经规划 Schema 的要素。

!!! Note

本示例已经创建图空间。如果账号拥有 GOD 权限,也可以在 **控制台** 或 **Schema** 上创建一个图空间。

## 入口

在顶部导航栏里,单击![Schema_page](https://docs-cdn.nebula-graph.com.cn/figures/studio-nav-schema.png) 图标。

## 创建图空间

1. 单击**创建图空间**

2. 设置参数。参数介绍参见 [CREATE SPACE](../../3.ngql-guide/9.space-statements/1.create-space.md)

3. 单击**创建**

## 创建标签/边类型

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

2. 单击**标签****边类型**页签,单击**创建**

3. 设置参数。参数介绍参见[CREATE TAG](../../3.ngql-guide/10.tag-statements/1.create-tag.md)[CREATE EDGE](../../3.ngql-guide/11.edge-type-statements/1.create-edge.md)

!!! Note

未设置索引时,用户才可以设置 TTL。详情参见 [TTL 配置](../../3.ngql-guide/8.clauses-and-options/ttl-options.md)。

4. 单击**创建**

**标签****边类型**列表里,可以执行修改和删除操作。

## 创建索引

!!! Note

- 创建索引前需要确保相关的 Tag 或 Edge type 已创建。
- 由于索引会影响写性能,建议首次导入大批量数据时,先导入数据,再创建索引并重建索引。详情参见[索引介绍](../../3.ngql-guide/14.native-index-statements/README.md)。

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

2. 单击**索引**页签,单击**创建**

3. 设置参数。参数介绍参见[CREATE INDEX](../../3.ngql-guide/14.native-index-statements/1.create-native-index.md)

!!! Note

索引属性的顺序会影响 `LOOKUP` 语句的查询结果。详情参见 [LOOKUP](../../3.ngql-guide/7.general-query-statements/5.lookup.md)。

4. 单击**创建**

**索引**列表里,可以重建索引或删除索引。

## 查看统计信息

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

2. 单击**统计**页签,单击**更新**

## 查看 Schema

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

2. 单击**查看 Schema**页签,单击**获取 Schema**
50 changes: 47 additions & 3 deletions docs-2.0/nebula-explorer/db-management/11.import-data.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,51 @@
# 数据导入

Explorer 支持界面化地将数据导入至 NebulaGraph 中。
Explorer 支持界面化地将 CSV 格式数据导入至 NebulaGraph 中。

在 Explorer 页面右上方,单击![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png)进入导入数据页面。
## 前提条件

Explorer 的导入数据功能同 Studio。详情参见[导入数据](../../nebula-studio/quick-start/st-ug-import-data.md)
- NebulaGraph 数据库里已经创建 Schema。

- CSV 文件符合 Schema 要求。

- 账号拥有 GOD、ADMIN 或 DBA 权限。详情参见 [NebulaGraph 内置角色](../../7.data-security/1.authentication/3.role-list.md)

## 入口

在顶部导航栏里,单击 ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) 图标。

## 操作步骤

### 上传文件

1. 选择的**上传文件**页签,单击**上传文件**按钮,选择需要的 CSV 文件。

!!! Note

一次可以选择多个 CSV 文件。

2. 上传结束后,可以在文件列表的 **操作** 列,单击 ![detail](https://docs-cdn.nebula-graph.com.cn/figures/detail.png) 图标预览文件内容。

### 导入数据

1. 选择**导入数据**页签,单击**创建导入任务**按钮,完成如下设置:

!!! caution

用户也可以单击**导入模版**,下载示例配置文件`example.yaml`,配置后再上传配置文件。配置方式与 [NebulaGraph Importer](../../nebula-importer/use-importer.md) 大致相同,但是所有文件路径仅保留文件名。并且请确保在导入配置文件之前已上传所有 CSV 数据文件。

- **图空间**:需要导入数据的图空间名称。
- **任务名称**:默认自动生成,可以修改。
- **批处理量**(可选):每批导入多少行数据。
- **关联点**:单击**绑定数据源** 按钮,在对话框中选择绑定文件并单击**确认**按钮。

-**vertices 1** 页签内的 `vertexID` 项中,单击 **Select CSV Index**,在弹出的对话框内为 VID 选择数据源。
- 单击**添加Tag**按钮,然后在新创建的**Tag**页签内单击**选择 Tag**,选择需要关联的 Tag。在显示的属性列表中,为属性选择数据源。

- **关联边**:与关联点的操作相同。

![导入任务](https://docs-cdn.nebula-graph.com.cn/figures/import_task_221111_cn.png)

2. 完成设置后,单击**导入**,输入 NebulaGraph 账号的密码并确认。

后可以在**导入数据**页签内查看日志、下载日志、下载配置文件、删除任务等操作。
2 changes: 1 addition & 1 deletion docs-2.0/nebula-explorer/db-management/draft.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Explorer 支持 Schema 草图功能。用户可以在画板上自行设计 Schem

## 入口

在顶部导航栏里,点击 ![Template](https://docs-cdn.nebula-graph.com.cn/figures/sketch_cion_221018.png) 图标。
在顶部导航栏里,单击 ![Template](https://docs-cdn.nebula-graph.com.cn/figures/sketch_cion_221018.png) 图标。

## 设计 Schema

Expand Down
29 changes: 26 additions & 3 deletions docs-2.0/nebula-explorer/db-management/explorer-console.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,31 @@
# 控制台

Explorer 的控制台功能允许用户手动输入 nGQL 语句,并可视化地呈现查询结果。
Explorer 的控制台功能允许用户手动输入 nGQL 语句,并可视化地呈现查询结果。本文介绍控制台的界面。

在 Explorer 页面的右上方,单击![console](https://docs-cdn.nebula-graph.com.cn/figures/nav-console2.png)进入控制台页面。
## 入口

Explorer 控制台功能同 Studio。详情,参见[控制台](../../nebula-studio/quick-start/st-ug-console.md)
在顶部导航栏里,单击 ![console](https://docs-cdn.nebula-graph.com.cn/figures/nav-console2.png) 图标

## 页面介绍

![控制台界面截图](https://docs-cdn.nebula-graph.com.cn/figures/console_ovewview_221111_cn.png)

下表列出了控制台界面上的各种功能。

| 编号 | 功能 | 说明 |
| :-- | :--| :-- |
| 1 | 选择图空间 | 选择执行 nGQL 的图空间。不支持在控制台执行`USE <space_name>`语句切换图空间。 |
| 2 | 收藏夹 | 点击![save](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-save.png) 按钮,展开收藏夹,点击其中一个语句,输入框中即自动输入该语句。 |
| 3 | 历史清单 | 点击 ![history](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-history.png) 按钮,在语句运行记录列表里,点击其中一个语句,输入框中即自动输入该语句。列表里提供最近 15 次语句运行记录。 |
| 4 | 清空输入框 | 点击 ![clear](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-clear.png) 按钮,清空输入框中已经输入的内容。 |
| 5 | 运行 | 在输入框中输入 nGQL 语句后,点击 ![play](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-play.png) 按钮即开始运行语句。 |
| 6 | 保存为模板 | 将输入框中输入的 nGQL 语句保存为模板。详情参见[查询语句模板](ngql-template.md)|
| 7 | 输入框 | 输入 nGQL 语句的区域。可以同时输入多个语句按顺序执行,语句之间以 `;` 分隔。支持用`//`添加注释。 |
| 8 | 自定义参数展示 | 点击 ![查询](https://docs-cdn.nebula-graph.com.cn/figures/down.png)按钮可展开查看自定义参数,用于参数化查询。详情信息可见[管理参数](../../nebula-console.md)|
| 9 | 语句运行状态 | 运行 nGQL 语句后,这里显示语句运行状态。如果语句运行成功,语句以绿色显示。如果语句运行失败,语句以红色显示。 |
| 10 | 添加到收藏夹 | 点击![save](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-save.png) 按钮,将语句存入收藏夹中,已收藏的语句该按钮以黄色展示。|
| 11 | 导出 CSV 文件或 PNG 格式图片 | 运行 nGQL 语句返回结果后,返回结果为表格形式时,点击 ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) 按钮即能将结果以 CSV 文件的形式导出。</br>切换到可视化窗口,点击 ![download](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-download.png) 按钮即能将结果以 CSV 文件或 PNG 图片的形式导出。 |
| 12 | 展开/隐藏执行结果 | 点击 ![up](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-up.png) 按钮,隐藏此条 nGQL 语句返回的结果。 |
| 13 | 关闭执行结果 | 点击 ![close](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-close.png)按钮,关闭此条 nGQL 语句返回的结果。 |
| 14 | 表格窗口 | 显示语句运行结果。如果语句会返回结果,窗口会以表格形式呈现返回的结果。 |
| 15 | 可视化窗口 | 显示语句运行结果。如果语句会返回完整的点边结果,窗口会以可视化形式呈现返回的结果。点击右方 ![expand](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-back.png)按钮,展开数据概览面板。 |

0 comments on commit 8d3fc93

Please sign in to comment.