@apicity/dolthub

DoltHub API provider for executing SQL and managing Dolt databases.

Runtime dependencies:

• zod@^4.4.3 — 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({ apiKey: process.env.DOLTHUB_API_KEY! });

API Reference

11 endpoints across 1 group. Each method mirrors an upstream URL path.

v1alpha1

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

Upstream docs ↗

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

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

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

Upstream docs ↗

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

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

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

Upstream docs ↗

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

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

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

Upstream docs ↗

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

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

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

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

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

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

Upstream docs ↗

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

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

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

Upstream docs ↗

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

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

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

Upstream docs ↗

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

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

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

Upstream docs ↗

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

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

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

Upstream docs ↗

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

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

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

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

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

Middleware

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

const dolthub = createDoltHub({ apiKey: process.env.DOLTHUB_API_KEY! });
const models = withRetry(dolthub.get.v1.models, { retries: 3 });

Part of the apicity monorepo.

License

MIT — see LICENSE.