chkit 0.1.0-beta.6 → 0.1.0-beta.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/package.json +10 -4
package/README.md
CHANGED
|
@@ -2,12 +2,24 @@
|
|
|
2
2
|
|
|
3
3
|
ClickHouse schema and migration CLI for TypeScript projects.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Define your ClickHouse schema in TypeScript, generate migrations automatically, detect drift, and run CI checks -- all from a single CLI.
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- **Schema-as-code** -- Define tables, views, and materialized views in TypeScript using a declarative DSL
|
|
10
|
+
- **Automatic migration generation** -- Diff your schema changes and generate timestamped SQL migrations with rename detection
|
|
11
|
+
- **Safe migrations** -- Destructive operations are flagged with risk levels and require explicit confirmation
|
|
12
|
+
- **Drift detection** -- Compare your local schema against a live ClickHouse instance to catch out-of-band changes
|
|
13
|
+
- **CI gate** -- Run `chkit check` to fail builds on pending migrations, checksum mismatches, or schema drift
|
|
14
|
+
- **TypeScript codegen** -- Generate row types and optional Zod schemas from your schema definitions (`@chkit/plugin-codegen`)
|
|
15
|
+
- **Schema pulling** -- Introspect an existing ClickHouse database into local schema files (`@chkit/plugin-pull`)
|
|
16
|
+
- **Data backfill** -- Time-windowed, checkpointed backfill operations with retry logic (`@chkit/plugin-backfill`)
|
|
17
|
+
- **JSON output** -- Every command supports `--json` for scripting and automation
|
|
6
18
|
|
|
7
19
|
## Install
|
|
8
20
|
|
|
9
21
|
```bash
|
|
10
|
-
bun add -d chkit
|
|
22
|
+
bun add -d chkit
|
|
11
23
|
```
|
|
12
24
|
|
|
13
25
|
## Usage
|
|
@@ -34,6 +46,14 @@ bunx chkit check
|
|
|
34
46
|
|
|
35
47
|
All commands support `--json` for machine-readable output and `--config <path>` to specify a custom config file.
|
|
36
48
|
|
|
49
|
+
## Plugins
|
|
50
|
+
|
|
51
|
+
| Plugin | Description |
|
|
52
|
+
|--------|-------------|
|
|
53
|
+
| [`@chkit/plugin-codegen`](https://www.npmjs.com/package/@chkit/plugin-codegen) | Generate TypeScript row types and Zod schemas |
|
|
54
|
+
| [`@chkit/plugin-pull`](https://www.npmjs.com/package/@chkit/plugin-pull) | Pull schemas from a live ClickHouse instance |
|
|
55
|
+
| [`@chkit/plugin-backfill`](https://www.npmjs.com/package/@chkit/plugin-backfill) | Time-windowed data backfill with checkpoints |
|
|
56
|
+
|
|
37
57
|
## Documentation
|
|
38
58
|
|
|
39
59
|
See the [chkit documentation](https://chkit.obsessiondb.com).
|
|
@@ -41,3 +61,7 @@ See the [chkit documentation](https://chkit.obsessiondb.com).
|
|
|
41
61
|
## License
|
|
42
62
|
|
|
43
63
|
[MIT](../../LICENSE)
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
Sponsored by [ObsessionDB](https://obsessiondb.com)
|
package/package.json
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "chkit",
|
|
3
|
-
"version": "0.1.0-beta.
|
|
3
|
+
"version": "0.1.0-beta.7",
|
|
4
|
+
"homepage": "https://chkit.obsessiondb.com",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/obsessiondb/chkit.git",
|
|
8
|
+
"directory": "packages/cli"
|
|
9
|
+
},
|
|
4
10
|
"type": "module",
|
|
5
11
|
"main": "./dist/index.js",
|
|
6
12
|
"types": "./dist/index.d.ts",
|
|
@@ -19,9 +25,9 @@
|
|
|
19
25
|
"clean": "rm -rf dist"
|
|
20
26
|
},
|
|
21
27
|
"dependencies": {
|
|
22
|
-
"@chkit/clickhouse": "0.1.0-beta.
|
|
23
|
-
"@chkit/codegen": "0.1.0-beta.
|
|
24
|
-
"@chkit/core": "0.1.0-beta.
|
|
28
|
+
"@chkit/clickhouse": "0.1.0-beta.7",
|
|
29
|
+
"@chkit/codegen": "0.1.0-beta.7",
|
|
30
|
+
"@chkit/core": "0.1.0-beta.7",
|
|
25
31
|
"@stricli/core": "^1.2.5",
|
|
26
32
|
"fast-glob": "^3.3.2"
|
|
27
33
|
}
|