# @aws-sdk/client-qldb 中文文档

规范地址：https://npmcn.com/package/%40aws-sdk/client-qldb/

版本：3\.918\.0
npm 元数据更新时间：2025-10-28T17:16:18.987Z
中文译文更新时间：2026-11-07T12:01:53.764Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aws-sdk/client-qldb
原文对照：https://npmcn.com/package/%40aws-sdk/client-qldb/?lang=original
项目主页：https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-qldb
源码仓库：https://github.com/aws/aws-sdk-js-v3

弃用说明：The QLDB client was removed from the SDK\.

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：473 kB，146 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：39 个
- 首次发布：2020-01-08T03:13:27.833Z
- 最新版本发布：2025-10-27T19:15:24.203Z
- 近 30 天下载量：100889（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：504（近 12 个月 0 个）

## 中文简介

JavaScript Qldb 客户端的 AWS SDK 用于节点.js, 浏览器和 React 本地

## 安装

```sh
npm install @aws-sdk/client-qldb
```

也可以使用：`pnpm add @aws-sdk/client-qldb`、`yarn add @aws-sdk/client-qldb`、`bun add @aws-sdk/client-qldb`

## README

# @aws-sdk/客户端-qldb

## 说明

用于节点.js的JavaScript QLDB客户端的AWS SDK,浏览器和React Industrial.

Amazon QLDB 的资源管理 API

## 安装

要安装此软件包, 只需输入或安装@aws- sdk/ client- qldb 使用您最喜欢的软件包管理器 :

-   `npm install @aws-sdk/client-qldb`
-   `yarn add @aws-sdk/client-qldb`
-   `pnpm add @aws-sdk/client-qldb`

## 开始

### 导入

AWS SDK由客户端和命令进行调制. 要发送请求,只需导入 `QLDBClient` 财务报告和审定财务报表 例如,您需要的命令 `ListLedgersCommand`数字 :

```js
// ES5 example
const { QLDBClient, ListLedgersCommand } = require("@aws-sdk/client-qldb");
```

```ts
// ES6+ example
import { QLDBClient, ListLedgersCommand } from "@aws-sdk/client-qldb";
```

### 使用量

为了发出一个请求,你:

-   以配置启动客户端(如证书,区域).
-   用输入参数启动命令 .
-   打电话 `send` 在客户端上操作,以命令对象作为输入.
-   如果您使用自定义 http 处理器, 您可以拨打 `destroy()` 关闭打开的连接.

```js
// a client can be shared by different commands.
const client = new QLDBClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListLedgersCommand(params);
```

#### 自动/等待

我们建议使用 [等待时](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) 运算符等待通过发送操作返回的承诺如下:

```js
// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}
```

Async-await 是干净的,简洁的,直观的,容易调试的,并且有更好的错误处理 与使用 " 承诺 " 链条或回调相比.

#### 承诺

您还可以使用 [承诺连锁](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) 以执行发送操作.

```js
client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);
```

承诺也可以称为使用 `.catch()` 财务报告和审定财务报表 `.finally()` 内容如下:

```js
client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });
```

#### 回电

