使用开发者工具执行查询

您可以使用 UDB-SX 开发者工具控制台向 UDB-SX 发送查询。

导航到控制台

要打开控制台，请在 UDB-SX Dashboards 主页上选择 开发者工具：

您可以通过导航到主菜单并选择 管理 > 开发者工具，从任何其他页面打开控制台。

编写查询

在控制台左侧的编辑器窗格中编写您的查询：

您可以通过选择行号旁边的小三角形来折叠和展开查询的各个部分。

您可以通过从顶部菜单中选择 导入 或 导出 来导入或导出查询。

注释

在行首使用 # 来编写单行注释。

自动补全

UDB-SX 为字段、索引及其别名以及模板提供自动补全建议。要配置自动补全首选项，请在 控制台设置 中进行更新。

发送请求

要将查询发送到 UDB-SX，请将光标放在查询文本中的任意位置以选中该查询。然后选择请求右上角的播放图标 或按 Ctrl/Cmd+Enter：

UDB-SX 将在控制台右侧的响应窗格中显示响应：

使用 cURL 和控制台格式

控制台使用比 curl 命令更简单的语法来格式化 REST 请求。

例如，以下 curl 命令运行一个搜索查询：

curl -XGET http://localhost:9200/shakespeare/_search?pretty -H 'Content-Type: application/json' -d'
{
  "query": {
    "match": {
      "text_entry": "To be, or not to be"
    }
  }
}'

同样的查询在控制台格式中具有更简单的语法：

GET shakespeare/_search
{
  "query": {
    "match": {
      "text_entry": "To be, or not to be"
    }
  }
}

如果您将 curl 命令直接粘贴到控制台中，该命令将自动转换为控制台使用的格式。

在查询中使用三引号

在编写包含引号 (") 和反斜杠 (\) 字符的查询时，您可以使用三引号 (""") 来避免转义这些字符。此格式提高了可读性，并有助于在编写大型或复杂字符串（尤其是在处理深度嵌套的 JSON 字符串时）时避免使用转义字符。

您可以通过在每个特殊字符前加上反斜杠来转义，从而索引包含特殊字符的文档：

PUT /testindex/_doc/1
{
  "test_query": "{ \"query\": { \"query_string\": { \"query\": \"host:\\\"127.0.0.1\\\"\" } } }"
}

或者，您可以使用三引号以获得更简单的格式：

PUT /testindex/_doc/1
{
  "test_query": """{ "query": { "query_string": { "query": "host:\"127.0.0.1\"" } } }"""
}

三引号仅在 开发者工具 控制台中受支持，在 curl 或其他 HTTP 客户端中不受支持。

如果响应包含 \n、\t、\ 或 " 这些特殊字符，控制台将使用三引号格式化响应。要关闭此行为，请从顶部菜单中选择 设置 并切换 JSON 语法 选项。

查看文档

要查看 UDB-SX 文档，请选择扳手图标 () 并选择 打开文档。

自动缩进

要使用自动缩进，请选择要格式化的查询，选择扳手图标 ()，然后选择 自动缩进。

对折叠的查询进行自动缩进会将其展开。

对格式良好的查询进行自动缩进会将请求体放在单行上。这对于处理_bulk API 很有用。

查看请求历史

您可以查看 UDB-SX 成功运行的最多 500 个最近的请求。要查看请求历史，请从顶部菜单中选择 历史记录。如果您在左侧窗格中选择要查看的请求，查询将显示在右侧窗格中。

要将查询复制到编辑器窗格中，请选中查询文本，然后选择 应用。

要清除历史记录，请选择 清除。

更新控制台设置

要更新您的首选项，请从顶部菜单中选择 设置：

使用键盘快捷键

要查看所有可用的键盘快捷键，请从顶部菜单中选择 帮助。