# @apple/cktool\.api\.database 中文文档

规范地址：https://npmcn.com/package/%40apple/cktool.api.database/

版本：1\.3\.2
npm 元数据更新时间：2025-10-22T07:27:40.399Z
中文译文更新时间：2026-11-06T17:26:39.256Z
软件包许可：SEE LICENSE IN LICENSE\.md

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

原始 npm 页面：https://www.npmjs.com/package/%40apple/cktool.api.database
原文对照：https://npmcn.com/package/%40apple/cktool.api.database/?lang=original

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

- 包体积（解压后）：1.1 MB，179 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2021-11-30T23:45:35.895Z
- 最新版本发布：2022-06-03T17:17:31.971Z
- 近 30 天下载量：2586（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

Apple CKTool JS "数据库" API

## 安装

```sh
npm install @apple/cktool.api.database
```

也可以使用：`pnpm add @apple/cktool.api.database`、`yarn add @apple/cktool.api.database`、`bun add @apple/cktool.api.database`

## README

# CKTool JS - “数据库”API软件包

这个软件包是 CKTool JS JavaScript 客户端的一部分 库套件,包括操作和类型Script 与"数据库"有关.

每个操作都有相应的功能,即 返回 a `CancellablePromise` 解决 如果操作失败,则拒绝.

别自己用这个包裹 自动拉出 包含时 `@apple/cktool.database` 在你身边 `package.json` 依赖性.

## 开始