我们不建议使用回调,因为 [召回地狱](http://callbackhell.com/), (中文(简体) ), 但他们得到发送操作的支持.

```js
// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});
```

#### v2 兼容样式

客户端也可以使用v2相容的样式发送请求. 然而,这导致了更大的捆绑尺寸,并可能在下个主要版本中下降. 更多细节在博客文章中 打开 [javaScript 的 AWS SDK 模块包](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)

```ts
import * as AWS from "@aws-sdk/client-qldb";
const client = new AWS.QLDB({ region: "REGION" });

// async/await.
try {
  const data = await client.listLedgers(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listLedgers(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listLedgers(params, (err, data) => {
  // process err and data.
});
```

### 解决问题

当服务返回例外时,错误将包括例外信息, 以及响应元数据(如请求编号).

```js
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}
```

## 获取帮助

请利用这些社区资源获得帮助. 我们使用 GitHub 问题来跟踪错误和特性请求,但处理它们的带宽有限.

-   访问 [开发者指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) 或者说 [API 参考](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html)。 。 。 .
-   看看贴有标签的博客文章 [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) aWS 开发者博客.
-   问个问题 [叠叠流](https://stackoverflow.com/questions/tagged/aws-sdk-js) 并贴上标签 `aws-sdk-js`。 。 。 .
-   加入 AWS JavaScript 社区 [发光](https://gitter.im/aws/aws-sdk-js-v3)。 。 。 .
-   如果你发现你发现了一个虫子,请 [打开一个问题](https://github.com/aws/aws-sdk-js-v3/issues/new/choose)。 。 。 .

为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 [代码样本 repo](https://github.com/aws-samples/aws-sdk-js-tests)。 。 。 .

## 捐款

此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 `@aws-sdk/client-qldb` 软件包正在更新. 为了帮助客户,你可以检查我们 [生成客户端脚本](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients)。 。 。 .

## 许可证

此 SDK 分布于 [Apache 许可证,2.0版本](http://www.apache.org/licenses/LICENSE-2.0), (中文(简体) ), 更多信息见LICENSE.

## 客户端命令( 操作列表)

取消 Journal Kinesis 结构

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/CancelJournalKinesisStreamCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/CancelJournalKinesisStreamCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/CancelJournalKinesisStreamCommandOutput/)

创建编辑器

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/CreateLedgerCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/CreateLedgerCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/CreateLedgerCommandOutput/)

删除编辑器

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/DeleteLedgerCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/DeleteLedgerCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/DeleteLedgerCommandOutput/)

描述 Journal Kinesis 结构

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/DescribeJournalKinesisStreamCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/DescribeJournalKinesisStreamCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/DescribeJournalKinesisStreamCommandOutput/)

描述 JournalS3 出口

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/DescribeJournalS3ExportCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/DescribeJournalS3ExportCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/DescribeJournalS3ExportCommandOutput/)

描述编辑器

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/DescribeLedgerCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/DescribeLedgerCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/DescribeLedgerCommandOutput/)

导出 JournalToS3

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/ExportJournalToS3Command/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/ExportJournalToS3CommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/ExportJournalToS3CommandOutput/)

获取锁定

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/GetBlockCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/GetBlockCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/GetBlockCommandOutput/)

获取数据

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/GetDigestCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/GetDigestCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/GetDigestCommandOutput/)

获取修订版

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/GetRevisionCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/GetRevisionCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/GetRevisionCommandOutput/)

列表 JournalKinesis 结构化

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/ListJournalKinesisStreamsForLedgerCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/ListJournalKinesisStreamsForLedgerCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/ListJournalKinesisStreamsForLedgerCommandOutput/)

列表JournalS3 输出

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/ListJournalS3ExportsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/ListJournalS3ExportsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/ListJournalS3ExportsCommandOutput/)

列表JournalS3 输出格式

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/ListJournalS3ExportsForLedgerCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/ListJournalS3ExportsForLedgerCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/ListJournalS3ExportsForLedgerCommandOutput/)

列表

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/ListLedgersCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/ListLedgersCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/ListLedgersCommandOutput/)

列表标签格式资源

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/ListTagsForResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/ListTagsForResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/ListTagsForResourceCommandOutput/)

串流杂志

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/StreamJournalToKinesisCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/StreamJournalToKinesisCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/StreamJournalToKinesisCommandOutput/)

标签资源

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/TagResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/TagResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/TagResourceCommandOutput/)

调和资源

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/UntagResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/UntagResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/UntagResourceCommandOutput/)

更新编辑器

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/UpdateLedgerCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/UpdateLedgerCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/UpdateLedgerCommandOutput/)

更新编目程序

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qldb/command/UpdateLedgerPermissionsModeCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/UpdateLedgerPermissionsModeCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qldb/Interface/UpdateLedgerPermissionsModeCommandOutput/)

## 常见问题

### @aws-sdk/client-qldb 是什么？

JavaScript Qldb 客户端的 AWS SDK 用于节点\.js, 浏览器和 React 本地注意：该包已被作者标记为弃用——The QLDB client was removed from the SDK\.

### 如何安装 @aws-sdk/client-qldb？

在项目目录运行 npm install @aws-sdk/client-qldb，或使用 pnpm add / yarn add / bun add。

### @aws-sdk/client-qldb 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aws-sdk/client-qldb 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @aws-sdk/client-qldb 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @aws-sdk/client-qldb 可以商用吗？

@aws-sdk/client-qldb 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aws-sdk/client-qldb 的下载量有多少？

根据 npm 官方下载统计，@aws-sdk/client-qldb 在 2026/10/08 – 2026/11/06 这 30 天内被下载 100,889 次，日均约 3,363 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aws-sdk/client-qldb 还在维护吗？

最新版本 3\.918\.0 发布于 2025/10/28（1 年前）；至今共发布 504 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/01/08。作者已将其标记为弃用，新项目建议寻找替代方案。