forgedb 0.3.1

ForgeDB — an application database generator. Compiles a declarative .forge schema into tailored Rust database code, a TypeScript SDK, and a REST API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

---
title: "forgedb compact"
description: "Inspect database statistics and get maintenance recommendations. Offline compaction is deprecated."
purpose: "reference"
---
Database maintenance and inspection. The read-only `stats` and `analyze` subcommands
work over a data directory; the mutating `run` and `vacuum` subcommands are **deprecated
and exit non-zero**.

<Callout type="warning" title="Offline compaction is removed">
`compact run` and `compact vacuum` mutate nothing and exit non-zero (code 6). Their
tombstone-based algorithm is unsafe against the generated mutation surface: it reclaims
nothing from updates and can **resurrect deleted rows**. Generated databases compact
automatically in-process under the single-writer lock, or call `Database::compact()` from
your running app. That path is keep-set-based and never resurrects deletes.
</Callout>

## Subcommands

| Command | Status | Purpose |
|---|---|---|
| `stats` | active | Show per-model or database-wide statistics. |
| `analyze` | active | Analyze the database and print recommendations. |
| `run` | **deprecated** | No-op; exits non-zero with guidance. |
| `vacuum` | **deprecated** | Alias for `run`; no-op, exits non-zero. |

### stats

```bash
forgedb compact stats [--data-dir <DIR>] [--model <NAME>] [--json]
```

| Flag | Type / default | Meaning |
|---|---|---|
| `-d`, `--data-dir <DIR>` | string (`data`) | Data directory to inspect. |
| `-m`, `--model <NAME>` | string | Show statistics for a single model only. |
| `--json` | bool (false) | Emit JSON. |

### analyze

```bash
forgedb compact analyze [--data-dir <DIR>] [--json]
```

| Flag | Type / default | Meaning |
|---|---|---|
| `-d`, `--data-dir <DIR>` | string (`data`) | Data directory to analyze. |
| `--json` | bool (false) | Emit JSON. |

## Examples

Database-wide statistics as JSON:

```bash
forgedb compact stats --data-dir ./data --json
```

Analyze a single data directory:

```bash
forgedb compact analyze --data-dir ./data
```

The deprecated path exits non-zero:

```bash
forgedb compact run
# error: Offline `forgedb compact` / `vacuum` is removed ...
# (exit code 6)
```