TigerGraph文档
2.4
Search…
⌃K

编写查询

在编写查询页面中,你可以设计并执行自己的查询。该过程将使用由TigerGraph开发的强大图查询语言—— GSQL。
编写查询页面由上下两个部分组成
  1. 1.
    查询编写区
  2. 2.
    结果输出、日志和可视化图形区

查询编写区

查询编写区又分为左右两块:左侧的部分用于选择需要编辑的查询,右侧更大的区域则用于显示被选中查询的具体代码。你可以在这个面板中编辑、保存、删除、安装或执行一个查询。查询编辑器会根据GSQL语言的语法为查询代码自动赋予特定的格式,同事也会进行实时的语法检查。
在查询编写区的上方工具栏中有五个按钮,它们分别是:
  • 扩展/折叠 : 将查询编辑器扩展至全屏模式或从全屏模式退出。按钮本身会依据当前查询编辑器所处的状态而变化。
  • 保存 : 保存当前的查询草稿
  • 安装 : 将查询安装到数据库中
  • 开始执行 : 执行已安装的查询
  • 删除 : 删除所选查询

新建或修改查询

点击查询编辑区左侧窗口下方的按钮
可新建一个查询。你需要在弹出的窗口中输入新查询的名称:
系统会为该查询草稿提供一个模板:
如果要编辑任何已经存在的查询,你可以在左侧列表中选中它:

保存查询草稿

在工具栏点击按钮
可以将当前对于查询的修改保存下来.

安装查询

在一个查询草稿被保存后,对应的安装查询按钮会变为可用状态。 此时点击这个按钮
会开始安装该查询的操作。整个安装过程大约需要一分钟:

执行查询

任何查询必须在安装完成后才能被执行。
点击按钮
会开始执行选中的查询,如果该查询不包含任何参数,它会直接运行,并将输出的结果显示在下方的结果栏中。
如果一个查询需依赖参数才能执行,则“输入参数面板”会自动出现。你需要在点击“执行查询”按钮
之前输入所有相关的参数值。如果参数比较多,你可能需要将该小窗口滚动到最下方才能找到该按钮。
最后,系统会执行该查询,并将结果显示在下方的结果栏中。

删除查询

点击删除按钮
可删除选中的查询。该删除动作是永久性的。

安装所有的查询

如果你想一次性安装所有未安装的查询,你可以选择点击全部安装按钮
。点击后,系统会花费一些时间验证所有需要安装的查询并将结果显示在弹出的窗口中:
点击 INSTALL 按钮开始查询的安装:

结果输出面板

结果输出面板用于显示查询的执行结果。每个查询都至少会输出三种类型的结果:可视化的图结构,JSON格式的文本以及日志消息。左侧的工具栏中包含有调整面板大小以及调整输出格式的按钮。四个按钮从上到下依次为:
按钮
功能
扩展/折叠: 扩展或折叠结果输出区域
图形化格式输出: 将查询结果以图形化格式输出
JSON 格式: 将最近的一些查询结果以JSON格式的纯文本输出
查询日志: 显示最近一次查询的执行日志
图形化格式 <a id="TigerGraphGraphStudioUIGuide-VisualResult"></a>
如果查询结果中包含一个图的逻辑结构,则该结果会在结果面板中以一个图的方式展现。这时,这个面板的功能类似于“探索图页面”的面板,详情你可以参考上一个章节中的介绍。两者唯一的区别在于,每次重新执行查询后,本面板中的结果都会被完全刷新,而“探索图页面”中的图则只会发生增量变化。
你可以点击JSON按钮将输出的结果切换为JSON格式。

JSON格式

如果结果中不存在图结构,则结果会以一个JSON对象的格式输出。
关于JSON格式的详细介绍,请参考 GSQL Language documentation。你也可以选择让TigerGraph扮演一个后端内嵌的图数据服务的角色,从而通过JSON格式的输出与你的应用层完美集成。

查询日志

如果某个查询成功执行,则日志面板中会出现诸如 “Query Ran Successfully" 这样的消息。如果执行过程中出现了任何问题,例如发现无效的参数或者运行错误等,则一条错误消息会显示在日志面板中。

扩展面板

如果你只是想专注于设计你的查询,亦或是想一次性看到更多的查询结果,你可以选择点击扩展面板按钮
将查询编辑区或者结果输出区的面积扩大到整个窗口。
如果你扩展的是查询编辑区,则它看上去会是这个样子:
如果你扩展的是结果输出区,则它看上去会是这个样子:
当面板被扩展后,扩展按钮会自动变为折叠按钮。再次点击折叠按钮
会回到上下分窗的模式。