用于 IntelliJ IDEA 的新 ES|QL 插件

作者来自 Elastic Laura Trotta使用 IntelliJ IDEA 的新插件在你的 IDE 中构建并运行 ES|QL 查询。通过 Elasticsearch 实践操作深入了解 Elasticsearch Labs 仓库中的示例 notebooks开始免费云试用或现在就在你的本地机器上尝试 Elastic。Elasticsearch 查询语言 ES|QL 是 Elasticsearch 的管道式查询语言旨在实现直观的数据查询和操作。请参考我们的入门指南以了解更多信息。Elasticsearch Java 客户端通过 DSL 支持 ES|QL 查询但目前它将查询视为简单字符串没有专门的辅助工具虽然 Kibana 提供了出色的 UI 来构建 ES|QL查询但我们也意识到有时在集成开发环境 IDE 中拥有编写应用程序所需的一切会带来更好的体验。因此在 Java 客户端将其类型支持扩展到 ES|QL 之前我们编写了一个 IntelliJ IDEA 插件用于自动补全、语法检查、显示文档以及执行 ES|QL 查询。该插件目前支持 Java、 Kotlin 和纯文本文件以防 Java 虚拟机 JVM 不是你的选择。请在 JetBrains Marketplace 页面和 GitHub 仓库中查看它以获取更多信息。前提条件IDEIntellij IDEA 版本 253 community 或 ultimate 使用方法像安装其他插件一样在 Intellij IDEA 中安装该插件可以通过 JetBrains marketplace或者进入 Settings - Plugins - Marketplace 并搜索 “ esql ”。以下示例使用 Java 编写但也支持 Kotlin使用方式基本相同。创建一个文本块字符串在其上方写一个简单注释 “ ES|QL ”即可完成。// ES|QL String query ;然后一切即可正常工作你已经准备好编写你的查询。为什么使用文本块而不是简单字符串ES|QL 语法在多种上下文中接受引号对其进行转义会在语法检查器中触发其他错误因此我们选择使用文本块来保持简单。对于 txt 文件来说更简单因为你只需添加该注释然后直接在下方开始编写查询// ES|QL连接到服务器实例该插件可以连接到 Elasticsearch 服务器实例以获取索引和字段名称然后将它们添加到自动补全选项中。请在屏幕左下角或你放置工具的位置查找 Elastic 标志并配置你到任意服务器实例的连接自动补全在文本块中开始输入时会自动打开自动补全弹窗它会返回一个可接受的命令/值列表帮助你正确继续编写查询。如果你想手动触发自动补全可以使用 IDE 的快捷键 ctrl space语法检查该插件会高亮查询中的错误并说明需要修复的内容文档将光标悬停在命令上会显示文档说明该命令的用途以及其正确语法运行查询连接到服务器实例后你可以点击 Elastic 图标旁边的绿色按钮来运行查询结果将显示在工具窗口中或者如果你正在编写应用程序可以像这样使用 Java 客户端// ES|QL String query FROM my-index | SORT year DESC | LIMIT 10 ; try (ElasticsearchClient client ElasticsearchClient.of(e - e .host(serverUrl) .apiKey(apiKey))) { client.esql().query(QueryRequest.of(qr - qr.query(query))); }查看我们之前关于 ES|QL Java Client 的文章以获取将 ES|QL 结果映射到 Java 对象的完整示例。它是如何工作的这里没有 AI 参与该插件基于 ES|QL ANTLR 语法来实现自动补全和语法检查并使用 Elasticsearch 文档来展示说明。结论该插件仍处于实验阶段因此欢迎你在 GitHub 仓库中提交任何 bug 或功能请求。原文https://www.elastic.co/search-labs/blog/esql-plugin-intellij-idea