让开源，少一点语言距离。
npm包中文文档

@apicity/dolthub

中文文档
0.27.0发布于 2026/11/06MITTypeScriptES Module近 30 天下载 3579

DoltHub API provider for executing SQL and managing Dolt databases.

原始使用文档
中文原文
文档目录8 节
  1. Installation
  2. Quick Start
  3. API Reference
  4. databases
  5. operations
  6. user
  7. v1alpha1
  8. License

@apicity/dolthub

npm dependencies TypeScript

DoltHub API provider for executing SQL and managing Dolt databases.

Runtime dependencies:

  • zod@^4.6.6 — request schemas attached to every POST endpoint as .schema

Installation

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

Quick Start

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

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

API Reference

23 endpoints across 4 groups. Each method mirrors an upstream URL path.

databases

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

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

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

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

POST dolthub.api.v2.databases.create

POST https://www.dolthub.com/api/v2/databases

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

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

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

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

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

GET dolthub.api.v2.databases.pulls

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

Cost tier: cheap

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

Source: packages/provider/dolthub/src/dolthub.ts

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

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

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

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

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

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

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

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

operations

GET dolthub.api.v2.operations

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

Cost tier: cheap

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

Source: packages/provider/dolthub/src/dolthub.ts

user

GET dolthub.api.v2.user

GET https://www.dolthub.com/api/v2/user

Cost tier: cheap

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

Source: packages/provider/dolthub/src/dolthub.ts

v1alpha1

POST dolthub.v1alpha1.branches.create

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

GET dolthub.v1alpha1.branches.list

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

POST dolthub.v1alpha1.database.create

POST https://www.dolthub.com/api/v1alpha1/database

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

POST dolthub.v1alpha1.pulls.create

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

GET dolthub.v1alpha1.pulls

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

Cost tier: cheap

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

Source: packages/provider/dolthub/src/dolthub.ts

GET dolthub.v1alpha1.pulls.list

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

POST dolthub.v1alpha1.pulls.merge

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

GET dolthub.v1alpha1.sql.read

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

POST dolthub.v1alpha1.sql.write

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

GET dolthub.v1alpha1.sql.writePoll

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

Cost tier: cheap

Upstream docs ↗

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

Source: packages/provider/dolthub/src/dolthub.ts

GET dolthub.v1alpha1.user

GET https://www.dolthub.com/api/v1alpha1/user

Cost tier: cheap

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

Source: packages/provider/dolthub/src/dolthub.ts

Part of the apicity monorepo.

License

MIT — see LICENSE.

版本与发布记录

@apicity/dolthub 共发布 88 个版本，首次发布于 2026/05/31；过去 12 个月发布了 88 个版本。

版本发布日期距今
0.27.0latest2026/11/06今天
0.26.02026/11/051 天前
0.25.02026/11/033 天前
0.24.12026/11/024 天前
0.24.02026/11/014 天前
0.23.12026/11/015 天前

关于 @apicity/dolthub 的常见问题

@apicity/dolthub 是什么？

DoltHub API provider for executing SQL and managing Dolt databases.

如何安装 @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 和提交记录判断。