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

release studio 3.9.0 #2451

Merged
merged 16 commits into from
Feb 1, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
4 changes: 2 additions & 2 deletions docs-2.0-en/nebula-studio/quick-start/st-ug-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The following table lists the functions on the console page.
| 14 | **Table** window | Display the results from running the nGQL statement in a table. |
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved
| 15 | **Plan** window | Display the execution plan. If an `EXPLAIN` or `PROFILE` statement is executed, the window presents the execution plan in visual form. See the description of the execution plan below. |
| 16 | **Graph** window | Display the results from running the nGQL statement in a graph if the results contain complete vertex and edge information. Click the ![expand](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-back.png) button on the right to view the overview panel. |
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved
| 17 | AI Assistant | You can chat with an AI assistant to convert natural language instructions into nGQL query statements and then copy the nGQL statements into the input box with one click. This feature needs to be set up and enabled in the [system settings](../system-settings.md) before use.</br>Note: The schema information of the current graph space is sent to the large language model when you chat with the assistant. Please pay attention to information security.|
| 17 | AI Assistant | You can chat with an AI assistant to convert natural language instructions into nGQL query statements and then copy the nGQL statements into the input box with one click. This feature needs to be set up and enabled in the [system settings](../system-settings.md) before use.</br>Note: </br>The schema information of the current graph space is sent to the large language model when you chat with the assistant. Please pay attention to information security.</br>The toggle **text2match** is used to switch between normal Q&A and query Q&A. The query Q&A can convert the input natural languages to nGQL query statements.|
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved

## Execution plan descriptions

Expand All @@ -41,7 +41,7 @@ The Studio can display the execution plan of the statement. The execution plan d
|No.|Description|
|:---|:---|
|1 |An `EXPLAIN` or `PROFILE` statement.|
|2 |The operators used by the execution plan, which are sorted according to the execution duration. The top three operators are labeled as red, orange, and yellow, respectively. Clicking on an operator directly selects the corresponding operator in the operator execution flow and displays the operator information.|
|2 |The operators used by the execution plan, which are sorted according to the execution duration. The top three operators are labeled as red, orange, and yellow, respectively. Clicking on an operator directly selects the corresponding operator in the operator execution flow and displays the operator information.</br>Note: The `PROFILE` statement actually executes the statement, and the actual execution durations can be obtained and sorted. The `EXPLAIN` statement does not actually execute the statement, and the execution durations of all operators are considered the same and are labeled as red.|
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved
|3 |The operator execution flow. For each operator, the following information is displayed: in-parameters, out-parameters, and total execution duration.</br>The `Select`, `Loop`, `PassThrough`, and `Start` operators have independent color schemes.</br>The arrows show the direction of data flow and the number of rows. The thicker the arrows, the more rows of data.</br> You can click on the operator to check the details of the operator on the right side.|
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved
|4 |The details of the operator, divided into `Profiling data` and `Operator info`.</br>`Profiling data` shows the performance data of the operator, including the rows of data received, the execution time, the total time, etc.</br>`Operator info` shows the detailed operation information of the operator.|
|5 |Zoom out, zoom in, or reverse the execution flow.|
Expand Down
4 changes: 2 additions & 2 deletions docs-2.0-zh/nebula-studio/quick-start/st-ug-console.md
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved
cooper-lzy marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
| 14 | 表格窗口 | 在表格中显示语句的运行结果。 |
| 15 | 执行计划窗口 | 显示执行计划。如果执行的是`EXPLAIN`或`PROFILE`语句,窗口会以可视化形式呈现执行计划。如何理解执行计划请参见下文说明。 |
| 16 | 可视化窗口 | 显示语句运行结果。如果结果包含完整的点边信息,窗口会以可视化形式呈现返回的结果。点击右方 ![expand](https://docs-cdn.nebula-graph.com.cn/figures/studio-btn-back.png)按钮,展开数据概览面板。 |
| 17 | AI 查询语句助手 | 用户可以和助手聊天,将自然语言转换为 nGQL 查询语句,并支持一键复制 nGQL 语句到输入框中。使用前需要在[系统设置](../system-settings.md)里设置和启用该功能。</br>注意:和助手交互时,会将当前图空间的 Schema 信息发送给大规模语言模型,请注意信息安全。|
| 17 | AI 查询语句助手 | 用户可以和助手聊天,将自然语言转换为 nGQL 查询语句,并支持一键复制 nGQL 语句到输入框中。使用前需要在[系统设置](../system-settings.md)里设置和启用该功能。</br>注意:</br>和助手交互时,会将当前图空间的 Schema 信息发送给大规模语言模型,请注意信息安全。</br>开关**text2match**用于切换普通问答和查询问答。查询问答可以输入自然语言转换为 nGQL 查询语句。|

## 执行计划说明

Expand All @@ -41,7 +41,7 @@ Studio 可以展示语句的执行计划,界面说明如下。
|序号|说明|
|:---|:---|
|1 |`EXPLAIN`或`PROFILE`语句。|
|2 |执行计划涉及的算子并根据执行耗时排序。耗时前三的算子分别标记为为红色、橘红色和黄色。单击算子可以直接选中执行流程中的对应算子并展示算子信息。|
|2 |执行计划涉及的算子并根据执行耗时排序。耗时前三的算子分别标记为为红色、橘红色和黄色。单击算子可以直接选中执行流程中的对应算子并展示算子信息。</br>注意:`PROFILE`语句会实际执行语句,才能得到实际的耗时并排序。`EXPLAIN`不会执行语句,所有算子耗时视为相同并标记为红色。|
|3 |算子执行流程。每个算子都会显示该算子的入参、出参和耗时。</br>`Select`、`Loop`、`PassThrough`和`Start`算子有独立配色。</br>箭头展示数据流向和行数,行数越多,箭头越粗。</br>单击算子会在右侧展示算子的详细信息。|
|4 |算子详细信息。分为`Profiling data`和`Operator info`两部分。</br>`Profiling data`展示算子的性能数据,包括接收到的数据行数、执行耗时、总耗时等。</br>`Operator info`展示算子的具体操作信息。|
|5 |放大或缩小界面,还可以倒序显式算子执行流程。|
Expand Down