见 [苹果开发者文档](https://developer.apple.com/documentation/cktooljs) 关于如何开始使用CKTool JS的更多细节.

## API 承诺混音

`DatabasePromisesApiMixin`

不要直接使用这种混合剂. 相反,使用 `PromisesApi` 从 `@apple/cktool.database`。 。 。 .

### 方法

以下方法由混音加入.

-   `acceptRecord` 代表当前用户接受共享.
-   `createAssetUploadUrl` 为上传资产创建新 URL .
-   `createRecord` 创建新记录.
-   `createZone` 创建新区域.
-   `deleteRecord` 删除单一记录.
-   `deleteRecordsByQuery` 删除匹配所提供查询的记录.
-   `deleteZone` 删除一个区域.
-   `exportSchema` 下载容器的图谋 .
-   `getRecord` 返回记录的细节 .
-   `getSessionUser` 在当前会话中返回用户的详细信息 .
-   `getZone` 返回一个区域的细节.
-   `getZones` 返回一组区域.
-   `importSchema` 上传一个定义容器新方案的文件.
-   `lookupRecords` 按记录名称获取多个记录.
-   `queryRecordChanges` 返回自指定同步符号或自创建区后更改的记录.
-   `queryRecords` 返回匹配所提供查询的记录集合 .
-   `resetConfigToProduction` 将容器配置重置为生产 .
-   `resetToProduction` 将环境计划重新用于生产.
-   `resolveRecord` 获取有关记录的信息,以获得其简短的Guid属性.
-   `updateRecord` 更新现有记录.
-   `validateSchema` 验证容器上传的 schema 文件 .

## 类型脚本

-   `CKDBAsset`
-   `CKDBAssetUploadUrlResponse`
-   `CKDBBatchDeleteError`
-   `CKDBChangeMetadata`
-   `CKDBCreateAssetUploadUrlRequestBody`
-   `CKDBCreateRecordRequestBody`
-   `CKDBCreateZoneRequestBody`
-   `CKDBDeleteRecordsByQueryRequestBody`
-   `CKDBDeletedRecordResult`
-   `CKDBErrorRecordResult`
-   `CKDBExistingRecordResult`
-   `CKDBForRecord`
-   `CKDBLocation`
-   `CKDBLookupRecordsRequestBody`
-   `CKDBLookupRecordsResponse`
-   `CKDBModifyRecordRequestBody`
-   `CKDBNullableReference`
-   `CKDBPagedBatchDeleteResponse`
-   `CKDBPermissionType`
-   `CKDBQuery`
-   `CKDBQueryFilter`
-   `CKDBQueryFilterType`
-   `CKDBQueryRecordsRequestBody`
-   `CKDBQuerySort`
-   `CKDBQuerySortOrder`
-   `CKDBRecord`
-   `CKDBRecordChangesRequestBody`
-   `CKDBRecordChangesResponse`
-   `CKDBRecordFieldAssetListValue`
-   `CKDBRecordFieldAssetValue`
-   `CKDBRecordFieldBytesListValue`
-   `CKDBRecordFieldBytesValue`
-   `CKDBRecordFieldDoubleListValue`
-   `CKDBRecordFieldDoubleValue`
-   `CKDBRecordFieldEmptyListValue`
-   `CKDBRecordFieldEncryptedBytesListValue`
-   `CKDBRecordFieldEncryptedBytesValue`
-   `CKDBRecordFieldEncryptedDoubleListValue`
-   `CKDBRecordFieldEncryptedDoubleValue`
-   `CKDBRecordFieldEncryptedInt64ListValue`
-   `CKDBRecordFieldEncryptedInt64Value`
-   `CKDBRecordFieldEncryptedLocationListValue`
-   `CKDBRecordFieldEncryptedLocationValue`
-   `CKDBRecordFieldEncryptedStringListValue`
-   `CKDBRecordFieldEncryptedStringValue`
-   `CKDBRecordFieldEncryptedTimestampListValue`
-   `CKDBRecordFieldEncryptedTimestampValue`
-   `CKDBRecordFieldInt64ListValue`
-   `CKDBRecordFieldInt64Value`
-   `CKDBRecordFieldLocationListValue`
-   `CKDBRecordFieldLocationValue`
-   `CKDBRecordFieldReferenceListValue`
-   `CKDBRecordFieldReferenceValue`
-   `CKDBRecordFieldStringListValue`
-   `CKDBRecordFieldStringValue`
-   `CKDBRecordFieldTimestampListValue`
-   `CKDBRecordFieldTimestampValue`
-   `CKDBRecordFieldValue`
-   `CKDBRecordReference`
-   `CKDBRecordReferenceAction`
-   `CKDBRecordResponse`
-   `CKDBRecordResult`
-   `CKDBRecordsResponse`
-   `CKDBResolveRecordRequestBody`
-   `CKDBResolveRecordResponse`
-   `CKDBResolvedRecord`
-   `CKDBSchemaImportRequestBody`
-   `CKDBSessionUser`
-   `CKDBSessionUserResponse`
-   `CKDBShareAcceptanceStatus`
-   `CKDBShareParticipant`
-   `CKDBShareParticipantType`
-   `CKDBSharePotentialParticipant`
-   `CKDBStableUrl`
-   `CKDBStreamingAsset`
-   `CKDBUserIdentity`
-   `CKDBUserIdentityLookupInfo`
-   `CKDBUserNameComponents`
-   `CKDBValidateSchemaResponse`
-   `CKDBZone`
-   `CKDBZoneId`
-   `CKDBZoneResponse`
-   `CKDBZonesResponse`

## 常见问题

### @apple/cktool\.api\.database 是什么？

Apple CKTool JS "数据库" API

### 如何安装 @apple/cktool\.api\.database？

在项目目录运行 npm install @apple/cktool\.api\.database，或使用 pnpm add / yarn add / bun add。

### @apple/cktool\.api\.database 支持 TypeScript 吗？

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

### @apple/cktool\.api\.database 支持 ESM 还是 CommonJS？

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

### @apple/cktool\.api\.database 可以商用吗？

@apple/cktool\.api\.database 使用 SEE LICENSE IN LICENSE\.md 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @apple/cktool\.api\.database 的下载量有多少？

根据 npm 官方下载统计，@apple/cktool\.api\.database 在 2026/10/07 – 2026/11/05 这 30 天内被下载 2,586 次，日均约 86 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @apple/cktool\.api\.database 还在维护吗？

最新版本 1\.3\.2 发布于 2022/06/04（4 年前）；至今共发布 7 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/12/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。