查询编辑器UI指南

NOTE
旧版编辑器已于2024年5月24日弃用。 它不再可供使用。 您现在可以使用增强型查询编辑器来编写、验证和运行查询

查询编辑器是Adobe Experience Platform查询服务提供的交互式工具,允许您在Experience Platform用户界面中编写、验证和运行客户体验数据的查询。 查询编辑器支持开发用于分析和数据探索的查询,并允许您运行交互式查询以进行开发,以及运行非交互式查询以填充Experience Platform中的数据集。

有关查询服务的概念和功能的详细信息,请参阅查询服务概述。 要了解有关如何在Platform上导航查询服务用户界面的详细信息,请参阅查询服务UI概述

快速入门 getting-started

查询编辑器通过连接到查询服务来提供灵活的查询执行,并且查询仅在此连接处于活动状态时运行。

访问查询编辑器 accessing-query-editor

在Experience Platform UI中,从左侧导航菜单中选择​ 查询 ​以打开查询服务工作区。 接下来,要开始编写查询,请选择屏幕右上角的​ 创建查询。 此链接可从查询服务工作区中的任何页面使用。

突出显示了“创建查询”的“查询”工作区概述选项卡。

正在连接到查询服务 connecting-to-query-service

查询编辑器需要几秒钟才能初始化,并在打开时连接到查询服务。 控制台将告诉您连接时间,如下所示。 如果在编辑器连接之前尝试运行查询,则会延迟执行,直到连接完成。

初始连接时查询编辑器的控制台输出。

如何从查询编辑器运行查询 run-a-query

从查询编辑器执行的查询以交互方式运行,这意味着如果关闭浏览器或离开浏览器,查询将被取消。 对于通过查询输出生成数据集的查询,也是如此。

使用增强型查询编辑器创作查询 query-authoring

NOTE
旧版编辑器已于2024年5月24日弃用。 它不再可供使用。 您现在可以使用增强型查询编辑器来编写、验证和运行查询。

使用查询编辑器,您可以编写、执行和保存客户体验数据的查询。 在查询编辑器中执行或保存的所有查询都可供贵组织中有权访问查询服务的所有用户使用。

设置 settings

查询编辑器输入字段上方的设置图标包括用于启用/禁用深色主题或禁用/启用自动完成的选项。

TIP
您可以在创作查询时禁用语法自动完成,而不会丢失进度。

要启用深色或浅色主题,请选择设置图标( A设置图标)。 ),其后显示下拉菜单中的选项。

查询编辑器的“设置”图标和“启用深色主题”下拉菜单选项突出显示。

自动完成 auto-complete

查询编辑器会在您编写查询时,自动为查询建议潜在的SQL关键字以及表或列详细信息。 默认情况下,自动完成功能处于启用状态,可以随时从查询编辑器设置中禁用或启用该功能。

自动完成配置设置针对每个用户,并在该用户的连续登录中被记住。 禁用此功能会阻止处理多个元数据命令,并提供通常有利于作者在编辑查询时提高速度的建议。

执行多个顺序查询 execute-multiple-sequential-queries

使用增强型查询编辑器编写多个查询并按顺序执行所有查询。 按顺序执行多个查询,每个查询都会生成日志条目。 但是,查询编辑器控制台中只显示第一个查询的结果。 如果需要排除问题或确认已执行的查询,请查看查询日志。 有关详细信息,请参阅查询日志文档

NOTE
如果在查询编辑器中的第一个查询之后执行CTAS查询,则仍会创建一个表,但查询编辑器控制台上没有输出。

执行选定的查询 execute-selected-query

如果您已经编写了多个查询,但只需要执行一个查询,则可以突出显示所选的查询并选择
运行选定的查询图标。 默认情况下,此图标处于禁用状态,直到您在编辑器中选择查询语法。

突出显示具有运行选定查询图标的查询编辑器。

取消查询编辑器会话 cancel-query

通过取消长时间运行的查询来控制查询执行并提高生产效率。 此操作在查询运行时清除查询编辑器。 请注意,查询将继续在后台执行。 如果它是CTAS查询,仍会生成输出数据集。 要在编辑器中取消运行并继续编写SQL语句,请在执行查询后选择​ 取消查询

带有取消查询的查询编辑器已突出显示。

