使用 QLDB Shell 访问Amazon QLDB（仅限数据 API）

Amazon QLDB 提供了一个命令行 Shell，用于与事务数据 API 进行交互。使用 QLDB Shell，您可以对分类账数据运行 PartiQL语句。

这个 shell 的最新版本是用 Rust 编写的，在默认分支的 awslabs/ GitHub 存储库中是开源amazon-qldb-shell的。mainPython 版本（v1）也仍然可以在 master 分支的同一个存储库中使用。

此工具不会整合至应用程序中或用于生产目的。该工具旨在让您快速试验 QLDB 和 PartiQL。

以下各节介绍如何开始使用 QLDB Shell。

先决条件

开始使用 QLDB Shell之前，您必须执行以下操作：

安装 Shell

要安装最新版本的 QLDB 外壳，请参阅上的 README.md 文件。 GitHubQLDB 在存储库的 “发布” 部分提供了适用于 Linux、macOS 和 Windows 的预建二进制文件。 GitHub

对于 macOS，Shell 与aws/tap Homebrew 选项卡集成。若要使用 Homebrew 在 macOS 上安装 Shell，请运行以下命令。

$ xcode-select --install # Required to use Homebrew
$ brew tap aws/tap # Add AWS as a Homebrew tap
$ brew install qldbshell

配置

安装后，Shell 会加载初始化 $XDG_CONFIG_HOME/qldbshell/config.ion 期间位于的默认配置文件。在 Linux 和 macOS，此文件通常位于 ~/.config/qldbshell/config.ion。如果这样的文件不存在，Shell 将按默认设置运行。

安装后可以手动创建 config.ion 文件。此配置文件采用 Amazon Ion 数据格式。以下是最小 config.ion 文件的示例。

{
  default_ledger: "my-example-ledger"
}

如果配置文件中未设置default_ledger，则在调用 Shell 时必须使用--ledger参数。有关配置选项的完整列表，请参阅上的 README.md 文件。 GitHub

调用 Shell

要在命令行终端上为特定分类账调用 QLDB Shell，请运行以下命令。my-example-ledger用您的账本名称替换。

$ qldb --ledger my-example-ledger

此命令连接到您的默认命令 AWS 区域。要明确指定区域，您可以使用 --region 或 --qldb-session-endpoint 参数运行命令，如下一节所述。

调用 qldb Shell 会话后，您可输入以下类型的输入：

Shell 参数

要查看调用 Shell 的可用标志和选项的完整列表，请按如下方式运行带有 --help 标志的 qldb 命令。

$ qldb --help

以下是 qldb 命令的一些键标和选项。您可以添加这些可选参数来覆盖凭证配置文件、端点、结果格式和其他配置选项。 AWS 区域

用法

$ qldb [FLAGS] [OPTIONS]

命令参考

调用 qldb会话后，Shell 支持以下密钥和数据库命令：

运行单独语句

除了 README.md 中列出的数据库命令和 Shell 元命令外，Shell 程序会将您输入的每条命令解释为单独的 PartiQL 语句。默认情况下，Shell 会启用auto-commit模式。此模式为可配置。

在auto-commit模式下，Shell 会在自己的事务中隐式运行每条语句，如果未发现错误，则自动提交事务。这意味着您不必在每次运行语句时都手动运行start transaction（或 begin）和 commit。

管理事务

或者，QLDB Shell 允许您手动控制事务。您可在事务中以交互方式运行多个语句，也可以通过按顺序批处理命令和语句来以非交互方式运行多个语句。

交互式事务

若要运行交互式事务，请执行以下步骤。

事务超时限制

交互式事务遵守 QLDB 事务超时限制。如果您未在事务启动后的 30 秒内提交此事务，QLDB 会自动使该事务过期，并拒绝事务期间所做的任何更改。

然后，Shell 不显示语句结果，而是显示一条过期错误消息并返回到普通的命令提示符。要重试，必须再次输入 begin 命令才能开始新的事务。

transaction failed after 1 attempts, last error: communication failure: Transaction 2UMpiJ5hh7WLjVgEiMLOoO has expired

非交互式事务

您可以按以下顺序对命令和语句进行批处理，从而运行包含多条语句的完整事务。

qldb> begin; SELECT * FROM Vehicle WHERE VIN = '1N4AL11D75C109151'; SELECT * FROM Person p, DriversLicense l WHERE p.GovId = l.LicenseNumber; commit

必须用分号（;）分隔符分隔每条命令与语句。如果事务中的任何语句无效，则 Shell 会自动拒绝该事务。Shell 不会继续处理您随后输入的任何语句项。

您还可设置多笔事务。

qldb> begin; statement1; commit; begin; statement2; statement3; commit

与前面的示例类似的是，如果事务失败，Shell 将不会继续处理您输入的任何后续事务或语句。

如果您不结束事务，Shell 会切换至交互模式，并提示您输入下一个命令或语句。

qldb> begin; statement1; commit; begin
qldb *>  

退出 Shell

要退出当前 qldb Shell 会话，请输入exit或quit命令，或者在 Shell 不在事务中时使用键盘快捷键Ctrl+D。

qldb> exit
$ 

qldb> quit
$ 

示例

有关在 QLDB 中编写 PartiQL 语句的信息，请参阅Amazon QLDB PartiQL 参考。

$ qldb --ledger test-ledger --region us-east-1

qldb> CREATE TABLE TestTable
qldb> INSERT INTO TestTable `{"Name": "John Doe"}`
qldb> SELECT * FROM TestTable
qldb> DROP TABLE TestTable
qldb> exit