Configuration
A node is configured through CLI flags (and, for clusters, a cluster.json).
The most common knobs:
| Flag | Default | Purpose |
|---|---|---|
--port | 5000 | HTTP listen port |
--data-dir | ./data | Directory holding the .dfdb file(s) |
Engine options (when embedding) include the page-cache size and whether the write-ahead log is enabled:
var options = new DatabaseOptions {
CacheSizeInPages = 200_000, // page cache (8 KB pages)
EnableWal = true, // durability via write-ahead log
};
using var db = DocumentForgeDb.Create("app.dfdb", options);The cluster.json schema (shards, leaders, collection strategies) is covered in
Concepts → Sharding.
A complete field-by-field reference (every option, default, and effect) is being built out.
Last updated on