将显示确认对话框。 选择​ 确认 ​以取消查询运行。

高亮显示了“确认”的“取消查询”确认对话框。

结果计数 result-count

查询编辑器的行输出最多为50,000个。 您可以选择在查询编辑器控制台中一次显示的行数。 要更改控制台中显示的行数,请选择​ 结果计数 ​下拉列表,并从50、100、150、300和500选项中进行选择。

结果计数下拉列表突出显示的查询编辑器。

编写查询 writing-queries

查询编辑器的组织方式使编写查询尽可能容易。 下面的屏幕截图显示了编辑器在UI中的显示方式,其中高亮显示了SQL输入字段和​ Play

已突出显示SQL输入字段和“播放”的查询编辑器。

为了最大限度地缩短开发时间,建议您开发对返回行数具有限制的查询。 例如:SELECT fields FROM table WHERE conditions LIMIT number_of_rows。在验证您的查询产生了预期的输出后,请移除限制并运行包含CREATE TABLE tablename AS SELECT的查询以生成包含该输出的数据集。

在查询编辑器中编写工具 writing-tools

  • 自动语法突出显示: ​使读取和组织SQL更容易。

查询编辑器中的SQL语句演示语法颜色突出显示。

  • SQL关键字自动完成: ​开始键入您的查询,然后使用箭头键导航到所需的搜索词,然后按​ Enter

带有自动完成下拉菜单的SQL的一些字符,该菜单提供查询编辑器中的选项。

  • 表和字段自动完成: ​开始键入要SELECT的表的名称,然后使用箭头键导航到要查找的表,然后按​ Enter。 选择表后,自动完成将识别该表中的字段。

显示下拉表名称建议的查询编辑器输入。

设置文本格式 format-text

格式文本功能通过添加标准语法样式使您的查询更易读。 选择​ 设置文本格式 ​以标准化查询编辑器中的所有文本。

NOTE
格式文本功能不适用于匿名块。 若要了解如何按顺序链接一个或多个SQL语句,请参阅匿名块文档

查询编辑器格式文本和突出显示的SQL语句。

复制 SQL copy-sql

选择复制图标以将SQL从查询编辑器复制到剪贴板。 此复制功能可用于查询模板和查询编辑器中新创建的查询。

查询工作区中有一个示例查询模板,该模板中突出显示了复制图标。

查询详细信息 query-details

要在查询编辑器中查看查询,请从模板选项卡中选择任何已保存的模板。 查询详细信息面板提供了更多信息和工具来管理所选查询。 它还显示有用的元数据,例如上次修改查询的时间以及修改查询的人员(如果适用)。

NOTE
查看计划、添加计划和删除查询选项仅在将查询另存为模板后可用。 使用添加计划选项,您可以从查询编辑器直接转到计划生成器。 使用查看计划选项,您可以直接查看该查询的计划清单。 请参阅查询计划文档,了解如何在UI🔗中创建查询计划。

查询详细信息面板突出显示的查询编辑器。

在详细信息面板中,您可以直接从UI生成输出数据集,删除或命名显示的查询,查看查询运行计划,并将查询添加到计划中。

要生成输出数据集,请选择​ 以CTAS ​身份运行。 出现​ 输入输出数据集详细信息 ​对话框。 输入名称和说明,然后选择​ 以CTAS身份运行。 新数据集显示在​ 数据集 ​浏览选项卡中。 请参阅查看数据集文档,了解有关贵组织可用数据集的更多信息。

NOTE
作为CTAS运行选项仅在查询有​ 未计划 ​时才可用。

输入输出数据集详细信息对话框。

执行以CTAS 身份运行的 ​操作后,将弹出一条确认消息,通知您操作成功。 此弹出消息包含一个链接,为导航到查询日志工作区提供了一种便捷的方式。 有关查询日志的详细信息,请参阅查询日志文档

保存查询 saving-queries

查询编辑器提供保存功能,允许您保存查询并稍后处理。 要保存查询,请选择查询编辑器右上角的​ 保存。 在保存查询之前,必须使用​ 查询详细信息 ​面板为查询提供一个名称。

NOTE
使用查询编辑器命名并保存在中的查询可用作查询仪表板模板选项卡中的模板。 有关详细信息,请参阅模板文档

