Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update sql editor #260

Merged
merged 1 commit into from
Feb 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ MatrixOne Cloud 支持使用 Web 页面访问数据库,我们将此访问平

- **数据库:**在菜单栏中点击**数据库**,您可以查看和操作数据对象。详细使用方法请参考[相关文档](../../../Monitor/Data-Monitoring/)。

- **查询 -> 查询编辑器:**在菜单栏中依次点击**查询 -> 查询编辑器**,可以进行 SQL 的编辑和执行。详细使用方法请参考[查询编辑器文档](../../../Data-Explore/sql-editor/)。
- **SQL 编辑器:**在菜单栏中点击 **SQL 编辑器**,可以进行 SQL 的编辑和执行。详细使用方法请参考 [SQL 编辑器文档](../../../Data-Explore/sql-editor/)。

- **查询 -> 查询历史:**在菜单栏中依次点击**查询 -> 查询历史**,您可以查看历史 SQL 查询的执行状态。详细使用方法请参考[查询分析文档](../../../Data-Explore/query-anlysis/query_profile/)。
- **查询历史:**在菜单栏中点击**查询历史**,您可以查看历史 SQL 查询的执行状态。详细使用方法请参考[查询分析文档](../../../Data-Explore/query-anlysis/query_profile/)。

希望这些操作指南能够帮助您顺利使用 MatrixOne 数据库管理平台。如果您有任何疑问或需要进一步的帮助,请查看我们的文档或联系支持团队。
Original file line number Diff line number Diff line change
Expand Up @@ -55,25 +55,33 @@ MatrixOne 现在支持通过以下几种数据库客户端工具的方式连接

3. 点击 **Save** 保存设置。

<img src="https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/navicat-new-fillin.png" style="zoom: 40%;" />
<div align="center">
<img src=https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/navicat-new-fillin.png width=60% heigth=60%/>
</div>

4. 双击左侧数据库目录中的 **MOCloud**,图标点亮,连接成功。

5. 连接到 MatrixOne Cloud 后,在左侧数据库目录栏,你将看到 6 个默认系统数据库:

<img src="https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/navicat-4-databases.png" style="zoom: 40%;" />
<div align="center">
<img src=https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/navicat-4-databases.png width=60% heigth=60%/>
</div>

右侧窗口可查看有关此连接的基本信息:

<img src="https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/navicat-database-msg.png" style="zoom: 40%;" />
<div align="center">
<img src=https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/navicat-database-msg.png width=40% heigth=40%/>
</div>

## 通过 DBeaver 连接 MatrixOne Cloud 服务

