# @chkit/core 中文文档

规范地址：https://npmcn.com/package/%40chkit/core/

版本：0\.2\.0-beta\.16
npm 元数据更新时间：2026-11-08T23:59:28.107Z
中文译文更新时间：2026-11-09T13:58:44.828Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：716 kB，170 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：zod ^4\.3\.0
- 首次发布：2026-02-15T22:42:20.553Z
- 最新版本发布：2026-11-08T23:59:27.799Z
- 近 30 天下载量：12878（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 44 个）

## 中文简介

Schema DSL, 配置、 diff 引擎和 chkit 的迁移规划器

## 安装

```sh
npm install @chkit/core
```

也可以使用：`pnpm add @chkit/core`、`yarn add @chkit/core`、`bun add @chkit/core`

## README

# @ chkit/ 核心

TypeScript schema DSL,配置,以及用于ClickHouse schema管理的diff引擎.

部分 [齐克特](https://github.com/obsessiondb/chkit) 单相机。 此软件包一般与 [`chkit`](https://www.npmjs.com/package/chkit) CLI(英语:CLI).

## 安装

```sh
bun add -d chkit @chkit/core
```

## 使用量

在 TypeScript 中定义您的 ClickHouse 计划 :

```ts
// src/db/schema/events.ts
import { schema, table } from '@chkit/core'

const events = table({
  database: 'default',
  name: 'events',
  engine: 'MergeTree',
  columns: [
    { name: 'id', type: 'UInt64' },
    { name: 'source', type: 'String' },
    { name: 'occurred_at', type: 'DateTime64(3)', default: { expression: 'now64(3)' } },
  ],
  primaryKey: ['id'],
  orderBy: ['id'],
  partitionBy: 'toYYYYMM(occurred_at)',
})

export default schema(events)
```

配置您的工程 :

```ts
// clickhouse.config.ts
import { defineConfig } from '@chkit/core'

export default defineConfig({
  schema: './src/db/schema/**/*.ts',
  outDir: './chkit',
  clickhouse: {
    url: process.env.CLICKHOUSE_URL ?? 'http://localhost:8123',
    username: process.env.CLICKHOUSE_USER ?? 'default',
    password: process.env.CLICKHOUSE_PASSWORD ?? '',
    database: 'default',
  },
})
```

设置开发数据库的连接环境变量,然后生成、审查和应用迁移:

```sh
bunx chkit generate --name create-events
# Review the SQL in chkit/migrations/ and preview the plan:
bunx chkit migrate --json
bunx chkit migrate --apply
bunx chkit check
```

提交计划定义、迁移文件,以及 `chkit/meta/` 一起来 更改定义并重复工作流程来发展数据库.

## 文档

-   [初学辅导](https://chkit.obsessiondb.com/tutorials/first-schema/) ——完整的迁移工作流程.
-   [Schema DSL 参考文献](https://chkit.obsessiondb.com/schema/dsl-reference/) 表格、观点、实际观点、词典和计划选项.
-   [配置](https://chkit.obsessiondb.com/configuration/overview/) ——配置文件,连接和插件.
-   [Python 概览 (β)](https://chkit.obsessiondb.com/python/overview/) - 与之相当的工作流程 `chkit-py`。 。 。 .

## 许可证

[麻省理工学院](https://npmcn.com/package/LICENSE)

## 常见问题

### @chkit/core 是什么？

Schema DSL, 配置、 diff 引擎和 chkit 的迁移规划器

### 如何安装 @chkit/core？

在项目目录运行 npm install @chkit/core，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.3\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @chkit/core 支持 TypeScript 吗？

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

### @chkit/core 支持 ESM 还是 CommonJS？

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

### @chkit/core 可以商用吗？

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

### @chkit/core 的下载量有多少？

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

### @chkit/core 还在维护吗？

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