在查询编辑器中保存查询时,将会弹出一条确认消息,通知您操作成功。 此弹出消息包含一个链接,为导航到查询计划工作区提供了一种便捷的方法。 请参阅计划查询文档以了解如何以自定义节奏运行查询。

计划的查询 scheduled-queries

可以从“查询编辑器”安排已另存为模板的查询。 计划查询允许您以自定义节奏自动运行查询。 您可以根据频率、日期和时间安排查询,还可以在必要时为结果选择输出数据集。 也可以通过UI禁用或删除查询计划。

在查询编辑器中设置计划。 使用查询编辑器时,您只能将计划添加到已创建和保存的查询中。 该限制不适用于查询服务API。

NOTE
连续运行10次失败的已计划查询将自动置于隔离状态。 具有此状态的查询需要您的干预,然后才能进行任何进一步的执行。 有关更多详细信息,请参阅隔离的查询文档。

请参阅查询计划文档,了解如何在UI🔗中创建查询计划。 或者,要了解如何使用API添加计划,请阅读计划查询端点指南

任何计划的查询都会添加到计划查询选项卡的列表中。 在该工作区中,您可以通过UI监控所有已计划查询作业的状态。 在计划的查询选项卡上,您可以找到有关查询运行的重要信息并订阅警报。 可用信息包括状态、计划详细信息和运行失败时的错误消息/代码。 有关详细信息,请参阅监视计划查询文档

如何查找以前的查询 previous-queries

从“查询编辑器”执行的所有查询都在“日志”表中捕获。 您可以使用​ 日志 ​选项卡中的搜索功能来查找查询执行。 已保存的查询列在​ 模板 ​选项卡中。

如果已计划查询,则计划查询选项卡通过UI提高了这些查询作业的可见性。 有关详细信息,请参阅查询监视文档

NOTE
日志不会保存未执行的查询。 为了使查询在查询服务中可用,必须在查询编辑器中运行或保存查询。

使用查询编辑器执行查询 executing-queries

若要在查询编辑器中运行查询,您可以在编辑器中输入SQL,或者从​ 日志 ​或​ 模板 ​选项卡加载上一个查询,然后选择​ 播放。 查询执行状态显示在下面的​ 控制台 ​选项卡中,输出数据显示在​ 结果 ​选项卡中。

控制台 console

控制台提供有关查询服务的状态和操作的信息。 控制台显示与查询服务的连接状态、正在执行的查询操作以及这些查询产生的任何错误消息。

查询编辑器控制台的控制台选项卡。

NOTE
控制台仅显示执行查询导致的错误。 它不显示查询执行前发生的查询验证错误。

查询结果 query-results

完成查询后,结果将显示在​ 控制台 ​选项卡旁边的​ 结果 ​选项卡中。 此视图显示查询的表格输出,根据您选择的结果计数显示50到500行结果。 此视图允许您验证查询是否生成预期的输出。 要使用您的查询生成数据集,请删除对返回行的限制,然后使用CREATE TABLE tablename AS SELECT运行查询以使用输出生成数据集。 有关如何从查询编辑器中的查询结果生成数据集的说明,请参阅生成数据集教程

查询编辑器控制台的“结果”选项卡显示查询运行的结果。

用例 use-cases

查询服务为跨行业和业务场景的各种用例提供解决方案。 这些实际示例展示了服务在满足各种需求方面的灵活性和影响。 要揭示查询服务如何为您的特定业务需求带来价值,请探索使用案例文档的完整集合。 了解如何使用查询服务提供洞察信息和解决方案,以增强运营效率和业务成功。

使用查询服务运行查询教程视频 query-tutorial-video

以下视频介绍了如何在Adobe Experience Platform界面和PSQL客户端中运行查询。 此视频还演示了如何在XDM对象中使用单个属性、Adobe定义的函数,以及如何使用CREATE TABLE AS SELECT (CTAS)查询。

NOTE
视频中描述的UI已过时,但在工作流中使用的逻辑保持不变。

后续步骤

现在您已经知道查询编辑器中提供了哪些功能以及如何导航应用程序,您可以开始直接在Platform中创作自己的查询。 有关对Data Lake中的数据集运行SQL查询的详细信息,请参阅运行查询指南。

recommendation-more-help
ccf2b369-4031-483f-af63-a93b5ae5e3fb