1. 下载安装 [DBeaver](https://dbeaver.io/download/)。

2. 安装 DBeaver 完成后,打开 DBeaver,点击左上角**连接**图标,在弹窗中选择 **MySQL**,点击 **Next**。

<img src="https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/docs/develop/dbeaver-mysql.png" style="zoom: 40%;" />
<div align="center">
<img src=https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/docs/develop/dbeaver-mysql.png width=60% heigth=60%/>
</div>

在 **Connect to a database** 窗口的 **Main** 区中填写如下参数:

Expand All @@ -86,20 +94,30 @@ MatrixOne 现在支持通过以下几种数据库客户端工具的方式连接
!!! note
初次连接可以将 Database 选项填写系统库 `system` 方便连接,后续可根据需求自行修改。

<img src="https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/dbeaver-new-fillin.png" style="zoom: 40%;" />
<div align="center">
<img src=https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/dbeaver-new-fillin.png width=60% heigth=60%/>
</div>

并点击**连接详情**修改连接名称为 **MOCloud**。

<img src="https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/dbeaver-new-edit-name.png" style="zoom: 40%;" />
<div align="center">
<img src=https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/dbeaver-new-edit-name.png width=60% heigth=60%/>
</div>

3. 双击左侧目录中的 **MatrixOne Cloud**,连接 MatrixOne Cloud 服务。你可以在左侧目录树中看到默认的三个系统数据库:

<img src="https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/dbeaver-3-dbs.png" style="zoom: 40%;" />
<div align="center">
<img src=https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/dbeaver-3-dbs.png width=60% heigth=60%/>
</div>

4. 默认情况下,DBeaver 中不展示视图。如需显示完整的系统数据库,你可以右键单击 **MatrixOne**,选择 **Connection view** 并打开 **Show system objects**:

<img src="https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/dbeaver-show-dbobj.png" style="zoom: 40%;" />
<div align="center">
<img src=https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/dbeaver-show-dbobj.png width=60% heigth=60%/>
</div>

设置完成后,你将看到五个系统数据库。

<img src="https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/dbeaver-5-dbs.png" style="zoom: 40%;" />
<div align="center">
<img src=https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/connect/dbeaver-5-dbs.png width=60% heigth=60%/>
</div>
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,25 @@

2. 在 IDEA 中新建 Java 名称为 **testJDBC** 的项目并选择在 **Build System** 中选择 **Maven** 作为构建系统,点击 **Create**。

![JDBC create project](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/docs/develop/JDBC_connect/JDBC-create-project.png)
<div align="center">
<img src=https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/docs/develop/JDBC_connect/JDBC-create-project.png width=60% heigth=60%/>
</div>

3. 点击 **File > Project Structure**,进入到 **Project Setting**,点选 **Library**,并点击 **+** 按钮,添加 **From Maven**。

![JDBC project structure](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/docs/develop/JDBC_connect/JDBC-project-structure.png)
<div align="center">
<img src=https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/docs/develop/JDBC_connect/JDBC-project-structure.png width=40% heigth=40%/>
</div>

![JDBC add library](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/docs/develop/JDBC_connect/JDBC-from-maven.png)
<div align="center">
<img src=https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/docs/develop/JDBC_connect/JDBC-from-maven.png width=60% heigth=60%/>
</div>

4. 输入框中输入 **mysql-connector-java** 搜索整个库,选择 **mysql:mysql-connector-java:8.0.30**,应用到本项目中。

![JDBC add driver](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/docs/develop/JDBC_connect/JDBC-add-driver.png)
<div align="center">
<img src=https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/docs/develop/JDBC_connect/JDBC-add-driver.png width=60% heigth=60%/>
</div>

5. 修改 **src/main/java/org/example/Main.java** 中的默认 Java 源代码。如下面的代码示例中所示,这段代码使用连接地址和凭据创建连接。连接到 MatrixOne 后,你可以使用 Java 语言对 MatrixOne 数据库和表进行操作。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@

1. 登录到 MatrixOne Cloud 实例管理平台。选择目标实例,然后点击**通过云平台连接**以访问 MatrixOne Cloud 数据库管理平台。

2. 在 MatrixOne Cloud 数据库管理平台中,找到左侧菜单栏中的**查询**,然后选择**查询历史**模块。点击以进入 SQL 查询历史页面。
2. 在 MatrixOne Cloud 数据库管理平台中,找到左侧菜单栏中的**查询历史**模块。点击以进入 SQL 查询历史页面。

在此页面,您可以设置特定筛选条件,如数据库、状态、查询类型,以及更多的筛选条件,如 SQL 文本、执行时间、时间范围等,以缩小查询范围,快速定位到特定条件下的 SQL 查询记录。点击**搜索**按钮,以筛选出符合特定条件的查询记录列表。
!!! note
当开启 SQL 文本作为筛选条件时,请注意区分大小写。

![查询历史页面](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/src_history.png)
![查询历史页面](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/src_history_1.png)

Queries 列表支持显示多个字段,包括 SQL 文本、查询 ID、执行时间、状态、查询类型、开始时间。
Queries 列表支持显示多个字段,包括 SQL 文本、查询 ID、执行时间、状态、SQL 类型、开始时间、用户和 CU

在 **SQL 文本**列您可以看到部分 SQL 前面会有 "/ *x queries*/" 的标志,这是因为记录查询历史的表信息量较大。为了提高查询速度,我们将超轻量级的 tp sqls 按以下规则聚合记录:

Expand All @@ -28,17 +28,17 @@ Queries 列表支持显示多个字段,包括 SQL 文本、查询 ID、执行

作为 MatrixOne 的云上数据库管理平台,MatrixOne Cloud 为用户提供了数据库信息的界面化展示,在实例平台上的任何操作获得的信息都是从数据库中获取的,也就是说在平台的所有操作都会产生 SQL 从而消耗 CU。但是由于考虑到用户可能更关心业务方面的 SQL,为了给用户更好的观测体验,平台上非用户操作的 SQL(除了 SQL Editor 执行的 SQL)在查询历史中默认是不显示的。对于生产实例来说,平台上非用户操作产生的 CU 也是收费的,可在筛选项中开启**非用户执行**选项来查看这部分 SQL 的详细信息。

![](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/nouser.png)
![](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/src_history_2.png)

## SQL 查询详情

在列表中,点击 SQL 文本内容,即可进入 SQL 查询详情页。在此页面,您可以详细查看特定 SQL 查询的执行时间、起止时间、事务 ID、会话 ID、CU 消耗、SQL 查询语句内容等详细信息,同时,您也可以查看特定 SQL 查询的查询结果,点击**下载**按钮以导出完整的查询结果。

![查询详情页面](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/query_history-1.png)
![查询详情页面](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/src_history_3.png)

需要注意的是,对于非在平台**查询编辑器**执行的 SELECT 语句,只保存以 `/* cloud_user */` 和 `/* save_result */` 固定开头的 SELECT 语句的查询结果,当不带上述 hint 时,Query 将不会显示详细的查询结果,如下图所示:
需要注意的是,对于非在平台 **SQL 编辑器**执行的 SELECT 语句,只保存以 `/* cloud_user */` 和 `/* save_result */` 固定开头的 SELECT 语句的查询结果,当不带上述 hint 时,Query 将不会显示详细的查询结果,如下图所示:

![](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/query_history-2.png)
![](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/src_history_4.png)

若想了解更多 MatrixOne 对于保存查询结果的支持,请查看[保存查询结果支持](https://docs.matrixorigin.cn/1.1.0/MatrixOne/Reference/Variable/system-variables/save_query_result/#_2)。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ MatrixOne 查询优化器对输入的 SQL 查询语句通过**执行计划**而

在查询历史中找到您想了解的 Query,这里我们以系统自带的 TPCH10G 数据集的 Q1 为例,如下图所示:

![Alt text](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/history_1.png)
![Alt text](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/history-1.png)

## 查看该 Query 的查询分析

点击进入这条 Query 的查询详情界面,我们可以同时看到它的查询分析(Query Profile)界面,如下图所示:

![Alt text](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/history_2.png)
![Alt text](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/history-2.png)

该界面展示了 TPCH Q1 的整个执行过程,总共分为了 4 个算子:表扫描 (Table Scan),聚合 (Aggregate),排序 (Sort) 及投影 (Project)。

Expand All @@ -39,7 +39,7 @@ MatrixOne 查询优化器对输入的 SQL 查询语句通过**执行计划**而

如果我们再选中点击 Table Scan 算子方块,我们将看到 Table Scan 算子执行的更多细节,如下图:

![Alt text](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/history_3.png)
![Alt text](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/history-3.png)

在该案例中我们可以看到 Table Scan 算子执行的过程中选中的是 18 个列中的 7 个 `(l_quantity, l_extendedprice, l_discount, l_tax, l_returnflag, l_linestatus, l_shipdate)`,另外还包含了一个过滤的条件 `(lineitem.l_shipdate <= 1998-08-11)`。

Expand Down
14 changes: 7 additions & 7 deletions docs/MatrixOne-Cloud/Data-Explore/sql-editor.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# **SQL 编辑器**

查询编辑器是 MatrixOne cloud 平台非常重要的一个工具,你可以通过在线 SQL 编辑器,进行 SQL 语句的快速编写、执行、结果查看,还可以将常用的 SQL 语句保存在 WorkBook 中,方便后续使用、参考和对比。
SQL 编辑器是 MatrixOne cloud 平台非常重要的一个工具,你可以通过在线 SQL 编辑器,进行 SQL 语句的快速编写、执行、结果查看,还可以将常用的 SQL 语句保存在 WorkBook 中,方便后续使用、参考和对比。

本篇文档将指导你如何通过 MatrixOne Cloud 内置的查询编辑器(SQL Editor)进行在线 SQL 查询与数据探索。
本篇文档将指导你如何通过 MatrixOne Cloud 内置的 SQL 编辑器(SQL Editor)进行在线 SQL 查询与数据探索。

## 打开 SQL 编辑器

登录 MatrixOne Cloud 实例管理平台,选择目标实例 > 通过云平台连接,进入 MatrixOne Cloud 数据库管理平台,在左侧菜单栏中找到查询 > 查询编辑器模块,点击即可进入查询编辑器页面
登录 MatrixOne Cloud 实例管理平台,选择目标实例 > 通过云平台连接,进入 MatrixOne Cloud 数据库管理平台,在左侧菜单栏中找到 SQL 编辑器模块,点击即可进入 SQL 编辑器页面

![Alt text](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/image.png)
SQL 编辑器模块的页面由 3 部分构成。

查询编辑器模块的页面由 3 部分构成。
![Alt text](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/sqleditor-1.png)

- **左侧区域**:显示当前实例已有的数据库表和 Workbook,你可以快速查看和复制所关注的数据库名、表名、列名和已保存在 Workbook 中的 SQL 语句。

Expand Down Expand Up @@ -39,7 +39,7 @@ MatrixOne Cloud 在线数据导入支持两种导入方式:导入样例数据

**从 Database 中查看和选择库表**

在查询编辑器中进行 SQL 语句编写过程中,开发者经常需要查看目标库表中的数据结构和数据类型,提升 SQL 语句编写的效率和准确性。
在 SQL 编辑器中进行 SQL 语句编写过程中,开发者经常需要查看目标库表中的数据结构和数据类型,提升 SQL 语句编写的效率和准确性。

![Alt text](https://community-shared-data-1308875761.cos.ap-beijing.myqcloud.com/artwork/mocdocs/sqleditor/image-4.png)

Expand All @@ -50,7 +50,7 @@ MatrixOne Cloud 在线数据导入支持两种导入方式:导入样例数据
右侧 SQL 编辑区域上方的下拉列表用于数据库选择,你可以在下拉列表中查看和选择目前 SQL 查询使用的数据库。选择数据库后,SQL 语句中可以不包括 dbname 执行,相当于已执行 `use database` 语句。

!!! note
当你在查询编辑器中重新编辑并执行了一条新的 `use database` 语句且成功后,刷新左侧的 Database 树列表,右侧上方的下拉框中数据库选项将同步切换。
当你在 SQL 编辑器中重新编辑并执行了一条新的 `use database` 语句且成功后,刷新左侧的 Database 树列表,右侧上方的下拉框中数据库选项将同步切换。

进一步输入想要查询的 SQL 语句,点击执行按钮,MatrixOne Cloud 将直接在线执行对应 SQL 请求。

Expand Down
2 changes: 1 addition & 1 deletion docs/MatrixOne-Cloud/Get-Started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@

### 2. 查询 TPC-H 数据集

- 在菜单栏中点击并进入**查询 > 查询编辑器**页面。
- 在菜单栏中点击并进入 **SQL 编辑器**页面。
- 在编辑器上方的数据库下拉框中选择 **mo_sample_data_tpch_sf1**。
- 在**快捷互动**窗口的**导入数据**中点击**试一试**,将其中的查询语句复制到编辑器中,然后点击**执行**执行查询。

Expand Down
Loading