# @apicity/dolthub 中文文档

规范地址：https://npmcn.com/package/%40apicity/dolthub/

版本：0\.27\.0
npm 元数据更新时间：2026-11-06T09:53:54.569Z
中文译文更新时间：2026-11-06T10:17:11.143Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40apicity/dolthub
原文对照：https://npmcn.com/package/%40apicity/dolthub/?lang=original
项目主页：https://github.com/justintanner/apicity#readme
源码仓库：https://github.com/justintanner/apicity

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

- 包体积（解压后）：145 kB，23 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：1 个
- 首次发布：2026-05-31T12:10:45.636Z
- 最新版本发布：2026-11-06T09:53:52.769Z
- 近 30 天下载量：3579（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：88（近 12 个月 88 个）

## 中文简介

多尔特Hub API 提供商,用于执行 SQL 和管理多尔特数据库.

## 安装

```sh
npm install @apicity/dolthub
```

也可以使用：`pnpm add @apicity/dolthub`、`yarn add @apicity/dolthub`、`bun add @apicity/dolthub`

## README

# @apicity/dolthub (英语)

[![npm](https://img.shields.io/npm/v/@apicity/dolthub?color=cb0000)](https://www.npmjs.com/package/@apicity/dolthub) [![dependencies](https://img.shields.io/badge/dependencies-1-blue)](https://npmcn.com/package/%40apicity/dolthub/package.json) [![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue?logo=typescript&logoColor=white)](https://npmcn.com/package/%40apicity/dolthub/tsconfig.json)

多尔特Hub API 提供商,用于执行 SQL 和管理多尔特数据库.

运行时间依赖性 :

-   `zod@^4.6.6` - 请求在每一个 POST 端点上附加计划 `.schema`

## 安装

```bash
npm install @apicity/dolthub
# or
pnpm add @apicity/dolthub
```

## 快速启动

```typescript
import { createDoltHub } from "@apicity/dolthub";

const dolthub = createDoltHub({ apiToken: process.env.DOLTHUB_API_KEY! });
```

## API 参考

23个终点跨出4个组. 每个方法都映射出上游的 URL 路径 .

### 数据库

`POST` **`dolthub.api.v2.databases.branches.create`**

`POST https://www.dolthub.com/api/v2/databases/{owner}/{database}/branches`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/v2/database)

```typescript
const res = await dolthub.api.v2.databases.branches.create({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`GET` **`dolthub.api.v2.databases.branches.list`**

`GET https://www.dolthub.com/api/v2/databases/{owner}/{database}/branches{query}`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/v2/database)

```typescript
const res = await dolthub.api.v2.databases.branches.list({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`POST` **`dolthub.api.v2.databases.create`**

`POST [https://www.dolthub.com/api/v2/databases](https://www.dolthub.com/api/v2/databases)`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/v2/database)

```typescript
const res = await dolthub.api.v2.databases.create({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`POST` **`dolthub.api.v2.databases.forks.create`**

`POST https://www.dolthub.com/api/v2/databases/{owner}/{database}/forks`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/v2/database)

```typescript
const res = await dolthub.api.v2.databases.forks.create({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`POST` **`dolthub.api.v2.databases.pulls.create`**

`POST https://www.dolthub.com/api/v2/databases/{owner}/{database}/pulls`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/v2/database)

```typescript
const res = await dolthub.api.v2.databases.pulls.create({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`GET` **`dolthub.api.v2.databases.pulls`**

`GET https://www.dolthub.com/api/v2/databases/{owner}/{database}/pulls/{pullNumber}`

成本等级 : `cheap`

```typescript
const res = await dolthub.api.v2.databases.pulls.get({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`GET` **`dolthub.api.v2.databases.pulls.list`**

`GET https://www.dolthub.com/api/v2/databases/{owner}/{database}/pulls{query}`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/v2/database)

```typescript
const res = await dolthub.api.v2.databases.pulls.list({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`POST` **`dolthub.api.v2.databases.pulls.merge`**

`POST https://www.dolthub.com/api/v2/databases/{owner}/{database}/pulls/{pullNumber}/merge`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/v2/database)

```typescript
const res = await dolthub.api.v2.databases.pulls.merge({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`GET` **`dolthub.api.v2.databases.sql.read`**

`GET https://www.dolthub.com/api/v2/databases/{owner}/{database}/sql{query}`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/v2/database)

```typescript
const res = await dolthub.api.v2.databases.sql.read({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`POST` **`dolthub.api.v2.databases.sql.write`**

`POST https://www.dolthub.com/api/v2/databases/{owner}/{database}/sql-writes`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/v2/database)

```typescript
const res = await dolthub.api.v2.databases.sql.write({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

### 业务

`GET` **`dolthub.api.v2.operations`**

`GET https://www.dolthub.com/api/v2/operations/{operationId}`

成本等级 : `cheap`

```typescript
const res = await dolthub.api.v2.operations.get({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

### 用户

`GET` **`dolthub.api.v2.user`**

`GET [https://www.dolthub.com/api/v2/user](https://www.dolthub.com/api/v2/user)`

成本等级 : `cheap`

```typescript
const res = await dolthub.api.v2.user.get();
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

### v1alpha1 (英语)

`POST` **`dolthub.v1alpha1.branches.create`**

`POST https://www.dolthub.com/api/v1alpha1/{owner}/{database}/branches`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/database)

```typescript
const res = await dolthub.v1alpha1.branches.create({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`GET` **`dolthub.v1alpha1.branches.list`**

`GET https://www.dolthub.com/api/v1alpha1/{owner}/{database}/branches`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/database)

```typescript
const res = await dolthub.v1alpha1.branches.list({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`POST` **`dolthub.v1alpha1.database.create`**

`POST [https://www.dolthub.com/api/v1alpha1/database](https://www.dolthub.com/api/v1alpha1/database)`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/database)

```typescript
const res = await dolthub.v1alpha1.database.create({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`POST` **`dolthub.v1alpha1.pulls.create`**

`POST https://www.dolthub.com/api/v1alpha1/{owner}/{database}/pulls`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/database)

```typescript
const res = await dolthub.v1alpha1.pulls.create({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`GET` **`dolthub.v1alpha1.pulls`**

`GET https://www.dolthub.com/api/v1alpha1/{owner}/{database}/pulls/{pullId}`

成本等级 : `cheap`

```typescript
const res = await dolthub.v1alpha1.pulls.get({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`GET` **`dolthub.v1alpha1.pulls.list`**

`GET https://www.dolthub.com/api/v1alpha1/{owner}/{database}/pulls{query}`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/database)

```typescript
const res = await dolthub.v1alpha1.pulls.list({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`POST` **`dolthub.v1alpha1.pulls.merge`**

`POST https://www.dolthub.com/api/v1alpha1/{owner}/{database}/pulls/{pullId}/merge`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/database)

```typescript
const res = await dolthub.v1alpha1.pulls.merge({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`GET` **`dolthub.v1alpha1.sql.read`**

`GET https://www.dolthub.com/api/v1alpha1/{owner}/{database}{refPath}{query}`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/sql)

```typescript
const res = await dolthub.v1alpha1.sql.read({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`POST` **`dolthub.v1alpha1.sql.write`**

`POST https://www.dolthub.com/api/v1alpha1/{owner}/{database}/write/{fromBranch}/{toBranch}{query}`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/sql)

```typescript
const res = await dolthub.v1alpha1.sql.write({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`GET` **`dolthub.v1alpha1.sql.writePoll`**

`GET https://www.dolthub.com/api/v1alpha1/{owner}/{database}/write{query}`

成本等级 : `cheap`

[上游区域](https://www.dolthub.com/docs/products/dolthub/api/sql)

```typescript
const res = await dolthub.v1alpha1.sql.writePoll({ /* ... */ });
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

`GET` **`dolthub.v1alpha1.user`**

`GET [https://www.dolthub.com/api/v1alpha1/user](https://www.dolthub.com/api/v1alpha1/user)`

成本等级 : `cheap`

```typescript
const res = await dolthub.v1alpha1.user.get();
```

资料来源: [`packages/provider/dolthub/src/dolthub.ts`](https://npmcn.com/package/%40apicity/dolthub/src/dolthub.ts)

部分 [辣点](https://github.com/justintanner/apicity) 单相机.

## 许可证

麻省理工学院——见 [自由主义](https://npmcn.com/package/%40apicity/dolthub/LICENSE)。 。 。 .

## 常见问题

### @apicity/dolthub 是什么？

多尔特Hub API 提供商,用于执行 SQL 和管理多尔特数据库\.

### 如何安装 @apicity/dolthub？

在项目目录运行 npm install @apicity/dolthub，或使用 pnpm add / yarn add / bun add。

### @apicity/dolthub 支持 TypeScript 吗？

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

### @apicity/dolthub 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @apicity/dolthub 需要什么版本的 Node\.js？

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

### @apicity/dolthub 可以商用吗？

@apicity/dolthub 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @apicity/dolthub 的下载量有多少？

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

### @apicity/dolthub 还在维护吗？

最新版本 0\.27\.0 发布于 2026/11/06（今天）；至今共发布 88 个版本，其中过去 12 个月发布了 88 个；首次发布于 2026/05/31。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。