SQL 和 PPL CLI

SQL 和 PPL 命令行界面 (CLI) 是一个独立的 Python 应用程序，您可以使用 opensearchsql 命令启动它。

要使用 SQL 和 PPL CLI，请在 OpenSearch 实例上安装 SQL 插件，使用 MacOS 或 Linux 运行 CLI，并连接到任何有效的 OpenSearch 端点。

功能

SQL 和 PPL CLI 具有以下功能

• 多行输入
• 支持 PPL
• SQL 语法和索引名称自动完成
• 语法高亮
• 格式化输出
  • 表格格式
  • 带颜色的字段名称
  • 启用横向显示（默认）以及当输出对于终端过宽时启用纵向显示，以获得更好的可视化效果
  • 大型输出分页
• 支持启用或不启用安全性
• 支持加载配置文件
• 支持所有 SQL 插件查询

安装

启动您的本地 OpenSearch 实例，并确保已安装 SQL 插件。

1. 安装 CLI

   pip3 install opensearchsql
   

SQL CLI 仅适用于 Python 3。

1. 要启动 CLI，请运行

   opensearchsql https://:9200 --username admin --password admin
   

   默认情况下，opensearchsql 命令连接到 https://:9200。

配置

首次启动 SQL CLI 时，会在 ~/.config/opensearchsql-cli/config（适用于 MacOS 和 Linux）自动创建一个配置文件，此后会自动加载该配置。

您可以配置以下连接属性

• endpoint: 您无需指定选项。紧跟启动命令 opensearchsql 的任何内容都被视为端点。如果您未提供端点，SQL CLI 默认连接到 https://:9200。
• -u/-w: 支持使用用户名和密码进行 HTTP 基本认证，例如使用 Security 插件或针对 Amazon OpenSearch Service 的精细访问控制。
• --aws-auth: 开启 AWS sigV4 认证以连接到 Amazon OpenSearch 端点。与 AWS CLI (aws configure) 结合使用，以检索本地 AWS 配置进行认证和连接。

有关所有可用配置的列表，请参阅 clirc。

使用 CLI

1. 运行 CLI 工具。如果您的集群使用默认安全设置运行，请使用以下命令

   opensearchsql --username admin --password admin https://:9200
   

   如果您的集群未启用安全性，请运行

   opensearchsql
   

2. 运行一个示例 SQL 命令

   SELECT * FROM accounts;
   

默认情况下，您会看到最多 200 行输出。要显示更多结果，请添加一个带有所需值的 LIMIT 子句。

要退出 CLI 工具，请按 Ctrl+D。

将 CLI 与 PPL 结合使用

1. 通过指定查询语言运行 CLI

   opensearchsql -l ppl <params>
   

2. 执行 PPL 查询

   source=accounts | fields firstname, lastname
   

查询选项

使用以下命令行选项运行单个查询

• -q: 后跟单个查询
• -f: 指定 JDBC 或原始格式输出
• -v: 垂直显示数据
• -e: 将 SQL 转换为 DSL

CLI 选项

• --help: 选项帮助页面
• -l: 查询语言选项。可用选项为 sql 和 ppl。默认值为 sql
• -p: 始终使用分页器显示输出
• --clirc: 提供配置文件的路径